Class: Aws::IVS::Types::PlaybackRestrictionPolicy

Inherits:

Struct

• Object
• Struct
• Aws::IVS::Types::PlaybackRestrictionPolicy

Includes:

Structure

Defined in:

lib/aws-sdk-ivs/types.rb

Overview

An object representing a policy to constrain playback by country and/or origin sites.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #allowed_countries ⇒ Array<String>

  A list of country codes that control geoblocking restriction.

• #allowed_origins ⇒ Array<String>

  A list of origin sites that control CORS restriction.

• #arn ⇒ String

  Playback-restriction-policy ARN.

• #enable_strict_origin_enforcement ⇒ Boolean

  Whether channel playback is constrained by origin site.

• #name ⇒ String

  Playback-restriction-policy name.

• #tags ⇒ Hash<String,String>

  Tags attached to the resource.

Instance Attribute Details

#allowed_countries ⇒ Array<String>

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).

[1]: en.wikipedia.org/wiki/ISO_3166-1_alpha-2

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ivs/types.rb', line 1584

class PlaybackRestrictionPolicy < Struct.new(
  :allowed_countries,
  :allowed_origins,
  :arn,
  :enable_strict_origin_enforcement,
  :name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#allowed_origins ⇒ Array<String>

A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at [developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin][1]. Default: All origins (an empty array).

[1]: developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ivs/types.rb', line 1584

class PlaybackRestrictionPolicy < Struct.new(
  :allowed_countries,
  :allowed_origins,
  :arn,
  :enable_strict_origin_enforcement,
  :name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

Playback-restriction-policy ARN

Returns:

• (String)

# File 'lib/aws-sdk-ivs/types.rb', line 1584

class PlaybackRestrictionPolicy < Struct.new(
  :allowed_countries,
  :allowed_origins,
  :arn,
  :enable_strict_origin_enforcement,
  :name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#enable_strict_origin_enforcement ⇒ Boolean

Whether channel playback is constrained by origin site. Default: ‘false`.

Returns:

• (Boolean)

# File 'lib/aws-sdk-ivs/types.rb', line 1584

class PlaybackRestrictionPolicy < Struct.new(
  :allowed_countries,
  :allowed_origins,
  :arn,
  :enable_strict_origin_enforcement,
  :name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

Playback-restriction-policy name. The value does not need to be unique.

Returns:

• (String)

# File 'lib/aws-sdk-ivs/types.rb', line 1584

class PlaybackRestrictionPolicy < Struct.new(
  :allowed_countries,
  :allowed_origins,
  :arn,
  :enable_strict_origin_enforcement,
  :name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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.

[1]: docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-ivs/types.rb', line 1584

class PlaybackRestrictionPolicy < Struct.new(
  :allowed_countries,
  :allowed_origins,
  :arn,
  :enable_strict_origin_enforcement,
  :name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end