stages

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

Overview

Name	stages
Type	Resource
Description	Resource Type definition for AWS::IVS::Stage.
Id	awscc.ivs.stages

Fields

get (all properties)

Name	Datatype	Description
arn	string	Stage ARN is automatically generated on creation and assigned as the unique identifier.
name	string	Stage name
▶auto_participant_recording_configuration	object	Configuration object for individual participant recording, to attach to the new stage.
▶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.

list (identifiers only)

Name	Datatype	Description
arn	string	Stage ARN is automatically generated on creation and assigned as the unique identifier.
region	string	AWS region.

For more information, see AWS::IVS::Stage.

Methods

Name	Resource	Accessible by	Required Params
create_resource	stages	INSERT	region
delete_resource	stages	DELETE	Identifier, region
update_resource	stages	UPDATE	Identifier, PatchDocument, region
list_resources	stages_list_only	SELECT	region
get_resource	stages	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual stage.

SELECT
  region,
  arn,
  name,
  auto_participant_recording_configuration,
  tags,
  active_session_id
FROM awscc.ivs.stages
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all stages in a region.

SELECT
  region,
  arn
FROM awscc.ivs.stages_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ivs.stages (
  Name,
  AutoParticipantRecordingConfiguration,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ auto_participant_recording_configuration }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ivs.stages (
  Name,
  AutoParticipantRecordingConfiguration,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ auto_participant_recording_configuration }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: auto_participant_recording_configuration
      value:
        storage_configuration_arn: '{{ storage_configuration_arn }}'
        media_types:
          - '{{ media_types[0] }}'
        hls_configuration:
          participant_recording_hls_configuration:
            target_segment_duration_seconds: '{{ target_segment_duration_seconds }}'
        recording_reconnect_window_seconds: '{{ recording_reconnect_window_seconds }}'
        thumbnail_configuration:
          participant_thumbnail_configuration:
            recording_mode: '{{ recording_mode }}'
            storage:
              - '{{ storage[0] }}'
            target_interval_seconds: '{{ target_interval_seconds }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ivs.stages
SET PatchDocument = string('{{ {
    "Name": name,
    "AutoParticipantRecordingConfiguration": auto_participant_recording_configuration,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ivs.stages
WHERE
  Identifier = '{{ arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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