TagProps

class aws_cdk.core.TagProps(*, apply_to_launched_instances=None, exclude_resource_types=None, include_resource_types=None, priority=None)

Bases: object

Properties for a tag.

Parameters

  • apply_to_launched_instances (Optional[bool]) – Whether the tag should be applied to instances in an AutoScalingGroup. Default: true

  • exclude_resource_types (Optional[Sequence[str]]) – An array of Resource Types that will not receive this tag. An empty array will allow this tag to be applied to all resources. A non-empty array will apply this tag only if the Resource type is not in this array. Default: []

  • include_resource_types (Optional[Sequence[str]]) – An array of Resource Types that will receive this tag. An empty array will match any Resource. A non-empty array will apply this tag only to Resource types that are included in this array. Default: []

  • priority (Union[int, float, None]) – Priority of the tag operation. Higher or equal priority tags will take precedence. Setting priority will enable the user to control tags when they need to not follow the default precedence pattern of last applied and closest to the construct in the tree. Default: Default priorities: - 100 for {@link SetTag} - 200 for {@link RemoveTag} - 50 for tags added directly to CloudFormation resources

Attributes

apply_to_launched_instances

Whether the tag should be applied to instances in an AutoScalingGroup.

Default

true

Return type

Optional[bool]

exclude_resource_types

An array of Resource Types that will not receive this tag.

An empty array will allow this tag to be applied to all resources. A non-empty array will apply this tag only if the Resource type is not in this array.

Default

[]

Return type

Optional[List[str]]

include_resource_types

An array of Resource Types that will receive this tag.

An empty array will match any Resource. A non-empty array will apply this tag only to Resource types that are included in this array.

Default

[]

Return type

Optional[List[str]]

priority

Priority of the tag operation.

Higher or equal priority tags will take precedence.

Setting priority will enable the user to control tags when they need to not follow the default precedence pattern of last applied and closest to the construct in the tree.

Default

Default priorities:

  • 100 for {@link SetTag}

  • 200 for {@link RemoveTag}

  • 50 for tags added directly to CloudFormation resources

Return type

Union[int, float, None]