Package software.amazon.awscdk.services.ivs

Interface CfnPlaybackRestrictionPolicyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPlaybackRestrictionPolicyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-17T05:10:12.679Z")
@Stability(Stable)
public interface CfnPlaybackRestrictionPolicyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnPlaybackRestrictionPolicy.

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.*;
 CfnPlaybackRestrictionPolicyProps cfnPlaybackRestrictionPolicyProps = CfnPlaybackRestrictionPolicyProps.builder()
         .allowedCountries(List.of("allowedCountries"))
         .allowedOrigins(List.of("allowedOrigins"))
         // the properties below are optional
         .enableStrictOriginEnforcement(false)
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-playbackrestrictionpolicy.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPlaybackRestrictionPolicyProps.Builder	A builder for CfnPlaybackRestrictionPolicyProps
static final class	CfnPlaybackRestrictionPolicyProps.Jsii$Proxy	An implementation for CfnPlaybackRestrictionPolicyProps

Method Summary

Modifier and Type	Method	Description
static CfnPlaybackRestrictionPolicyProps.Builder	builder()
List<String>	getAllowedCountries()	A list of country codes that control geoblocking restrictions.
List<String>	getAllowedOrigins()	A list of origin sites that control CORS restriction.
default Object	getEnableStrictOriginEnforcement()	Whether channel playback is constrained by the origin site.
default String	getName()	Playback-restriction-policy name.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAllowedCountries

@Stability(Stable)
@NotNull
List<String> getAllowedCountries()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-playbackrestrictionpolicy.html#cfn-ivs-playbackrestrictionpolicy-allowedcountries

getAllowedOrigins

@Stability(Stable)
@NotNull
List<String> getAllowedOrigins()

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"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-playbackrestrictionpolicy.html#cfn-ivs-playbackrestrictionpolicy-allowedorigins

getEnableStrictOriginEnforcement

@Stability(Stable)
@Nullable
default Object getEnableStrictOriginEnforcement()

Whether channel playback is constrained by the origin site.

Default: - false

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-playbackrestrictionpolicy.html#cfn-ivs-playbackrestrictionpolicy-enablestrictoriginenforcement

getName

@Stability(Stable)
@Nullable
default String getName()

Playback-restriction-policy name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-playbackrestrictionpolicy.html#cfn-ivs-playbackrestrictionpolicy-name

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

For more information, see Tag .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-playbackrestrictionpolicy.html#cfn-ivs-playbackrestrictionpolicy-tags

builder

@Stability(Stable)
static CfnPlaybackRestrictionPolicyProps.Builder builder()

Returns:

a CfnPlaybackRestrictionPolicyProps.Builder of CfnPlaybackRestrictionPolicyProps