software.amazon.awscdk

Class Tag

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Tag

All Implemented Interfaces:

IAspect, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:35.940Z")
 @Stability(value=Stable)
public class Tag
extends software.amazon.jsii.JsiiObject
implements IAspect

The Tag Aspect will handle adding a tag to this node and cascading tags to children.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 Tag tag = Tag.Builder.create("key", "value")
         .applyToLaunchedInstances(false)
         .excludeResourceTypes(List.of("excludeResourceTypes"))
         .includeResourceTypes(List.of("includeResourceTypes"))
         .priority(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Tag.Builder A fluent builder for Tag.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IAspect

IAspect.Jsii$Default, IAspect.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Tag(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Tag(software.amazon.jsii.JsiiObjectRef objRef)
	Tag(String key, String value)
	Tag(String key, String value, TagProps props)

Method Summary

Modifier and Type	Method and Description
protected void	applyTag(ITaggable resource)
String	getKey() The string key for the tag.
protected TagProps	getProps()
String	getValue() The string value of the tag.
void	visit(software.constructs.IConstruct construct) All aspects can visit an IConstruct.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Tag

protected Tag(software.amazon.jsii.JsiiObjectRef objRef)

Tag

protected Tag(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Tag

@Stability(value=Stable)
public Tag(@NotNull
                                    String key,
                                    @NotNull
                                    String value,
                                    @Nullable
                                    TagProps props)

Parameters:

key - This parameter is required.

value - This parameter is required.

props -

Tag

@Stability(value=Stable)
public Tag(@NotNull
                                    String key,
                                    @NotNull
                                    String value)

Parameters:

key - This parameter is required.

value - This parameter is required.

Method Detail

applyTag

@Stability(value=Stable)
protected void applyTag(@NotNull
                                                 ITaggable resource)

Parameters:

resource - This parameter is required.

visit

@Stability(value=Stable)
public void visit(@NotNull
                                           software.constructs.IConstruct construct)

All aspects can visit an IConstruct.

Specified by:

visit in interface IAspect

Parameters:

construct - This parameter is required.

getKey

@Stability(value=Stable)
 @NotNull
public String getKey()

The string key for the tag.

getProps

@Stability(value=Stable)
 @NotNull
protected TagProps getProps()

getValue

@Stability(value=Stable)
 @NotNull
public String getValue()

The string value of the tag.