Package software.amazon.awscdk.services.servicecatalog

Class TagOptions

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.servicecatalog.TagOptions

All Implemented Interfaces:

IEnvironmentAware, IResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-07-31T10:49:38.609Z")
@Stability(Stable)
public class TagOptions
extends Resource

Defines a set of TagOptions, which are a list of key-value pairs managed in AWS Service Catalog.

It is not an AWS tag, but serves as a template for creating an AWS tag based on the TagOption. See https://docs.aws.amazon.com/servicecatalog/latest/adminguide/tagoptions.html

Example:

 Portfolio portfolio;
 CloudFormationProduct product;
 TagOptions tagOptionsForPortfolio = TagOptions.Builder.create(this, "OrgTagOptions")
         .allowedValuesForTags(Map.of(
                 "Group", List.of("finance", "engineering", "marketing", "research"),
                 "CostCenter", List.of("01", "02", "03")))
         .build();
 portfolio.associateTagOptions(tagOptionsForPortfolio);
 TagOptions tagOptionsForProduct = TagOptions.Builder.create(this, "ProductTagOptions")
         .allowedValuesForTags(Map.of(
                 "Environment", List.of("dev", "alpha", "prod")))
         .build();
 product.associateTagOptions(tagOptionsForProduct);
 

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IResource.Jsii$Default

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TagOptions(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	TagOptions(software.amazon.jsii.JsiiObjectRef objRef)
	TagOptions(software.constructs.Construct scope, String id, TagOptionsProps props)

Method Summary

Methods inherited from class software.amazon.awscdk.Resource

applyCrossStackReferenceStrength, applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource, with

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

TagOptions

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

TagOptions

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

TagOptions

@Stability(Stable)
public TagOptions(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 TagOptionsProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.