Skip to content

CustomOriginConfig

Source code in docs_src/capo_cloudfront/types/custom_origin_config.py
class CustomOriginConfig(TypedDict, closed=True):
    http_port: "capo_cloudfront.types.integer.integer"
    """<p>The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.</p>"""
    https_port: "capo_cloudfront.types.integer.integer"
    """<p>The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.</p>"""
    origin_protocol_policy: (
        "capo_cloudfront.types.origin_protocol_policy.OriginProtocolPolicy"
    )
    """<p>Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:</p> <ul> <li> <p> <code>http-only</code> – CloudFront always uses HTTP to connect to the origin.</p> </li> <li> <p> <code>match-viewer</code> – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.</p> </li> <li> <p> <code>https-only</code> – CloudFront always uses HTTPS to connect to the origin.</p> </li> </ul>"""
    origin_ssl_protocols: NotRequired[
        "capo_cloudfront.types.origin_ssl_protocols.OriginSslProtocols"
    ]
    """<p>Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include <code>SSLv3</code>, <code>TLSv1</code>, <code>TLSv1.1</code>, and <code>TLSv1.2</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginSSLProtocols">Minimum Origin SSL Protocol</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"""
    origin_read_timeout: NotRequired["capo_cloudfront.types.integer.integer"]
    """<p>Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the <i>origin response timeout</i>. The minimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't specify otherwise) is 30 seconds.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginResponseTimeout">Response timeout</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"""
    origin_keepalive_timeout: NotRequired["capo_cloudfront.types.integer.integer"]
    """<p>Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't specify otherwise) is 5 seconds.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginKeepaliveTimeout">Keep-alive timeout (custom origins only)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"""
    ip_address_type: NotRequired["capo_cloudfront.types.ip_address_type.IpAddressType"]
    """<p>Specifies which IP protocol CloudFront uses when connecting to your origin. If your origin uses both IPv4 and IPv6 protocols, you can choose <code>dualstack</code> to help optimize reliability.</p>"""
    origin_mtls_config: NotRequired[
        "capo_cloudfront.types.origin_mtls_config.OriginMtlsConfig"
    ]
    """<p>Configures mutual TLS authentication between CloudFront and your origin server.</p>"""

http_port instance-attribute

http_port: integer

The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.

https_port instance-attribute

https_port: integer

The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.

ip_address_type instance-attribute

ip_address_type: NotRequired[IpAddressType]

Specifies which IP protocol CloudFront uses when connecting to your origin. If your origin uses both IPv4 and IPv6 protocols, you can choose dualstack to help optimize reliability.

origin_keepalive_timeout instance-attribute

origin_keepalive_timeout: NotRequired[integer]

Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't specify otherwise) is 5 seconds.

For more information, see Keep-alive timeout (custom origins only) in the Amazon CloudFront Developer Guide.

origin_mtls_config instance-attribute

origin_mtls_config: NotRequired[OriginMtlsConfig]

Configures mutual TLS authentication between CloudFront and your origin server.

origin_protocol_policy instance-attribute

origin_protocol_policy: OriginProtocolPolicy

Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:

  • http-only – CloudFront always uses HTTP to connect to the origin.

  • match-viewer – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.

  • https-only – CloudFront always uses HTTPS to connect to the origin.

origin_read_timeout instance-attribute

origin_read_timeout: NotRequired[integer]

Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't specify otherwise) is 30 seconds.

For more information, see Response timeout in the Amazon CloudFront Developer Guide.

origin_ssl_protocols instance-attribute

origin_ssl_protocols: NotRequired[OriginSslProtocols]

Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include SSLv3, TLSv1, TLSv1.1, and TLSv1.2.

For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide.