class TagOptions (construct)

Language	Type name
.NET	Amazon.CDK.AWS.Servicecatalog.TagOptions
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsservicecatalog#TagOptions
Java	software.amazon.awscdk.services.servicecatalog.TagOptions
Python	aws_cdk.aws_servicecatalog.TagOptions
TypeScript (source)	aws-cdk-lib » aws_servicecatalog » TagOptions

Implements IConstruct, IDependable, IResource, IEnvironmentAware

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

declare const portfolio: servicecatalog.Portfolio;
declare const product: servicecatalog.CloudFormationProduct;

const tagOptionsForPortfolio = new servicecatalog.TagOptions(this, 'OrgTagOptions', {
  allowedValuesForTags: {
    Group: ['finance', 'engineering', 'marketing', 'research'],
    CostCenter: ['01', '02','03'],
  },
});
portfolio.associateTagOptions(tagOptionsForPortfolio);

const tagOptionsForProduct = new servicecatalog.TagOptions(this, 'ProductTagOptions', {
  allowedValuesForTags: {
    Environment: ['dev', 'alpha', 'prod'],
  },
});
product.associateTagOptions(tagOptionsForProduct);

Initializer

new TagOptions(scope: Construct, id: string, props: TagOptionsProps)

Parameters

• scope Construct
• id string
• props TagOptionsProps

Construct Props

Name	Type	Description
allowedValuesForTags	{ [string]: string[] }	The values that are allowed to be set for specific tags.

---

allowedValuesForTags

Type: { [string]: string[] }

The values that are allowed to be set for specific tags.

The keys of the map represent the tag keys, and the values of the map are a list of allowed values for that particular tag key.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.
static PROPERTY_INJECTION_ID	string	Uniquely identifies this class.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

---

static PROPERTY_INJECTION_ID

Type: string

Uniquely identifies this class.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.