software.amazon.awscdk.core

Class TagManager

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.core.TagManager

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/0.20.4 (build 96d89e1)",
           date="2019-11-12T11:54:39.769Z")
 @Stability(value=Stable)
public class TagManager
extends software.amazon.jsii.JsiiObject

TagManager facilitates a common implementation of tagging for Constructs.

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TagManager(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	TagManager(software.amazon.jsii.JsiiObjectRef objRef)
	TagManager(TagType tagType, String resourceTypeName)
	TagManager(TagType tagType, String resourceTypeName, Object tagStructure)

Method Summary

Modifier and Type	Method and Description
Boolean	applyTagAspectHere()
Boolean	applyTagAspectHere(List<String> include)
Boolean	applyTagAspectHere(List<String> include, List<String> exclude)
Boolean	hasTags() Returns true if there are any tags defined.
static Boolean	isTaggable(Object construct) Check whether the given construct is Taggable.
void	removeTag(String key, Number priority) Removes the specified tag from the array if it exists.
Object	renderTags() Renders tags into the proper format based on TagType.
void	setTag(String key, String value) Adds the specified tag to the array of tags.
void	setTag(String key, String value, Number priority) Adds the specified tag to the array of tags.
void	setTag(String key, String value, Number priority, Boolean applyToLaunchedInstances) Adds the specified tag to the array of tags.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiCall, jsiiGet, jsiiSet, jsiiStaticCall, 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

TagManager

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

TagManager

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

TagManager

@Stability(value=Stable)
public TagManager(TagType tagType,
                                           String resourceTypeName,
                                           Object tagStructure)

Parameters:

tagType - This parameter is required.

resourceTypeName - This parameter is required.

tagStructure -

TagManager

@Stability(value=Stable)
public TagManager(TagType tagType,
                                           String resourceTypeName)

Parameters:

tagType - This parameter is required.

resourceTypeName - This parameter is required.

Method Detail

isTaggable

@Stability(value=Stable)
public static Boolean isTaggable(Object construct)

Check whether the given construct is Taggable.

Parameters:

construct - This parameter is required.

applyTagAspectHere

@Stability(value=Stable)
public Boolean applyTagAspectHere(List<String> include,
                                                           List<String> exclude)

Parameters:

include -

exclude -

applyTagAspectHere

@Stability(value=Stable)
public Boolean applyTagAspectHere(List<String> include)

Parameters:

include -

applyTagAspectHere

@Stability(value=Stable)
public Boolean applyTagAspectHere()

hasTags

@Stability(value=Stable)
public Boolean hasTags()

Returns true if there are any tags defined.

removeTag

@Stability(value=Stable)
public void removeTag(String key,
                                               Number priority)

Removes the specified tag from the array if it exists.

Parameters:

key - The tag to remove. This parameter is required.

priority - The priority of the remove operation. This parameter is required.

renderTags

@Stability(value=Stable)
public Object renderTags()

Renders tags into the proper format based on TagType.

setTag

@Stability(value=Stable)
public void setTag(String key,
                                            String value,
                                            Number priority,
                                            Boolean applyToLaunchedInstances)

Adds the specified tag to the array of tags.

Parameters:

key - This parameter is required.

value - This parameter is required.

priority -

applyToLaunchedInstances -

setTag

@Stability(value=Stable)
public void setTag(String key,
                                            String value,
                                            Number priority)

Adds the specified tag to the array of tags.

Parameters:

key - This parameter is required.

value - This parameter is required.

priority -

setTag

@Stability(value=Stable)
public void setTag(String key,
                                            String value)

Adds the specified tag to the array of tags.

Parameters:

key - This parameter is required.

value - This parameter is required.