Crate rusoto_cloudfront

Amazon CloudFront

This is the Amazon CloudFront API Reference. This guide is for developers who need detailed information about CloudFront API actions, data types, and errors. For detailed information about CloudFront features, see the Amazon CloudFront Developer Guide.

If you’re using the service, you’re probably looking for CloudFrontClient and CloudFront.

Structs

ActiveTrustedKeyGroups

A list of key groups, and the public keys in each key group, that CloudFront can use to verify the signatures of signed URLs and signed cookies.

ActiveTrustedSigners

A list of AWS accounts and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.

AliasICPRecordal

AWS services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions. The status is returned in the CloudFront response; you can't configure it yourself.

For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with AWS services in China.

AliasListSerializer

Aliases

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

AliasesSerializer

AllowedMethods

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 might not want users to have permissions to delete objects from your origin.

AllowedMethodsSerializer

AwsAccountNumberListSerializer

BooleanSerializer

CacheBehavior

A complex type that describes how CloudFront processes requests.

You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to serve 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 is never used.

For the current quota (formerly known as limit) on the number of cache behaviors that you can add to a distribution, see Quotas in the Amazon CloudFront Developer Guide.

If you don’t want to specify any cache behaviors, include only an empty CacheBehaviors element. Don’t include an empty CacheBehavior element because this is invalid.

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.

For more information about cache behaviors, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.

CacheBehaviorListSerializer

CacheBehaviorSerializer

CacheBehaviors

A complex type that contains zero or more CacheBehavior elements.

CacheBehaviorsSerializer

CachePolicy

A cache policy.

When it’s attached to a cache behavior, the cache policy determines the following:

• The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.

• The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.

The headers, cookies, and query strings that are included in the cache key are automatically included in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t find a valid object in its cache that matches the request’s cache key. If you want to send values to the origin but not include them in the cache key, use OriginRequestPolicy.

CachePolicyConfig

A cache policy configuration.

This configuration determines the following:

• The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.

• The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.

The headers, cookies, and query strings that are included in the cache key are automatically included in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t find a valid object in its cache that matches the request’s cache key. If you want to send values to the origin but not include them in the cache key, use OriginRequestPolicy.

CachePolicyConfigSerializer

CachePolicyCookieBehaviorSerializer

CachePolicyCookiesConfig

An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin.

CachePolicyCookiesConfigSerializer

CachePolicyHeaderBehaviorSerializer

CachePolicyHeadersConfig

An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin.

CachePolicyHeadersConfigSerializer

CachePolicyList

A list of cache policies.

CachePolicyQueryStringBehaviorSerializer

CachePolicyQueryStringsConfig

An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin.

CachePolicyQueryStringsConfigSerializer

CachePolicySummary

Contains a cache policy.

CachePolicyTypeSerializer

CachedMethods

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 Amazon 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.

CachedMethodsSerializer

CloudFrontClient

A client for the CloudFront API.

CloudFrontOriginAccessIdentity

CloudFront origin access identity.

CloudFrontOriginAccessIdentityConfig

Origin access identity configuration. Send a GET request to the /CloudFront API version/CloudFront/identity ID/config resource.

CloudFrontOriginAccessIdentityConfigSerializer

CloudFrontOriginAccessIdentityList

Lists the origin access identities for CloudFront.Send a GET request to the /CloudFront API version/origin-access-identity/cloudfront resource. The response includes a CloudFrontOriginAccessIdentityList element with zero or more CloudFrontOriginAccessIdentitySummary child elements. By default, your entire list of origin access identities is returned in one single page. If the list is long, you can paginate it using the MaxItems and Marker parameters.

CloudFrontOriginAccessIdentitySummary

Summary of the information about a CloudFront origin access identity.

CommentTypeSerializer

ContentTypeProfile

A field-level encryption content type profile.

ContentTypeProfileConfig

The configuration for a field-level encryption content type-profile mapping.

ContentTypeProfileConfigSerializer

ContentTypeProfileListSerializer

ContentTypeProfileSerializer

ContentTypeProfiles

Field-level encryption content type-profile.

ContentTypeProfilesSerializer

CookieNameListSerializer

CookieNames

Contains a list of cookie names.

CookieNamesSerializer

CookiePreference

This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.

If you want to include cookies in the cache key, use CookiesConfig in a cache policy. See CachePolicy.

If you want to send cookies to the origin but not include them in the cache key, use CookiesConfig in an origin request policy. See OriginRequestPolicy.

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see Caching Content Based on Cookies in the Amazon CloudFront Developer Guide.

CreateCachePolicyRequest

CreateCachePolicyResult

CreateCloudFrontOriginAccessIdentityRequest

The request to create a new origin access identity (OAI). An origin access identity is a special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or just some of your Amazon S3 content. For more information, see Restricting Access to Amazon S3 Content by Using an Origin Access Identity in the Amazon CloudFront Developer Guide.

CreateCloudFrontOriginAccessIdentityResult

The returned result of the corresponding request.

CreateDistributionRequest

The request to create a new distribution.

CreateDistributionResult

The returned result of the corresponding request.

CreateDistributionWithTagsRequest

The request to create a new distribution with tags.

CreateDistributionWithTagsResult

The returned result of the corresponding request.

CreateFieldLevelEncryptionConfigRequest

CreateFieldLevelEncryptionConfigResult

CreateFieldLevelEncryptionProfileRequest

CreateFieldLevelEncryptionProfileResult

CreateFunctionRequest

CreateFunctionRequestSerializer

CreateFunctionResult

CreateInvalidationRequest

The request to create an invalidation.

CreateInvalidationResult

The returned result of the corresponding request.

CreateKeyGroupRequest

CreateKeyGroupResult

CreateMonitoringSubscriptionRequest

CreateMonitoringSubscriptionResult

CreateOriginRequestPolicyRequest

CreateOriginRequestPolicyResult

CreatePublicKeyRequest

CreatePublicKeyResult

CreateRealtimeLogConfigRequest

CreateRealtimeLogConfigRequestSerializer

CreateRealtimeLogConfigResult

CreateStreamingDistributionRequest

The request to create a new streaming distribution.

CreateStreamingDistributionResult

The returned result of the corresponding request.

CreateStreamingDistributionWithTagsRequest

The request to create a new streaming distribution with tags.

CreateStreamingDistributionWithTagsResult

The returned result of the corresponding request.

CustomErrorResponse

A complex type that controls:

• Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

• How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

CustomErrorResponseListSerializer

CustomErrorResponseSerializer

CustomErrorResponses

A complex type that controls:

• Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

• How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

CustomErrorResponsesSerializer

CustomHeaders

A complex type that contains the list of Custom Headers for each origin.

CustomHeadersSerializer

CustomOriginConfig

A custom origin. A custom origin is any origin that is not an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is configured with static website hosting is a custom origin.

CustomOriginConfigSerializer

DefaultCacheBehavior

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

DefaultCacheBehaviorSerializer

DeleteCachePolicyRequest

DeleteCloudFrontOriginAccessIdentityRequest

Deletes a origin access identity.

DeleteDistributionRequest

This action deletes a web distribution. To delete a web distribution using the CloudFront API, perform the following steps.

To delete a web distribution using the CloudFront API:

1. Disable the web distribution

2. Submit a GET Distribution Config request to get the current configuration and the Etag header for the distribution.

3. Update the XML document that was returned in the response to your GET Distribution Config request to change the value of Enabled to false.

4. Submit a PUT Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 2.

5. Review the response to the PUT Distribution Config request to confirm that the distribution was successfully disabled.

6. Submit a GET Distribution request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

7. Submit a DELETE Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 6.

8. Review the response to your DELETE Distribution request to confirm that the distribution was successfully deleted.

For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.

DeleteFieldLevelEncryptionConfigRequest

DeleteFieldLevelEncryptionProfileRequest

DeleteFunctionRequest

DeleteKeyGroupRequest

DeleteMonitoringSubscriptionRequest

DeleteMonitoringSubscriptionResult

DeleteOriginRequestPolicyRequest

DeletePublicKeyRequest

DeleteRealtimeLogConfigRequest

DeleteRealtimeLogConfigRequestSerializer

DeleteStreamingDistributionRequest

The request to delete a streaming distribution.

DescribeFunctionRequest

DescribeFunctionResult

Distribution

A distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery.

DistributionConfig

A distribution configuration.

DistributionConfigSerializer

DistributionConfigWithTags

A distribution Configuration and a list of tags to be associated with the distribution.

DistributionConfigWithTagsSerializer

DistributionIdList

A list of distribution IDs.

DistributionList

A distribution list.

DistributionSummary

A summary of the information about a CloudFront distribution.

EncryptionEntities

Complex data type for field-level encryption profiles that includes all of the encryption entities.

EncryptionEntitiesSerializer

EncryptionEntity

Complex data type for field-level encryption profiles that includes the encryption key and field pattern specifications.

EncryptionEntityListSerializer

EncryptionEntitySerializer

EndPoint

Contains information about the Amazon Kinesis data stream where you are sending real-time log data in a real-time log configuration.

EndPointListSerializer

EndPointSerializer

EventTypeSerializer

FieldLevelEncryption

A complex data type that includes the profile configurations and other options specified for field-level encryption.

FieldLevelEncryptionConfig

A complex data type that includes the profile configurations specified for field-level encryption.

FieldLevelEncryptionConfigSerializer

FieldLevelEncryptionList

List of field-level encrpytion configurations.

FieldLevelEncryptionProfile

A complex data type for field-level encryption profiles.

FieldLevelEncryptionProfileConfig

A complex data type of profiles for the field-level encryption.

FieldLevelEncryptionProfileConfigSerializer

FieldLevelEncryptionProfileList

List of field-level encryption profiles.

FieldLevelEncryptionProfileSummary

The field-level encryption profile summary.

FieldLevelEncryptionSummary

A summary of a field-level encryption item.

FieldListSerializer

FieldPatternListSerializer

FieldPatterns

A complex data type that includes the field patterns to match for field-level encryption.

FieldPatternsSerializer

FormatSerializer

ForwardedValues

This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.

If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.

If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.

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

FunctionARNSerializer

FunctionAssociation

A CloudFront function that is associated with a cache behavior in a CloudFront distribution.

FunctionAssociationListSerializer

FunctionAssociationSerializer

FunctionAssociations

A list of CloudFront functions that are associated with a cache behavior in a CloudFront distribution. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.

FunctionAssociationsSerializer

FunctionBlobSerializer

FunctionConfig

Contains configuration information about a CloudFront function.

FunctionConfigSerializer

FunctionEventObjectSerializer

FunctionList

A list of CloudFront functions.

FunctionMetadata

Contains metadata about a CloudFront function.

FunctionNameSerializer

FunctionRuntimeSerializer

FunctionStageSerializer

FunctionSummary

Contains configuration information and metadata about a CloudFront function.

GeoRestriction

A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.

GeoRestrictionSerializer

GeoRestrictionTypeSerializer

GetCachePolicyConfigRequest

GetCachePolicyConfigResult

GetCachePolicyRequest

GetCachePolicyResult

GetCloudFrontOriginAccessIdentityConfigRequest

The origin access identity's configuration information. For more information, see CloudFrontOriginAccessIdentityConfig.

GetCloudFrontOriginAccessIdentityConfigResult

The returned result of the corresponding request.

GetCloudFrontOriginAccessIdentityRequest

The request to get an origin access identity's information.

GetCloudFrontOriginAccessIdentityResult

The returned result of the corresponding request.

GetDistributionConfigRequest

The request to get a distribution configuration.

GetDistributionConfigResult

The returned result of the corresponding request.

GetDistributionRequest

The request to get a distribution's information.

GetDistributionResult

The returned result of the corresponding request.

GetFieldLevelEncryptionConfigRequest

GetFieldLevelEncryptionConfigResult

GetFieldLevelEncryptionProfileConfigRequest

GetFieldLevelEncryptionProfileConfigResult

GetFieldLevelEncryptionProfileRequest

GetFieldLevelEncryptionProfileResult

GetFieldLevelEncryptionRequest

GetFieldLevelEncryptionResult

GetFunctionRequest

GetFunctionResult

GetInvalidationRequest

The request to get an invalidation's information.

GetInvalidationResult

The returned result of the corresponding request.

GetKeyGroupConfigRequest

GetKeyGroupConfigResult

GetKeyGroupRequest

GetKeyGroupResult

GetMonitoringSubscriptionRequest

GetMonitoringSubscriptionResult

GetOriginRequestPolicyConfigRequest

GetOriginRequestPolicyConfigResult

GetOriginRequestPolicyRequest

GetOriginRequestPolicyResult

GetPublicKeyConfigRequest

GetPublicKeyConfigResult

GetPublicKeyRequest

GetPublicKeyResult

GetRealtimeLogConfigRequest

GetRealtimeLogConfigRequestSerializer

GetRealtimeLogConfigResult

GetStreamingDistributionConfigRequest

To request to get a streaming distribution configuration.

GetStreamingDistributionConfigResult

The returned result of the corresponding request.

GetStreamingDistributionRequest

The request to get a streaming distribution's information.

GetStreamingDistributionResult

The returned result of the corresponding request.

HeaderListSerializer

Headers

Contains a list of HTTP header names.

HeadersSerializer

HttpVersionSerializer

IntegerSerializer

Invalidation

An invalidation.

InvalidationBatch

An invalidation batch.

InvalidationBatchSerializer

InvalidationList

The InvalidationList complex type describes the list of invalidation objects. For more information about invalidation, see Invalidating Objects (Web Distributions Only) in the Amazon CloudFront Developer Guide.

InvalidationSummary

A summary of an invalidation request.

KGKeyPairIds

A list of identifiers for the public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies.

KeyGroup

A key group.

A key group contains a list of public keys that you can use with CloudFront signed URLs and signed cookies.

KeyGroupConfig

A key group configuration.

A key group contains a list of public keys that you can use with CloudFront signed URLs and signed cookies.

KeyGroupConfigSerializer

KeyGroupList

A list of key groups.

KeyGroupSummary

Contains information about a key group.

KeyPairIds

A list of CloudFront key pair identifiers.

KinesisStreamConfig

Contains information about the Amazon Kinesis data stream where you are sending real-time log data.

KinesisStreamConfigSerializer

LambdaFunctionARNSerializer

LambdaFunctionAssociation

A complex type that contains a Lambda function association.

LambdaFunctionAssociationListSerializer

LambdaFunctionAssociationSerializer

LambdaFunctionAssociations

A complex type that specifies a list of Lambda functions associations for a cache behavior.

If you want to invoke one or more Lambda functions triggered by requests that match the PathPattern of the cache behavior, specify the applicable values for Quantity and Items. Note that there can be up to 4 LambdaFunctionAssociation items in this list (one for each possible value of EventType) and each EventType can be associated with the Lambda function only once.

If you don't want to invoke any Lambda functions for the requests that match PathPattern, specify 0 for Quantity and omit Items.

LambdaFunctionAssociationsSerializer

ListCachePoliciesRequest

ListCachePoliciesResult

ListCloudFrontOriginAccessIdentitiesRequest

The request to list origin access identities.

ListCloudFrontOriginAccessIdentitiesResult

The returned result of the corresponding request.

ListDistributionsByCachePolicyIdRequest

ListDistributionsByCachePolicyIdResult

ListDistributionsByKeyGroupRequest

ListDistributionsByKeyGroupResult

ListDistributionsByOriginRequestPolicyIdRequest

ListDistributionsByOriginRequestPolicyIdResult

ListDistributionsByRealtimeLogConfigRequest

ListDistributionsByRealtimeLogConfigRequestSerializer

ListDistributionsByRealtimeLogConfigResult

ListDistributionsByWebACLIdRequest

The request to list distributions that are associated with a specified AWS WAF web ACL.

ListDistributionsByWebACLIdResult

The response to a request to list the distributions that are associated with a specified AWS WAF web ACL.

ListDistributionsRequest

The request to list your distributions.

ListDistributionsResult

The returned result of the corresponding request.

ListFieldLevelEncryptionConfigsRequest

ListFieldLevelEncryptionConfigsResult

ListFieldLevelEncryptionProfilesRequest

ListFieldLevelEncryptionProfilesResult

ListFunctionsRequest

ListFunctionsResult

ListInvalidationsRequest

The request to list invalidations.

ListInvalidationsResult

The returned result of the corresponding request.

ListKeyGroupsRequest

ListKeyGroupsResult

ListOriginRequestPoliciesRequest

ListOriginRequestPoliciesResult

ListPublicKeysRequest

ListPublicKeysResult

ListRealtimeLogConfigsRequest

ListRealtimeLogConfigsResult

ListStreamingDistributionsRequest

The request to list your streaming distributions.

ListStreamingDistributionsResult

The returned result of the corresponding request.

ListTagsForResourceRequest

The request to list tags for a CloudFront resource.

ListTagsForResourceResult

The returned result of the corresponding request.

LocationListSerializer

LoggingConfig

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

LoggingConfigSerializer

LongSerializer

MethodSerializer

MethodsListSerializer

MinimumProtocolVersionSerializer

MonitoringSubscription

A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.

MonitoringSubscriptionSerializer

Origin

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).

OriginCustomHeader

A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution.

OriginCustomHeaderSerializer

OriginCustomHeadersListSerializer

OriginGroup

An origin group includes two origins (a primary origin and a second origin to failover to) and a failover criteria that you specify. You create an origin group to support origin failover in CloudFront. When you create or update a distribution, you can specifiy the origin group instead of a single origin, and CloudFront will failover from the primary origin to the second origin under the failover conditions that you've chosen.

OriginGroupFailoverCriteria

A complex data type that includes information about the failover criteria for an origin group, including the status codes for which CloudFront will failover from the primary origin to the second origin.

OriginGroupFailoverCriteriaSerializer

OriginGroupListSerializer

OriginGroupMember

An origin in an origin group.

OriginGroupMemberListSerializer

OriginGroupMemberSerializer

OriginGroupMembers

A complex data type for the origins included in an origin group.

OriginGroupMembersSerializer

OriginGroupSerializer

OriginGroups

A complex data type for the origin groups specified for a distribution.

OriginGroupsSerializer

OriginListSerializer

OriginProtocolPolicySerializer

OriginRequestPolicy

An origin request policy.

When it’s attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:

• The request body and the URL path (without the domain name) from the viewer request.

• The headers that CloudFront automatically includes in every origin request, including Host, User-Agent, and X-Amz-Cf-Id.

• All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.

CloudFront sends a request when it can’t find an object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use CachePolicy.

OriginRequestPolicyConfig

An origin request policy configuration.

This configuration determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:

• The request body and the URL path (without the domain name) from the viewer request.

• The headers that CloudFront automatically includes in every origin request, including Host, User-Agent, and X-Amz-Cf-Id.

• All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.

CloudFront sends a request when it can’t find an object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use CachePolicy.

OriginRequestPolicyConfigSerializer

OriginRequestPolicyCookieBehaviorSerializer

OriginRequestPolicyCookiesConfig

An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in requests that CloudFront sends to the origin.

OriginRequestPolicyCookiesConfigSerializer

OriginRequestPolicyHeaderBehaviorSerializer

OriginRequestPolicyHeadersConfig

An object that determines whether any HTTP headers (and if so, which headers) are included in requests that CloudFront sends to the origin.

OriginRequestPolicyHeadersConfigSerializer

OriginRequestPolicyList

A list of origin request policies.

OriginRequestPolicyQueryStringBehaviorSerializer

OriginRequestPolicyQueryStringsConfig

An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in requests that CloudFront sends to the origin.

OriginRequestPolicyQueryStringsConfigSerializer

OriginRequestPolicySummary

Contains an origin request policy.

OriginRequestPolicyTypeSerializer

OriginSerializer

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.

OriginShieldRegionSerializer

OriginShieldSerializer

OriginSslProtocols

A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin.

OriginSslProtocolsSerializer

Origins

Contains information about the origins for this distribution.

OriginsSerializer

ParametersInCacheKeyAndForwardedToOrigin

This object determines the values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.

The headers, cookies, and query strings that are included in the cache key are automatically included in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t find an object in its cache that matches the request’s cache key. If you want to send values to the origin but not include them in the cache key, use OriginRequestPolicy.

ParametersInCacheKeyAndForwardedToOriginSerializer

PathListSerializer

Paths

A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.

PathsSerializer

PriceClassSerializer

PublicKey

A public key that you can use with signed URLs and signed cookies, or with field-level encryption.

PublicKeyConfig

Configuration information about a public key that you can use with signed URLs and signed cookies, or with field-level encryption.

PublicKeyConfigSerializer

PublicKeyIdListSerializer

PublicKeyList

A list of public keys that you can use with signed URLs and signed cookies, or with field-level encryption.

PublicKeySummary

Contains information about a public key.

PublishFunctionRequest

PublishFunctionResult

QueryArgProfile

Query argument-profile mapping for field-level encryption.

QueryArgProfileConfig

Configuration for query argument-profile mapping for field-level encryption.

QueryArgProfileConfigSerializer

QueryArgProfileListSerializer

QueryArgProfileSerializer

QueryArgProfiles

Query argument-profile mapping for field-level encryption.

QueryArgProfilesSerializer

QueryStringCacheKeys

This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.

If you want to include query strings in the cache key, use QueryStringsConfig in a cache policy. See CachePolicy.

If you want to send query strings to the origin but not include them in the cache key, use QueryStringsConfig in an origin request policy. See OriginRequestPolicy.

A complex type that contains information about the query string parameters that you want CloudFront to use for caching for a cache behavior.

QueryStringNames

Contains a list of query string names.

QueryStringNamesListSerializer

QueryStringNamesSerializer

RealtimeLogConfig

A real-time log configuration.

RealtimeLogConfigs

A list of real-time log configurations.

RealtimeMetricsSubscriptionConfig

A subscription configuration for additional CloudWatch metrics.

RealtimeMetricsSubscriptionConfigSerializer

RealtimeMetricsSubscriptionStatusSerializer

ResourceARNSerializer

Restrictions

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

RestrictionsSerializer

S3Origin

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

S3OriginConfig

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.

S3OriginConfigSerializer

S3OriginSerializer

SSLSupportMethodSerializer

Signer

A list of AWS accounts and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.

SslProtocolSerializer

SslProtocolsListSerializer

StatusCodeListSerializer

StatusCodes

A complex data type for the status codes that you specify that, when returned by a primary origin, trigger CloudFront to failover to a second origin.

StatusCodesSerializer

StreamingDistribution

A streaming distribution tells CloudFront where you want RTMP content to be delivered from, and the details about how to track and manage content delivery.

StreamingDistributionConfig

The RTMP distribution's configuration information.

StreamingDistributionConfigSerializer

StreamingDistributionConfigWithTags

A streaming distribution Configuration and a list of tags to be associated with the streaming distribution.

StreamingDistributionConfigWithTagsSerializer

StreamingDistributionList

A streaming distribution list.

StreamingDistributionSummary

A summary of the information for a CloudFront streaming distribution.

StreamingLoggingConfig

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

StreamingLoggingConfigSerializer

StringSerializer

Tag

A complex type that contains Tag key and Tag value.

TagKeyListSerializer

TagKeySerializer

TagKeys

A complex type that contains zero or more Tag elements.

TagKeysSerializer

TagListSerializer

TagResourceRequest

The request to add tags to a CloudFront resource.

TagSerializer

TagValueSerializer

Tags

A complex type that contains zero or more Tag elements.

TagsSerializer

TestFunctionRequest

TestFunctionRequestSerializer

TestFunctionResult

TestResult

Contains the result of testing a CloudFront function with TestFunction.

TrustedKeyGroupIdListSerializer

TrustedKeyGroups

A list of key groups whose public keys CloudFront can use to verify the signatures of signed URLs and signed cookies.

TrustedKeyGroupsSerializer

TrustedSigners

A list of AWS accounts whose public keys CloudFront can use to verify the signatures of signed URLs and signed cookies.

TrustedSignersSerializer

UntagResourceRequest

The request to remove tags from a CloudFront resource.

UpdateCachePolicyRequest

UpdateCachePolicyResult

UpdateCloudFrontOriginAccessIdentityRequest

The request to update an origin access identity.

UpdateCloudFrontOriginAccessIdentityResult

The returned result of the corresponding request.

UpdateDistributionRequest

The request to update a distribution.

UpdateDistributionResult

The returned result of the corresponding request.

UpdateFieldLevelEncryptionConfigRequest

UpdateFieldLevelEncryptionConfigResult

UpdateFieldLevelEncryptionProfileRequest

UpdateFieldLevelEncryptionProfileResult

UpdateFunctionRequest

UpdateFunctionRequestSerializer

UpdateFunctionResult

UpdateKeyGroupRequest

UpdateKeyGroupResult

UpdateOriginRequestPolicyRequest

UpdateOriginRequestPolicyResult

UpdatePublicKeyRequest

UpdatePublicKeyResult

UpdateRealtimeLogConfigRequest

UpdateRealtimeLogConfigRequestSerializer

UpdateRealtimeLogConfigResult

UpdateStreamingDistributionRequest

The request to update a streaming distribution.

UpdateStreamingDistributionResult

The returned result of the corresponding request.

ViewerCertificate

A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.

If the distribution doesn’t use Aliases (also known as alternate domain names or CNAMEs)—that is, if the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net—set CloudFrontDefaultCertificate to true and leave all other fields empty.

If the distribution uses Aliases (alternate domain names or CNAMEs), use the fields in this type to specify the following settings:

• Which viewers the distribution accepts HTTPS connections from: only viewers that support server name indication (SNI) (recommended), or all viewers including those that don’t support SNI.

  • To accept HTTPS connections from only viewers that support SNI, set SSLSupportMethod to sni-only. This is recommended. Most browsers and clients support SNI.

  • To accept HTTPS connections from all viewers, including those that don’t support SNI, set SSLSupportMethod to vip. This is not recommended, and results in additional monthly charges from CloudFront.

• The minimum SSL/TLS protocol version that the distribution can use to communicate with viewers. To specify a minimum version, choose a value for MinimumProtocolVersion. For more information, see Security Policy in the Amazon CloudFront Developer Guide.

• The location of the SSL/TLS certificate, AWS Certificate Manager (ACM) (recommended) or AWS Identity and Access Management (AWS IAM). You specify the location by setting a value in one of the following fields (not both):

  • ACMCertificateArn

  • IAMCertificateId

All distributions support HTTPS connections from viewers. To require viewers to use HTTPS only, or to redirect them from HTTP to HTTPS, use ViewerProtocolPolicy in the CacheBehavior or DefaultCacheBehavior. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, use CustomOriginConfig.

For more information, see Using HTTPS with CloudFront and Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide.

ViewerCertificateSerializer

ViewerProtocolPolicySerializer

Enums

CreateCachePolicyError

Errors returned by CreateCachePolicy

CreateCloudFrontOriginAccessIdentityError

Errors returned by CreateCloudFrontOriginAccessIdentity

CreateDistributionError

Errors returned by CreateDistribution

CreateDistributionWithTagsError

Errors returned by CreateDistributionWithTags

CreateFieldLevelEncryptionConfigError

Errors returned by CreateFieldLevelEncryptionConfig

CreateFieldLevelEncryptionProfileError

Errors returned by CreateFieldLevelEncryptionProfile

CreateFunctionError

Errors returned by CreateFunction

CreateInvalidationError

Errors returned by CreateInvalidation

CreateKeyGroupError

Errors returned by CreateKeyGroup

CreateMonitoringSubscriptionError

Errors returned by CreateMonitoringSubscription

CreateOriginRequestPolicyError

Errors returned by CreateOriginRequestPolicy

CreatePublicKeyError

Errors returned by CreatePublicKey

CreateRealtimeLogConfigError

Errors returned by CreateRealtimeLogConfig

CreateStreamingDistributionError

Errors returned by CreateStreamingDistribution

CreateStreamingDistributionWithTagsError

Errors returned by CreateStreamingDistributionWithTags

DeleteCachePolicyError

Errors returned by DeleteCachePolicy

DeleteCloudFrontOriginAccessIdentityError

Errors returned by DeleteCloudFrontOriginAccessIdentity

DeleteDistributionError

Errors returned by DeleteDistribution

DeleteFieldLevelEncryptionConfigError

Errors returned by DeleteFieldLevelEncryptionConfig

DeleteFieldLevelEncryptionProfileError

Errors returned by DeleteFieldLevelEncryptionProfile

DeleteFunctionError

Errors returned by DeleteFunction

DeleteKeyGroupError

Errors returned by DeleteKeyGroup

DeleteMonitoringSubscriptionError

Errors returned by DeleteMonitoringSubscription

DeleteOriginRequestPolicyError

Errors returned by DeleteOriginRequestPolicy

DeletePublicKeyError

Errors returned by DeletePublicKey

DeleteRealtimeLogConfigError

Errors returned by DeleteRealtimeLogConfig

DeleteStreamingDistributionError

Errors returned by DeleteStreamingDistribution

DescribeFunctionError

Errors returned by DescribeFunction

GetCachePolicyConfigError

Errors returned by GetCachePolicyConfig

GetCachePolicyError

Errors returned by GetCachePolicy

GetCloudFrontOriginAccessIdentityConfigError

Errors returned by GetCloudFrontOriginAccessIdentityConfig

GetCloudFrontOriginAccessIdentityError

Errors returned by GetCloudFrontOriginAccessIdentity

GetDistributionConfigError

Errors returned by GetDistributionConfig

GetDistributionError

Errors returned by GetDistribution

GetFieldLevelEncryptionConfigError

Errors returned by GetFieldLevelEncryptionConfig

GetFieldLevelEncryptionError

Errors returned by GetFieldLevelEncryption

GetFieldLevelEncryptionProfileConfigError

Errors returned by GetFieldLevelEncryptionProfileConfig

GetFieldLevelEncryptionProfileError

Errors returned by GetFieldLevelEncryptionProfile

GetFunctionError

Errors returned by GetFunction

GetInvalidationError

Errors returned by GetInvalidation

GetKeyGroupConfigError

Errors returned by GetKeyGroupConfig

GetKeyGroupError

Errors returned by GetKeyGroup

GetMonitoringSubscriptionError

Errors returned by GetMonitoringSubscription

GetOriginRequestPolicyConfigError

Errors returned by GetOriginRequestPolicyConfig

GetOriginRequestPolicyError

Errors returned by GetOriginRequestPolicy

GetPublicKeyConfigError

Errors returned by GetPublicKeyConfig

GetPublicKeyError

Errors returned by GetPublicKey

GetRealtimeLogConfigError

Errors returned by GetRealtimeLogConfig

GetStreamingDistributionConfigError

Errors returned by GetStreamingDistributionConfig

GetStreamingDistributionError

Errors returned by GetStreamingDistribution

ListCachePoliciesError

Errors returned by ListCachePolicies

ListCloudFrontOriginAccessIdentitiesError

Errors returned by ListCloudFrontOriginAccessIdentities

ListDistributionsByCachePolicyIdError

Errors returned by ListDistributionsByCachePolicyId

ListDistributionsByKeyGroupError

Errors returned by ListDistributionsByKeyGroup

ListDistributionsByOriginRequestPolicyIdError

Errors returned by ListDistributionsByOriginRequestPolicyId

ListDistributionsByRealtimeLogConfigError

Errors returned by ListDistributionsByRealtimeLogConfig

ListDistributionsByWebACLIdError

Errors returned by ListDistributionsByWebACLId

ListDistributionsError

Errors returned by ListDistributions

ListFieldLevelEncryptionConfigsError

Errors returned by ListFieldLevelEncryptionConfigs

ListFieldLevelEncryptionProfilesError

Errors returned by ListFieldLevelEncryptionProfiles

ListFunctionsError

Errors returned by ListFunctions

ListInvalidationsError

Errors returned by ListInvalidations

ListKeyGroupsError

Errors returned by ListKeyGroups

ListOriginRequestPoliciesError

Errors returned by ListOriginRequestPolicies

ListPublicKeysError

Errors returned by ListPublicKeys

ListRealtimeLogConfigsError

Errors returned by ListRealtimeLogConfigs

ListStreamingDistributionsError

Errors returned by ListStreamingDistributions

ListTagsForResourceError

Errors returned by ListTagsForResource

PublishFunctionError

Errors returned by PublishFunction

TagResourceError

Errors returned by TagResource

TestFunctionError

Errors returned by TestFunction

UntagResourceError

Errors returned by UntagResource

UpdateCachePolicyError

Errors returned by UpdateCachePolicy

UpdateCloudFrontOriginAccessIdentityError

Errors returned by UpdateCloudFrontOriginAccessIdentity

UpdateDistributionError

Errors returned by UpdateDistribution

UpdateFieldLevelEncryptionConfigError

Errors returned by UpdateFieldLevelEncryptionConfig

UpdateFieldLevelEncryptionProfileError

Errors returned by UpdateFieldLevelEncryptionProfile

UpdateFunctionError

Errors returned by UpdateFunction

UpdateKeyGroupError

Errors returned by UpdateKeyGroup

UpdateOriginRequestPolicyError

Errors returned by UpdateOriginRequestPolicy

UpdatePublicKeyError

Errors returned by UpdatePublicKey

UpdateRealtimeLogConfigError

Errors returned by UpdateRealtimeLogConfig

UpdateStreamingDistributionError

Errors returned by UpdateStreamingDistribution

Traits

CloudFront

Trait representing the capabilities of the CloudFront API. CloudFront clients implement this trait.