sdi_sources

Creates, updates, deletes, gets or lists a sdi_sources resource.

Overview

Name	sdi_sources
Type	Resource
Id	aws.medialive.sdi_sources

Fields

The following fields are returned by SELECT queries:

describe_sdi_source

Name	Datatype	Description
arn	string	Placeholder documentation for __string
id	string	Placeholder documentation for __string
inputs	array	Placeholder documentation for __listOf__string
mode	string	Used in SdiSource, CreateSdiSourceRequest, UpdateSdiSourceRequest. (QUADRANT, INTERLEAVE)
name	string	Placeholder documentation for __string
state	string	Specifies whether the SDI source is attached to an SDI input (IN_USE) or not (IDLE). (IDLE, IN_USE, DELETED)
type	string	Used in SdiSource, CreateSdiSourceRequest, UpdateSdiSourceRequest. (SINGLE, QUAD)

list_sdi_sources

Name	Datatype	Description
arn	string	Placeholder documentation for __string
id	string	Placeholder documentation for __string
inputs	array	Placeholder documentation for __listOf__string
mode	string	Used in SdiSource, CreateSdiSourceRequest, UpdateSdiSourceRequest. (QUADRANT, INTERLEAVE)
name	string	Placeholder documentation for __string
state	string	Specifies whether the SDI source is attached to an SDI input (IN_USE) or not (IDLE). (IDLE, IN_USE, DELETED)
type	string	Used in SdiSource, CreateSdiSourceRequest, UpdateSdiSourceRequest. (SINGLE, QUAD)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_sdi_source	select	sdi_source_id, region		Gets details about a SdiSource.
list_sdi_sources	select	region	maxResults, nextToken	List all the SdiSources in the AWS account.
create_sdi_source	insert	region		Create an SdiSource for each video source that uses the SDI protocol. You will reference the SdiSource when you create an SDI input in MediaLive. You will also reference it in an SdiSourceMapping, in order to create a connection between the logical SdiSource and the physical SDI card and port that the physical SDI source uses.
update_sdi_source	update	sdi_source_id, region		Change some of the settings in an SdiSource.
delete_sdi_source	delete	sdi_source_id, region		Delete an SdiSource. The SdiSource must not be part of any SidSourceMapping and must not be attached to any input.

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)
sdi_source_id	string	The ID of the SdiSource.
maxResults	integer	The maximum number of items to return.
nextToken	string	The token to retrieve the next page of results.

SELECT examples

describe_sdi_source

Gets details about a SdiSource.

SELECT
arn,
id,
inputs,
mode,
name,
state,
type
FROM aws.medialive.sdi_sources
WHERE sdi_source_id = '{{ sdi_source_id }}' -- required
AND region = '{{ region }}' -- required
;

list_sdi_sources

List all the SdiSources in the AWS account.

SELECT
arn,
id,
inputs,
mode,
name,
state,
type
FROM aws.medialive.sdi_sources
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_sdi_source

Create an SdiSource for each video source that uses the SDI protocol. You will reference the SdiSource when you create an SDI input in MediaLive. You will also reference it in an SdiSourceMapping, in order to create a connection between the logical SdiSource and the physical SDI card and port that the physical SDI source uses.

INSERT INTO aws.medialive.sdi_sources (
Mode,
Name,
RequestId,
Tags,
Type,
region
)
SELECT 
'{{ Mode }}',
'{{ Name }}',
'{{ RequestId }}',
'{{ Tags }}',
'{{ Type }}',
'{{ region }}'
RETURNING
sdi_source
;

Manifest

# Description fields are for documentation purposes
- name: sdi_sources
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the sdi_sources resource.
  - name: Mode
    value: "{{ Mode }}"
    description: |
      Used in SdiSource, CreateSdiSourceRequest, UpdateSdiSourceRequest.
    valid_values: ['QUADRANT', 'INTERLEAVE']
  - name: Name
    value: "{{ Name }}"
    description: |
      Placeholder documentation for __string
  - name: RequestId
    value: "{{ RequestId }}"
    description: |
      Placeholder documentation for __string
  - name: Tags
    value: "{{ Tags }}"
    description: |
      Placeholder documentation for Tags
  - name: Type
    value: "{{ Type }}"
    description: |
      Used in SdiSource, CreateSdiSourceRequest, UpdateSdiSourceRequest.
    valid_values: ['SINGLE', 'QUAD']

UPDATE examples

update_sdi_source

Change some of the settings in an SdiSource.

UPDATE aws.medialive.sdi_sources
SET 
Mode = '{{ Mode }}',
Name = '{{ Name }}',
Type = '{{ Type }}'
WHERE 
sdi_source_id = '{{ sdi_source_id }}' --required
AND region = '{{ region }}' --required
RETURNING
sdi_source;

DELETE examples

delete_sdi_source

Delete an SdiSource. The SdiSource must not be part of any SidSourceMapping and must not be attached to any input.

DELETE FROM aws.medialive.sdi_sources
WHERE sdi_source_id = '{{ sdi_source_id }}' --required
AND region = '{{ region }}' --required
;