Package software.amazon.awscdk.services.mediapackagev2.alpha

Class OriginEndpoint

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.mediapackagev2.alpha.OriginEndpoint
All Implemented Interfaces:
IEnvironmentAware, IOriginEndpointRef, IResource, IOriginEndpoint, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-04-02T09:32:03.724Z") @Stability(Experimental) public class OriginEndpoint extends Resource implements IOriginEndpoint
(experimental) Defines an AWS Elemental MediaPackage V2 Origin Endpoint.

Example: 

 Channel channel;
 IRole spekeRole;
 OriginEndpoint.Builder.create(this, "TsEndpoint")
         .channel(channel)
         .segment(Segment.ts(TsSegmentProps.builder()
                 .encryption(TsEncryption.speke(TsSpekeEncryptionProps.builder()
                         .method(TsEncryptionMethod.SAMPLE_AES)
                         .resourceId("my-content-id")
                         .url("https://example.com/speke")
                         .role(spekeRole)
                         .build()))
                 .build()))
         .manifests(List.of(Manifest.hls(HlsManifestConfiguration.builder().manifestName("index").build())))
         .build();

  • Field Details

    • PROPERTY_INJECTION_ID

      @Stability(Experimental) public static final String PROPERTY_INJECTION_ID
      (experimental) Uniquely identifies this class.

  • Constructor Details

    • OriginEndpoint

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

    • OriginEndpoint

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

    • OriginEndpoint

      @Stability(Experimental) public OriginEndpoint(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull OriginEndpointProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • fromOriginEndpointAttributes

      @Stability(Experimental) @NotNull public static IOriginEndpoint fromOriginEndpointAttributes(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull OriginEndpointAttributes attrs)
      (experimental) Creates an OriginEndpoint construct that represents an external (imported) Origin Endpoint.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      attrs - This parameter is required.

    • addToResourcePolicy

      @Stability(Experimental) @NotNull public AddToResourcePolicyResult addToResourcePolicy(@NotNull PolicyStatement statement, @Nullable CdnAuthConfiguration cdnAuth)
      (experimental) Configure origin endpoint policy.

      You can only add 1 OriginEndpointPolicy to an OriginEndpoint. If you have already defined one, it will append to the policy already created.

      Specified by:
      addToResourcePolicy in interface IOriginEndpoint
      Parameters:
      statement -
      • The policy statement to add.
      This parameter is required.
      cdnAuth -
      • Optional CDN authorization configuration.

    • addToResourcePolicy

      @Stability(Experimental) @NotNull public AddToResourcePolicyResult addToResourcePolicy(@NotNull PolicyStatement statement)
      (experimental) Configure origin endpoint policy.

      You can only add 1 OriginEndpointPolicy to an OriginEndpoint. If you have already defined one, it will append to the policy already created.

      Specified by:
      addToResourcePolicy in interface IOriginEndpoint
      Parameters:
      statement -
      • The policy statement to add.
      This parameter is required.

    • metric

      @Stability(Experimental) @NotNull public Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
      (experimental) Create a CloudWatch metric.

      Specified by:
      metric in interface IOriginEndpoint
      Parameters:
      metricName - name of the metric. This parameter is required.
      props - metric options.

    • metric

      @Stability(Experimental) @NotNull public Metric metric(@NotNull String metricName)
      (experimental) Create a CloudWatch metric.

      Specified by:
      metric in interface IOriginEndpoint
      Parameters:
      metricName - name of the metric. This parameter is required.

    • metricEgressBytes

      @Stability(Experimental) @NotNull public Metric metricEgressBytes(@Nullable MetricOptions props)
      (experimental) Returns Metric for Egress Bytes.

      Default: - sum over 60 seconds

      Specified by:
      metricEgressBytes in interface IOriginEndpoint
      Parameters:
      props -

    • metricEgressBytes

      @Stability(Experimental) @NotNull public Metric metricEgressBytes()
      (experimental) Returns Metric for Egress Bytes.

      Default: - sum over 60 seconds

      Specified by:
      metricEgressBytes in interface IOriginEndpoint

    • metricEgressRequestCount

      @Stability(Experimental) @NotNull public Metric metricEgressRequestCount(@Nullable MetricOptions props)
      (experimental) Returns Metric for Egress Request Count.

      Default: - sum over 60 seconds

      Specified by:
      metricEgressRequestCount in interface IOriginEndpoint
      Parameters:
      props -

    • metricEgressRequestCount

      @Stability(Experimental) @NotNull public Metric metricEgressRequestCount()
      (experimental) Returns Metric for Egress Request Count.

      Default: - sum over 60 seconds

      Specified by:
      metricEgressRequestCount in interface IOriginEndpoint

    • metricEgressResponseTime

      @Stability(Experimental) @NotNull public Metric metricEgressResponseTime(@Nullable MetricOptions props)
      (experimental) Returns Metric for Egress Response time.

      Default: - average over 60 seconds

      Specified by:
      metricEgressResponseTime in interface IOriginEndpoint
      Parameters:
      props -

    • metricEgressResponseTime

      @Stability(Experimental) @NotNull public Metric metricEgressResponseTime()
      (experimental) Returns Metric for Egress Response time.

      Default: - average over 60 seconds

      Specified by:
      metricEgressResponseTime in interface IOriginEndpoint

    • metricIngressBytes

      @Stability(Experimental) @NotNull public Metric metricIngressBytes(@Nullable MetricOptions props)
      (experimental) Returns Metric for Ingress Bytes.

      Default: - sum over 60 seconds

      Specified by:
      metricIngressBytes in interface IOriginEndpoint
      Parameters:
      props -

    • metricIngressBytes

      @Stability(Experimental) @NotNull public Metric metricIngressBytes()
      (experimental) Returns Metric for Ingress Bytes.

      Default: - sum over 60 seconds

      Specified by:
      metricIngressBytes in interface IOriginEndpoint

    • metricIngressRequestCount

      @Stability(Experimental) @NotNull public Metric metricIngressRequestCount(@Nullable MetricOptions props)
      (experimental) Returns Metric for Ingress Request Count.

      Default: - sum over 60 seconds

      Specified by:
      metricIngressRequestCount in interface IOriginEndpoint
      Parameters:
      props -

    • metricIngressRequestCount

      @Stability(Experimental) @NotNull public Metric metricIngressRequestCount()
      (experimental) Returns Metric for Ingress Request Count.

      Default: - sum over 60 seconds

      Specified by:
      metricIngressRequestCount in interface IOriginEndpoint

    • metricIngressResponseTime

      @Stability(Experimental) @NotNull public Metric metricIngressResponseTime(@Nullable MetricOptions props)
      (experimental) Returns Metric for Ingress response time.

      Default: - average over 60 seconds

      Specified by:
      metricIngressResponseTime in interface IOriginEndpoint
      Parameters:
      props -

    • metricIngressResponseTime

      @Stability(Experimental) @NotNull public Metric metricIngressResponseTime()
      (experimental) Returns Metric for Ingress response time.

      Default: - average over 60 seconds

      Specified by:
      metricIngressResponseTime in interface IOriginEndpoint

    • segmentValidation

      @Stability(Experimental) @Nullable protected CfnOriginEndpoint.SegmentProperty segmentValidation(@NotNull ContainerType segmentContainerType, @Nullable SegmentConfiguration segment)
      (experimental) Validate and modify Segment configuration for endpoint.

      Parameters:
      segmentContainerType - This parameter is required.
      segment -

    • segmentValidation

      @Stability(Experimental) @Nullable protected CfnOriginEndpoint.SegmentProperty segmentValidation(@NotNull ContainerType segmentContainerType)
      (experimental) Validate and modify Segment configuration for endpoint.

      Parameters:
      segmentContainerType - This parameter is required.

    • getChannelGroupName

      @Stability(Experimental) @NotNull public String getChannelGroupName()
      (experimental) The name of the channel group associated with the origin endpoint configuration.
      Specified by:
      getChannelGroupName in interface IOriginEndpoint

    • getChannelName

      @Stability(Experimental) @NotNull public String getChannelName()
      (experimental) The channel name associated with the origin endpoint.
      Specified by:
      getChannelName in interface IOriginEndpoint

    • getOriginEndpointArn

      @Stability(Experimental) @NotNull public String getOriginEndpointArn()
      (experimental) The Amazon Resource Name (ARN) of the origin endpoint.
      Specified by:
      getOriginEndpointArn in interface IOriginEndpoint

    • getOriginEndpointName

      @Stability(Experimental) @NotNull public String getOriginEndpointName()
      (experimental) The name of the origin endpoint associated with the origin endpoint configuration.
      Specified by:
      getOriginEndpointName in interface IOriginEndpoint

    • getOriginEndpointRef

      @Stability(Experimental) @NotNull public OriginEndpointReference getOriginEndpointRef()
      (experimental) A reference to this Origin Endpoint resource.

      Required by the auto-generated IOriginEndpointRef interface.

      Specified by:
      getOriginEndpointRef in interface IOriginEndpointRef

    • getCreatedAt

      @Stability(Experimental) @Nullable public String getCreatedAt()
      (experimental) The timestamp of the creation of the origin endpoint.
      Specified by:
      getCreatedAt in interface IOriginEndpoint

    • getDashManifestUrls

      @Stability(Experimental) @Nullable public List<String> getDashManifestUrls()
      (experimental) Array containing DASH Manifests created by the OriginEndpoint.
      Specified by:
      getDashManifestUrls in interface IOriginEndpoint

    • getHlsManifestUrls

      @Stability(Experimental) @Nullable public List<String> getHlsManifestUrls()
      (experimental) Array containing HLS Manifests created by the OriginEndpoint.
      Specified by:
      getHlsManifestUrls in interface IOriginEndpoint

    • getLowLatencyHlsManifestUrls

      @Stability(Experimental) @Nullable public List<String> getLowLatencyHlsManifestUrls()
      (experimental) Array containing Low Latency HLS Manifests created by the OriginEndpoint.
      Specified by:
      getLowLatencyHlsManifestUrls in interface IOriginEndpoint

    • getModifiedAt

      @Stability(Experimental) @Nullable public String getModifiedAt()
      (experimental) The timestamp of the modification of the origin endpoint.
      Specified by:
      getModifiedAt in interface IOriginEndpoint

    • getMssManifestUrls

      @Stability(Experimental) @Nullable public List<String> getMssManifestUrls()
      (experimental) Array containing MSS Manifests created by the OriginEndpoint.
      Specified by:
      getMssManifestUrls in interface IOriginEndpoint

    • getAutoCreatePolicy

      @Stability(Experimental) @NotNull protected Boolean getAutoCreatePolicy()
      (experimental) Indicates if an origin endpoint resource policy should automatically be created upon the first call to addToResourcePolicy.

    • setAutoCreatePolicy

      @Stability(Experimental) protected void setAutoCreatePolicy(@NotNull Boolean value)
      (experimental) Indicates if an origin endpoint resource policy should automatically be created upon the first call to addToResourcePolicy.

    • getDashManifests

      @Stability(Experimental) @NotNull protected List<CfnOriginEndpoint.DashManifestConfigurationProperty> getDashManifests()

    • setDashManifests

      @Stability(Experimental) protected void setDashManifests(@NotNull List<CfnOriginEndpoint.DashManifestConfigurationProperty> value)

    • getHlsManifests

      @Stability(Experimental) @NotNull protected List<CfnOriginEndpoint.HlsManifestConfigurationProperty> getHlsManifests()

    • setHlsManifests

      @Stability(Experimental) protected void setHlsManifests(@NotNull List<CfnOriginEndpoint.HlsManifestConfigurationProperty> value)

    • getLlHlsManifests

      @Stability(Experimental) @NotNull protected List<CfnOriginEndpoint.LowLatencyHlsManifestConfigurationProperty> getLlHlsManifests()

    • setLlHlsManifests

      @Stability(Experimental) protected void setLlHlsManifests(@NotNull List<CfnOriginEndpoint.LowLatencyHlsManifestConfigurationProperty> value)

    • getMssManifests

      @Stability(Experimental) @NotNull protected List<CfnOriginEndpoint.MssManifestConfigurationProperty> getMssManifests()

    • setMssManifests

      @Stability(Experimental) protected void setMssManifests(@NotNull List<CfnOriginEndpoint.MssManifestConfigurationProperty> value)

    • getPolicy

      @Stability(Experimental) @Nullable public OriginEndpointPolicy getPolicy()
      (experimental) The resource policy associated with this origin endpoint.

      If autoCreatePolicy is true, an OriginEndpointPolicy will be created upon the first call to addToResourcePolicy(s).

    • setPolicy

      @Stability(Experimental) public void setPolicy(@Nullable OriginEndpointPolicy value)
      (experimental) The resource policy associated with this origin endpoint.

      If autoCreatePolicy is true, an OriginEndpointPolicy will be created upon the first call to addToResourcePolicy(s).

    • getSegment

      @Stability(Experimental) @Nullable protected SegmentConfiguration getSegment()

    • setSegment

      @Stability(Experimental) protected void setSegment(@Nullable SegmentConfiguration value)