Package software.amazon.awscdk.services.mediapackagev2

Class CfnOriginEndpointPolicy

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.mediapackagev2.CfnOriginEndpointPolicy
All Implemented Interfaces:
IInspectable, IOriginEndpointPolicyRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:43.741Z") @Stability(Stable) public class CfnOriginEndpointPolicy extends CfnResource implements IInspectable, IOriginEndpointPolicyRef
Specifies the configuration parameters of a policy associated with a MediaPackage V2 origin endpoint.

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.mediapackagev2.*;
 Object policy;
 CfnOriginEndpointPolicy cfnOriginEndpointPolicy = CfnOriginEndpointPolicy.Builder.create(this, "MyCfnOriginEndpointPolicy")
         .channelGroupName("channelGroupName")
         .channelName("channelName")
         .originEndpointName("originEndpointName")
         .policy(policy)
         // the properties below are optional
         .cdnAuthConfiguration(CdnAuthConfigurationProperty.builder()
                 .cdnIdentifierSecretArns(List.of("cdnIdentifierSecretArns"))
                 .secretsRoleArn("secretsRoleArn")
                 .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

    • CfnOriginEndpointPolicy

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

    • CfnOriginEndpointPolicy

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

    • CfnOriginEndpointPolicy

      @Stability(Stable) public CfnOriginEndpointPolicy(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnOriginEndpointPolicyProps props)
      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. This parameter is required.

  • Method Details

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

    • getCfnProperties

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

    • getOriginEndpointPolicyRef

      @Stability(Stable) @NotNull public OriginEndpointPolicyReference getOriginEndpointPolicyRef()
      A reference to a OriginEndpointPolicy resource.
      Specified by:
      getOriginEndpointPolicyRef in interface IOriginEndpointPolicyRef

    • getChannelGroupName

      @Stability(Stable) @NotNull public String getChannelGroupName()
      The name of the channel group associated with the origin endpoint policy.

    • setChannelGroupName

      @Stability(Stable) public void setChannelGroupName(@NotNull String value)
      The name of the channel group associated with the origin endpoint policy.

    • getChannelName

      @Stability(Stable) @NotNull public String getChannelName()
      The channel name associated with the origin endpoint policy.

    • setChannelName

      @Stability(Stable) public void setChannelName(@NotNull String value)
      The channel name associated with the origin endpoint policy.

    • getOriginEndpointName

      @Stability(Stable) @NotNull public String getOriginEndpointName()
      The name of the origin endpoint associated with the origin endpoint policy.

    • setOriginEndpointName

      @Stability(Stable) public void setOriginEndpointName(@NotNull String value)
      The name of the origin endpoint associated with the origin endpoint policy.

    • getPolicy

      @Stability(Stable) @NotNull public Object getPolicy()
      The policy associated with the origin endpoint.

    • setPolicy

      @Stability(Stable) public void setPolicy(@NotNull Object value)
      The policy associated with the origin endpoint.

    • getCdnAuthConfiguration

      @Stability(Stable) @Nullable public Object getCdnAuthConfiguration()
      The settings to enable CDN authorization headers in MediaPackage.

      Returns union: either IResolvable or CfnOriginEndpointPolicy.CdnAuthConfigurationProperty

    • setCdnAuthConfiguration

      @Stability(Stable) public void setCdnAuthConfiguration(@Nullable IResolvable value)
      The settings to enable CDN authorization headers in MediaPackage.

    • setCdnAuthConfiguration

      @Stability(Stable) public void setCdnAuthConfiguration(@Nullable CfnOriginEndpointPolicy.CdnAuthConfigurationProperty value)
      The settings to enable CDN authorization headers in MediaPackage.