Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CloudFront.Types.Origin

Description

Synopsis

Documentation

data Origin Source #

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 AWS Elemental MediaPackage endpoint
- 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).

See: newOrigin smart constructor.

Constructors

Origin'

Fields

customHeaders :: Maybe 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.
customOriginConfig :: Maybe 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.
connectionTimeout :: Maybe Int
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.
connectionAttempts :: Maybe Int
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.
s3OriginConfig :: Maybe 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.
originPath :: Maybe Text
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.
originShield :: Maybe 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.
id :: Text
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.
domainName :: Text
The domain name for the origin.
For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide.

Instances

Instances details

Eq Origin Source #
Instance details Defined in Amazonka.CloudFront.Types.Origin Methods (==) :: Origin -> Origin -> Bool # (/=) :: Origin -> Origin -> Bool #
Read Origin Source #
Instance details Defined in Amazonka.CloudFront.Types.Origin Methods readsPrec :: Int -> ReadS Origin # readList :: ReadS [Origin] # readPrec :: ReadPrec Origin # readListPrec :: ReadPrec [Origin] #
Show Origin Source #
Instance details Defined in Amazonka.CloudFront.Types.Origin Methods showsPrec :: Int -> Origin -> ShowS # show :: Origin -> String # showList :: [Origin] -> ShowS #
Generic Origin Source #
Instance details Defined in Amazonka.CloudFront.Types.Origin Associated Types type Rep Origin :: Type -> Type # Methods from :: Origin -> Rep Origin x # to :: Rep Origin x -> Origin #
NFData Origin Source #
Instance details Defined in Amazonka.CloudFront.Types.Origin Methods rnf :: Origin -> () #
Hashable Origin Source #
Instance details Defined in Amazonka.CloudFront.Types.Origin Methods hashWithSalt :: Int -> Origin -> Int # hash :: Origin -> Int #
FromXML Origin Source #
Instance details Defined in Amazonka.CloudFront.Types.Origin Methods parseXML :: [Node] -> Either String Origin #
ToXML Origin Source #
Instance details Defined in Amazonka.CloudFront.Types.Origin Methods toXML :: Origin -> XML #
type Rep Origin Source #
Instance details Defined in Amazonka.CloudFront.Types.Origin type Rep Origin = D1 ('MetaData "Origin" "Amazonka.CloudFront.Types.Origin" "libZSservicesZSamazonka-cloudfrontZSamazonka-cloudfront" 'False) (C1 ('MetaCons "Origin'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "customHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomHeaders)) :: S1 ('MetaSel ('Just "customOriginConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomOriginConfig))) :: (S1 ('MetaSel ('Just "connectionTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "connectionAttempts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "s3OriginConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3OriginConfig)) :: S1 ('MetaSel ('Just "originPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "originShield") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OriginShield)) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newOrigin Source #

Arguments

:: Text	`$sel:id:Origin'`
-> Text	`$sel:domainName:Origin'`
-> Origin

Create a value of Origin with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:customHeaders:Origin', origin_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.

$sel:customOriginConfig:Origin', origin_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.

$sel:connectionTimeout:Origin', origin_connectionTimeout - 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.

$sel:connectionAttempts:Origin', origin_connectionAttempts - 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.

$sel:s3OriginConfig:Origin', origin_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.

$sel:originPath:Origin', origin_originPath - 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.

$sel:originShield:Origin', origin_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.

$sel:id:Origin', origin_id - 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.

$sel:domainName:Origin', origin_domainName - The domain name for the origin.

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

origin_customHeaders :: Lens' Origin (Maybe CustomHeaders) Source #

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.

origin_customOriginConfig :: Lens' Origin (Maybe CustomOriginConfig) Source #

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.

origin_connectionTimeout :: Lens' Origin (Maybe Int) Source #

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.

origin_connectionAttempts :: Lens' Origin (Maybe Int) Source #

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.

origin_s3OriginConfig :: Lens' Origin (Maybe S3OriginConfig) Source #

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.

origin_originPath :: Lens' Origin (Maybe Text) Source #

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.

origin_originShield :: Lens' Origin (Maybe OriginShield) Source #

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.

origin_id :: Lens' Origin Text Source #

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.

origin_domainName :: Lens' Origin Text Source #

The domain name for the origin.

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