ingest_configurations

Creates, updates, deletes, gets or lists an ingest_configurations resource.

Overview

Name	ingest_configurations
Type	Resource
Id	aws.ivs_realtime.ingest_configurations

Fields

The following fields are returned by SELECT queries:

get_ingest_configuration

Name	Datatype	Description
name	string	Ingest name (pattern: <code>[a-zA-Z0-9-_]*</code>)
arn	string	Ingest configuration ARN. (pattern: <code>arn:aws:ivs:[a-z0-9-]+:[0-9]+:ingest-configuration/[a-zA-Z0-9-]+</code>)
attributes	object	Application-provided attributes to to store in the IngestConfiguration and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
ingest_protocol	string	Type of ingest protocol that the user employs for broadcasting. (RTMP, RTMPS)
participant_id	string	ID of the participant within the stage. (pattern: <code>[a-zA-Z0-9-]*</code>)
redundant_ingest	boolean	Indicates whether redundant ingest is enabled for the ingest configuration.
redundant_ingest_credentials	array	A list of redundant ingest credentials, present only when redundantIngest is set to true. See Redundant Ingest in IVS RTMP Publishing for details.
stage_arn	string	ARN of the stage with which the IngestConfiguration is associated. (pattern: <code>^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+$</code>)
state	string	State of the ingest configuration. It is ACTIVE if a publisher currently is publishing to the stage associated with the ingest configuration. (ACTIVE, INACTIVE)
stream_key	string	Ingest-key value for the RTMP(S) protocol. (pattern: <code>rt_[0-9]+[a-z0-9-]+[a-zA-Z0-9-]+_.+</code>)
tags	object	Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.
user_id	string	Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

list_ingest_configurations

Name	Datatype	Description
name	string	Ingest name. (pattern: <code>[a-zA-Z0-9-_]*</code>)
arn	string	Ingest configuration ARN. (pattern: <code>arn:aws:ivs:[a-z0-9-]+:[0-9]+:ingest-configuration/[a-zA-Z0-9-]+</code>)
ingest_protocol	string	Type of ingest protocol that the user employs for broadcasting. (RTMP, RTMPS)
participant_id	string	ID of the participant within the stage. (pattern: <code>[a-zA-Z0-9-]*</code>)
redundant_ingest	boolean	Indicates whether redundant ingest is enabled for the ingest configuration.
stage_arn	string	ARN of the stage with which the IngestConfiguration is associated. (pattern: <code>^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+$</code>)
state	string	State of the ingest configuration. It is ACTIVE if a publisher currently is publishing to the stage associated with the ingest configuration. (ACTIVE, INACTIVE)
user_id	string	Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ingest_configuration	select	region		Gets information about the specified IngestConfiguration.
list_ingest_configurations	select	region		Lists all IngestConfigurations in your account, in the AWS region where the API request is processed.
create_ingest_configuration	insert	region, ingestProtocol		Creates a new IngestConfiguration resource, used to specify the ingest protocol for a stage.
update_ingest_configuration	update	region, arn		Updates a specified IngestConfiguration. Only the stage ARN attached to the IngestConfiguration can be updated. An IngestConfiguration that is active cannot be updated.
delete_ingest_configuration	delete	region		Deletes a specified IngestConfiguration, so it can no longer be used to broadcast. An IngestConfiguration cannot be deleted if the publisher is actively streaming to a stage, unless force is set to true.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_ingest_configuration

Gets information about the specified IngestConfiguration.

SELECT
name,
arn,
attributes,
ingest_protocol,
participant_id,
redundant_ingest,
redundant_ingest_credentials,
stage_arn,
state,
stream_key,
tags,
user_id
FROM aws.ivs_realtime.ingest_configurations
WHERE region = '{{ region }}' -- required
;

list_ingest_configurations

Lists all IngestConfigurations in your account, in the AWS region where the API request is processed.

SELECT
name,
arn,
ingest_protocol,
participant_id,
redundant_ingest,
stage_arn,
state,
user_id
FROM aws.ivs_realtime.ingest_configurations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_ingest_configuration

Creates a new IngestConfiguration resource, used to specify the ingest protocol for a stage.

INSERT INTO aws.ivs_realtime.ingest_configurations (
name,
stageArn,
userId,
attributes,
ingestProtocol,
insecureIngest,
redundantIngest,
tags,
region
)
SELECT 
'{{ name }}',
'{{ stageArn }}',
'{{ userId }}',
'{{ attributes }}',
'{{ ingestProtocol }}' /* required */,
{{ insecureIngest }},
{{ redundantIngest }},
'{{ tags }}',
'{{ region }}'
RETURNING
ingest_configuration
;

Manifest

# Description fields are for documentation purposes
- name: ingest_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the ingest_configurations resource.
  - name: name
    value: "{{ name }}"
  - name: stageArn
    value: "{{ stageArn }}"
  - name: userId
    value: "{{ userId }}"
  - name: attributes
    value: "{{ attributes }}"
  - name: ingestProtocol
    value: "{{ ingestProtocol }}"
    valid_values: ['RTMP', 'RTMPS']
  - name: insecureIngest
    value: {{ insecureIngest }}
  - name: redundantIngest
    value: {{ redundantIngest }}
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_ingest_configuration

Updates a specified IngestConfiguration. Only the stage ARN attached to the IngestConfiguration can be updated. An IngestConfiguration that is active cannot be updated.

UPDATE aws.ivs_realtime.ingest_configurations
SET 
arn = '{{ arn }}',
stageArn = '{{ stageArn }}',
redundantIngest = {{ redundantIngest }}
WHERE 
region = '{{ region }}' --required
AND arn = '{{ arn }}' --required
RETURNING
ingest_configuration;

DELETE examples

delete_ingest_configuration

Deletes a specified IngestConfiguration, so it can no longer be used to broadcast. An IngestConfiguration cannot be deleted if the publisher is actively streaming to a stage, unless force is set to true.

DELETE FROM aws.ivs_realtime.ingest_configurations
WHERE region = '{{ region }}' --required
;