software.amazon.awscdk.services.servicecatalog

Class CfnTagOption

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.servicecatalog.CfnTagOption

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.098Z")
 @Stability(value=Stable)
public class CfnTagOption
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ServiceCatalog::TagOption`.

Specifies a TagOption. A TagOption is a key-value pair managed by AWS Service Catalog that serves as a template for creating an AWS 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.services.servicecatalog.*;
 CfnTagOption cfnTagOption = CfnTagOption.Builder.create(this, "MyCfnTagOption")
         .key("key")
         .value("value")
         // the properties below are optional
         .active(false)
         .build();
 

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnTagOption(software.constructs.Construct scope, String id, CfnTagOptionProps props) Create a new `AWS::ServiceCatalog::TagOption`.
protected	CfnTagOption(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTagOption(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getActive() The TagOption active state.
protected Map<String,Object>	getCfnProperties()
String	getKey() The TagOption key.
String	getValue() The TagOption value.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setActive(Boolean value) The TagOption active state.
void	setActive(IResolvable value) The TagOption active state.
void	setKey(String value) The TagOption key.
void	setValue(String value) The TagOption value.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnTagOption

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

CfnTagOption

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

CfnTagOption

@Stability(value=Stable)
public CfnTagOption(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id,
                                             @NotNull
                                             CfnTagOptionProps props)

Create a new `AWS::ServiceCatalog::TagOption`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getKey

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

The TagOption key.

setKey

@Stability(value=Stable)
public void setKey(@NotNull
                                            String value)

The TagOption key.

getValue

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

The TagOption value.

setValue

@Stability(value=Stable)
public void setValue(@NotNull
                                              String value)

The TagOption value.

getActive

@Stability(value=Stable)
 @Nullable
public Object getActive()

The TagOption active state.

setActive

@Stability(value=Stable)
public void setActive(@Nullable
                                               Boolean value)

The TagOption active state.

setActive

@Stability(value=Stable)
public void setActive(@Nullable
                                               IResolvable value)

The TagOption active state.