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

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

Overview

Note:

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

{
  id: "string", # required
  domain_name: "string", # required
  origin_path: "string",
  custom_headers: {
    quantity: 1, # required
    items: [
      {
        header_name: "string", # required
        header_value: "string", # required
      },
    ],
  },
  s3_origin_config: {
    origin_access_identity: "string", # required
  },
  custom_origin_config: {
    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,
  },
  connection_attempts: 1,
  connection_timeout: 1,
}

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 the S3OriginConfig type to specify an Amazon S3 bucket that is not configured with static website hosting.

  • Use the CustomOriginConfig type to specify various other kinds of content containers or HTTP servers, including:

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

    • An Elastic Load Balancing load balancer

    • An AWS Elemental MediaPackage origin

    • An AWS 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).

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#connection_attemptsInteger

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.

Returns:

  • (Integer)


6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 6494

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

#connection_timeoutInteger

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.

Returns:

  • (Integer)


6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 6494

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

#custom_headersTypes::CustomHeaders

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

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



6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 6494

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

#custom_origin_configTypes::CustomOriginConfig

Use this type to specify an origin that is a content container or HTTP server, including an Amazon S3 bucket that is configured with static website hosting. To specify an Amazon S3 bucket that is not configured with static website hosting, use the S3OriginConfig type instead.



6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 6494

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

#domain_nameString

The domain name for the origin.

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

Returns:

  • (String)


6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 6494

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

#idString

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)


6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 6494

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

#origin_pathString

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.

Returns:

  • (String)


6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 6494

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

#s3_origin_configTypes::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.



6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 6494

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