Class CfnPlaybackRestrictionPolicy
The AWS::IVS::PlaybackRestrictionPolicy
resource specifies an playback restriction policy.
Inherited Members
Namespace: Amazon.CDK.AWS.Ivs
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnPlaybackRestrictionPolicy : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnPlaybackRestrictionPolicy
Inherits CfnResource
Implements IInspectable, ITaggableV2
Remarks
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 .
CloudformationResource: AWS::IVS::PlaybackRestrictionPolicy
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Ivs;
var cfnPlaybackRestrictionPolicy = new CfnPlaybackRestrictionPolicy(this, "MyCfnPlaybackRestrictionPolicy", new CfnPlaybackRestrictionPolicyProps {
AllowedCountries = new [] { "allowedCountries" },
AllowedOrigins = new [] { "allowedOrigins" },
// the properties below are optional
EnableStrictOriginEnforcement = false,
Name = "name",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnPlaybackRestrictionPolicy(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnPlaybackRestrictionPolicy(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnPlaybackRestrictionPolicy(Construct, String, ICfnPlaybackRestrictionPolicyProps) |
Properties
AllowedCountries | A list of country codes that control geoblocking restrictions. |
AllowedOrigins | A list of origin sites that control CORS restriction. |
AttrArn | The playback-restriction-policy ARN. |
CdkTagManager | Tag Manager which manages the tags for this resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
EnableStrictOriginEnforcement | Whether channel playback is constrained by the origin site. |
Name | Playback-restriction-policy name. |
Tags | An array of key-value pairs to apply to this resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnPlaybackRestrictionPolicy(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnPlaybackRestrictionPolicy(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnPlaybackRestrictionPolicy(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnPlaybackRestrictionPolicy(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnPlaybackRestrictionPolicy(Construct, String, ICfnPlaybackRestrictionPolicyProps)
public CfnPlaybackRestrictionPolicy(Construct scope, string id, ICfnPlaybackRestrictionPolicyProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnPlaybackRestrictionPolicyProps
Resource properties.
Properties
AllowedCountries
A list of country codes that control geoblocking restrictions.
public virtual string[] AllowedCountries { get; set; }
Property Value
System.String[]
AllowedOrigins
A list of origin sites that control CORS restriction.
public virtual string[] AllowedOrigins { get; set; }
Property Value
System.String[]
AttrArn
The playback-restriction-policy ARN.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
For example: arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/abcdABCDefgh
CloudformationAttribute: Arn
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }
Property Value
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
EnableStrictOriginEnforcement
Whether channel playback is constrained by the origin site.
public virtual object EnableStrictOriginEnforcement { get; set; }
Property Value
System.Object
Name
Playback-restriction-policy name.
public virtual string Name { get; set; }
Property Value
System.String
Tags
An array of key-value pairs to apply to this resource.
public virtual ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>