stages

Creates, updates, deletes or gets a stage resource or lists stages in a region

Overview

Name	stages
Type	Resource
Description	Resource Definition for type AWS::IVS::Stage.
Id	aws.ivs.stages

Fields

Name	Datatype	Description
arn	string	Stage ARN is automatically generated on creation and assigned as the unique identifier.
name	string	Stage name
tags	array	An array of key-value pairs to apply to this resource.
active_session_id	string	ID of the active session within the stage.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	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 stages in a region.

SELECT
region,
arn,
name,
tags,
active_session_id
FROM aws.ivs.stages
WHERE region = 'us-east-1';

Gets all properties from an individual stage.

SELECT
region,
arn,
name,
tags,
active_session_id
FROM aws.ivs.stages
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.ivs.stages (
 Name,
 Tags,
 region
)
SELECT 
'{{ Name }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ivs.stages (
 Name,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

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

DELETE example

/*+ delete */
DELETE FROM aws.ivs.stages
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

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

Create

ivs:CreateStage,
ivs:GetStage,
ivs:TagResource,
ivs:ListTagsForResource

Read

ivs:GetStage,
ivs:ListTagsForResource

Update

ivs:GetStage,
ivs:UpdateStage,
ivs:TagResource,
ivs:UnTagResource,
ivs:ListTagsForResource

Delete

ivs:DeleteStage,
ivs:UnTagResource

List

ivs:ListStages,
ivs:ListTagsForResource