MediaPackageV2OriginProps

class aws_cdk.aws_mediapackagev2_alpha.MediaPackageV2OriginProps(*, connection_attempts=None, connection_timeout=None, custom_headers=None, origin_access_control_id=None, origin_id=None, origin_shield_enabled=None, origin_shield_region=None, response_completion_timeout=None, origin_path=None, channel_group, cdn_auth=None, origin_access_control=None)

Bases: OriginProps

(experimental) Properties for a MediaPackage V2 Origin with OAC.

Parameters:

  • connection_attempts (Union[int, float, None]) – The number of times that CloudFront attempts to connect to the origin; valid values are 1, 2, or 3 attempts. Default: 3

  • connection_timeout (Optional[Duration]) – The number of seconds that CloudFront waits when trying to establish a connection to the origin. Valid values are 1-10 seconds, inclusive. Default: Duration.seconds(10)

  • custom_headers (Optional[Mapping[str, str]]) – A list of HTTP header names and values that CloudFront adds to requests it sends to the origin. Default: {}

  • origin_access_control_id (Optional[str]) – The unique identifier of an origin access control for this origin. Default: - no origin access control

  • origin_id (Optional[str]) – A unique identifier for the origin. This value must be unique within the distribution. Default: - an originid will be generated for you

  • origin_shield_enabled (Optional[bool]) – 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. Default: - true

  • origin_shield_region (Optional[str]) – When you enable Origin Shield in the AWS Region that has the lowest latency to your origin, you can get better network performance. Default: - origin shield not enabled

  • response_completion_timeout (Optional[Duration]) – 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. Default: undefined - AWS CloudFront default is not enforcing a maximum value

  • origin_path (Optional[str]) – 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’). Default: ‘/’

  • channel_group (IChannelGroup) – (experimental) The channel group that the origin endpoint belongs to. Used to derive the egress domain for the CloudFront origin.

  • cdn_auth (Union[CdnAuthConfiguration, Dict[str, Any], None]) – (experimental) Optional CDN authorization configuration. If you need CDN auth on this endpoint, provide it here so it is configured on the first addToResourcePolicy call. If CDN auth is added separately after this origin is bound, it will be ignored. Default: - no CDN authorization

  • origin_access_control (Optional[IOriginAccessControlRef]) – (experimental) An optional Origin Access Control. Default: - an Origin Access Control will be created automatically.

Stability:

experimental

ExampleMetadata:

infused

Example:

# endpoint: OriginEndpoint
# group: ChannelGroup


cloudfront.Distribution(self, "Distribution",
    default_behavior=cloudfront.BehaviorOptions(
        origin=MediaPackageV2Origin(endpoint,
            channel_group=group
        )
    )
)

Attributes

cdn_auth

(experimental) Optional CDN authorization configuration.

If you need CDN auth on this endpoint, provide it here so it is configured on the first addToResourcePolicy call. If CDN auth is added separately after this origin is bound, it will be ignored.

Default:

  • no CDN authorization

Stability:

experimental

channel_group

(experimental) The channel group that the origin endpoint belongs to.

Used to derive the egress domain for the CloudFront origin.

Stability:

experimental

connection_attempts

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

valid values are 1, 2, or 3 attempts.

Default:

3

connection_timeout

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

Valid values are 1-10 seconds, inclusive.

Default:

Duration.seconds(10)

custom_headers

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

Default:

{}

origin_access_control

(experimental) An optional Origin Access Control.

Default:

  • an Origin Access Control will be created automatically.

Stability:

experimental

origin_access_control_id

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

Default:

  • no origin access control

origin_id

A unique identifier for the origin.

This value must be unique within the distribution.

Default:

  • an originid will be generated for you

origin_path

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

Default:

‘/’

origin_shield_enabled

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.

Default:

  • true

origin_shield_region

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

Default:

  • origin shield not enabled

See:

https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html

response_completion_timeout

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.

Default:

undefined - AWS CloudFront default is not enforcing a maximum value

See:

https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#response-completion-timeout