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	awscc.ivs.playback_restriction_policies

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
arn	string	Playback-restriction-policy identifier.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	playback_restriction_policies	INSERT	region
delete_resource	playback_restriction_policies	DELETE	Identifier, region
update_resource	playback_restriction_policies	UPDATE	Identifier, PatchDocument, region
list_resources	playback_restriction_policies_list_only	SELECT	region
get_resource	playback_restriction_policies	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual playback_restriction_policy.

SELECT
  region,
  arn,
  allowed_countries,
  allowed_origins,
  enable_strict_origin_enforcement,
  name,
  tags
FROM awscc.ivs.playback_restriction_policies
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all playback_restriction_policies in a region.

SELECT
  region,
  arn
FROM awscc.ivs.playback_restriction_policies_list_only
WHERE
  region = '{{ region }}';

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 awscc.ivs.playback_restriction_policies (
  AllowedCountries,
  AllowedOrigins,
  EnableStrictOriginEnforcement,
  Name,
  Tags,
  region
)
SELECT
  '{{ allowed_countries }}',
  '{{ allowed_origins }}',
  '{{ enable_strict_origin_enforcement }}',
  '{{ name }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ivs.playback_restriction_policies (
  AllowedCountries,
  AllowedOrigins,
  EnableStrictOriginEnforcement,
  Name,
  Tags,
  region
)
SELECT
  '{{ allowed_countries }}',
  '{{ allowed_origins }}',
  '{{ enable_strict_origin_enforcement }}',
  '{{ name }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: allowed_countries
      value:
        - '{{ allowed_countries[0] }}'
    - name: allowed_origins
      value:
        - '{{ allowed_origins[0] }}'
    - name: enable_strict_origin_enforcement
      value: '{{ enable_strict_origin_enforcement }}'
    - name: name
      value: '{{ name }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ivs.playback_restriction_policies
SET PatchDocument = string('{{ {
    "AllowedCountries": allowed_countries,
    "AllowedOrigins": allowed_origins,
    "EnableStrictOriginEnforcement": enable_strict_origin_enforcement,
    "Name": name,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ivs.playback_restriction_policies
WHERE
  Identifier = '{{ arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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