AWS::IVS::PlaybackRestrictionPolicy - AWS CloudFormation
SyntaxPropertiesReturn valuesExamplesSee also

AWS::IVS::PlaybackRestrictionPolicy

The AWS::IVS::PlaybackRestrictionPolicy resource specifies an Amazon IVS playback restriction policy. A playback restriction policy constrains playback by country and/or origin sites. For more information, see Undesired Content and Viewers in the Amazon IVS Low-Latency Streaming User Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::IVS::PlaybackRestrictionPolicy",
  "Properties" : {
      "AllowedCountries" : [ String, ... ],
      "AllowedOrigins" : [ String, ... ],
      "EnableStrictOriginEnforcement" : Boolean,
      "Name" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::IVS::PlaybackRestrictionPolicy
Properties:
  AllowedCountries: 
    - String
  AllowedOrigins: 
    - String
  EnableStrictOriginEnforcement: Boolean
  Name: String
  Tags: 
    - Tag

Properties

AllowedCountries

A list of country codes that control geoblocking restrictions. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).

Required: Yes

Type: Array of String

Update requires: No interruption

AllowedOrigins

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"

Required: Yes

Type: Array of String

Update requires: No interruption

EnableStrictOriginEnforcement

Whether channel playback is constrained by the origin site.

Required: No

Type: Boolean

Update requires: No interruption

Name

Playback-restriction-policy name.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9-_]*$

Minimum: 0

Maximum: 128

Update requires: No interruption

Tags

An array of key-value pairs to apply to this resource.

For more information, see Tag.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the playback-restriction-policy ARN. For example:

{ "Ref": "myPlaybackRestrictionPolicy" }

For the Amazon IVS playback restriction policy "myPlaybackRestrictionPolicy", Ref returns the playback-restriction-policy ARN.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The playback-restriction-policy ARN. For example: arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/abcdABCDefgh

Examples

PlaybackRestrictionPolicy Template Examples

The following examples specify an Amazon IVS playback restriction policy.

JSON

{
    "AWSTemplateFormatVersion": "2010-09-09",
    "Resources": {
        "PlaybackRestrictionPolicy": {
            "Type": "AWS::IVS::PlaybackRestrictionPolicy",
            "Properties": {
                "AllowedCountries" : [ "US" ],
                "AllowedOrigins" : [ "https://aws.amazon.com" ],
                "EnableStrictOriginEnforcement" : true,
                "Name": "myPlaybackRestrictionPolicy",
                "Tags": [
                    {
                        "Key": "MyKey",
                        "Value": "MyValue"
                    }
                ]
            }
        }
    }
}

YAML

AWSTemplateFormatVersion: 2010-09-09
Resources:
  PlaybackRestrictionPolicy
    Type: AWS::IVS::PlaybackRestrictionPolicy
    Properties:
      AllowedCountries: 
        - US
      AllowedOrigins: 
        - https://aws.amazon.com
      EnableStrictOriginEnforcement: true
      Name: myPlaybackRestrictionPolicy
      Tags: 
        - Key: myKey
          Value: myValue

See also