tag_options

Creates, updates, deletes or gets a tag_option resource or lists tag_options in a region

Overview

Name	tag_options
Type	Resource
Description	Resource type definition for AWS::ServiceCatalog::TagOption
Id	awscc.servicecatalog.tag_options

Fields

Name	Datatype	Description
id	string	The TagOption identifier.
active	boolean	The TagOption active state.
value	string	The TagOption value.
key	string	The TagOption key.
region	string	AWS region.

For more information, see AWS::ServiceCatalog::TagOption.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Value, Key, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all properties from an individual tag_option.

SELECT
region,
id,
active,
value,
key
FROM awscc.servicecatalog.tag_options
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

Use the following StackQL query and manifest file to create a new tag_option resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.servicecatalog.tag_options (
 Value,
 Key,
 region
)
SELECT 
'{{ Value }}',
 '{{ Key }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.servicecatalog.tag_options (
 Active,
 Value,
 Key,
 region
)
SELECT 
 '{{ Active }}',
 '{{ Value }}',
 '{{ Key }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: tag_option
    props:
      - name: Active
        value: '{{ Active }}'
      - name: Value
        value: '{{ Value }}'
      - name: Key
        value: '{{ Key }}'

DELETE example

/*+ delete */
DELETE FROM awscc.servicecatalog.tag_options
WHERE data__Identifier = '<Id>'
AND region = 'us-east-1';

Permissions

To operate on the tag_options resource, the following permissions are required:

Create

servicecatalog:CreateTagOption

Read

servicecatalog:DescribeTagOption

Update

servicecatalog:UpdateTagOption,
servicecatalog:DescribeTagOption

Delete

servicecatalog:DeleteTagOption

List

servicecatalog:ListTagOptions