Package software.amazon.awscdk

Interface TagProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

TagProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:10.156Z")
@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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	TagProps.Builder	A builder for TagProps
static final class	TagProps.Jsii$Proxy	An implementation for TagProps

Method Summary

Modifier and Type	Method	Description
static TagProps.Builder	builder()
default Boolean	getApplyToLaunchedInstances()	Whether the tag should be applied to instances in an AutoScalingGroup.
default List<String>	getExcludeResourceTypes()	An array of Resource Types that will not receive this tag.
default List<String>	getIncludeResourceTypes()	An array of Resource Types that will receive this tag.
default Number	getPriority()	Priority of the tag operation.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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