interface MediaPackageV2OriginProps 🔹

Language	Type name
.NET	`Amazon.CDK.AWS.MediaPackageV2.Alpha.MediaPackageV2OriginProps`
Go	`github.com/aws/aws-cdk-go/awsmediapackagev2alpha/v2#MediaPackageV2OriginProps`
Java	`software.amazon.awscdk.services.mediapackagev2.alpha.MediaPackageV2OriginProps`
Python	`aws_cdk.aws_mediapackagev2_alpha.MediaPackageV2OriginProps`
TypeScript (source)	`@aws-cdk/aws-mediapackagev2-alpha` » `MediaPackageV2OriginProps`

Implements OriginOptions, OriginProps

Properties for a MediaPackage V2 Origin with OAC.

Example

declare const endpoint: OriginEndpoint;
declare const group: ChannelGroup;

new cloudfront.Distribution(this, 'Distribution', {
  defaultBehavior: {
    origin: new MediaPackageV2Origin(endpoint, {
      channelGroup: group,
    }),
  },
});

Properties

Name	Type	Description
channelGroup🔹	`IChannelGroup`	The channel group that the origin endpoint belongs to.
connectionAttempts?🔹	`number`	The number of times that CloudFront attempts to connect to the origin;
connectionTimeout?🔹	`Duration`	The number of seconds that CloudFront waits when trying to establish a connection to the origin.
customHeaders?🔹	`{ [string]: string }`	A list of HTTP header names and values that CloudFront adds to requests it sends to the origin.
originAccessControl?🔹	`IOriginAccessControlRef`	An optional Origin Access Control.
originAccessControlId?🔹	`string`	The unique identifier of an origin access control for this origin.
originId?🔹	`string`	A unique identifier for the origin.
originPath?🔹	`string`	An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
originShieldEnabled?🔹	`boolean`	Origin Shield is enabled by setting originShieldRegion to a valid region, after this to disable Origin Shield again you must set this flag to false.
originShieldRegion?🔹	`string`	When you enable Origin Shield in the AWS Region that has the lowest latency to your origin, you can get better network performance.
responseCompletionTimeout?🔹	`Duration`	The time that a request from CloudFront to the origin can stay open and wait for a response.

channelGroup🔹

Type: IChannelGroup

The channel group that the origin endpoint belongs to.

Used to derive the egress domain for the CloudFront origin.

connectionAttempts?🔹

Type: number (optional, default: 3)

The number of times that CloudFront attempts to connect to the origin;

valid values are 1, 2, or 3 attempts.

connectionTimeout?🔹

Type: Duration (optional, default: Duration.seconds(10))

The number of seconds that CloudFront waits when trying to establish a connection to the origin.

Valid values are 1-10 seconds, inclusive.

customHeaders?🔹

Type: { [string]: string } (optional, default: {})

A list of HTTP header names and values that CloudFront adds to requests it sends to the origin.

originAccessControl?🔹

Type: IOriginAccessControlRef (optional, default: an Origin Access Control will be created automatically.)

An optional Origin Access Control.

originAccessControlId?🔹

Type: string (optional, default: no origin access control)

The unique identifier of an origin access control for this origin.

originId?🔹

Type: string (optional, default: an originid will be generated for you)

A unique identifier for the origin.

This value must be unique within the distribution.

originPath?🔹

Type: string (optional, default: '/')

An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.

Must begin, but not end, with '/' (e.g., '/production/images').

originShieldEnabled?🔹

Type: boolean (optional, default: true)

Origin Shield is enabled by setting originShieldRegion to a valid region, after this to disable Origin Shield again you must set this flag to false.

originShieldRegion?🔹

Type: string (optional, default: origin shield not enabled)

When you enable Origin Shield in the AWS Region that has the lowest latency to your origin, you can get better network performance.

responseCompletionTimeout?🔹

Type: Duration (optional, default: undefined - AWS CloudFront default is not enforcing a maximum value)

The time that a request from CloudFront to the origin can stay open and wait for a response.

If the complete response isn't received from the origin by this time, CloudFront ends the connection.

Valid values are 1-3600 seconds, inclusive.

AWS CDK

2.260.0