@finnairoyj/cdk-constructs-lib
    Preparing search index...

    Aspect that requires that a specified tag is defined for a resource

    NOTE: Due to the CDK Aspects processing order, if the Tag value is set by an Aspect, this validation will not work if the Tag Aspect is defined in an inner scope. For example, RequireTagAspect is defined for the Stack scope, but the Tag itself is set at Construct scope. This limitation doesn't apply to tags that are explicitly defined for resources

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    throwErrors: boolean

    Methods

    • Adds a deprecation warning for a specific API.

      Deprecations will be added only once per construct as a warning and will be deduplicated based on the api.

      If the environment variable CDK_BLOCK_DEPRECATIONS is set, this method will throw an error instead with the deprecation message.

      Parameters

      • node: IConstruct

        Construct to add the message to

      • api: string

        The API being deprecated in the format module.Class.property (e.g. @aws-cdk/core.Construct.node).

      • message: string

        The deprecation message to display, with information about alternatives.

      Returns void

    • Adds an { "error": } metadata entry to this construct. The toolkit will fail deployment of any stack that has errors reported against it.

      Parameters

      • node: IConstruct

        Target construct

      • message: string

        The error message

      Returns void

    • Adds an acknowledgeable info metadata entry to this construct.

      The CLI will display the info when an app is synthesized. If the info is acknowledged using acknowledgeInfo(), it will not be shown by the CLI.

      Parameters

      • node: IConstruct

        Target construct

      • id: string

        — The unique identifier for the warning. This can be used to acknowledge the warning

      • message: string

        — The info message

      Returns void

    • Adds an acknowledgeable warning metadata entry to this construct.

      The CLI will display the warning when an app is synthesized, or fail if run in --strict mode.

      If the warning is acknowledged using acknowledgeWarning(), it will not be shown by the CLI, and will notcause --strict mode to fail synthesis.

      Parameters

      • node: IConstruct

        Target construct

      • id: string

        — The unique identifier for the warning. This can be used to acknowledge the warning

      • message: string

        — The warning message

      Returns void