encoder_configurations

Creates, updates, deletes or gets an encoder_configuration resource or lists encoder_configurations in a region

Overview

Name	encoder_configurations
Type	Resource
Description	Resource Type definition for AWS::IVS::EncoderConfiguration.
Id	awscc.ivs.encoder_configurations

Fields

get (all properties)

Name	Datatype	Description
arn	string	Encoder configuration identifier.
▶video	object	Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps
name	string	Encoder configuration name.
▶tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string	Encoder configuration identifier.
region	string	AWS region.

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

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual encoder_configuration.

SELECT
  region,
  arn,
  video,
  name,
  tags
FROM awscc.ivs.encoder_configurations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all encoder_configurations in a region.

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

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ivs.encoder_configurations (
  ,
  region
)
SELECT
  '{{  }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ivs.encoder_configurations (
  Video,
  Name,
  Tags,
  region
)
SELECT
  '{{ video }}',
  '{{ name }}',
  '{{ 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: encoder_configuration
  props:
    - name: video
      value:
        bitrate: '{{ bitrate }}'
        framerate: null
        height: '{{ height }}'
        width: '{{ width }}'
    - name: name
      value: '{{ name }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ivs.encoder_configurations
SET PatchDocument = string('{{ {
    "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.encoder_configurations
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 encoder_configurations resource, the following permissions are required:

Create

ivs:CreateEncoderConfiguration,
ivs:TagResource

Read

ivs:GetEncoderConfiguration,
ivs:ListTagsForResource

Update

ivs:GetEncoderConfiguration,
ivs:ListTagsForResource,
ivs:UntagResource,
ivs:TagResource

Delete

ivs:DeleteEncoderConfiguration,
ivs:UntagResource

List

ivs:ListEncoderConfigurations,
ivs:ListTagsForResource