Class: Aws::CloudFront::Types::Origin

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

Overview

An origin.

An origin is the location where content is stored, and from which CloudFront gets content to serve to viewers. To specify an origin:

  • Use ‘S3OriginConfig` to specify an Amazon S3 bucket that is not configured with static website hosting.

  • Use ‘CustomOriginConfig` to specify all other kinds of origins, including:

    • An Amazon S3 bucket that is configured with static website hosting

    • An Elastic Load Balancing load balancer

    • An Elemental MediaPackage endpoint

    • An Elemental MediaStore container

    • Any other HTTP server, running on an Amazon EC2 instance or any other kind of host

For the current maximum number of origins that you can specify per distribution, see [General Quotas on Web Distributions] in the *Amazon CloudFront Developer Guide* (quotas were formerly referred to as limits).

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html#limits-web-distributions

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#connection_attempts ⇒ Integer

The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don’t specify otherwise) is 3.

For a custom origin (including an Amazon S3 bucket that’s configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an [Origin Response Timeout].

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

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

Returns:

  • (Integer) 


8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 8814

class Origin < Struct.new(
  :id,
  :domain_name,
  :origin_path,
  :custom_headers,
  :s3_origin_config,
  :custom_origin_config,
  :vpc_origin_config,
  :connection_attempts,
  :connection_timeout,
  :origin_shield,
  :origin_access_control_id)
  SENSITIVE = []
  include Aws::Structure
end

#connection_timeout ⇒ Integer

The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don’t specify otherwise) is 10 seconds.

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

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

Returns:

  • (Integer) 


8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 8814

class Origin < Struct.new(
  :id,
  :domain_name,
  :origin_path,
  :custom_headers,
  :s3_origin_config,
  :custom_origin_config,
  :vpc_origin_config,
  :connection_attempts,
  :connection_timeout,
  :origin_shield,
  :origin_access_control_id)
  SENSITIVE = []
  include Aws::Structure
end

#custom_headers ⇒ Types::CustomHeaders

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

For more information, see [Adding Custom Headers to Origin Requests] in the *Amazon CloudFront Developer Guide*.

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/add-origin-custom-headers.html

Returns:



8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 8814

class Origin < Struct.new(
  :id,
  :domain_name,
  :origin_path,
  :custom_headers,
  :s3_origin_config,
  :custom_origin_config,
  :vpc_origin_config,
  :connection_attempts,
  :connection_timeout,
  :origin_shield,
  :origin_access_control_id)
  SENSITIVE = []
  include Aws::Structure
end

#custom_origin_config ⇒ Types::CustomOriginConfig

Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the ‘S3OriginConfig` type instead.

Returns:



8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 8814

class Origin < Struct.new(
  :id,
  :domain_name,
  :origin_path,
  :custom_headers,
  :s3_origin_config,
  :custom_origin_config,
  :vpc_origin_config,
  :connection_attempts,
  :connection_timeout,
  :origin_shield,
  :origin_access_control_id)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name ⇒ String

The domain name for the origin.

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

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

Returns:

  • (String) 


8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 8814

class Origin < Struct.new(
  :id,
  :domain_name,
  :origin_path,
  :custom_headers,
  :s3_origin_config,
  :custom_origin_config,
  :vpc_origin_config,
  :connection_attempts,
  :connection_timeout,
  :origin_shield,
  :origin_access_control_id)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

A unique identifier for the origin. This value must be unique within the distribution.

Use this value to specify the ‘TargetOriginId` in a `CacheBehavior` or `DefaultCacheBehavior`.

Returns:

  • (String) 


8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 8814

class Origin < Struct.new(
  :id,
  :domain_name,
  :origin_path,
  :custom_headers,
  :s3_origin_config,
  :custom_origin_config,
  :vpc_origin_config,
  :connection_attempts,
  :connection_timeout,
  :origin_shield,
  :origin_access_control_id)
  SENSITIVE = []
  include Aws::Structure
end

#origin_access_control_id ⇒ String

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

For more information, see [Restricting access to an Amazon S3 origin] in the *Amazon CloudFront Developer Guide*.

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html

Returns:

  • (String) 


8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 8814

class Origin < Struct.new(
  :id,
  :domain_name,
  :origin_path,
  :custom_headers,
  :s3_origin_config,
  :custom_origin_config,
  :vpc_origin_config,
  :connection_attempts,
  :connection_timeout,
  :origin_shield,
  :origin_access_control_id)
  SENSITIVE = []
  include Aws::Structure
end

#origin_path ⇒ String

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

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

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

Returns:

  • (String) 


8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 8814

class Origin < Struct.new(
  :id,
  :domain_name,
  :origin_path,
  :custom_headers,
  :s3_origin_config,
  :custom_origin_config,
  :vpc_origin_config,
  :connection_attempts,
  :connection_timeout,
  :origin_shield,
  :origin_access_control_id)
  SENSITIVE = []
  include Aws::Structure
end

#origin_shield ⇒ Types::OriginShield

CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin.

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

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html

Returns:



8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 8814

class Origin < Struct.new(
  :id,
  :domain_name,
  :origin_path,
  :custom_headers,
  :s3_origin_config,
  :custom_origin_config,
  :vpc_origin_config,
  :connection_attempts,
  :connection_timeout,
  :origin_shield,
  :origin_access_control_id)
  SENSITIVE = []
  include Aws::Structure
end

#s3_origin_config ⇒ Types::S3OriginConfig

Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the ‘CustomOriginConfig` type instead.

Returns:



8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 8814

class Origin < Struct.new(
  :id,
  :domain_name,
  :origin_path,
  :custom_headers,
  :s3_origin_config,
  :custom_origin_config,
  :vpc_origin_config,
  :connection_attempts,
  :connection_timeout,
  :origin_shield,
  :origin_access_control_id)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_origin_config ⇒ Types::VpcOriginConfig

The VPC origin configuration.

Returns:



8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 8814

class Origin < Struct.new(
  :id,
  :domain_name,
  :origin_path,
  :custom_headers,
  :s3_origin_config,
  :custom_origin_config,
  :vpc_origin_config,
  :connection_attempts,
  :connection_timeout,
  :origin_shield,
  :origin_access_control_id)
  SENSITIVE = []
  include Aws::Structure
end