libZSservicesZSamazonka-cloudfrontZSamazonka-cloudfront
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudFront.Types.S3OriginConfig

Description

 
Synopsis

Documentation

data S3OriginConfig Source #

A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin or an S3 bucket that is configured as a website endpoint, use the CustomOriginConfig element instead.

See: newS3OriginConfig smart constructor.

Constructors

S3OriginConfig' 

Fields

  • originAccessIdentity :: Text

    The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:

    origin-access-identity/cloudfront/ID-of-origin-access-identity

    where ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.

    If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

    To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

    To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

    For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

Instances

Instances details
Eq S3OriginConfig Source # 
Instance details

Defined in Amazonka.CloudFront.Types.S3OriginConfig

Read S3OriginConfig Source # 
Instance details

Defined in Amazonka.CloudFront.Types.S3OriginConfig

Show S3OriginConfig Source # 
Instance details

Defined in Amazonka.CloudFront.Types.S3OriginConfig

Generic S3OriginConfig Source # 
Instance details

Defined in Amazonka.CloudFront.Types.S3OriginConfig

Associated Types

type Rep S3OriginConfig :: Type -> Type #

NFData S3OriginConfig Source # 
Instance details

Defined in Amazonka.CloudFront.Types.S3OriginConfig

Methods

rnf :: S3OriginConfig -> () #

Hashable S3OriginConfig Source # 
Instance details

Defined in Amazonka.CloudFront.Types.S3OriginConfig

FromXML S3OriginConfig Source # 
Instance details

Defined in Amazonka.CloudFront.Types.S3OriginConfig

ToXML S3OriginConfig Source # 
Instance details

Defined in Amazonka.CloudFront.Types.S3OriginConfig

Methods

toXML :: S3OriginConfig -> XML #

type Rep S3OriginConfig Source # 
Instance details

Defined in Amazonka.CloudFront.Types.S3OriginConfig

type Rep S3OriginConfig = D1 ('MetaData "S3OriginConfig" "Amazonka.CloudFront.Types.S3OriginConfig" "libZSservicesZSamazonka-cloudfrontZSamazonka-cloudfront" 'False) (C1 ('MetaCons "S3OriginConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "originAccessIdentity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newS3OriginConfig Source #

Create a value of S3OriginConfig 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:originAccessIdentity:S3OriginConfig', s3OriginConfig_originAccessIdentity - The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:

origin-access-identity/cloudfront/ID-of-origin-access-identity

where ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.

If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

s3OriginConfig_originAccessIdentity :: Lens' S3OriginConfig Text Source #

The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:

origin-access-identity/cloudfront/ID-of-origin-access-identity

where ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.

If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.