Package software.amazon.awscdk.services.ivs

Class CfnPlaybackRestrictionPolicy

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ivs.CfnPlaybackRestrictionPolicy
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IPlaybackRestrictionPolicyRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:22.931Z") @Stability(Stable) public class CfnPlaybackRestrictionPolicy extends CfnResource implements IInspectable, IPlaybackRestrictionPolicyRef, ITaggableV2
The AWS::IVS::PlaybackRestrictionPolicy resource specifies an 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 .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ivs.*;
 CfnPlaybackRestrictionPolicy cfnPlaybackRestrictionPolicy = CfnPlaybackRestrictionPolicy.Builder.create(this, "MyCfnPlaybackRestrictionPolicy")
         .allowedCountries(List.of("allowedCountries"))
         .allowedOrigins(List.of("allowedOrigins"))
         .enableStrictOriginEnforcement(false)
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnPlaybackRestrictionPolicy

      protected CfnPlaybackRestrictionPolicy(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnPlaybackRestrictionPolicy

      protected CfnPlaybackRestrictionPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnPlaybackRestrictionPolicy

      @Stability(Stable) public CfnPlaybackRestrictionPolicy(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnPlaybackRestrictionPolicyProps props)
      Create a new AWS::IVS::PlaybackRestrictionPolicy.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnPlaybackRestrictionPolicy

      @Stability(Stable) public CfnPlaybackRestrictionPolicy(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::IVS::PlaybackRestrictionPolicy.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • arnForPlaybackRestrictionPolicy

      @Stability(Stable) @NotNull public static String arnForPlaybackRestrictionPolicy(@NotNull IPlaybackRestrictionPolicyRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnPlaybackRestrictionPolicy

      @Stability(Stable) @NotNull public static Boolean isCfnPlaybackRestrictionPolicy(@NotNull Object x)
      Checks whether the given object is a CfnPlaybackRestrictionPolicy.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The playback-restriction-policy ARN.

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

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getPlaybackRestrictionPolicyRef

      @Stability(Stable) @NotNull public PlaybackRestrictionPolicyReference getPlaybackRestrictionPolicyRef()
      A reference to a PlaybackRestrictionPolicy resource.
      Specified by:
      getPlaybackRestrictionPolicyRef in interface IPlaybackRestrictionPolicyRef

    • getAllowedCountries

      @Stability(Stable) @Nullable public List<String> getAllowedCountries()
      A list of country codes that control geoblocking restrictions.

    • setAllowedCountries

      @Stability(Stable) public void setAllowedCountries(@Nullable List<String> value)
      A list of country codes that control geoblocking restrictions.

    • getAllowedOrigins

      @Stability(Stable) @Nullable public List<String> getAllowedOrigins()
      A list of origin sites that control CORS restriction.

    • setAllowedOrigins

      @Stability(Stable) public void setAllowedOrigins(@Nullable List<String> value)
      A list of origin sites that control CORS restriction.

    • getEnableStrictOriginEnforcement

      @Stability(Stable) @Nullable public Object getEnableStrictOriginEnforcement()
      Whether channel playback is constrained by the origin site.

      Returns union: either Boolean or IResolvable

    • setEnableStrictOriginEnforcement

      @Stability(Stable) public void setEnableStrictOriginEnforcement(@Nullable Boolean value)
      Whether channel playback is constrained by the origin site.

    • setEnableStrictOriginEnforcement

      @Stability(Stable) public void setEnableStrictOriginEnforcement(@Nullable IResolvable value)
      Whether channel playback is constrained by the origin site.

    • getName

      @Stability(Stable) @Nullable public String getName()
      Playback-restriction-policy name.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      Playback-restriction-policy name.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.