software.amazon.awscdk.core

Class Tag

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.core.Tag

All Implemented Interfaces:

IAspect

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:19:53.152Z")
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.core.*;
 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 interface software.amazon.awscdk.core.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(java.lang.String key, java.lang.String value)
	Tag(java.lang.String key, java.lang.String value, TagProps props)

Method Summary

Modifier and Type	Method and Description
static void	add(Construct scope, java.lang.String key, java.lang.String value) Deprecated. use `Tags.of(scope).add()`
static void	add(Construct scope, java.lang.String key, java.lang.String value, TagProps props) Deprecated. use `Tags.of(scope).add()`
protected void	applyTag(ITaggable resource)
java.lang.String	getKey() The string key for the tag.
protected TagProps	getProps()
java.lang.String	getValue() The string value of the tag.
static void	remove(Construct scope, java.lang.String key) Deprecated. use `Tags.of(scope).remove()`
static void	remove(Construct scope, java.lang.String key, TagProps props) Deprecated. use `Tags.of(scope).remove()`
void	visit(IConstruct construct) All aspects can visit an IConstruct.

Methods inherited from class java.lang.Object

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

Constructor Detail

Tag

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

Tag

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

Tag

public Tag(java.lang.String key,
           java.lang.String value,
           TagProps props)

Parameters:

key - This parameter is required.

value - This parameter is required.

props -

Tag

public Tag(java.lang.String key,
           java.lang.String value)

Parameters:

key - This parameter is required.

value - This parameter is required.

Method Detail

add

@Deprecated
public static void add(Construct scope,
                                   java.lang.String key,
                                   java.lang.String value,
                                   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

@Deprecated
public static void add(Construct scope,
                                   java.lang.String key,
                                   java.lang.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

@Deprecated
public static void remove(Construct scope,
                                      java.lang.String key,
                                      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

@Deprecated
public static void remove(Construct scope,
                                      java.lang.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

protected void applyTag(ITaggable resource)

Parameters:

resource - This parameter is required.

visit

public void visit(IConstruct construct)

All aspects can visit an IConstruct.

Specified by:

visit in interface IAspect

Parameters:

construct - This parameter is required.

getKey

public java.lang.String getKey()

The string key for the tag.

getProps

protected TagProps getProps()

getValue

public java.lang.String getValue()

The string value of the tag.