amazonka-cloudfront-1.1.0: Amazon CloudFront SDK.

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

Network.AWS.CloudFront

Contents

Description

Amazon CloudFront is a web service that speeds up distribution of your static and dynamic web content, for example, .html, .css, .php, image, and media files, to end users. CloudFront delivers your content through a worldwide network of edge locations. When an end user requests content that you're serving with CloudFront, the user is routed to the edge location that provides the lowest latency, so content is delivered with the best possible performance. If the content is already in that edge location, CloudFront delivers it immediately. If the content is not currently in that edge location, CloudFront retrieves it from an Amazon S3 bucket or an HTTP server (for example, a web server) that you have identified as the source for the definitive version of your content.

See: AWS API Reference

Synopsis

Service

data CloudFront Source

Version 2015-04-17 of the Amazon CloudFront SDK.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by CloudFront.

InvalidErrorCode

_InvalidErrorCode :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for InvalidErrorCode' errors.

TooManyCacheBehaviors

_TooManyCacheBehaviors :: AsError a => Getting (First ServiceError) a ServiceError Source

You cannot create anymore cache behaviors for the distribution.

DistributionNotDisabled

_DistributionNotDisabled :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for DistributionNotDisabled' errors.

InvalidOriginAccessIdentity

_InvalidOriginAccessIdentity :: AsError a => Getting (First ServiceError) a ServiceError Source

The origin access identity is not valid or doesn't exist.

TooManyCloudFrontOriginAccessIdentities

_TooManyCloudFrontOriginAccessIdentities :: AsError a => Getting (First ServiceError) a ServiceError Source

Processing your request would cause you to exceed the maximum number of origin access identities allowed.

TooManyStreamingDistributions

_TooManyStreamingDistributions :: AsError a => Getting (First ServiceError) a ServiceError Source

Processing your request would cause you to exceed the maximum number of streaming distributions allowed.

InvalidArgument

NoSuchCloudFrontOriginAccessIdentity

_NoSuchCloudFrontOriginAccessIdentity :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified origin access identity does not exist.

NoSuchStreamingDistribution

_NoSuchStreamingDistribution :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified streaming distribution does not exist.

CloudFrontOriginAccessIdentityInUse

_CloudFrontOriginAccessIdentityInUse :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for CloudFrontOriginAccessIdentityInUse' errors.

InconsistentQuantities

_InconsistentQuantities :: AsError a => Getting (First ServiceError) a ServiceError Source

The value of Quantity and the size of Items do not match.

TooManyInvalidationsInProgress

_TooManyInvalidationsInProgress :: AsError a => Getting (First ServiceError) a ServiceError Source

You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.

TooManyDistributionCNAMEs

_TooManyDistributionCNAMEs :: AsError a => Getting (First ServiceError) a ServiceError Source

Your request contains more CNAMEs than are allowed per distribution.

InvalidForwardCookies

_InvalidForwardCookies :: AsError a => Getting (First ServiceError) a ServiceError Source

Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.

TooManyCookieNamesInWhiteList

_TooManyCookieNamesInWhiteList :: AsError a => Getting (First ServiceError) a ServiceError Source

Your request contains more cookie names in the whitelist than are allowed per cache behavior.

BatchTooLarge

_BatchTooLarge :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for BatchTooLarge' errors.

InvalidOrigin

_InvalidOrigin :: AsError a => Getting (First ServiceError) a ServiceError Source

The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.

TooManyTrustedSigners

_TooManyTrustedSigners :: AsError a => Getting (First ServiceError) a ServiceError Source

Your request contains more trusted signers than are allowed per distribution.

NoSuchOrigin

_NoSuchOrigin :: AsError a => Getting (First ServiceError) a ServiceError Source

No origin exists with the specified Origin Id.

NoSuchInvalidation

_NoSuchInvalidation :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified invalidation does not exist.

StreamingDistributionNotDisabled

_StreamingDistributionNotDisabled :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for StreamingDistributionNotDisabled' errors.

InvalidTTLOrder

_InvalidTTLOrder :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for InvalidTTLOrder' errors.

TooManyStreamingDistributionCNAMEs

_TooManyStreamingDistributionCNAMEs :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for TooManyStreamingDistributionCNAMEs' errors.

TooManyDistributions

_TooManyDistributions :: AsError a => Getting (First ServiceError) a ServiceError Source

Processing your request would cause you to exceed the maximum number of distributions allowed.

InvalidRequiredProtocol

_InvalidRequiredProtocol :: AsError a => Getting (First ServiceError) a ServiceError Source

This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration.

TooManyHeadersInForwardedValues

_TooManyHeadersInForwardedValues :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for TooManyHeadersInForwardedValues' errors.

TooManyCertificates

_TooManyCertificates :: AsError a => Getting (First ServiceError) a ServiceError Source

You cannot create anymore custom ssl certificates.

MissingBody

_MissingBody :: AsError a => Getting (First ServiceError) a ServiceError Source

This operation requires a body. Ensure that the body is present and the Content-Type header is set.

DistributionAlreadyExists

_DistributionAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source

The caller reference you attempted to create the distribution with is associated with another distribution.

IllegalUpdate

_IllegalUpdate :: AsError a => Getting (First ServiceError) a ServiceError Source

Origin and CallerReference cannot be updated.

InvalidResponseCode

_InvalidResponseCode :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for InvalidResponseCode' errors.

InvalidIfMatchVersion

_InvalidIfMatchVersion :: AsError a => Getting (First ServiceError) a ServiceError Source

The If-Match version is missing or not valid for the distribution.

PreconditionFailed

_PreconditionFailed :: AsError a => Getting (First ServiceError) a ServiceError Source

The precondition given in one or more of the request-header fields evaluated to false.

InvalidProtocolSettings

_InvalidProtocolSettings :: AsError a => Getting (First ServiceError) a ServiceError Source

You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI).

TrustedSignerDoesNotExist

_TrustedSignerDoesNotExist :: AsError a => Getting (First ServiceError) a ServiceError Source

One or more of your trusted signers do not exist.

InvalidHeadersForS3Origin

_InvalidHeadersForS3Origin :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for InvalidHeadersForS3Origin' errors.

CNAMEAlreadyExists

_CNAMEAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for CNAMEAlreadyExists' errors.

StreamingDistributionAlreadyExists

_StreamingDistributionAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for StreamingDistributionAlreadyExists' errors.

TooManyOrigins

_TooManyOrigins :: AsError a => Getting (First ServiceError) a ServiceError Source

You cannot create anymore origins for the distribution.

CloudFrontOriginAccessIdentityAlreadyExists

_CloudFrontOriginAccessIdentityAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source

If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.

InvalidRelativePath

_InvalidRelativePath :: AsError a => Getting (First ServiceError) a ServiceError Source

The relative path is too big, is not URL-encoded, or does not begin with a slash (/).

InvalidMinimumProtocolVersion

_InvalidMinimumProtocolVersion :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for InvalidMinimumProtocolVersion' errors.

AccessDenied

NoSuchDistribution

_NoSuchDistribution :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified distribution does not exist.

InvalidViewerCertificate

_InvalidViewerCertificate :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for InvalidViewerCertificate' errors.

InvalidDefaultRootObject

_InvalidDefaultRootObject :: AsError a => Getting (First ServiceError) a ServiceError Source

The default root object file name is too big or contains an invalid character.

InvalidLocationCode

_InvalidLocationCode :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for InvalidLocationCode' errors.

InvalidGeoRestrictionParameter

_InvalidGeoRestrictionParameter :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for InvalidGeoRestrictionParameter' errors.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

DeleteStreamingDistribution

UpdateStreamingDistribution

CreateDistribution

GetDistributionConfig

GetDistribution

DeleteCloudFrontOriginAccessIdentity

UpdateCloudFrontOriginAccessIdentity

ListStreamingDistributions

GetStreamingDistributionConfig

GetCloudFrontOriginAccessIdentityConfig

CreateStreamingDistribution

CreateCloudFrontOriginAccessIdentity

ListCloudFrontOriginAccessIdentities

GetInvalidation

ListInvalidations

GetStreamingDistribution

GetCloudFrontOriginAccessIdentity

CreateInvalidation

UpdateDistribution

DeleteDistribution

ListDistributions

Types

GeoRestrictionType

ItemSelection

Method

MinimumProtocolVersion

OriginProtocolPolicy

PriceClass

SSLSupportMethod

ViewerProtocolPolicy

ActiveTrustedSigners

data ActiveTrustedSigners Source

A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for the default cache behavior or for any of the other cache behaviors for this distribution. These are accounts that you want to allow to create signed URLs for private content.

See: activeTrustedSigners smart constructor.

activeTrustedSigners Source

Creates a value of ActiveTrustedSigners with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

atsItems :: Lens' ActiveTrustedSigners [Signer] Source

A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors.

atsEnabled :: Lens' ActiveTrustedSigners Bool Source

Each active trusted signer.

atsQuantity :: Lens' ActiveTrustedSigners Int Source

The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3.

Aliases

data Aliases Source

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

See: aliases smart constructor.

aliases Source

Arguments

:: Int

aQuantity

-> Aliases 

Creates a value of Aliases with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

aItems :: Lens' Aliases [Text] Source

Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items.

aQuantity :: Lens' Aliases Int Source

The number of CNAMEs, if any, for this distribution.

AllowedMethods

data AllowedMethods Source

A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards only GET, HEAD and OPTIONS requests. - CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin.

See: allowedMethods smart constructor.

allowedMethods Source

Creates a value of AllowedMethods with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

amQuantity :: Lens' AllowedMethods Int Source

The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests).

amItems :: Lens' AllowedMethods [Method] Source

A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.

CacheBehavior

data CacheBehavior Source

A complex type that describes how CloudFront processes requests. You can create up to 10 cache behaviors.You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin will never be used. If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.

See: cacheBehavior smart constructor.

cbMaxTTL :: Lens' CacheBehavior (Maybe Integer) Source

The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years).

cbSmoothStreaming :: Lens' CacheBehavior (Maybe Bool) Source

Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false.

cbDefaultTTL :: Lens' CacheBehavior (Maybe Integer) Source

If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years).

cbPathPattern :: Lens' CacheBehavior Text Source

The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.

cbTargetOriginId :: Lens' CacheBehavior Text Source

The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior.

cbForwardedValues :: Lens' CacheBehavior ForwardedValues Source

A complex type that specifies how CloudFront handles query strings, cookies and headers.

cbTrustedSigners :: Lens' CacheBehavior TrustedSigners Source

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

cbViewerProtocolPolicy :: Lens' CacheBehavior ViewerProtocolPolicy Source

Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL.

cbMinTTL :: Lens' CacheBehavior Integer Source

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years).

CacheBehaviors

cacheBehaviors Source

Creates a value of CacheBehaviors with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cbItems :: Lens' CacheBehaviors [CacheBehavior] Source

Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items.

cbQuantity :: Lens' CacheBehaviors Int Source

The number of cache behaviors for this distribution.

CachedMethods

data CachedMethods Source

A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: - CloudFront caches responses to GET and HEAD requests. - CloudFront caches responses to GET, HEAD, and OPTIONS requests. If you pick the second choice for your S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers and Origin headers for the responses to be cached correctly.

See: cachedMethods smart constructor.

cachedMethods Source

Creates a value of CachedMethods with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cmQuantity :: Lens' CachedMethods Int Source

The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests).

cmItems :: Lens' CachedMethods [Method] Source

A complex type that contains the HTTP methods that you want CloudFront to cache responses to.

CloudFrontOriginAccessIdentity

cloudFrontOriginAccessIdentity Source

Creates a value of CloudFrontOriginAccessIdentity with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cfoaiId :: Lens' CloudFrontOriginAccessIdentity Text Source

The ID for the origin access identity. For example: E74FTE3AJFJ256A.

cfoaiS3CanonicalUserId :: Lens' CloudFrontOriginAccessIdentity Text Source

The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3.

CloudFrontOriginAccessIdentityConfig

cloudFrontOriginAccessIdentityConfig Source

Creates a value of CloudFrontOriginAccessIdentityConfig with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cfoaicCallerReference :: Lens' CloudFrontOriginAccessIdentityConfig Text Source

A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. If the CallerReference is a value you already sent in a previous request to create an identity, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.

cfoaicComment :: Lens' CloudFrontOriginAccessIdentityConfig Text Source

Any comments you want to include about the origin access identity.

CloudFrontOriginAccessIdentityList

cfoailItems :: Lens' CloudFrontOriginAccessIdentityList [CloudFrontOriginAccessIdentitySummary] Source

A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account.

cfoailNextMarker :: Lens' CloudFrontOriginAccessIdentityList (Maybe Text) Source

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off.

cfoailMarker :: Lens' CloudFrontOriginAccessIdentityList Text Source

The value you provided for the Marker request parameter.

cfoailMaxItems :: Lens' CloudFrontOriginAccessIdentityList Int Source

The value you provided for the MaxItems request parameter.

cfoailIsTruncated :: Lens' CloudFrontOriginAccessIdentityList Bool Source

A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list.

cfoailQuantity :: Lens' CloudFrontOriginAccessIdentityList Int Source

The number of CloudFront origin access identities that were created by the current AWS account.

CloudFrontOriginAccessIdentitySummary

cloudFrontOriginAccessIdentitySummary Source

Creates a value of CloudFrontOriginAccessIdentitySummary with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cfoaisId :: Lens' CloudFrontOriginAccessIdentitySummary Text Source

The ID for the origin access identity. For example: E74FTE3AJFJ256A.

cfoaisS3CanonicalUserId :: Lens' CloudFrontOriginAccessIdentitySummary Text Source

The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3.

cfoaisComment :: Lens' CloudFrontOriginAccessIdentitySummary Text Source

The comment for this origin access identity, as originally specified when created.

CookieNames

data CookieNames Source

A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior.

See: cookieNames smart constructor.

cookieNames Source

Arguments

:: Int

cnQuantity

-> CookieNames 

Creates a value of CookieNames with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cnItems :: Lens' CookieNames [Text] Source

Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items.

cnQuantity :: Lens' CookieNames Int Source

The number of whitelisted cookies for this cache behavior.

CookiePreference

cookiePreference Source

Creates a value of CookiePreference with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cpWhitelistedNames :: Lens' CookiePreference (Maybe CookieNames) Source

A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior.

cpForward :: Lens' CookiePreference ItemSelection Source

Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses.

CustomErrorResponse

data CustomErrorResponse Source

A complex type that describes how you'd prefer CloudFront to respond to requests that result in either a 4xx or 5xx response. You can control whether a custom error page should be displayed, what the desired response code should be for this error page and how long should the error response be cached by CloudFront. If you don't want to specify any custom error responses, include only an empty CustomErrorResponses element. To delete all custom error responses in an existing distribution, update the distribution configuration and include only an empty CustomErrorResponses element. To add, change, or remove one or more custom error responses, update the distribution configuration and specify all of the custom error responses that you want to include in the updated distribution.

See: customErrorResponse smart constructor.

customErrorResponse Source

Creates a value of CustomErrorResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ceResponsePagePath :: Lens' CustomErrorResponse (Maybe Text) Source

The path of the custom error page (for example, /custom_404.html). The path is relative to the distribution and must begin with a slash (/). If the path includes any non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not return the custom error page to the viewer.

ceResponseCode :: Lens' CustomErrorResponse (Maybe Text) Source

The HTTP status code that you want CloudFront to return with the custom error page to the viewer. For a list of HTTP status codes that you can replace, see CloudFront Documentation.

ceErrorCachingMinTTL :: Lens' CustomErrorResponse (Maybe Integer) Source

The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. You can specify a value from 0 to 31,536,000.

ceErrorCode :: Lens' CustomErrorResponse Int Source

The 4xx or 5xx HTTP status code that you want to customize. For a list of HTTP status codes that you can customize, see CloudFront documentation.

CustomErrorResponses

customErrorResponses Source

Creates a value of CustomErrorResponses with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cerItems :: Lens' CustomErrorResponses [CustomErrorResponse] Source

Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items.

cerQuantity :: Lens' CustomErrorResponses Int Source

The number of custom error responses for this distribution.

CustomOriginConfig

customOriginConfig Source

Creates a value of CustomOriginConfig with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cocHTTPPort :: Lens' CustomOriginConfig Int Source

The HTTP port the custom origin listens on.

cocHTTPSPort :: Lens' CustomOriginConfig Int Source

The HTTPS port the custom origin listens on.

cocOriginProtocolPolicy :: Lens' CustomOriginConfig OriginProtocolPolicy Source

The origin protocol policy to apply to your origin.

DefaultCacheBehavior

data DefaultCacheBehavior Source

A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior.

See: defaultCacheBehavior smart constructor.

dcbMaxTTL :: Lens' DefaultCacheBehavior (Maybe Integer) Source

The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years).

dcbSmoothStreaming :: Lens' DefaultCacheBehavior (Maybe Bool) Source

Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false.

dcbDefaultTTL :: Lens' DefaultCacheBehavior (Maybe Integer) Source

If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years).

dcbTargetOriginId :: Lens' DefaultCacheBehavior Text Source

The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior.

dcbForwardedValues :: Lens' DefaultCacheBehavior ForwardedValues Source

A complex type that specifies how CloudFront handles query strings, cookies and headers.

dcbTrustedSigners :: Lens' DefaultCacheBehavior TrustedSigners Source

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

dcbViewerProtocolPolicy :: Lens' DefaultCacheBehavior ViewerProtocolPolicy Source

Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL.

dcbMinTTL :: Lens' DefaultCacheBehavior Integer Source

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years).

Distribution

dId :: Lens' Distribution Text Source

The identifier for the distribution. For example: EDFDVBD632BHDS5.

dStatus :: Lens' Distribution Text Source

This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.

dLastModifiedTime :: Lens' Distribution UTCTime Source

The date and time the distribution was last modified.

dInProgressInvalidationBatches :: Lens' Distribution Int Source

The number of invalidation batches currently in progress.

dDomainName :: Lens' Distribution Text Source

The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net.

dActiveTrustedSigners :: Lens' Distribution ActiveTrustedSigners Source

CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs.

dDistributionConfig :: Lens' Distribution DistributionConfig Source

The current configuration information for the distribution.

DistributionConfig

dcDefaultRootObject :: Lens' DistributionConfig (Maybe Text) Source

The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object.

dcAliases :: Lens' DistributionConfig (Maybe Aliases) Source

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

dcCustomErrorResponses :: Lens' DistributionConfig (Maybe CustomErrorResponses) Source

A complex type that contains zero or more CustomErrorResponse elements.

dcPriceClass :: Lens' DistributionConfig (Maybe PriceClass) Source

A complex type that contains information about price class for this distribution.

dcCacheBehaviors :: Lens' DistributionConfig (Maybe CacheBehaviors) Source

A complex type that contains zero or more CacheBehavior elements.

dcLogging :: Lens' DistributionConfig (Maybe LoggingConfig) Source

A complex type that controls whether access logs are written for the distribution.

dcCallerReference :: Lens' DistributionConfig Text Source

A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error.

dcOrigins :: Lens' DistributionConfig Origins Source

A complex type that contains information about origins for this distribution.

dcDefaultCacheBehavior :: Lens' DistributionConfig DefaultCacheBehavior Source

A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior.

dcComment :: Lens' DistributionConfig Text Source

Any comments you want to include about the distribution.

dcEnabled :: Lens' DistributionConfig Bool Source

Whether the distribution is enabled to accept end user requests for content.

DistributionList

distributionList Source

Creates a value of DistributionList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dlItems :: Lens' DistributionList [DistributionSummary] Source

A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account.

dlNextMarker :: Lens' DistributionList (Maybe Text) Source

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off.

dlMarker :: Lens' DistributionList Text Source

The value you provided for the Marker request parameter.

dlMaxItems :: Lens' DistributionList Int Source

The value you provided for the MaxItems request parameter.

dlIsTruncated :: Lens' DistributionList Bool Source

A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.

dlQuantity :: Lens' DistributionList Int Source

The number of distributions that were created by the current AWS account.

DistributionSummary

dsId :: Lens' DistributionSummary Text Source

The identifier for the distribution. For example: EDFDVBD632BHDS5.

dsStatus :: Lens' DistributionSummary Text Source

This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.

dsLastModifiedTime :: Lens' DistributionSummary UTCTime Source

The date and time the distribution was last modified.

dsDomainName :: Lens' DistributionSummary Text Source

The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net.

dsAliases :: Lens' DistributionSummary Aliases Source

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

dsOrigins :: Lens' DistributionSummary Origins Source

A complex type that contains information about origins for this distribution.

dsDefaultCacheBehavior :: Lens' DistributionSummary DefaultCacheBehavior Source

A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior.

dsCacheBehaviors :: Lens' DistributionSummary CacheBehaviors Source

A complex type that contains zero or more CacheBehavior elements.

dsCustomErrorResponses :: Lens' DistributionSummary CustomErrorResponses Source

A complex type that contains zero or more CustomErrorResponses elements.

dsComment :: Lens' DistributionSummary Text Source

The comment originally specified when this distribution was created.

dsEnabled :: Lens' DistributionSummary Bool Source

Whether the distribution is enabled to accept end user requests for content.

ForwardedValues

data ForwardedValues Source

A complex type that specifies how CloudFront handles query strings, cookies and headers.

See: forwardedValues smart constructor.

forwardedValues Source

Creates a value of ForwardedValues with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

fvHeaders :: Lens' ForwardedValues (Maybe Headers) Source

A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior.

fvQueryString :: Lens' ForwardedValues Bool Source

Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. If so, specify true; if not, specify false.

fvCookies :: Lens' ForwardedValues CookiePreference Source

A complex type that specifies how CloudFront handles cookies.

GeoRestriction

data GeoRestriction Source

A complex type that controls the countries in which your content is distributed. For more information about geo restriction, go to Customizing Error Responses in the Amazon CloudFront Developer Guide. CloudFront determines the location of your users using MaxMind GeoIP databases. For information about the accuracy of these databases, see How accurate are your GeoIP databases? on the MaxMind website.

See: geoRestriction smart constructor.

geoRestriction Source

Creates a value of GeoRestriction with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

grItems :: Lens' GeoRestriction [Text] Source

A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes.

grRestrictionType :: Lens' GeoRestriction GeoRestrictionType Source

The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

grQuantity :: Lens' GeoRestriction Int Source

When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items.

Headers

data Headers Source

A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior. For the headers that you specify, CloudFront also caches separate versions of a given object based on the header values in viewer requests; this is known as varying on headers. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to vary on the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value.

See: headers smart constructor.

headers Source

Arguments

:: Int

hQuantity

-> Headers 

Creates a value of Headers with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

hItems :: Lens' Headers [Text] Source

Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items.

hQuantity :: Lens' Headers Int Source

The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items.

Invalidation

invalidation Source

Creates a value of Invalidation with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

iId :: Lens' Invalidation Text Source

The identifier for the invalidation request. For example: IDFDVBD632BHDS5.

iStatus :: Lens' Invalidation Text Source

The status of the invalidation request. When the invalidation batch is finished, the status is Completed.

iCreateTime :: Lens' Invalidation UTCTime Source

The date and time the invalidation request was first made.

iInvalidationBatch :: Lens' Invalidation InvalidationBatch Source

The current invalidation information for the batch request.

InvalidationBatch

invalidationBatch Source

Creates a value of InvalidationBatch with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ibPaths :: Lens' InvalidationBatch Paths Source

The path of the object to invalidate. The path is relative to the distribution and must begin with a slash (/). You must enclose each invalidation object with the Path element tags. If the path includes non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object.

ibCallerReference :: Lens' InvalidationBatch Text Source

A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create an invalidation batch, and the content of each Path element is identical to the original request, the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error.

InvalidationList

invalidationList Source

Creates a value of InvalidationList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ilItems :: Lens' InvalidationList [InvalidationSummary] Source

A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account.

ilNextMarker :: Lens' InvalidationList (Maybe Text) Source

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your invalidation batches where they left off.

ilMarker :: Lens' InvalidationList Text Source

The value you provided for the Marker request parameter.

ilMaxItems :: Lens' InvalidationList Int Source

The value you provided for the MaxItems request parameter.

ilIsTruncated :: Lens' InvalidationList Bool Source

A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list.

ilQuantity :: Lens' InvalidationList Int Source

The number of invalidation batches that were created by the current AWS account.

InvalidationSummary

invalidationSummary Source

Creates a value of InvalidationSummary with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

isId :: Lens' InvalidationSummary Text Source

The unique ID for an invalidation request.

isStatus :: Lens' InvalidationSummary Text Source

The status of an invalidation request.

KeyPairIds

data KeyPairIds Source

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

See: keyPairIds smart constructor.

keyPairIds Source

Arguments

:: Int

kpiQuantity

-> KeyPairIds 

Creates a value of KeyPairIds with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

kpiItems :: Lens' KeyPairIds [Text] Source

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

kpiQuantity :: Lens' KeyPairIds Int Source

The number of active CloudFront key pairs for AwsAccountNumber.

LoggingConfig

data LoggingConfig Source

A complex type that controls whether access logs are written for the distribution.

See: loggingConfig smart constructor.

loggingConfig Source

Creates a value of LoggingConfig with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lcEnabled :: Lens' LoggingConfig Bool Source

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted.

lcIncludeCookies :: Lens' LoggingConfig Bool Source

Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies.

lcBucket :: Lens' LoggingConfig Text Source

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

lcPrefix :: Lens' LoggingConfig Text Source

An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element.

Origin

data Origin Source

A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files.You must create at least one origin.

See: origin smart constructor.

origin Source

Arguments

:: Text

oId

-> Text

oDomainName

-> Origin 

Creates a value of Origin with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

oCustomOriginConfig :: Lens' Origin (Maybe CustomOriginConfig) Source

A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead.

oS3OriginConfig :: Lens' Origin (Maybe S3OriginConfig) Source

A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead.

oOriginPath :: Lens' Origin (Maybe Text) Source

An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName.

oId :: Lens' Origin Text Source

A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior.

oDomainName :: Lens' Origin Text Source

Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com.

Origins

data Origins Source

A complex type that contains information about origins for this distribution.

See: origins smart constructor.

origins Source

Arguments

:: Int

oQuantity

-> Origins 

Creates a value of Origins with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

oItems :: Lens' Origins (Maybe (NonEmpty Origin)) Source

A complex type that contains origins for this distribution.

oQuantity :: Lens' Origins Int Source

The number of origins for this distribution.

Paths

data Paths Source

A complex type that contains information about the objects that you want to invalidate.

See: paths smart constructor.

paths Source

Arguments

:: Int

pQuantity

-> Paths 

Creates a value of Paths with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

pItems :: Lens' Paths [Text] Source

A complex type that contains a list of the objects that you want to invalidate.

pQuantity :: Lens' Paths Int Source

The number of objects that you want to invalidate.

Restrictions

data Restrictions Source

A complex type that identifies ways in which you want to restrict distribution of your content.

See: restrictions smart constructor.

restrictions Source

Creates a value of Restrictions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

S3Origin

data S3Origin Source

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

See: s3Origin smart constructor.

s3Origin Source

Creates a value of S3Origin with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

soDomainName :: Lens' S3Origin Text Source

The DNS name of the S3 origin.

soOriginAccessIdentity :: Lens' S3Origin Text Source

Your S3 origin's origin access identity.

S3OriginConfig

data S3OriginConfig Source

A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead.

See: s3OriginConfig smart constructor.

s3OriginConfig Source

Creates a value of S3OriginConfig with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

socOriginAccessIdentity :: 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 end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users 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. Use the format origin-access-identity/cloudfront/Id where Id is the value that CloudFront returned in the Id element when you created the origin access identity.

Signer

data Signer Source

A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any.

See: signer smart constructor.

signer :: Signer Source

Creates a value of Signer with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

sAWSAccountNumber :: Lens' Signer (Maybe Text) Source

Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number.

sKeyPairIds :: Lens' Signer (Maybe KeyPairIds) Source

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

StreamingDistribution

sdLastModifiedTime :: Lens' StreamingDistribution (Maybe UTCTime) Source

The date and time the distribution was last modified.

sdId :: Lens' StreamingDistribution Text Source

The identifier for the streaming distribution. For example: EGTXBD79H29TRA8.

sdStatus :: Lens' StreamingDistribution Text Source

The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.

sdDomainName :: Lens' StreamingDistribution Text Source

The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net.

sdActiveTrustedSigners :: Lens' StreamingDistribution ActiveTrustedSigners Source

CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs.

sdStreamingDistributionConfig :: Lens' StreamingDistribution StreamingDistributionConfig Source

The current configuration information for the streaming distribution.

StreamingDistributionConfig

sdcAliases :: Lens' StreamingDistributionConfig (Maybe Aliases) Source

A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.

sdcPriceClass :: Lens' StreamingDistributionConfig (Maybe PriceClass) Source

A complex type that contains information about price class for this streaming distribution.

sdcLogging :: Lens' StreamingDistributionConfig (Maybe StreamingLoggingConfig) Source

A complex type that controls whether access logs are written for the streaming distribution.

sdcCallerReference :: Lens' StreamingDistributionConfig Text Source

A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. If the CallerReference is a value you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error.

sdcS3Origin :: Lens' StreamingDistributionConfig S3Origin Source

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

sdcComment :: Lens' StreamingDistributionConfig Text Source

Any comments you want to include about the streaming distribution.

sdcTrustedSigners :: Lens' StreamingDistributionConfig TrustedSigners Source

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

sdcEnabled :: Lens' StreamingDistributionConfig Bool Source

Whether the streaming distribution is enabled to accept end user requests for content.

StreamingDistributionList

streamingDistributionList Source

Creates a value of StreamingDistributionList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

sdlItems :: Lens' StreamingDistributionList [StreamingDistributionSummary] Source

A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account.

sdlNextMarker :: Lens' StreamingDistributionList (Maybe Text) Source

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your streaming distributions where they left off.

sdlMarker :: Lens' StreamingDistributionList Text Source

The value you provided for the Marker request parameter.

sdlMaxItems :: Lens' StreamingDistributionList Int Source

The value you provided for the MaxItems request parameter.

sdlIsTruncated :: Lens' StreamingDistributionList Bool Source

A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.

sdlQuantity :: Lens' StreamingDistributionList Int Source

The number of streaming distributions that were created by the current AWS account.

StreamingDistributionSummary

sdsId :: Lens' StreamingDistributionSummary Text Source

The identifier for the distribution. For example: EDFDVBD632BHDS5.

sdsStatus :: Lens' StreamingDistributionSummary Text Source

Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.

sdsLastModifiedTime :: Lens' StreamingDistributionSummary UTCTime Source

The date and time the distribution was last modified.

sdsDomainName :: Lens' StreamingDistributionSummary Text Source

The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net.

sdsS3Origin :: Lens' StreamingDistributionSummary S3Origin Source

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

sdsAliases :: Lens' StreamingDistributionSummary Aliases Source

A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.

sdsTrustedSigners :: Lens' StreamingDistributionSummary TrustedSigners Source

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

sdsComment :: Lens' StreamingDistributionSummary Text Source

The comment originally specified when this distribution was created.

sdsEnabled :: Lens' StreamingDistributionSummary Bool Source

Whether the distribution is enabled to accept end user requests for content.

StreamingLoggingConfig

streamingLoggingConfig Source

Creates a value of StreamingLoggingConfig with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

slcEnabled :: Lens' StreamingLoggingConfig Bool Source

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted.

slcBucket :: Lens' StreamingLoggingConfig Text Source

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

slcPrefix :: Lens' StreamingLoggingConfig Text Source

An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element.

TrustedSigners

data TrustedSigners Source

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

See: trustedSigners smart constructor.

trustedSigners Source

Creates a value of TrustedSigners with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tsItems :: Lens' TrustedSigners [Text] Source

Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items.

tsEnabled :: Lens' TrustedSigners Bool Source

Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId.

tsQuantity :: Lens' TrustedSigners Int Source

The number of trusted signers for this cache behavior.

ViewerCertificate

viewerCertificate :: ViewerCertificate Source

Creates a value of ViewerCertificate with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

vcSSLSupportMethod :: Lens' ViewerCertificate (Maybe SSLSupportMethod) Source

If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate.

vcMinimumProtocolVersion :: Lens' ViewerCertificate (Maybe MinimumProtocolVersion) Source

Specify the minimum version of the SSL protocol that you want CloudFront to use, SSLv3 or TLSv1, for HTTPS connections. CloudFront will serve your objects only to browsers or devices that support at least the SSL version that you specify. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using dedicated IP (if you specify vip for SSLSupportMethod), you can choose SSLv3 or TLSv1 as the MinimumProtocolVersion. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion.

vcIAMCertificateId :: Lens' ViewerCertificate (Maybe Text) Source

If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value or CloudFrontDefaultCertificate.

vcCloudFrontDefaultCertificate :: Lens' ViewerCertificate (Maybe Bool) Source

If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an IAMCertificateId.