ingest_configurations

Creates, updates, deletes or gets an ingest_configuration resource or lists ingest_configurations in a region

Overview

Name	ingest_configurations
Type	Resource
Description	Resource Type definition for AWS::IVS::IngestConfiguration
Id	awscc.ivs.ingest_configurations

Fields

get (all properties)

Name	Datatype	Description
arn	string	IngestConfiguration ARN is automatically generated on creation and assigned as the unique identifier.
name	string	IngestConfiguration
stage_arn	string	Stage ARN. A value other than an empty string indicates that stage is linked to IngestConfiguration. Default: "" (recording is disabled).
participant_id	string	Participant Id is automatically generated on creation and assigned.
ingest_protocol	string	Ingest Protocol.
insecure_ingest	boolean	Whether ingest configuration allows insecure ingest.
state	string	State of IngestConfiguration which determines whether IngestConfiguration is in use or not.
stream_key	string	Stream-key value.
user_id	string	User defined indentifier for participant associated with IngestConfiguration.
▶tags	array	A list of key-value pairs that contain metadata for the asset model.
region	string	AWS region.

list (identifiers only)

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

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

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual ingest_configuration.

SELECT
  region,
  arn,
  name,
  stage_arn,
  participant_id,
  ingest_protocol,
  insecure_ingest,
  state,
  stream_key,
  user_id,
  tags
FROM awscc.ivs.ingest_configurations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all ingest_configurations in a region.

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

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.ivs.ingest_configurations (
  Name,
  StageArn,
  IngestProtocol,
  InsecureIngest,
  UserId,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ stage_arn }}',
  '{{ ingest_protocol }}',
  '{{ insecure_ingest }}',
  '{{ user_id }}',
  '{{ 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: ingest_configuration
  props:
    - name: name
      value: '{{ name }}'
    - name: stage_arn
      value: '{{ stage_arn }}'
    - name: ingest_protocol
      value: '{{ ingest_protocol }}'
    - name: insecure_ingest
      value: '{{ insecure_ingest }}'
    - name: user_id
      value: '{{ user_id }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

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

Create

ivs:CreateIngestConfiguration,
ivs:TagResource

Read

ivs:GetIngestConfiguration,
ivs:ListTagsForResource

Update

ivs:GetIngestConfiguration,
ivs:UpdateIngestConfiguration,
ivs:TagResource,
ivs:UntagResource,
ivs:ListTagsForResource

Delete

ivs:DeleteIngestConfiguration,
ivs:UntagResource

List

ivs:ListIngestConfigurations,
ivs:ListTagsForResource