ad_configurations

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

Overview

Name	ad_configurations
Type	Resource
Id	aws.ivs.ad_configurations

Fields

The following fields are returned by SELECT queries:

get_ad_configuration

Name	Datatype	Description
name	string	Ad configuration name. Defaults to “”. (pattern: <code>[a-zA-Z0-9-_]*</code>)
arn	string	Ad configuration ARN. (pattern: <code>arn:aws:ivs:[a-z0-9-]+:[0-9]+:ad-configuration/[a-zA-Z0-9-]+</code>)
media_tailor_playback_configurations	array	List of integration configurations with MediaTailor resources. The first item in the list is the default playback configuration used for the ad configuration. To select a different configuration per viewing session, see Generate and Sign IVS Playback Tokens.
post_roll_configuration	object	Configuration for the post-roll ad break to use for this ad configuration.
tags	object	Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

list_ad_configurations

Name	Datatype	Description
name	string	Ad configuration name. Defaults to “”. (pattern: <code>[a-zA-Z0-9-_]*</code>)
arn	string	Ad configuration ARN. (pattern: <code>arn:aws:ivs:[a-z0-9-]+:[0-9]+:ad-configuration/[a-zA-Z0-9-]+</code>)
media_tailor_playback_configurations	array	List of integration configurations with MediaTailor resources. The first item in the list is the default playback configuration used for the ad configuration. To select a different configuration per viewing session, see Generate and Sign IVS Playback Tokens.
post_roll_configuration	object	Configuration for the post-roll ad break to use for this ad configuration.
tags	object	Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ad_configuration	select	region		Gets the ad configuration represented by the specified ARN.
list_ad_configurations	select	region		Gets summary information about all ad configurations in your account, in the AWS region where the API request is processed.
create_ad_configuration	insert	region, mediaTailorPlaybackConfigurations		Creates a new ad configuration to be used for server-side ad insertion.
update_ad_configuration	update	region, arn		Updates a specified ad configuration.
delete_ad_configuration	delete	region		Deletes the specified ad configuration.

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_ad_configuration

Gets the ad configuration represented by the specified ARN.

SELECT
name,
arn,
media_tailor_playback_configurations,
post_roll_configuration,
tags
FROM aws.ivs.ad_configurations
WHERE region = '{{ region }}' -- required
;

list_ad_configurations

Gets summary information about all ad configurations in your account, in the AWS region where the API request is processed.

SELECT
name,
arn,
media_tailor_playback_configurations,
post_roll_configuration,
tags
FROM aws.ivs.ad_configurations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_ad_configuration

Creates a new ad configuration to be used for server-side ad insertion.

INSERT INTO aws.ivs.ad_configurations (
name,
mediaTailorPlaybackConfigurations,
postRollConfiguration,
tags,
region
)
SELECT 
'{{ name }}',
'{{ mediaTailorPlaybackConfigurations }}' /* required */,
'{{ postRollConfiguration }}',
'{{ tags }}',
'{{ region }}'
RETURNING
ad_configuration
;

Manifest

# Description fields are for documentation purposes
- name: ad_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the ad_configurations resource.
  - name: name
    value: "{{ name }}"
  - name: mediaTailorPlaybackConfigurations
    value:
      - playbackConfigurationArn: "{{ playbackConfigurationArn }}"
  - name: postRollConfiguration
    description: |
      Configuration for the post-roll ad break to use for this ad configuration.
    value:
      durationSeconds: {{ durationSeconds }}
      enabled: {{ enabled }}
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_ad_configuration

Updates a specified ad configuration.

UPDATE aws.ivs.ad_configurations
SET 
arn = '{{ arn }}',
name = '{{ name }}',
mediaTailorPlaybackConfigurations = '{{ mediaTailorPlaybackConfigurations }}',
postRollConfiguration = '{{ postRollConfiguration }}'
WHERE 
region = '{{ region }}' --required
AND arn = '{{ arn }}' --required
RETURNING
ad_configuration;

DELETE examples

delete_ad_configuration

Deletes the specified ad configuration.

DELETE FROM aws.ivs.ad_configurations
WHERE region = '{{ region }}' --required
;