Class: Aws::CloudFront::Types::CustomOriginConfig

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudfront/types.rb

Overview

Note:

When making an API call, you may pass CustomOriginConfig data as a hash:

{
  http_port: 1, # required
  https_port: 1, # required
  origin_protocol_policy: "http-only", # required, accepts http-only, match-viewer, https-only
  origin_ssl_protocols: {
    quantity: 1, # required
    items: ["SSLv3"], # required, accepts SSLv3, TLSv1, TLSv1.1, TLSv1.2
  },
  origin_read_timeout: 1,
  origin_keepalive_timeout: 1,
}

A custom origin. A custom origin is any origin that is not an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is [configured with static website hosting] is a custom origin.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#http_portInteger

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

Returns:

  • (Integer)

3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
# File 'lib/aws-sdk-cloudfront/types.rb', line 3459

class CustomOriginConfig < Struct.new(
  :http_port,
  :https_port,
  :origin_protocol_policy,
  :origin_ssl_protocols,
  :origin_read_timeout,
  :origin_keepalive_timeout)
  SENSITIVE = []
  include Aws::Structure
end

#https_portInteger

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

Returns:

  • (Integer)

3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
# File 'lib/aws-sdk-cloudfront/types.rb', line 3459

class CustomOriginConfig < Struct.new(
  :http_port,
  :https_port,
  :origin_protocol_policy,
  :origin_ssl_protocols,
  :origin_read_timeout,
  :origin_keepalive_timeout)
  SENSITIVE = []
  include Aws::Structure
end

#origin_keepalive_timeoutInteger

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

For more information, see [Origin Keep-alive Timeout] in the *Amazon CloudFront Developer Guide*.

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginKeepaliveTimeout

Returns:

  • (Integer)

3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
# File 'lib/aws-sdk-cloudfront/types.rb', line 3459

class CustomOriginConfig < Struct.new(
  :http_port,
  :https_port,
  :origin_protocol_policy,
  :origin_ssl_protocols,
  :origin_read_timeout,
  :origin_keepalive_timeout)
  SENSITIVE = []
  include Aws::Structure
end

#origin_protocol_policyString

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.

Returns:

  • (String)

3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
# File 'lib/aws-sdk-cloudfront/types.rb', line 3459

class CustomOriginConfig < Struct.new(
  :http_port,
  :https_port,
  :origin_protocol_policy,
  :origin_ssl_protocols,
  :origin_read_timeout,
  :origin_keepalive_timeout)
  SENSITIVE = []
  include Aws::Structure
end

#origin_read_timeoutInteger

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 60 seconds, and the default (if you don’t specify otherwise) is 30 seconds.

For more information, see [Origin Response Timeout] in the *Amazon CloudFront Developer Guide*.

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout

Returns:

  • (Integer)

3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
# File 'lib/aws-sdk-cloudfront/types.rb', line 3459

class CustomOriginConfig < Struct.new(
  :http_port,
  :https_port,
  :origin_protocol_policy,
  :origin_ssl_protocols,
  :origin_read_timeout,
  :origin_keepalive_timeout)
  SENSITIVE = []
  include Aws::Structure
end

#origin_ssl_protocolsTypes::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*.

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginSSLProtocols


3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
# File 'lib/aws-sdk-cloudfront/types.rb', line 3459

class CustomOriginConfig < Struct.new(
  :http_port,
  :https_port,
  :origin_protocol_policy,
  :origin_ssl_protocols,
  :origin_read_timeout,
  :origin_keepalive_timeout)
  SENSITIVE = []
  include Aws::Structure
end