Interface TagProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
TagProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-27T16:50:51.961Z") @Stability(Stable) public interface TagProps extends software.amazon.jsii.JsiiSerializable
Properties for a tag.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 TagProps tagProps = TagProps.builder()
         .applyToLaunchedInstances(false)
         .excludeResourceTypes(List.of("excludeResourceTypes"))
         .includeResourceTypes(List.of("includeResourceTypes"))
         .priority(123)
         .build();
 
  • Method Details

    • getApplyToLaunchedInstances

      @Stability(Stable) @Nullable default Boolean getApplyToLaunchedInstances()
      Whether the tag should be applied to instances in an AutoScalingGroup.

      Default: true

    • getExcludeResourceTypes

      @Stability(Stable) @Nullable default List<String> getExcludeResourceTypes()
      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: []

    • getIncludeResourceTypes

      @Stability(Stable) @Nullable default List<String> getIncludeResourceTypes()
      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: []

    • getPriority

      @Stability(Stable) @Nullable default Number getPriority()
      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 `SetTag` - 200 for `RemoveTag` - 50 for tags added directly to CloudFormation resources

    • builder

      @Stability(Stable) static TagProps.Builder builder()
      Returns:
      a TagProps.Builder of TagProps