software.amazon.awscdk.core

Class Tag

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.core.Tag

All Implemented Interfaces:

IAspect, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.13.0 (build 385c325)",
           date="2020-10-19T20:38:05.426Z")
 @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.

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.core.IAspect

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
static void	add(Construct scope, String key, String value) Deprecated. use `Tags.of(scope).add()`
static void	add(Construct scope, String key, String value, TagProps props) Deprecated. use `Tags.of(scope).add()`
protected void	applyTag(ITaggable resource)
String	getKey() The string key for the tag.
protected TagProps	getProps()
String	getValue() The string value of the tag.
static void	remove(Construct scope, String key) Deprecated. use `Tags.of(scope).remove()`
static void	remove(Construct scope, String key, TagProps props) Deprecated. use `Tags.of(scope).remove()`
void	visit(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

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

add

@Stability(value=Deprecated)
 @Deprecated
public static void add(@NotNull
                                                                 Construct scope,
                                                                 @NotNull
                                                                 String key,
                                                                 @NotNull
                                                                 String value,
                                                                 @Nullable
                                                                 TagProps props)

Deprecated. use `Tags.of(scope).add()`

(deprecated) DEPRECATED: add tags to the node of a construct and all its the taggable children.

Parameters:

scope - This parameter is required.

key - This parameter is required.

value - This parameter is required.

props -

add

@Stability(value=Deprecated)
 @Deprecated
public static void add(@NotNull
                                                                 Construct scope,
                                                                 @NotNull
                                                                 String key,
                                                                 @NotNull
                                                                 String value)

Deprecated. use `Tags.of(scope).add()`

(deprecated) DEPRECATED: add tags to the node of a construct and all its the taggable children.

Parameters:

scope - This parameter is required.

key - This parameter is required.

value - This parameter is required.

remove

@Stability(value=Deprecated)
 @Deprecated
public static void remove(@NotNull
                                                                    Construct scope,
                                                                    @NotNull
                                                                    String key,
                                                                    @Nullable
                                                                    TagProps props)

Deprecated. use `Tags.of(scope).remove()`

(deprecated) DEPRECATED: remove tags to the node of a construct and all its the taggable children.

Parameters:

scope - This parameter is required.

key - This parameter is required.

props -

remove

@Stability(value=Deprecated)
 @Deprecated
public static void remove(@NotNull
                                                                    Construct scope,
                                                                    @NotNull
                                                                    String key)

Deprecated. use `Tags.of(scope).remove()`

(deprecated) DEPRECATED: remove tags to the node of a construct and all its the taggable children.

Parameters:

scope - This parameter is required.

key - This parameter is required.

applyTag

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

Parameters:

resource - This parameter is required.

visit

@Stability(value=Stable)
public void visit(@NotNull
                                           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.