RestApiOriginProps

class aws_cdk.aws_cloudfront_origins.RestApiOriginProps(*, 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, keepalive_timeout=None, read_timeout=None)

Bases: OriginProps

Properties for an Origin for an API Gateway REST API.

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: ‘/’

  • keepalive_timeout (Optional[Duration]) – Specifies how long, in seconds, CloudFront persists its connection to the origin. The valid range is from 1 to 180 seconds, inclusive. Note that values over 60 seconds are possible only after a limit increase request for the origin response timeout quota has been approved in the target account; otherwise, values over 60 seconds will produce an error at deploy time. Default: Duration.seconds(5)

  • read_timeout (Optional[Duration]) – Specifies how long, in seconds, CloudFront waits for a response from the origin, also known as the origin response timeout. The valid range is from 1 to 180 seconds, inclusive. Note that values over 60 seconds are possible only after a limit increase request for the origin response timeout quota has been approved in the target account; otherwise, values over 60 seconds will produce an error at deploy time. Default: Duration.seconds(30)

ExampleMetadata:

infused

Example:

# api: apigateway.RestApi

cloudfront.Distribution(self, "Distribution",
    default_behavior=cloudfront.BehaviorOptions(origin=origins.RestApiOrigin(api, origin_path="/custom-origin-path"))
)

Attributes

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:

{}

keepalive_timeout

Specifies how long, in seconds, CloudFront persists its connection to the origin.

The valid range is from 1 to 180 seconds, inclusive.

Note that values over 60 seconds are possible only after a limit increase request for the origin response timeout quota has been approved in the target account; otherwise, values over 60 seconds will produce an error at deploy time.

Default:

Duration.seconds(5)

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

read_timeout

Specifies how long, in seconds, CloudFront waits for a response from the origin, also known as the origin response timeout.

The valid range is from 1 to 180 seconds, inclusive.

Note that values over 60 seconds are possible only after a limit increase request for the origin response timeout quota has been approved in the target account; otherwise, values over 60 seconds will produce an error at deploy time.

Default:

Duration.seconds(30)

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