AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS::ServiceCatalog::TagOption

A TagOption is a key-value pair managed by AWS Service Catalog that serves as a template for creating an AWS tag. For more information, see AWS Service Catalog TagOptionLibrary in the AWS Service Catalog Administrator Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::ServiceCatalog::TagOption", "Properties" : { "Active" : Boolean, "Value" : String, "Key" : String } }

YAML

Type: "AWS::ServiceCatalog::TagOption" Properties: Active: Boolean Value: String Key: String

Properties

Active

Indicates whether the TagOption is active.

Required: No

Type: Boolean

Update requires: No interruption

Key

The TagOption key.

Required: Yes

Type: String

Update requires: Replacement

Value

The TagOption value.

Required: Yes

Type: String

Update requires: Replacement

Return Values

Ref

When you pass the logical ID of an AWS::ServiceCatalog::TagOption resource to the intrinsic Ref function, the function returns the TagOption identifier.

For more information about using the Ref function, see Ref.