playback_restriction_policies

Creates, updates, deletes or gets a playback_restriction_policy resource or lists playback_restriction_policies in a region

Overview

Name	playback_restriction_policies
Type	Resource
Description	Resource Type definition for AWS::IVS::PlaybackRestrictionPolicy.
Id	aws.ivs.playback_restriction_policies

Fields

Name	Datatype	Description
arn	string	Playback-restriction-policy identifier.
allowed_countries	array	A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
allowed_origins	array	A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
enable_strict_origin_enforcement	boolean	Whether channel playback is constrained by origin site.
name	string	Playback-restriction-policy name.
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	AllowedCountries, AllowedOrigins, 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 playback_restriction_policies in a region.

SELECT
region,
arn,
allowed_countries,
allowed_origins,
enable_strict_origin_enforcement,
name,
tags
FROM aws.ivs.playback_restriction_policies
WHERE region = 'us-east-1';

Gets all properties from an individual playback_restriction_policy.

SELECT
region,
arn,
allowed_countries,
allowed_origins,
enable_strict_origin_enforcement,
name,
tags
FROM aws.ivs.playback_restriction_policies
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.ivs.playback_restriction_policies (
 AllowedCountries,
 AllowedOrigins,
 region
)
SELECT 
'{{ AllowedCountries }}',
 '{{ AllowedOrigins }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ivs.playback_restriction_policies (
 AllowedCountries,
 AllowedOrigins,
 EnableStrictOriginEnforcement,
 Name,
 Tags,
 region
)
SELECT 
 '{{ AllowedCountries }}',
 '{{ AllowedOrigins }}',
 '{{ EnableStrictOriginEnforcement }}',
 '{{ Name }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: playback_restriction_policy
    props:
      - name: AllowedCountries
        value:
          - '{{ AllowedCountries[0] }}'
      - name: AllowedOrigins
        value:
          - '{{ AllowedOrigins[0] }}'
      - name: EnableStrictOriginEnforcement
        value: '{{ EnableStrictOriginEnforcement }}'
      - name: Name
        value: '{{ Name }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

To operate on the playback_restriction_policies resource, the following permissions are required:

Create

ivs:CreatePlaybackRestrictionPolicy,
ivs:TagResource

Read

ivs:GetPlaybackRestrictionPolicy,
ivs:ListTagsForResource

Update

ivs:GetPlaybackRestrictionPolicy,
ivs:UpdatePlaybackRestrictionPolicy,
ivs:ListTagsForResource,
ivs:UntagResource,
ivs:TagResource

Delete

ivs:DeletePlaybackRestrictionPolicy,
ivs:UntagResource

List

ivs:ListPlaybackRestrictionPolicies,
ivs:ListTagsForResource