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	aws.ivs.ingest_configurations

Fields

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.

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

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 ingest_configurations in a region.

SELECT
region,
arn,
name,
stage_arn,
participant_id,
ingest_protocol,
insecure_ingest,
state,
stream_key,
user_id,
tags
FROM aws.ivs.ingest_configurations
WHERE region = 'us-east-1';

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 aws.ivs.ingest_configurations
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

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 aws.ivs.ingest_configurations (
 ,
 region
)
SELECT 
'{{  }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ivs.ingest_configurations (
 Name,
 StageArn,
 IngestProtocol,
 InsecureIngest,
 UserId,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ StageArn }}',
 '{{ IngestProtocol }}',
 '{{ InsecureIngest }}',
 '{{ UserId }}',
 '{{ Tags }}',
 '{{ region }}';

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: StageArn
        value: '{{ StageArn }}'
      - name: IngestProtocol
        value: '{{ IngestProtocol }}'
      - name: InsecureIngest
        value: '{{ InsecureIngest }}'
      - name: UserId
        value: '{{ UserId }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

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