Table of Contents
CloudFront.Client¶A low-level client representing 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 .
import boto3
client = boto3.client('cloudfront')
These are the available methods:
associate_alias()can_paginate()close()create_cache_policy()create_cloud_front_origin_access_identity()create_distribution()create_distribution_with_tags()create_field_level_encryption_config()create_field_level_encryption_profile()create_function()create_invalidation()create_key_group()create_monitoring_subscription()create_origin_access_control()create_origin_request_policy()create_public_key()create_realtime_log_config()create_response_headers_policy()create_streaming_distribution()create_streaming_distribution_with_tags()delete_cache_policy()delete_cloud_front_origin_access_identity()delete_distribution()delete_field_level_encryption_config()delete_field_level_encryption_profile()delete_function()delete_key_group()delete_monitoring_subscription()delete_origin_access_control()delete_origin_request_policy()delete_public_key()delete_realtime_log_config()delete_response_headers_policy()delete_streaming_distribution()describe_function()get_cache_policy()get_cache_policy_config()get_cloud_front_origin_access_identity()get_cloud_front_origin_access_identity_config()get_distribution()get_distribution_config()get_field_level_encryption()get_field_level_encryption_config()get_field_level_encryption_profile()get_field_level_encryption_profile_config()get_function()get_invalidation()get_key_group()get_key_group_config()get_monitoring_subscription()get_origin_access_control()get_origin_access_control_config()get_origin_request_policy()get_origin_request_policy_config()get_paginator()get_public_key()get_public_key_config()get_realtime_log_config()get_response_headers_policy()get_response_headers_policy_config()get_streaming_distribution()get_streaming_distribution_config()get_waiter()list_cache_policies()list_cloud_front_origin_access_identities()list_conflicting_aliases()list_distributions()list_distributions_by_cache_policy_id()list_distributions_by_key_group()list_distributions_by_origin_request_policy_id()list_distributions_by_realtime_log_config()list_distributions_by_response_headers_policy_id()list_distributions_by_web_acl_id()list_field_level_encryption_configs()list_field_level_encryption_profiles()list_functions()list_invalidations()list_key_groups()list_origin_access_controls()list_origin_request_policies()list_public_keys()list_realtime_log_configs()list_response_headers_policies()list_streaming_distributions()list_tags_for_resource()publish_function()tag_resource()test_function()untag_resource()update_cache_policy()update_cloud_front_origin_access_identity()update_distribution()update_field_level_encryption_config()update_field_level_encryption_profile()update_function()update_key_group()update_origin_access_control()update_origin_request_policy()update_public_key()update_realtime_log_config()update_response_headers_policy()update_streaming_distribution()associate_alias(**kwargs)¶Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution.
With this operation you can move an alias that’s already in use on a CloudFront distribution to a different distribution in one step. This prevents the downtime that could occur if you first remove the alias from one distribution and then separately add the alias to another distribution.
To use this operation to associate an alias with a distribution, you provide the alias and the ID of the target distribution for the alias. For more information, including how to set up the target distribution, prerequisites that you must complete, and other restrictions, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.associate_alias(
TargetDistributionId='string',
Alias='string'
)
[REQUIRED]
The ID of the distribution that you’re associating the alias with.
[REQUIRED]
The alias (also known as a CNAME) to add to the target distribution.
None
Exceptions
CloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.NoSuchDistributionCloudFront.Client.exceptions.TooManyDistributionCNAMEsCloudFront.Client.exceptions.IllegalUpdateCloudFront.Client.exceptions.AccessDeniedcan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_cache_policy(**kwargs)¶Creates a cache policy.
After you create a cache policy, you can attach it to one or more cache behaviors. When it’s attached to a cache behavior, the cache policy determines the following:
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 .
For more information about cache policies, see Controlling the cache key in the Amazon CloudFront Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_cache_policy(
CachePolicyConfig={
'Comment': 'string',
'Name': 'string',
'DefaultTTL': 123,
'MaxTTL': 123,
'MinTTL': 123,
'ParametersInCacheKeyAndForwardedToOrigin': {
'EnableAcceptEncodingGzip': True|False,
'EnableAcceptEncodingBrotli': True|False,
'HeadersConfig': {
'HeaderBehavior': 'none'|'whitelist',
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'CookiesConfig': {
'CookieBehavior': 'none'|'whitelist'|'allExcept'|'all',
'Cookies': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'QueryStringsConfig': {
'QueryStringBehavior': 'none'|'whitelist'|'allExcept'|'all',
'QueryStrings': {
'Quantity': 123,
'Items': [
'string',
]
}
}
}
}
)
[REQUIRED]
A cache policy configuration.
A comment to describe the cache policy. The comment cannot be longer than 128 characters.
A unique name to identify the cache policy.
The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value as the object’s time to live (TTL) only when the origin does not send Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
The default value for this field is 86400 seconds (one day). If the value of MinTTL is more than 86400 seconds, then the default value for this field is the same as the value of MinTTL .
The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value only when the origin sends Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
The default value for this field is 31536000 seconds (one year). If the value of MinTTL or DefaultTTL is more than 31536000 seconds, then the default value for this field is the same as the value of DefaultTTL .
The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are automatically included in requests that CloudFront sends to the origin.
A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
This field is related to the EnableAcceptEncodingBrotli field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
Accept-Encoding headerFor more information, see Compression support in the Amazon CloudFront Developer Guide .
If you set this value to true , and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true , so including this header in an origin request policy has no effect.
If both of these fields are false , then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.
A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
This field is related to the EnableAcceptEncodingGzip field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
Accept-Encoding headerFor more information, see Compression support in the Amazon CloudFront Developer Guide .
If you set this value to true , and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true , so including this header in an origin request policy has no effect.
If both of these fields are false , then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.
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.
Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
none – HTTP headers are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any headers that are listed in an OriginRequestPolicy are included in origin requests.whitelist – The HTTP headers that are listed in the Headers type are included in the cache key and are automatically included in requests that CloudFront sends to the origin.Contains a list of HTTP header names.
The number of header names in the Items list.
A list of HTTP header names.
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.
Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
none – Cookies in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any cookies that are listed in an OriginRequestPolicy are included in origin requests.whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.allExcept – All cookies in viewer requests that are * not * listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.all – All cookies in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.Contains a list of cookie names.
The number of cookie names in the Items list.
A list of cookie names.
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.
Determines whether any URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
none – Query strings in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any query strings that are listed in an OriginRequestPolicy are included in origin requests.whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.allExcept – All query strings in viewer requests that are * not * listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.all – All query strings in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.Contains the specific query strings in viewer requests that either * are * or * are not * included in the cache key and automatically included in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the CachePolicyQueryStringsConfig type is set to whitelist (the listed query strings * are * included) or allExcept (the listed query strings * are not * included, but all other query strings are).
The number of query string names in the Items list.
A list of query string names.
{
'CachePolicy': {
'Id': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'CachePolicyConfig': {
'Comment': 'string',
'Name': 'string',
'DefaultTTL': 123,
'MaxTTL': 123,
'MinTTL': 123,
'ParametersInCacheKeyAndForwardedToOrigin': {
'EnableAcceptEncodingGzip': True|False,
'EnableAcceptEncodingBrotli': True|False,
'HeadersConfig': {
'HeaderBehavior': 'none'|'whitelist',
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'CookiesConfig': {
'CookieBehavior': 'none'|'whitelist'|'allExcept'|'all',
'Cookies': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'QueryStringsConfig': {
'QueryStringBehavior': 'none'|'whitelist'|'allExcept'|'all',
'QueryStrings': {
'Quantity': 123,
'Items': [
'string',
]
}
}
}
}
},
'Location': 'string',
'ETag': 'string'
}
Response Structure
A cache policy.
The unique identifier for the cache policy.
The date and time when the cache policy was last modified.
The cache policy configuration.
A comment to describe the cache policy. The comment cannot be longer than 128 characters.
A unique name to identify the cache policy.
The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value as the object’s time to live (TTL) only when the origin does not send Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
The default value for this field is 86400 seconds (one day). If the value of MinTTL is more than 86400 seconds, then the default value for this field is the same as the value of MinTTL .
The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value only when the origin sends Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
The default value for this field is 31536000 seconds (one year). If the value of MinTTL or DefaultTTL is more than 31536000 seconds, then the default value for this field is the same as the value of DefaultTTL .
The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are automatically included in requests that CloudFront sends to the origin.
A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
This field is related to the EnableAcceptEncodingBrotli field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
Accept-Encoding headerFor more information, see Compression support in the Amazon CloudFront Developer Guide .
If you set this value to true , and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true , so including this header in an origin request policy has no effect.
If both of these fields are false , then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.
A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
This field is related to the EnableAcceptEncodingGzip field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
Accept-Encoding headerFor more information, see Compression support in the Amazon CloudFront Developer Guide .
If you set this value to true , and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true , so including this header in an origin request policy has no effect.
If both of these fields are false , then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.
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.
Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
none – HTTP headers are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any headers that are listed in an OriginRequestPolicy are included in origin requests.whitelist – The HTTP headers that are listed in the Headers type are included in the cache key and are automatically included in requests that CloudFront sends to the origin.Contains a list of HTTP header names.
The number of header names in the Items list.
A list of HTTP header names.
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.
Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
none – Cookies in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any cookies that are listed in an OriginRequestPolicy are included in origin requests.whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.allExcept – All cookies in viewer requests that are * not * listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.all – All cookies in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.Contains a list of cookie names.
The number of cookie names in the Items list.
A list of cookie names.
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.
Determines whether any URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
none – Query strings in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any query strings that are listed in an OriginRequestPolicy are included in origin requests.whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.allExcept – All query strings in viewer requests that are * not * listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.all – All query strings in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.Contains the specific query strings in viewer requests that either * are * or * are not * included in the cache key and automatically included in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the CachePolicyQueryStringsConfig type is set to whitelist (the listed query strings * are * included) or allExcept (the listed query strings * are not * included, but all other query strings are).
The number of query string names in the Items list.
A list of query string names.
The fully qualified URI of the cache policy just created.
The current version of the cache policy.
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.InconsistentQuantitiesCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.CachePolicyAlreadyExistsCloudFront.Client.exceptions.TooManyCachePoliciesCloudFront.Client.exceptions.TooManyHeadersInCachePolicyCloudFront.Client.exceptions.TooManyCookiesInCachePolicyCloudFront.Client.exceptions.TooManyQueryStringsInCachePolicycreate_cloud_front_origin_access_identity(**kwargs)¶Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_cloud_front_origin_access_identity(
CloudFrontOriginAccessIdentityConfig={
'CallerReference': 'string',
'Comment': 'string'
}
)
[REQUIRED]
The current configuration information for the identity.
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of CallerReference is new (regardless of the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created.
If the CallerReference is a value already sent in a previous identity request, 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.
A comment to describe the origin access identity. The comment cannot be longer than 128 characters.
{
'CloudFrontOriginAccessIdentity': {
'Id': 'string',
'S3CanonicalUserId': 'string',
'CloudFrontOriginAccessIdentityConfig': {
'CallerReference': 'string',
'Comment': 'string'
}
},
'Location': 'string',
'ETag': 'string'
}
Response Structure
The returned result of the corresponding request.
The origin access identity's information.
The ID for the origin access identity, for example, E74FTE3AJFJ256A .
The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3.
The current configuration information for the identity.
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of CallerReference is new (regardless of the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created.
If the CallerReference is a value already sent in a previous identity request, 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.
A comment to describe the origin access identity. The comment cannot be longer than 128 characters.
The fully qualified URI of the new origin access identity just created.
The current version of the origin access identity created.
Exceptions
CloudFront.Client.exceptions.CloudFrontOriginAccessIdentityAlreadyExistsCloudFront.Client.exceptions.MissingBodyCloudFront.Client.exceptions.TooManyCloudFrontOriginAccessIdentitiesCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.InconsistentQuantitiescreate_distribution(**kwargs)¶Creates a new web distribution. You create a CloudFront distribution to tell CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery. Send a POST request to the /*CloudFront API version* /distribution /distribution ID resource.
Warning
When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using UpdateDistribution , follow the steps included in the documentation to get the current configuration and then make your updates. This helps to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_distribution(
DistributionConfig={
'CallerReference': 'string',
'Aliases': {
'Quantity': 123,
'Items': [
'string',
]
},
'DefaultRootObject': 'string',
'Origins': {
'Quantity': 123,
'Items': [
{
'Id': 'string',
'DomainName': 'string',
'OriginPath': 'string',
'CustomHeaders': {
'Quantity': 123,
'Items': [
{
'HeaderName': 'string',
'HeaderValue': 'string'
},
]
},
'S3OriginConfig': {
'OriginAccessIdentity': 'string'
},
'CustomOriginConfig': {
'HTTPPort': 123,
'HTTPSPort': 123,
'OriginProtocolPolicy': 'http-only'|'match-viewer'|'https-only',
'OriginSslProtocols': {
'Quantity': 123,
'Items': [
'SSLv3'|'TLSv1'|'TLSv1.1'|'TLSv1.2',
]
},
'OriginReadTimeout': 123,
'OriginKeepaliveTimeout': 123
},
'ConnectionAttempts': 123,
'ConnectionTimeout': 123,
'OriginShield': {
'Enabled': True|False,
'OriginShieldRegion': 'string'
},
'OriginAccessControlId': 'string'
},
]
},
'OriginGroups': {
'Quantity': 123,
'Items': [
{
'Id': 'string',
'FailoverCriteria': {
'StatusCodes': {
'Quantity': 123,
'Items': [
123,
]
}
},
'Members': {
'Quantity': 123,
'Items': [
{
'OriginId': 'string'
},
]
}
},
]
},
'DefaultCacheBehavior': {
'TargetOriginId': 'string',
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'TrustedKeyGroups': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'ViewerProtocolPolicy': 'allow-all'|'https-only'|'redirect-to-https',
'AllowedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
],
'CachedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
]
}
},
'SmoothStreaming': True|False,
'Compress': True|False,
'LambdaFunctionAssociations': {
'Quantity': 123,
'Items': [
{
'LambdaFunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response',
'IncludeBody': True|False
},
]
},
'FunctionAssociations': {
'Quantity': 123,
'Items': [
{
'FunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response'
},
]
},
'FieldLevelEncryptionId': 'string',
'RealtimeLogConfigArn': 'string',
'CachePolicyId': 'string',
'OriginRequestPolicyId': 'string',
'ResponseHeadersPolicyId': 'string',
'ForwardedValues': {
'QueryString': True|False,
'Cookies': {
'Forward': 'none'|'whitelist'|'all',
'WhitelistedNames': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
},
'QueryStringCacheKeys': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'MinTTL': 123,
'DefaultTTL': 123,
'MaxTTL': 123
},
'CacheBehaviors': {
'Quantity': 123,
'Items': [
{
'PathPattern': 'string',
'TargetOriginId': 'string',
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'TrustedKeyGroups': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'ViewerProtocolPolicy': 'allow-all'|'https-only'|'redirect-to-https',
'AllowedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
],
'CachedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
]
}
},
'SmoothStreaming': True|False,
'Compress': True|False,
'LambdaFunctionAssociations': {
'Quantity': 123,
'Items': [
{
'LambdaFunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response',
'IncludeBody': True|False
},
]
},
'FunctionAssociations': {
'Quantity': 123,
'Items': [
{
'FunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response'
},
]
},
'FieldLevelEncryptionId': 'string',
'RealtimeLogConfigArn': 'string',
'CachePolicyId': 'string',
'OriginRequestPolicyId': 'string',
'ResponseHeadersPolicyId': 'string',
'ForwardedValues': {
'QueryString': True|False,
'Cookies': {
'Forward': 'none'|'whitelist'|'all',
'WhitelistedNames': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
},
'QueryStringCacheKeys': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'MinTTL': 123,
'DefaultTTL': 123,
'MaxTTL': 123
},
]
},
'CustomErrorResponses': {
'Quantity': 123,
'Items': [
{
'ErrorCode': 123,
'ResponsePagePath': 'string',
'ResponseCode': 'string',
'ErrorCachingMinTTL': 123
},
]
},
'Comment': 'string',
'Logging': {
'Enabled': True|False,
'IncludeCookies': True|False,
'Bucket': 'string',
'Prefix': 'string'
},
'PriceClass': 'PriceClass_100'|'PriceClass_200'|'PriceClass_All',
'Enabled': True|False,
'ViewerCertificate': {
'CloudFrontDefaultCertificate': True|False,
'IAMCertificateId': 'string',
'ACMCertificateArn': 'string',
'SSLSupportMethod': 'sni-only'|'vip'|'static-ip',
'MinimumProtocolVersion': 'SSLv3'|'TLSv1'|'TLSv1_2016'|'TLSv1.1_2016'|'TLSv1.2_2018'|'TLSv1.2_2019'|'TLSv1.2_2021',
'Certificate': 'string',
'CertificateSource': 'cloudfront'|'iam'|'acm'
},
'Restrictions': {
'GeoRestriction': {
'RestrictionType': 'blacklist'|'whitelist'|'none',
'Quantity': 123,
'Items': [
'string',
]
}
},
'WebACLId': 'string',
'HttpVersion': 'http1.1'|'http2'|'http3'|'http2and3',
'IsIPV6Enabled': True|False
}
)
[REQUIRED]
The distribution's configuration information.
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of CallerReference is new (regardless of the content of the DistributionConfig object), CloudFront creates a new distribution.
If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
The number of CNAME aliases, if any, that you want to associate with this distribution.
A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
The object that you want CloudFront to request from your origin (for example, index.html ) when a viewer requests the root URL for your distribution (http://www.example.com ) instead of an object in your distribution (http://www.example.com/product-description.html ). Specifying a default root object avoids exposing the contents of your distribution.
Specify only the object name, for example, index.html . Don't add a / before the object name.
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.
For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide .
A complex type that contains information about origins for this distribution.
The number of origins for this distribution.
A list of origins.
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:
S3OriginConfig to specify an Amazon S3 bucket that is not configured with static website hosting.CustomOriginConfig to specify all other kinds of origins, including: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).
A unique identifier for the origin. This value must be unique within the distribution.
Use this value to specify the TargetOriginId in a CacheBehavior or DefaultCacheBehavior .
The domain name for the origin.
For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide .
An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
For more information, see Origin Path in the Amazon CloudFront Developer Guide .
A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.
For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .
The number of custom headers, if any, for this distribution.
Optional : A list that contains oneOriginCustomHeaderelement for each custom header that you want CloudFront to forward to the origin. If Quantity is0, omitItems.
A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution.
The name of a header that you want CloudFront to send to your origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .
The value for the header that you specified in the HeaderName field.
Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the CustomOriginConfig type instead.
The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
origin-access-identity/cloudfront/ID-of-origin-access-identity
where `` ID-of-origin-access-identity `` is the value that CloudFront returned in the ID element when you created the origin access identity.
If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.
To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.
To replace the origin access identity, update the distribution configuration and specify the new origin access identity.
For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.
The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:
http-only – CloudFront always uses HTTP to connect to the origin.match-viewer – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.https-only – CloudFront always uses HTTPS to connect to the origin.Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include SSLv3 , TLSv1 , TLSv1.1 , and TLSv1.2 .
For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide .
The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.
A list that contains allowed SSL/TLS protocols for this distribution.
Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout . The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 30 seconds.
For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide .
Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 5 seconds.
For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide .
The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don’t specify otherwise) is 3.
For a custom origin (including an Amazon S3 bucket that’s configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout .
For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide .
The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don’t specify otherwise) is 10 seconds.
For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide .
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 .
A flag that specifies whether Origin Shield is enabled.
When it’s enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it’s disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.
The Amazon Web Services Region for Origin Shield.
Specify the Amazon Web Services Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as us-east-2 .
When you enable CloudFront Origin Shield, you must specify the Amazon Web Services Region for Origin Shield. For the list of Amazon Web Services Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the Amazon Web Services Region for Origin Shield in the Amazon CloudFront Developer Guide .
The unique identifier of an origin access control for this origin.
For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide .
A complex type that contains information about origin groups for this distribution.
The number of origin groups.
The items (origin groups) in a distribution.
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.
The origin group's ID.
A complex type that contains information about the failover criteria for an origin group.
The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.
The number of status codes.
The items (status codes) for an origin group.
A complex type that contains information about the origins in an origin group.
The number of origins in an origin group.
Items (origins) in an origin group.
An origin in an origin group.
The ID for an origin in an origin group.
A complex type that describes the default cache behavior if you don't 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.
The value of ID for the origin that you want CloudFront to route requests to when they use the default cache behavior.
Warning
We recommend using TrustedKeyGroups instead of TrustedSigners .
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer’s Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services account identifiers.
A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of key groups in the list.
A list of key groups identifiers.
The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern . You can specify the following options:
allow-all : Viewers can use HTTP or HTTPS.redirect-to-https : If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only : If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide .
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:
GET and HEAD requests.GET , HEAD , and OPTIONS requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
GET and HEAD requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true ; if not, specify false . If you specify true for SmoothStreaming , you can still distribute other content using this cache behavior if the content matches the value of PathPattern .
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true ; if not, specify false . For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
The number of Lambda@Edge function associations for this cache behavior.
Optional : A complex type that containsLambdaFunctionAssociationitems for this cache behavior. IfQuantityis0, you can omitItems.
A complex type that contains a Lambda@Edge function association.
The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request : The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request : The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response : The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response : The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.
The number of CloudFront functions in the list.
The 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.
A CloudFront function that is associated with a cache behavior in a CloudFront distribution.
The Amazon Resource Name (ARN) of the function.
The event type of the function, either viewer-request or viewer-response . You cannot use origin-facing event types (origin-request and origin-response ) with a CloudFront function.
The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior.
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide .
The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
The identifier for a response headers policy.
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide .
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed 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 or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 .
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys , if any:
If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
If you specify false for QueryString , CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 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 How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide .
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.
Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 .
Required if you specify whitelist for the value of Forward . A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.
If you specify all or none for the value of Forward , omit WhitelistedNames . If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.
For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference .
The number of cookie names in the Items list.
A list of cookie names.
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 headers 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 headers 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 the Headers , if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.
For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide .
The number of header names in the Items list.
A list of HTTP header names.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
The number of whitelisted query string parameters for a cache behavior.
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items .
This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers , if you specify 1 for Quantity and * for Name ).
This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The default amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The maximum amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
A complex type that contains zero or more CacheBehavior elements.
The number of cache behaviors for this distribution.
Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0 , you can omit Items .
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 .
The pattern (for example, images/*.jpg ) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.
Note
You can optionally include a slash (/ ) at the beginning of the path pattern. For example, /images/*.jpg . CloudFront behavior is the same with or without the leading / .
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.
For more information, see Path Pattern in the Amazon CloudFront Developer Guide .
The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.
Warning
We recommend using TrustedKeyGroups instead of TrustedSigners .
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer’s Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services account identifiers.
A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of key groups in the list.
A list of key groups identifiers.
The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern . You can specify the following options:
allow-all : Viewers can use HTTP or HTTPS.redirect-to-https : If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only : If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide .
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:
GET and HEAD requests.GET , HEAD , and OPTIONS requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
GET and HEAD requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true ; if not, specify false . If you specify true for SmoothStreaming , you can still distribute other content using this cache behavior if the content matches the value of PathPattern .
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
The number of Lambda@Edge function associations for this cache behavior.
Optional : A complex type that containsLambdaFunctionAssociationitems for this cache behavior. IfQuantityis0, you can omitItems.
A complex type that contains a Lambda@Edge function association.
The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request : The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request : The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response : The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response : The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.
The number of CloudFront functions in the list.
The 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.
A CloudFront function that is associated with a cache behavior in a CloudFront distribution.
The Amazon Resource Name (ARN) of the function.
The event type of the function, either viewer-request or viewer-response . You cannot use origin-facing event types (origin-request and origin-response ) with a CloudFront function.
The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide .
The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
A CacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
The identifier for a response headers policy.
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide .
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed 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 or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
A CacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 .
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys , if any:
If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
If you specify false for QueryString , CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 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 How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide .
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.
Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 .
Required if you specify whitelist for the value of Forward . A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.
If you specify all or none for the value of Forward , omit WhitelistedNames . If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.
For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference .
The number of cookie names in the Items list.
A list of cookie names.
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 headers 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 headers 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 the Headers , if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.
For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide .
The number of header names in the Items list.
A list of HTTP header names.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
The number of whitelisted query string parameters for a cache behavior.
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items .
This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers , if you specify 1 for Quantity and * for Name ).
This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The default amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The maximum amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
A complex type that controls the following:
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0 , you can omit Items .
A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration.
A complex type that controls:
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
The HTTP status code for which you want to specify a custom error page and/or a caching duration.
The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode , for example, /4xx-errors/403-forbidden.html . If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:
PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors . Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, /4xx-errors/* .TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages.If you specify a value for ResponsePagePath , you must also specify a value for ResponseCode .
We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.
The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:
200 , the response typically won't be intercepted.400 or 500 as the ResponseCode for all 4xx or 5xx errors.200 status code (OK) and static website so your customers don't know that your website is down.If you specify a value for ResponseCode , you must also specify a value for ResponsePagePath .
The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode . When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.
For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
An optional comment to describe the distribution. The comment cannot be longer than 128 characters.
A complex type that controls whether access logs are written for the distribution.
For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide .
Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't 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.
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 don't 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 .
The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com .
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 don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.
The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All , CloudFront responds to requests for your objects from all CloudFront edge locations.
If you specify a price class other than PriceClass_All , CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.
For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide . For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing .
From this field, you can enable or disable the selected distribution.
A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net , set this field to true .
If the distribution uses Aliases (alternate domain names or CNAMEs), set this field to false and specify values for the following fields:
ACMCertificateArn or IAMCertificateId (specify a value for one, not both)MinimumProtocolVersionSSLSupportMethodIf the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Identity and Access Management (IAM) , provide the ID of the IAM certificate.
If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVersion and SSLSupportMethod .
If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Certificate Manager (ACM) , provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (us-east-1 ).
If you specify an ACM certificate ARN, you must also specify values for MinimumProtocolVersion and SSLSupportMethod .
If the distribution uses Aliases (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.
sni-only – The distribution accepts HTTPS connections from only viewers that support server name indication (SNI) . This is recommended. Most browsers and clients support SNI.vip – The distribution accepts HTTPS connections from all viewers including those that don’t support SNI. This is not recommended, and results in additional monthly charges from CloudFront.static-ip - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the Amazon Web Services Support Center .If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net , don’t set a value for this field.
If the distribution uses Aliases (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:
For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
On the CloudFront console, this setting is called Security Policy .
When you’re using SNI only (you set SSLSupportMethod to sni-only ), you must specify TLSv1 or higher.
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net (you set CloudFrontDefaultCertificate to true ), CloudFront automatically sets the security policy to TLSv1 regardless of the value that you set here.
This field is deprecated. Use one of the following fields instead:
ACMCertificateArnIAMCertificateIdCloudFrontDefaultCertificateThis field is deprecated. Use one of the following fields instead:
ACMCertificateArnIAMCertificateIdCloudFrontDefaultCertificateA complex type that identifies ways in which you want to restrict distribution of your content.
A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.
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 don't want CloudFront to distribute your content.whitelist : The Location elements specify the countries in which you want CloudFront to distribute your content.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 .
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 on the CloudFront console, which includes both country names and codes.
A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a . To specify a web ACL created using WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a .
WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the WAF Developer Guide .
(Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2 . Viewers that don't support HTTP/2 automatically use an earlier HTTP version.
For viewers and CloudFront to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI).
For viewers and CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CloudFront supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see Connection Migration at RFC 9000. For more information about supported TLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront .
If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true . If you specify false , CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.
In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide .
If you're using an Route 53 Amazon Web Services Integration alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:
For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Route 53 Amazon Web Services Integration Developer Guide .
If you created a CNAME resource record set, either with Route 53 Amazon Web Services Integration or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.
{
'Distribution': {
'Id': 'string',
'ARN': 'string',
'Status': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'InProgressInvalidationBatches': 123,
'DomainName': 'string',
'ActiveTrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
{
'AwsAccountNumber': 'string',
'KeyPairIds': {
'Quantity': 123,
'Items': [
'string',
]
}
},
]
},
'ActiveTrustedKeyGroups': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
{
'KeyGroupId': 'string',
'KeyPairIds': {
'Quantity': 123,
'Items': [
'string',
]
}
},
]
},
'DistributionConfig': {
'CallerReference': 'string',
'Aliases': {
'Quantity': 123,
'Items': [
'string',
]
},
'DefaultRootObject': 'string',
'Origins': {
'Quantity': 123,
'Items': [
{
'Id': 'string',
'DomainName': 'string',
'OriginPath': 'string',
'CustomHeaders': {
'Quantity': 123,
'Items': [
{
'HeaderName': 'string',
'HeaderValue': 'string'
},
]
},
'S3OriginConfig': {
'OriginAccessIdentity': 'string'
},
'CustomOriginConfig': {
'HTTPPort': 123,
'HTTPSPort': 123,
'OriginProtocolPolicy': 'http-only'|'match-viewer'|'https-only',
'OriginSslProtocols': {
'Quantity': 123,
'Items': [
'SSLv3'|'TLSv1'|'TLSv1.1'|'TLSv1.2',
]
},
'OriginReadTimeout': 123,
'OriginKeepaliveTimeout': 123
},
'ConnectionAttempts': 123,
'ConnectionTimeout': 123,
'OriginShield': {
'Enabled': True|False,
'OriginShieldRegion': 'string'
},
'OriginAccessControlId': 'string'
},
]
},
'OriginGroups': {
'Quantity': 123,
'Items': [
{
'Id': 'string',
'FailoverCriteria': {
'StatusCodes': {
'Quantity': 123,
'Items': [
123,
]
}
},
'Members': {
'Quantity': 123,
'Items': [
{
'OriginId': 'string'
},
]
}
},
]
},
'DefaultCacheBehavior': {
'TargetOriginId': 'string',
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'TrustedKeyGroups': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'ViewerProtocolPolicy': 'allow-all'|'https-only'|'redirect-to-https',
'AllowedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
],
'CachedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
]
}
},
'SmoothStreaming': True|False,
'Compress': True|False,
'LambdaFunctionAssociations': {
'Quantity': 123,
'Items': [
{
'LambdaFunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response',
'IncludeBody': True|False
},
]
},
'FunctionAssociations': {
'Quantity': 123,
'Items': [
{
'FunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response'
},
]
},
'FieldLevelEncryptionId': 'string',
'RealtimeLogConfigArn': 'string',
'CachePolicyId': 'string',
'OriginRequestPolicyId': 'string',
'ResponseHeadersPolicyId': 'string',
'ForwardedValues': {
'QueryString': True|False,
'Cookies': {
'Forward': 'none'|'whitelist'|'all',
'WhitelistedNames': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
},
'QueryStringCacheKeys': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'MinTTL': 123,
'DefaultTTL': 123,
'MaxTTL': 123
},
'CacheBehaviors': {
'Quantity': 123,
'Items': [
{
'PathPattern': 'string',
'TargetOriginId': 'string',
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'TrustedKeyGroups': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'ViewerProtocolPolicy': 'allow-all'|'https-only'|'redirect-to-https',
'AllowedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
],
'CachedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
]
}
},
'SmoothStreaming': True|False,
'Compress': True|False,
'LambdaFunctionAssociations': {
'Quantity': 123,
'Items': [
{
'LambdaFunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response',
'IncludeBody': True|False
},
]
},
'FunctionAssociations': {
'Quantity': 123,
'Items': [
{
'FunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response'
},
]
},
'FieldLevelEncryptionId': 'string',
'RealtimeLogConfigArn': 'string',
'CachePolicyId': 'string',
'OriginRequestPolicyId': 'string',
'ResponseHeadersPolicyId': 'string',
'ForwardedValues': {
'QueryString': True|False,
'Cookies': {
'Forward': 'none'|'whitelist'|'all',
'WhitelistedNames': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
},
'QueryStringCacheKeys': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'MinTTL': 123,
'DefaultTTL': 123,
'MaxTTL': 123
},
]
},
'CustomErrorResponses': {
'Quantity': 123,
'Items': [
{
'ErrorCode': 123,
'ResponsePagePath': 'string',
'ResponseCode': 'string',
'ErrorCachingMinTTL': 123
},
]
},
'Comment': 'string',
'Logging': {
'Enabled': True|False,
'IncludeCookies': True|False,
'Bucket': 'string',
'Prefix': 'string'
},
'PriceClass': 'PriceClass_100'|'PriceClass_200'|'PriceClass_All',
'Enabled': True|False,
'ViewerCertificate': {
'CloudFrontDefaultCertificate': True|False,
'IAMCertificateId': 'string',
'ACMCertificateArn': 'string',
'SSLSupportMethod': 'sni-only'|'vip'|'static-ip',
'MinimumProtocolVersion': 'SSLv3'|'TLSv1'|'TLSv1_2016'|'TLSv1.1_2016'|'TLSv1.2_2018'|'TLSv1.2_2019'|'TLSv1.2_2021',
'Certificate': 'string',
'CertificateSource': 'cloudfront'|'iam'|'acm'
},
'Restrictions': {
'GeoRestriction': {
'RestrictionType': 'blacklist'|'whitelist'|'none',
'Quantity': 123,
'Items': [
'string',
]
}
},
'WebACLId': 'string',
'HttpVersion': 'http1.1'|'http2'|'http3'|'http2and3',
'IsIPV6Enabled': True|False
},
'AliasICPRecordals': [
{
'CNAME': 'string',
'ICPRecordalStatus': 'APPROVED'|'SUSPENDED'|'PENDING'
},
]
},
'Location': 'string',
'ETag': 'string'
}
Response Structure
The returned result of the corresponding request.
The distribution's information.
The identifier for the distribution. For example: EDFDVBD632BHDS5 .
The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5 , where 123456789012 is your Amazon Web Services account ID.
This response element indicates the current status of the distribution. When the status is Deployed , the distribution's information is fully propagated to all CloudFront edge locations.
The date and time the distribution was last modified.
The number of invalidation batches currently in progress.
The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net .
Warning
We recommend using TrustedKeyGroups instead of TrustedSigners .
CloudFront automatically adds this field to the response if you’ve configured a cache behavior in this distribution to serve private content using trusted signers. This field contains a list of Amazon Web Services account IDs and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs or signed cookies.
This field is true if any of the Amazon Web Services accounts in the list have active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services accounts and the identifiers of active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.
A list of Amazon Web Services accounts and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.
An Amazon Web Services account number that contains active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If the Amazon Web Services account that owns the key pairs is the same account that owns the CloudFront distribution, the value of this field is self .
A list of CloudFront key pair identifiers.
The number of key pair identifiers in the list.
A list of CloudFront key pair identifiers.
CloudFront automatically adds this field to the response if you’ve configured a cache behavior in this distribution to serve private content using key groups. This field contains a list of key groups and the public keys in each key group that CloudFront can use to verify the signatures of signed URLs or signed cookies.
This field is true if any of the key groups have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of key groups in the list.
A list of key groups, including the identifiers of the public keys in each key group that CloudFront can use to verify the signatures of signed URLs and signed cookies.
A list of identifiers for the public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies.
The identifier of the key group that contains the public keys.
A list of CloudFront key pair identifiers.
The number of key pair identifiers in the list.
A list of CloudFront key pair identifiers.
The current configuration information for the distribution. Send a GET request to the /*CloudFront API version* /distribution ID/config resource.
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of CallerReference is new (regardless of the content of the DistributionConfig object), CloudFront creates a new distribution.
If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
The number of CNAME aliases, if any, that you want to associate with this distribution.
A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
The object that you want CloudFront to request from your origin (for example, index.html ) when a viewer requests the root URL for your distribution (http://www.example.com ) instead of an object in your distribution (http://www.example.com/product-description.html ). Specifying a default root object avoids exposing the contents of your distribution.
Specify only the object name, for example, index.html . Don't add a / before the object name.
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.
For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide .
A complex type that contains information about origins for this distribution.
The number of origins for this distribution.
A list of origins.
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:
S3OriginConfig to specify an Amazon S3 bucket that is not configured with static website hosting.CustomOriginConfig to specify all other kinds of origins, including: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).
A unique identifier for the origin. This value must be unique within the distribution.
Use this value to specify the TargetOriginId in a CacheBehavior or DefaultCacheBehavior .
The domain name for the origin.
For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide .
An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
For more information, see Origin Path in the Amazon CloudFront Developer Guide .
A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.
For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .
The number of custom headers, if any, for this distribution.
Optional : A list that contains oneOriginCustomHeaderelement for each custom header that you want CloudFront to forward to the origin. If Quantity is0, omitItems.
A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution.
The name of a header that you want CloudFront to send to your origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .
The value for the header that you specified in the HeaderName field.
Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the CustomOriginConfig type instead.
The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
origin-access-identity/cloudfront/ID-of-origin-access-identity
where `` ID-of-origin-access-identity `` is the value that CloudFront returned in the ID element when you created the origin access identity.
If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.
To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.
To replace the origin access identity, update the distribution configuration and specify the new origin access identity.
For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.
The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:
http-only – CloudFront always uses HTTP to connect to the origin.match-viewer – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.https-only – CloudFront always uses HTTPS to connect to the origin.Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include SSLv3 , TLSv1 , TLSv1.1 , and TLSv1.2 .
For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide .
The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.
A list that contains allowed SSL/TLS protocols for this distribution.
Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout . The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 30 seconds.
For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide .
Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 5 seconds.
For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide .
The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don’t specify otherwise) is 3.
For a custom origin (including an Amazon S3 bucket that’s configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout .
For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide .
The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don’t specify otherwise) is 10 seconds.
For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide .
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 .
A flag that specifies whether Origin Shield is enabled.
When it’s enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it’s disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.
The Amazon Web Services Region for Origin Shield.
Specify the Amazon Web Services Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as us-east-2 .
When you enable CloudFront Origin Shield, you must specify the Amazon Web Services Region for Origin Shield. For the list of Amazon Web Services Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the Amazon Web Services Region for Origin Shield in the Amazon CloudFront Developer Guide .
The unique identifier of an origin access control for this origin.
For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide .
A complex type that contains information about origin groups for this distribution.
The number of origin groups.
The items (origin groups) in a distribution.
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.
The origin group's ID.
A complex type that contains information about the failover criteria for an origin group.
The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.
The number of status codes.
The items (status codes) for an origin group.
A complex type that contains information about the origins in an origin group.
The number of origins in an origin group.
Items (origins) in an origin group.
An origin in an origin group.
The ID for an origin in an origin group.
A complex type that describes the default cache behavior if you don't 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.
The value of ID for the origin that you want CloudFront to route requests to when they use the default cache behavior.
Warning
We recommend using TrustedKeyGroups instead of TrustedSigners .
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer’s Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services account identifiers.
A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of key groups in the list.
A list of key groups identifiers.
The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern . You can specify the following options:
allow-all : Viewers can use HTTP or HTTPS.redirect-to-https : If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only : If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide .
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:
GET and HEAD requests.GET , HEAD , and OPTIONS requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
GET and HEAD requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true ; if not, specify false . If you specify true for SmoothStreaming , you can still distribute other content using this cache behavior if the content matches the value of PathPattern .
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true ; if not, specify false . For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
The number of Lambda@Edge function associations for this cache behavior.
Optional : A complex type that containsLambdaFunctionAssociationitems for this cache behavior. IfQuantityis0, you can omitItems.
A complex type that contains a Lambda@Edge function association.
The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request : The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request : The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response : The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response : The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.
The number of CloudFront functions in the list.
The 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.
A CloudFront function that is associated with a cache behavior in a CloudFront distribution.
The Amazon Resource Name (ARN) of the function.
The event type of the function, either viewer-request or viewer-response . You cannot use origin-facing event types (origin-request and origin-response ) with a CloudFront function.
The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior.
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide .
The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
The identifier for a response headers policy.
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide .
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed 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 or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 .
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys , if any:
If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
If you specify false for QueryString , CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 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 How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide .
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.
Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 .
Required if you specify whitelist for the value of Forward . A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.
If you specify all or none for the value of Forward , omit WhitelistedNames . If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.
For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference .
The number of cookie names in the Items list.
A list of cookie names.
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 headers 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 headers 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 the Headers , if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.
For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide .
The number of header names in the Items list.
A list of HTTP header names.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
The number of whitelisted query string parameters for a cache behavior.
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items .
This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers , if you specify 1 for Quantity and * for Name ).
This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The default amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The maximum amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
A complex type that contains zero or more CacheBehavior elements.
The number of cache behaviors for this distribution.
Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0 , you can omit Items .
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 .
The pattern (for example, images/*.jpg ) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.
Note
You can optionally include a slash (/ ) at the beginning of the path pattern. For example, /images/*.jpg . CloudFront behavior is the same with or without the leading / .
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.
For more information, see Path Pattern in the Amazon CloudFront Developer Guide .
The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.
Warning
We recommend using TrustedKeyGroups instead of TrustedSigners .
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer’s Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services account identifiers.
A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of key groups in the list.
A list of key groups identifiers.
The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern . You can specify the following options:
allow-all : Viewers can use HTTP or HTTPS.redirect-to-https : If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only : If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide .
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:
GET and HEAD requests.GET , HEAD , and OPTIONS requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
GET and HEAD requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true ; if not, specify false . If you specify true for SmoothStreaming , you can still distribute other content using this cache behavior if the content matches the value of PathPattern .
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
The number of Lambda@Edge function associations for this cache behavior.
Optional : A complex type that containsLambdaFunctionAssociationitems for this cache behavior. IfQuantityis0, you can omitItems.
A complex type that contains a Lambda@Edge function association.
The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request : The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request : The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response : The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response : The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.
The number of CloudFront functions in the list.
The 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.
A CloudFront function that is associated with a cache behavior in a CloudFront distribution.
The Amazon Resource Name (ARN) of the function.
The event type of the function, either viewer-request or viewer-response . You cannot use origin-facing event types (origin-request and origin-response ) with a CloudFront function.
The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide .
The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
A CacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
The identifier for a response headers policy.
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide .
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed 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 or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
A CacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 .
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys , if any:
If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
If you specify false for QueryString , CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 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 How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide .
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.
Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 .
Required if you specify whitelist for the value of Forward . A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.
If you specify all or none for the value of Forward , omit WhitelistedNames . If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.
For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference .
The number of cookie names in the Items list.
A list of cookie names.
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 headers 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 headers 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 the Headers , if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.
For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide .
The number of header names in the Items list.
A list of HTTP header names.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
The number of whitelisted query string parameters for a cache behavior.
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items .
This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers , if you specify 1 for Quantity and * for Name ).
This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The default amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The maximum amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
A complex type that controls the following:
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0 , you can omit Items .
A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration.
A complex type that controls:
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
The HTTP status code for which you want to specify a custom error page and/or a caching duration.
The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode , for example, /4xx-errors/403-forbidden.html . If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:
PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors . Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, /4xx-errors/* .TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages.If you specify a value for ResponsePagePath , you must also specify a value for ResponseCode .
We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.
The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:
200 , the response typically won't be intercepted.400 or 500 as the ResponseCode for all 4xx or 5xx errors.200 status code (OK) and static website so your customers don't know that your website is down.If you specify a value for ResponseCode , you must also specify a value for ResponsePagePath .
The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode . When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.
For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
An optional comment to describe the distribution. The comment cannot be longer than 128 characters.
A complex type that controls whether access logs are written for the distribution.
For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide .
Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't 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.
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 don't 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 .
The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com .
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 don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.
The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All , CloudFront responds to requests for your objects from all CloudFront edge locations.
If you specify a price class other than PriceClass_All , CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.
For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide . For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing .
From this field, you can enable or disable the selected distribution.
A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net , set this field to true .
If the distribution uses Aliases (alternate domain names or CNAMEs), set this field to false and specify values for the following fields:
ACMCertificateArn or IAMCertificateId (specify a value for one, not both)MinimumProtocolVersionSSLSupportMethodIf the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Identity and Access Management (IAM) , provide the ID of the IAM certificate.
If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVersion and SSLSupportMethod .
If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Certificate Manager (ACM) , provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (us-east-1 ).
If you specify an ACM certificate ARN, you must also specify values for MinimumProtocolVersion and SSLSupportMethod .
If the distribution uses Aliases (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.
sni-only – The distribution accepts HTTPS connections from only viewers that support server name indication (SNI) . This is recommended. Most browsers and clients support SNI.vip – The distribution accepts HTTPS connections from all viewers including those that don’t support SNI. This is not recommended, and results in additional monthly charges from CloudFront.static-ip - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the Amazon Web Services Support Center .If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net , don’t set a value for this field.
If the distribution uses Aliases (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:
For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
On the CloudFront console, this setting is called Security Policy .
When you’re using SNI only (you set SSLSupportMethod to sni-only ), you must specify TLSv1 or higher.
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net (you set CloudFrontDefaultCertificate to true ), CloudFront automatically sets the security policy to TLSv1 regardless of the value that you set here.
This field is deprecated. Use one of the following fields instead:
ACMCertificateArnIAMCertificateIdCloudFrontDefaultCertificateThis field is deprecated. Use one of the following fields instead:
ACMCertificateArnIAMCertificateIdCloudFrontDefaultCertificateA complex type that identifies ways in which you want to restrict distribution of your content.
A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.
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 don't want CloudFront to distribute your content.whitelist : The Location elements specify the countries in which you want CloudFront to distribute your content.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 .
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 on the CloudFront console, which includes both country names and codes.
A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a . To specify a web ACL created using WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a .
WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the WAF Developer Guide .
(Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2 . Viewers that don't support HTTP/2 automatically use an earlier HTTP version.
For viewers and CloudFront to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI).
For viewers and CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CloudFront supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see Connection Migration at RFC 9000. For more information about supported TLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront .
If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true . If you specify false , CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.
In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide .
If you're using an Route 53 Amazon Web Services Integration alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:
For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Route 53 Amazon Web Services Integration Developer Guide .
If you created a CNAME resource record set, either with Route 53 Amazon Web Services Integration or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.
Amazon Web Services 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.
For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China .
Amazon Web Services 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 Amazon Web Services services in China .
A domain name associated with a distribution.
The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in regions outside of China.
The status values returned are the following:
The fully qualified URI of the new distribution resource just created.
The current version of the distribution created.
Exceptions
CloudFront.Client.exceptions.CNAMEAlreadyExistsCloudFront.Client.exceptions.DistributionAlreadyExistsCloudFront.Client.exceptions.InvalidOriginCloudFront.Client.exceptions.InvalidOriginAccessIdentityCloudFront.Client.exceptions.InvalidOriginAccessControlCloudFront.Client.exceptions.IllegalOriginAccessConfigurationCloudFront.Client.exceptions.TooManyDistributionsAssociatedToOriginAccessControlCloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.TooManyTrustedSignersCloudFront.Client.exceptions.TrustedSignerDoesNotExistCloudFront.Client.exceptions.InvalidViewerCertificateCloudFront.Client.exceptions.InvalidMinimumProtocolVersionCloudFront.Client.exceptions.MissingBodyCloudFront.Client.exceptions.TooManyDistributionCNAMEsCloudFront.Client.exceptions.TooManyDistributionsCloudFront.Client.exceptions.InvalidDefaultRootObjectCloudFront.Client.exceptions.InvalidRelativePathCloudFront.Client.exceptions.InvalidErrorCodeCloudFront.Client.exceptions.InvalidResponseCodeCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.InvalidRequiredProtocolCloudFront.Client.exceptions.NoSuchOriginCloudFront.Client.exceptions.TooManyOriginsCloudFront.Client.exceptions.TooManyOriginGroupsPerDistributionCloudFront.Client.exceptions.TooManyCacheBehaviorsCloudFront.Client.exceptions.TooManyCookieNamesInWhiteListCloudFront.Client.exceptions.InvalidForwardCookiesCloudFront.Client.exceptions.TooManyHeadersInForwardedValuesCloudFront.Client.exceptions.InvalidHeadersForS3OriginCloudFront.Client.exceptions.InconsistentQuantitiesCloudFront.Client.exceptions.TooManyCertificatesCloudFront.Client.exceptions.InvalidLocationCodeCloudFront.Client.exceptions.InvalidGeoRestrictionParameterCloudFront.Client.exceptions.InvalidProtocolSettingsCloudFront.Client.exceptions.InvalidTTLOrderCloudFront.Client.exceptions.InvalidWebACLIdCloudFront.Client.exceptions.TooManyOriginCustomHeadersCloudFront.Client.exceptions.TooManyQueryStringParametersCloudFront.Client.exceptions.InvalidQueryStringParametersCloudFront.Client.exceptions.TooManyDistributionsWithLambdaAssociationsCloudFront.Client.exceptions.TooManyDistributionsWithSingleFunctionARNCloudFront.Client.exceptions.TooManyLambdaFunctionAssociationsCloudFront.Client.exceptions.InvalidLambdaFunctionAssociationCloudFront.Client.exceptions.TooManyDistributionsWithFunctionAssociationsCloudFront.Client.exceptions.TooManyFunctionAssociationsCloudFront.Client.exceptions.InvalidFunctionAssociationCloudFront.Client.exceptions.InvalidOriginReadTimeoutCloudFront.Client.exceptions.InvalidOriginKeepaliveTimeoutCloudFront.Client.exceptions.NoSuchFieldLevelEncryptionConfigCloudFront.Client.exceptions.IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorCloudFront.Client.exceptions.TooManyDistributionsAssociatedToFieldLevelEncryptionConfigCloudFront.Client.exceptions.NoSuchCachePolicyCloudFront.Client.exceptions.TooManyDistributionsAssociatedToCachePolicyCloudFront.Client.exceptions.NoSuchResponseHeadersPolicyCloudFront.Client.exceptions.TooManyDistributionsAssociatedToResponseHeadersPolicyCloudFront.Client.exceptions.NoSuchOriginRequestPolicyCloudFront.Client.exceptions.TooManyDistributionsAssociatedToOriginRequestPolicyCloudFront.Client.exceptions.TooManyDistributionsAssociatedToKeyGroupCloudFront.Client.exceptions.TooManyKeyGroupsAssociatedToDistributionCloudFront.Client.exceptions.TrustedKeyGroupDoesNotExistCloudFront.Client.exceptions.NoSuchRealtimeLogConfigCloudFront.Client.exceptions.RealtimeLogConfigOwnerMismatchCloudFront.Client.exceptions.InvalidDomainNameForOriginAccessControlCreate a new distribution with tags.
See also: AWS API Documentation
Request Syntax
response = client.create_distribution_with_tags(
DistributionConfigWithTags={
'DistributionConfig': {
'CallerReference': 'string',
'Aliases': {
'Quantity': 123,
'Items': [
'string',
]
},
'DefaultRootObject': 'string',
'Origins': {
'Quantity': 123,
'Items': [
{
'Id': 'string',
'DomainName': 'string',
'OriginPath': 'string',
'CustomHeaders': {
'Quantity': 123,
'Items': [
{
'HeaderName': 'string',
'HeaderValue': 'string'
},
]
},
'S3OriginConfig': {
'OriginAccessIdentity': 'string'
},
'CustomOriginConfig': {
'HTTPPort': 123,
'HTTPSPort': 123,
'OriginProtocolPolicy': 'http-only'|'match-viewer'|'https-only',
'OriginSslProtocols': {
'Quantity': 123,
'Items': [
'SSLv3'|'TLSv1'|'TLSv1.1'|'TLSv1.2',
]
},
'OriginReadTimeout': 123,
'OriginKeepaliveTimeout': 123
},
'ConnectionAttempts': 123,
'ConnectionTimeout': 123,
'OriginShield': {
'Enabled': True|False,
'OriginShieldRegion': 'string'
},
'OriginAccessControlId': 'string'
},
]
},
'OriginGroups': {
'Quantity': 123,
'Items': [
{
'Id': 'string',
'FailoverCriteria': {
'StatusCodes': {
'Quantity': 123,
'Items': [
123,
]
}
},
'Members': {
'Quantity': 123,
'Items': [
{
'OriginId': 'string'
},
]
}
},
]
},
'DefaultCacheBehavior': {
'TargetOriginId': 'string',
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'TrustedKeyGroups': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'ViewerProtocolPolicy': 'allow-all'|'https-only'|'redirect-to-https',
'AllowedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
],
'CachedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
]
}
},
'SmoothStreaming': True|False,
'Compress': True|False,
'LambdaFunctionAssociations': {
'Quantity': 123,
'Items': [
{
'LambdaFunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response',
'IncludeBody': True|False
},
]
},
'FunctionAssociations': {
'Quantity': 123,
'Items': [
{
'FunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response'
},
]
},
'FieldLevelEncryptionId': 'string',
'RealtimeLogConfigArn': 'string',
'CachePolicyId': 'string',
'OriginRequestPolicyId': 'string',
'ResponseHeadersPolicyId': 'string',
'ForwardedValues': {
'QueryString': True|False,
'Cookies': {
'Forward': 'none'|'whitelist'|'all',
'WhitelistedNames': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
},
'QueryStringCacheKeys': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'MinTTL': 123,
'DefaultTTL': 123,
'MaxTTL': 123
},
'CacheBehaviors': {
'Quantity': 123,
'Items': [
{
'PathPattern': 'string',
'TargetOriginId': 'string',
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'TrustedKeyGroups': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'ViewerProtocolPolicy': 'allow-all'|'https-only'|'redirect-to-https',
'AllowedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
],
'CachedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
]
}
},
'SmoothStreaming': True|False,
'Compress': True|False,
'LambdaFunctionAssociations': {
'Quantity': 123,
'Items': [
{
'LambdaFunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response',
'IncludeBody': True|False
},
]
},
'FunctionAssociations': {
'Quantity': 123,
'Items': [
{
'FunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response'
},
]
},
'FieldLevelEncryptionId': 'string',
'RealtimeLogConfigArn': 'string',
'CachePolicyId': 'string',
'OriginRequestPolicyId': 'string',
'ResponseHeadersPolicyId': 'string',
'ForwardedValues': {
'QueryString': True|False,
'Cookies': {
'Forward': 'none'|'whitelist'|'all',
'WhitelistedNames': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
},
'QueryStringCacheKeys': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'MinTTL': 123,
'DefaultTTL': 123,
'MaxTTL': 123
},
]
},
'CustomErrorResponses': {
'Quantity': 123,
'Items': [
{
'ErrorCode': 123,
'ResponsePagePath': 'string',
'ResponseCode': 'string',
'ErrorCachingMinTTL': 123
},
]
},
'Comment': 'string',
'Logging': {
'Enabled': True|False,
'IncludeCookies': True|False,
'Bucket': 'string',
'Prefix': 'string'
},
'PriceClass': 'PriceClass_100'|'PriceClass_200'|'PriceClass_All',
'Enabled': True|False,
'ViewerCertificate': {
'CloudFrontDefaultCertificate': True|False,
'IAMCertificateId': 'string',
'ACMCertificateArn': 'string',
'SSLSupportMethod': 'sni-only'|'vip'|'static-ip',
'MinimumProtocolVersion': 'SSLv3'|'TLSv1'|'TLSv1_2016'|'TLSv1.1_2016'|'TLSv1.2_2018'|'TLSv1.2_2019'|'TLSv1.2_2021',
'Certificate': 'string',
'CertificateSource': 'cloudfront'|'iam'|'acm'
},
'Restrictions': {
'GeoRestriction': {
'RestrictionType': 'blacklist'|'whitelist'|'none',
'Quantity': 123,
'Items': [
'string',
]
}
},
'WebACLId': 'string',
'HttpVersion': 'http1.1'|'http2'|'http3'|'http2and3',
'IsIPV6Enabled': True|False
},
'Tags': {
'Items': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
)
[REQUIRED]
The distribution's configuration information.
A distribution configuration.
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of CallerReference is new (regardless of the content of the DistributionConfig object), CloudFront creates a new distribution.
If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
The number of CNAME aliases, if any, that you want to associate with this distribution.
A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
The object that you want CloudFront to request from your origin (for example, index.html ) when a viewer requests the root URL for your distribution (http://www.example.com ) instead of an object in your distribution (http://www.example.com/product-description.html ). Specifying a default root object avoids exposing the contents of your distribution.
Specify only the object name, for example, index.html . Don't add a / before the object name.
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.
For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide .
A complex type that contains information about origins for this distribution.
The number of origins for this distribution.
A list of origins.
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:
S3OriginConfig to specify an Amazon S3 bucket that is not configured with static website hosting.CustomOriginConfig to specify all other kinds of origins, including: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).
A unique identifier for the origin. This value must be unique within the distribution.
Use this value to specify the TargetOriginId in a CacheBehavior or DefaultCacheBehavior .
The domain name for the origin.
For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide .
An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
For more information, see Origin Path in the Amazon CloudFront Developer Guide .
A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.
For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .
The number of custom headers, if any, for this distribution.
Optional : A list that contains oneOriginCustomHeaderelement for each custom header that you want CloudFront to forward to the origin. If Quantity is0, omitItems.
A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution.
The name of a header that you want CloudFront to send to your origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .
The value for the header that you specified in the HeaderName field.
Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the CustomOriginConfig type instead.
The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
origin-access-identity/cloudfront/ID-of-origin-access-identity
where `` ID-of-origin-access-identity `` is the value that CloudFront returned in the ID element when you created the origin access identity.
If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.
To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.
To replace the origin access identity, update the distribution configuration and specify the new origin access identity.
For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.
The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:
http-only – CloudFront always uses HTTP to connect to the origin.match-viewer – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.https-only – CloudFront always uses HTTPS to connect to the origin.Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include SSLv3 , TLSv1 , TLSv1.1 , and TLSv1.2 .
For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide .
The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.
A list that contains allowed SSL/TLS protocols for this distribution.
Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout . The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 30 seconds.
For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide .
Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 5 seconds.
For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide .
The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don’t specify otherwise) is 3.
For a custom origin (including an Amazon S3 bucket that’s configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout .
For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide .
The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don’t specify otherwise) is 10 seconds.
For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide .
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 .
A flag that specifies whether Origin Shield is enabled.
When it’s enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it’s disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.
The Amazon Web Services Region for Origin Shield.
Specify the Amazon Web Services Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as us-east-2 .
When you enable CloudFront Origin Shield, you must specify the Amazon Web Services Region for Origin Shield. For the list of Amazon Web Services Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the Amazon Web Services Region for Origin Shield in the Amazon CloudFront Developer Guide .
The unique identifier of an origin access control for this origin.
For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide .
A complex type that contains information about origin groups for this distribution.
The number of origin groups.
The items (origin groups) in a distribution.
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.
The origin group's ID.
A complex type that contains information about the failover criteria for an origin group.
The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.
The number of status codes.
The items (status codes) for an origin group.
A complex type that contains information about the origins in an origin group.
The number of origins in an origin group.
Items (origins) in an origin group.
An origin in an origin group.
The ID for an origin in an origin group.
A complex type that describes the default cache behavior if you don't 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.
The value of ID for the origin that you want CloudFront to route requests to when they use the default cache behavior.
Warning
We recommend using TrustedKeyGroups instead of TrustedSigners .
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer’s Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services account identifiers.
A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of key groups in the list.
A list of key groups identifiers.
The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern . You can specify the following options:
allow-all : Viewers can use HTTP or HTTPS.redirect-to-https : If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only : If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide .
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:
GET and HEAD requests.GET , HEAD , and OPTIONS requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
GET and HEAD requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true ; if not, specify false . If you specify true for SmoothStreaming , you can still distribute other content using this cache behavior if the content matches the value of PathPattern .
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true ; if not, specify false . For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
The number of Lambda@Edge function associations for this cache behavior.
Optional : A complex type that containsLambdaFunctionAssociationitems for this cache behavior. IfQuantityis0, you can omitItems.
A complex type that contains a Lambda@Edge function association.
The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request : The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request : The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response : The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response : The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.
The number of CloudFront functions in the list.
The 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.
A CloudFront function that is associated with a cache behavior in a CloudFront distribution.
The Amazon Resource Name (ARN) of the function.
The event type of the function, either viewer-request or viewer-response . You cannot use origin-facing event types (origin-request and origin-response ) with a CloudFront function.
The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior.
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide .
The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
The identifier for a response headers policy.
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide .
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed 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 or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 .
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys , if any:
If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
If you specify false for QueryString , CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 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 How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide .
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.
Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 .
Required if you specify whitelist for the value of Forward . A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.
If you specify all or none for the value of Forward , omit WhitelistedNames . If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.
For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference .
The number of cookie names in the Items list.
A list of cookie names.
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 headers 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 headers 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 the Headers , if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.
For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide .
The number of header names in the Items list.
A list of HTTP header names.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
The number of whitelisted query string parameters for a cache behavior.
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items .
This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers , if you specify 1 for Quantity and * for Name ).
This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The default amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The maximum amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
A complex type that contains zero or more CacheBehavior elements.
The number of cache behaviors for this distribution.
Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0 , you can omit Items .
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 .
The pattern (for example, images/*.jpg ) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.
Note
You can optionally include a slash (/ ) at the beginning of the path pattern. For example, /images/*.jpg . CloudFront behavior is the same with or without the leading / .
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.
For more information, see Path Pattern in the Amazon CloudFront Developer Guide .
The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.
Warning
We recommend using TrustedKeyGroups instead of TrustedSigners .
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer’s Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services account identifiers.
A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of key groups in the list.
A list of key groups identifiers.
The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern . You can specify the following options:
allow-all : Viewers can use HTTP or HTTPS.redirect-to-https : If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only : If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide .
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:
GET and HEAD requests.GET , HEAD , and OPTIONS requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
GET and HEAD requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true ; if not, specify false . If you specify true for SmoothStreaming , you can still distribute other content using this cache behavior if the content matches the value of PathPattern .
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
The number of Lambda@Edge function associations for this cache behavior.
Optional : A complex type that containsLambdaFunctionAssociationitems for this cache behavior. IfQuantityis0, you can omitItems.
A complex type that contains a Lambda@Edge function association.
The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request : The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request : The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response : The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response : The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.
The number of CloudFront functions in the list.
The 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.
A CloudFront function that is associated with a cache behavior in a CloudFront distribution.
The Amazon Resource Name (ARN) of the function.
The event type of the function, either viewer-request or viewer-response . You cannot use origin-facing event types (origin-request and origin-response ) with a CloudFront function.
The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide .
The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
A CacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
The identifier for a response headers policy.
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide .
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed 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 or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
A CacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 .
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys , if any:
If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
If you specify false for QueryString , CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 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 How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide .
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.
Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 .
Required if you specify whitelist for the value of Forward . A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.
If you specify all or none for the value of Forward , omit WhitelistedNames . If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.
For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference .
The number of cookie names in the Items list.
A list of cookie names.
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 headers 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 headers 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 the Headers , if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.
For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide .
The number of header names in the Items list.
A list of HTTP header names.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
The number of whitelisted query string parameters for a cache behavior.
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items .
This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers , if you specify 1 for Quantity and * for Name ).
This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The default amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The maximum amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
A complex type that controls the following:
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0 , you can omit Items .
A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration.
A complex type that controls:
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
The HTTP status code for which you want to specify a custom error page and/or a caching duration.
The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode , for example, /4xx-errors/403-forbidden.html . If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:
PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors . Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, /4xx-errors/* .TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages.If you specify a value for ResponsePagePath , you must also specify a value for ResponseCode .
We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.
The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:
200 , the response typically won't be intercepted.400 or 500 as the ResponseCode for all 4xx or 5xx errors.200 status code (OK) and static website so your customers don't know that your website is down.If you specify a value for ResponseCode , you must also specify a value for ResponsePagePath .
The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode . When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.
For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
An optional comment to describe the distribution. The comment cannot be longer than 128 characters.
A complex type that controls whether access logs are written for the distribution.
For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide .
Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't 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.
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 don't 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 .
The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com .
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 don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.
The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All , CloudFront responds to requests for your objects from all CloudFront edge locations.
If you specify a price class other than PriceClass_All , CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.
For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide . For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing .
From this field, you can enable or disable the selected distribution.
A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net , set this field to true .
If the distribution uses Aliases (alternate domain names or CNAMEs), set this field to false and specify values for the following fields:
ACMCertificateArn or IAMCertificateId (specify a value for one, not both)MinimumProtocolVersionSSLSupportMethodIf the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Identity and Access Management (IAM) , provide the ID of the IAM certificate.
If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVersion and SSLSupportMethod .
If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Certificate Manager (ACM) , provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (us-east-1 ).
If you specify an ACM certificate ARN, you must also specify values for MinimumProtocolVersion and SSLSupportMethod .
If the distribution uses Aliases (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.
sni-only – The distribution accepts HTTPS connections from only viewers that support server name indication (SNI) . This is recommended. Most browsers and clients support SNI.vip – The distribution accepts HTTPS connections from all viewers including those that don’t support SNI. This is not recommended, and results in additional monthly charges from CloudFront.static-ip - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the Amazon Web Services Support Center .If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net , don’t set a value for this field.
If the distribution uses Aliases (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:
For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
On the CloudFront console, this setting is called Security Policy .
When you’re using SNI only (you set SSLSupportMethod to sni-only ), you must specify TLSv1 or higher.
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net (you set CloudFrontDefaultCertificate to true ), CloudFront automatically sets the security policy to TLSv1 regardless of the value that you set here.
This field is deprecated. Use one of the following fields instead:
ACMCertificateArnIAMCertificateIdCloudFrontDefaultCertificateThis field is deprecated. Use one of the following fields instead:
ACMCertificateArnIAMCertificateIdCloudFrontDefaultCertificateA complex type that identifies ways in which you want to restrict distribution of your content.
A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.
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 don't want CloudFront to distribute your content.whitelist : The Location elements specify the countries in which you want CloudFront to distribute your content.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 .
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 on the CloudFront console, which includes both country names and codes.
A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a . To specify a web ACL created using WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a .
WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the WAF Developer Guide .
(Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2 . Viewers that don't support HTTP/2 automatically use an earlier HTTP version.
For viewers and CloudFront to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI).
For viewers and CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CloudFront supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see Connection Migration at RFC 9000. For more information about supported TLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront .
If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true . If you specify false , CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.
In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide .
If you're using an Route 53 Amazon Web Services Integration alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:
For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Route 53 Amazon Web Services Integration Developer Guide .
If you created a CNAME resource record set, either with Route 53 Amazon Web Services Integration or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.
A complex type that contains zero or more Tag elements.
A complex type that contains Tag elements.
A complex type that contains Tag key and Tag value.
A string that contains Tag key.
The string length should be between 1 and 128 characters. Valid characters include a-z , A-Z , 0-9 , space, and the special characters _ - . : / = + @ .
A string that contains an optional Tag value.
The string length should be between 0 and 256 characters. Valid characters include a-z , A-Z , 0-9 , space, and the special characters _ - . : / = + @ .
{
'Distribution': {
'Id': 'string',
'ARN': 'string',
'Status': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'InProgressInvalidationBatches': 123,
'DomainName': 'string',
'ActiveTrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
{
'AwsAccountNumber': 'string',
'KeyPairIds': {
'Quantity': 123,
'Items': [
'string',
]
}
},
]
},
'ActiveTrustedKeyGroups': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
{
'KeyGroupId': 'string',
'KeyPairIds': {
'Quantity': 123,
'Items': [
'string',
]
}
},
]
},
'DistributionConfig': {
'CallerReference': 'string',
'Aliases': {
'Quantity': 123,
'Items': [
'string',
]
},
'DefaultRootObject': 'string',
'Origins': {
'Quantity': 123,
'Items': [
{
'Id': 'string',
'DomainName': 'string',
'OriginPath': 'string',
'CustomHeaders': {
'Quantity': 123,
'Items': [
{
'HeaderName': 'string',
'HeaderValue': 'string'
},
]
},
'S3OriginConfig': {
'OriginAccessIdentity': 'string'
},
'CustomOriginConfig': {
'HTTPPort': 123,
'HTTPSPort': 123,
'OriginProtocolPolicy': 'http-only'|'match-viewer'|'https-only',
'OriginSslProtocols': {
'Quantity': 123,
'Items': [
'SSLv3'|'TLSv1'|'TLSv1.1'|'TLSv1.2',
]
},
'OriginReadTimeout': 123,
'OriginKeepaliveTimeout': 123
},
'ConnectionAttempts': 123,
'ConnectionTimeout': 123,
'OriginShield': {
'Enabled': True|False,
'OriginShieldRegion': 'string'
},
'OriginAccessControlId': 'string'
},
]
},
'OriginGroups': {
'Quantity': 123,
'Items': [
{
'Id': 'string',
'FailoverCriteria': {
'StatusCodes': {
'Quantity': 123,
'Items': [
123,
]
}
},
'Members': {
'Quantity': 123,
'Items': [
{
'OriginId': 'string'
},
]
}
},
]
},
'DefaultCacheBehavior': {
'TargetOriginId': 'string',
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'TrustedKeyGroups': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'ViewerProtocolPolicy': 'allow-all'|'https-only'|'redirect-to-https',
'AllowedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
],
'CachedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
]
}
},
'SmoothStreaming': True|False,
'Compress': True|False,
'LambdaFunctionAssociations': {
'Quantity': 123,
'Items': [
{
'LambdaFunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response',
'IncludeBody': True|False
},
]
},
'FunctionAssociations': {
'Quantity': 123,
'Items': [
{
'FunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response'
},
]
},
'FieldLevelEncryptionId': 'string',
'RealtimeLogConfigArn': 'string',
'CachePolicyId': 'string',
'OriginRequestPolicyId': 'string',
'ResponseHeadersPolicyId': 'string',
'ForwardedValues': {
'QueryString': True|False,
'Cookies': {
'Forward': 'none'|'whitelist'|'all',
'WhitelistedNames': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
},
'QueryStringCacheKeys': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'MinTTL': 123,
'DefaultTTL': 123,
'MaxTTL': 123
},
'CacheBehaviors': {
'Quantity': 123,
'Items': [
{
'PathPattern': 'string',
'TargetOriginId': 'string',
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'TrustedKeyGroups': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'ViewerProtocolPolicy': 'allow-all'|'https-only'|'redirect-to-https',
'AllowedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
],
'CachedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
]
}
},
'SmoothStreaming': True|False,
'Compress': True|False,
'LambdaFunctionAssociations': {
'Quantity': 123,
'Items': [
{
'LambdaFunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response',
'IncludeBody': True|False
},
]
},
'FunctionAssociations': {
'Quantity': 123,
'Items': [
{
'FunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response'
},
]
},
'FieldLevelEncryptionId': 'string',
'RealtimeLogConfigArn': 'string',
'CachePolicyId': 'string',
'OriginRequestPolicyId': 'string',
'ResponseHeadersPolicyId': 'string',
'ForwardedValues': {
'QueryString': True|False,
'Cookies': {
'Forward': 'none'|'whitelist'|'all',
'WhitelistedNames': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
},
'QueryStringCacheKeys': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'MinTTL': 123,
'DefaultTTL': 123,
'MaxTTL': 123
},
]
},
'CustomErrorResponses': {
'Quantity': 123,
'Items': [
{
'ErrorCode': 123,
'ResponsePagePath': 'string',
'ResponseCode': 'string',
'ErrorCachingMinTTL': 123
},
]
},
'Comment': 'string',
'Logging': {
'Enabled': True|False,
'IncludeCookies': True|False,
'Bucket': 'string',
'Prefix': 'string'
},
'PriceClass': 'PriceClass_100'|'PriceClass_200'|'PriceClass_All',
'Enabled': True|False,
'ViewerCertificate': {
'CloudFrontDefaultCertificate': True|False,
'IAMCertificateId': 'string',
'ACMCertificateArn': 'string',
'SSLSupportMethod': 'sni-only'|'vip'|'static-ip',
'MinimumProtocolVersion': 'SSLv3'|'TLSv1'|'TLSv1_2016'|'TLSv1.1_2016'|'TLSv1.2_2018'|'TLSv1.2_2019'|'TLSv1.2_2021',
'Certificate': 'string',
'CertificateSource': 'cloudfront'|'iam'|'acm'
},
'Restrictions': {
'GeoRestriction': {
'RestrictionType': 'blacklist'|'whitelist'|'none',
'Quantity': 123,
'Items': [
'string',
]
}
},
'WebACLId': 'string',
'HttpVersion': 'http1.1'|'http2'|'http3'|'http2and3',
'IsIPV6Enabled': True|False
},
'AliasICPRecordals': [
{
'CNAME': 'string',
'ICPRecordalStatus': 'APPROVED'|'SUSPENDED'|'PENDING'
},
]
},
'Location': 'string',
'ETag': 'string'
}
Response Structure
The returned result of the corresponding request.
The distribution's information.
The identifier for the distribution. For example: EDFDVBD632BHDS5 .
The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5 , where 123456789012 is your Amazon Web Services account ID.
This response element indicates the current status of the distribution. When the status is Deployed , the distribution's information is fully propagated to all CloudFront edge locations.
The date and time the distribution was last modified.
The number of invalidation batches currently in progress.
The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net .
Warning
We recommend using TrustedKeyGroups instead of TrustedSigners .
CloudFront automatically adds this field to the response if you’ve configured a cache behavior in this distribution to serve private content using trusted signers. This field contains a list of Amazon Web Services account IDs and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs or signed cookies.
This field is true if any of the Amazon Web Services accounts in the list have active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services accounts and the identifiers of active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.
A list of Amazon Web Services accounts and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.
An Amazon Web Services account number that contains active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If the Amazon Web Services account that owns the key pairs is the same account that owns the CloudFront distribution, the value of this field is self .
A list of CloudFront key pair identifiers.
The number of key pair identifiers in the list.
A list of CloudFront key pair identifiers.
CloudFront automatically adds this field to the response if you’ve configured a cache behavior in this distribution to serve private content using key groups. This field contains a list of key groups and the public keys in each key group that CloudFront can use to verify the signatures of signed URLs or signed cookies.
This field is true if any of the key groups have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of key groups in the list.
A list of key groups, including the identifiers of the public keys in each key group that CloudFront can use to verify the signatures of signed URLs and signed cookies.
A list of identifiers for the public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies.
The identifier of the key group that contains the public keys.
A list of CloudFront key pair identifiers.
The number of key pair identifiers in the list.
A list of CloudFront key pair identifiers.
The current configuration information for the distribution. Send a GET request to the /*CloudFront API version* /distribution ID/config resource.
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of CallerReference is new (regardless of the content of the DistributionConfig object), CloudFront creates a new distribution.
If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
The number of CNAME aliases, if any, that you want to associate with this distribution.
A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
The object that you want CloudFront to request from your origin (for example, index.html ) when a viewer requests the root URL for your distribution (http://www.example.com ) instead of an object in your distribution (http://www.example.com/product-description.html ). Specifying a default root object avoids exposing the contents of your distribution.
Specify only the object name, for example, index.html . Don't add a / before the object name.
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.
For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide .
A complex type that contains information about origins for this distribution.
The number of origins for this distribution.
A list of origins.
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:
S3OriginConfig to specify an Amazon S3 bucket that is not configured with static website hosting.CustomOriginConfig to specify all other kinds of origins, including: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).
A unique identifier for the origin. This value must be unique within the distribution.
Use this value to specify the TargetOriginId in a CacheBehavior or DefaultCacheBehavior .
The domain name for the origin.
For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide .
An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
For more information, see Origin Path in the Amazon CloudFront Developer Guide .
A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.
For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .
The number of custom headers, if any, for this distribution.
Optional : A list that contains oneOriginCustomHeaderelement for each custom header that you want CloudFront to forward to the origin. If Quantity is0, omitItems.
A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution.
The name of a header that you want CloudFront to send to your origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .
The value for the header that you specified in the HeaderName field.
Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the CustomOriginConfig type instead.
The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
origin-access-identity/cloudfront/ID-of-origin-access-identity
where `` ID-of-origin-access-identity `` is the value that CloudFront returned in the ID element when you created the origin access identity.
If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.
To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.
To replace the origin access identity, update the distribution configuration and specify the new origin access identity.
For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.
The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:
http-only – CloudFront always uses HTTP to connect to the origin.match-viewer – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.https-only – CloudFront always uses HTTPS to connect to the origin.Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include SSLv3 , TLSv1 , TLSv1.1 , and TLSv1.2 .
For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide .
The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.
A list that contains allowed SSL/TLS protocols for this distribution.
Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout . The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 30 seconds.
For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide .
Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 5 seconds.
For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide .
The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don’t specify otherwise) is 3.
For a custom origin (including an Amazon S3 bucket that’s configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout .
For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide .
The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don’t specify otherwise) is 10 seconds.
For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide .
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 .
A flag that specifies whether Origin Shield is enabled.
When it’s enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it’s disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.
The Amazon Web Services Region for Origin Shield.
Specify the Amazon Web Services Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as us-east-2 .
When you enable CloudFront Origin Shield, you must specify the Amazon Web Services Region for Origin Shield. For the list of Amazon Web Services Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the Amazon Web Services Region for Origin Shield in the Amazon CloudFront Developer Guide .
The unique identifier of an origin access control for this origin.
For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide .
A complex type that contains information about origin groups for this distribution.
The number of origin groups.
The items (origin groups) in a distribution.
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.
The origin group's ID.
A complex type that contains information about the failover criteria for an origin group.
The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.
The number of status codes.
The items (status codes) for an origin group.
A complex type that contains information about the origins in an origin group.
The number of origins in an origin group.
Items (origins) in an origin group.
An origin in an origin group.
The ID for an origin in an origin group.
A complex type that describes the default cache behavior if you don't 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.
The value of ID for the origin that you want CloudFront to route requests to when they use the default cache behavior.
Warning
We recommend using TrustedKeyGroups instead of TrustedSigners .
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer’s Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services account identifiers.
A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of key groups in the list.
A list of key groups identifiers.
The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern . You can specify the following options:
allow-all : Viewers can use HTTP or HTTPS.redirect-to-https : If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only : If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide .
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:
GET and HEAD requests.GET , HEAD , and OPTIONS requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
GET and HEAD requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true ; if not, specify false . If you specify true for SmoothStreaming , you can still distribute other content using this cache behavior if the content matches the value of PathPattern .
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true ; if not, specify false . For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
The number of Lambda@Edge function associations for this cache behavior.
Optional : A complex type that containsLambdaFunctionAssociationitems for this cache behavior. IfQuantityis0, you can omitItems.
A complex type that contains a Lambda@Edge function association.
The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request : The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request : The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response : The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response : The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.
The number of CloudFront functions in the list.
The 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.
A CloudFront function that is associated with a cache behavior in a CloudFront distribution.
The Amazon Resource Name (ARN) of the function.
The event type of the function, either viewer-request or viewer-response . You cannot use origin-facing event types (origin-request and origin-response ) with a CloudFront function.
The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior.
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide .
The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
The identifier for a response headers policy.
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide .
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed 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 or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 .
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys , if any:
If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
If you specify false for QueryString , CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 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 How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide .
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.
Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 .
Required if you specify whitelist for the value of Forward . A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.
If you specify all or none for the value of Forward , omit WhitelistedNames . If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.
For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference .
The number of cookie names in the Items list.
A list of cookie names.
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 headers 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 headers 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 the Headers , if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.
For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide .
The number of header names in the Items list.
A list of HTTP header names.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
The number of whitelisted query string parameters for a cache behavior.
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items .
This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers , if you specify 1 for Quantity and * for Name ).
This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The default amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The maximum amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
A complex type that contains zero or more CacheBehavior elements.
The number of cache behaviors for this distribution.
Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0 , you can omit Items .
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 .
The pattern (for example, images/*.jpg ) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.
Note
You can optionally include a slash (/ ) at the beginning of the path pattern. For example, /images/*.jpg . CloudFront behavior is the same with or without the leading / .
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.
For more information, see Path Pattern in the Amazon CloudFront Developer Guide .
The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.
Warning
We recommend using TrustedKeyGroups instead of TrustedSigners .
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer’s Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services account identifiers.
A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of key groups in the list.
A list of key groups identifiers.
The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern . You can specify the following options:
allow-all : Viewers can use HTTP or HTTPS.redirect-to-https : If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only : If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide .
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:
GET and HEAD requests.GET , HEAD , and OPTIONS requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
GET and HEAD requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true ; if not, specify false . If you specify true for SmoothStreaming , you can still distribute other content using this cache behavior if the content matches the value of PathPattern .
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
The number of Lambda@Edge function associations for this cache behavior.
Optional : A complex type that containsLambdaFunctionAssociationitems for this cache behavior. IfQuantityis0, you can omitItems.
A complex type that contains a Lambda@Edge function association.
The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request : The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request : The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response : The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response : The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.
The number of CloudFront functions in the list.
The 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.
A CloudFront function that is associated with a cache behavior in a CloudFront distribution.
The Amazon Resource Name (ARN) of the function.
The event type of the function, either viewer-request or viewer-response . You cannot use origin-facing event types (origin-request and origin-response ) with a CloudFront function.
The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide .
The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
A CacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
The identifier for a response headers policy.
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide .
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed 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 or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
A CacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 .
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys , if any:
If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
If you specify false for QueryString , CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 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 How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide .
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.
Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 .
Required if you specify whitelist for the value of Forward . A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.
If you specify all or none for the value of Forward , omit WhitelistedNames . If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.
For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference .
The number of cookie names in the Items list.
A list of cookie names.
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 headers 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 headers 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 the Headers , if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.
For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide .
The number of header names in the Items list.
A list of HTTP header names.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
The number of whitelisted query string parameters for a cache behavior.
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items .
This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers , if you specify 1 for Quantity and * for Name ).
This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The default amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The maximum amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
A complex type that controls the following:
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0 , you can omit Items .
A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration.
A complex type that controls:
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
The HTTP status code for which you want to specify a custom error page and/or a caching duration.
The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode , for example, /4xx-errors/403-forbidden.html . If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:
PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors . Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, /4xx-errors/* .TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages.If you specify a value for ResponsePagePath , you must also specify a value for ResponseCode .
We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.
The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:
200 , the response typically won't be intercepted.400 or 500 as the ResponseCode for all 4xx or 5xx errors.200 status code (OK) and static website so your customers don't know that your website is down.If you specify a value for ResponseCode , you must also specify a value for ResponsePagePath .
The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode . When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.
For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
An optional comment to describe the distribution. The comment cannot be longer than 128 characters.
A complex type that controls whether access logs are written for the distribution.
For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide .
Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't 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.
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 don't 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 .
The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com .
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 don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.
The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All , CloudFront responds to requests for your objects from all CloudFront edge locations.
If you specify a price class other than PriceClass_All , CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.
For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide . For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing .
From this field, you can enable or disable the selected distribution.
A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net , set this field to true .
If the distribution uses Aliases (alternate domain names or CNAMEs), set this field to false and specify values for the following fields:
ACMCertificateArn or IAMCertificateId (specify a value for one, not both)MinimumProtocolVersionSSLSupportMethodIf the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Identity and Access Management (IAM) , provide the ID of the IAM certificate.
If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVersion and SSLSupportMethod .
If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Certificate Manager (ACM) , provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (us-east-1 ).
If you specify an ACM certificate ARN, you must also specify values for MinimumProtocolVersion and SSLSupportMethod .
If the distribution uses Aliases (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.
sni-only – The distribution accepts HTTPS connections from only viewers that support server name indication (SNI) . This is recommended. Most browsers and clients support SNI.vip – The distribution accepts HTTPS connections from all viewers including those that don’t support SNI. This is not recommended, and results in additional monthly charges from CloudFront.static-ip - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the Amazon Web Services Support Center .If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net , don’t set a value for this field.
If the distribution uses Aliases (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:
For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
On the CloudFront console, this setting is called Security Policy .
When you’re using SNI only (you set SSLSupportMethod to sni-only ), you must specify TLSv1 or higher.
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net (you set CloudFrontDefaultCertificate to true ), CloudFront automatically sets the security policy to TLSv1 regardless of the value that you set here.
This field is deprecated. Use one of the following fields instead:
ACMCertificateArnIAMCertificateIdCloudFrontDefaultCertificateThis field is deprecated. Use one of the following fields instead:
ACMCertificateArnIAMCertificateIdCloudFrontDefaultCertificateA complex type that identifies ways in which you want to restrict distribution of your content.
A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.
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 don't want CloudFront to distribute your content.whitelist : The Location elements specify the countries in which you want CloudFront to distribute your content.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 .
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 on the CloudFront console, which includes both country names and codes.
A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a . To specify a web ACL created using WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a .
WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the WAF Developer Guide .
(Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2 . Viewers that don't support HTTP/2 automatically use an earlier HTTP version.
For viewers and CloudFront to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI).
For viewers and CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CloudFront supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see Connection Migration at RFC 9000. For more information about supported TLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront .
If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true . If you specify false , CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.
In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide .
If you're using an Route 53 Amazon Web Services Integration alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:
For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Route 53 Amazon Web Services Integration Developer Guide .
If you created a CNAME resource record set, either with Route 53 Amazon Web Services Integration or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.
Amazon Web Services 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.
For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China .
Amazon Web Services 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 Amazon Web Services services in China .
A domain name associated with a distribution.
The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in regions outside of China.
The status values returned are the following:
The fully qualified URI of the new distribution resource just created.
The current version of the distribution created.
Exceptions
CloudFront.Client.exceptions.CNAMEAlreadyExistsCloudFront.Client.exceptions.DistributionAlreadyExistsCloudFront.Client.exceptions.InvalidOriginCloudFront.Client.exceptions.InvalidOriginAccessIdentityCloudFront.Client.exceptions.InvalidOriginAccessControlCloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.TooManyTrustedSignersCloudFront.Client.exceptions.TrustedSignerDoesNotExistCloudFront.Client.exceptions.InvalidViewerCertificateCloudFront.Client.exceptions.InvalidMinimumProtocolVersionCloudFront.Client.exceptions.MissingBodyCloudFront.Client.exceptions.TooManyDistributionCNAMEsCloudFront.Client.exceptions.TooManyDistributionsCloudFront.Client.exceptions.InvalidDefaultRootObjectCloudFront.Client.exceptions.InvalidRelativePathCloudFront.Client.exceptions.InvalidErrorCodeCloudFront.Client.exceptions.InvalidResponseCodeCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.InvalidRequiredProtocolCloudFront.Client.exceptions.NoSuchOriginCloudFront.Client.exceptions.TooManyOriginsCloudFront.Client.exceptions.TooManyOriginGroupsPerDistributionCloudFront.Client.exceptions.TooManyCacheBehaviorsCloudFront.Client.exceptions.TooManyCookieNamesInWhiteListCloudFront.Client.exceptions.InvalidForwardCookiesCloudFront.Client.exceptions.TooManyHeadersInForwardedValuesCloudFront.Client.exceptions.InvalidHeadersForS3OriginCloudFront.Client.exceptions.InconsistentQuantitiesCloudFront.Client.exceptions.TooManyCertificatesCloudFront.Client.exceptions.InvalidLocationCodeCloudFront.Client.exceptions.InvalidGeoRestrictionParameterCloudFront.Client.exceptions.InvalidProtocolSettingsCloudFront.Client.exceptions.InvalidTTLOrderCloudFront.Client.exceptions.InvalidWebACLIdCloudFront.Client.exceptions.TooManyOriginCustomHeadersCloudFront.Client.exceptions.InvalidTaggingCloudFront.Client.exceptions.TooManyQueryStringParametersCloudFront.Client.exceptions.InvalidQueryStringParametersCloudFront.Client.exceptions.TooManyDistributionsWithLambdaAssociationsCloudFront.Client.exceptions.TooManyDistributionsWithSingleFunctionARNCloudFront.Client.exceptions.TooManyLambdaFunctionAssociationsCloudFront.Client.exceptions.InvalidLambdaFunctionAssociationCloudFront.Client.exceptions.TooManyDistributionsWithFunctionAssociationsCloudFront.Client.exceptions.TooManyFunctionAssociationsCloudFront.Client.exceptions.InvalidFunctionAssociationCloudFront.Client.exceptions.InvalidOriginReadTimeoutCloudFront.Client.exceptions.InvalidOriginKeepaliveTimeoutCloudFront.Client.exceptions.NoSuchFieldLevelEncryptionConfigCloudFront.Client.exceptions.IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorCloudFront.Client.exceptions.TooManyDistributionsAssociatedToFieldLevelEncryptionConfigCloudFront.Client.exceptions.NoSuchCachePolicyCloudFront.Client.exceptions.TooManyDistributionsAssociatedToCachePolicyCloudFront.Client.exceptions.NoSuchResponseHeadersPolicyCloudFront.Client.exceptions.TooManyDistributionsAssociatedToResponseHeadersPolicyCloudFront.Client.exceptions.NoSuchOriginRequestPolicyCloudFront.Client.exceptions.TooManyDistributionsAssociatedToOriginRequestPolicyCloudFront.Client.exceptions.TooManyDistributionsAssociatedToKeyGroupCloudFront.Client.exceptions.TooManyKeyGroupsAssociatedToDistributionCloudFront.Client.exceptions.TrustedKeyGroupDoesNotExistCloudFront.Client.exceptions.NoSuchRealtimeLogConfigCloudFront.Client.exceptions.RealtimeLogConfigOwnerMismatchCloudFront.Client.exceptions.InvalidDomainNameForOriginAccessControlcreate_field_level_encryption_config(**kwargs)¶Create a new field-level encryption configuration.
See also: AWS API Documentation
Request Syntax
response = client.create_field_level_encryption_config(
FieldLevelEncryptionConfig={
'CallerReference': 'string',
'Comment': 'string',
'QueryArgProfileConfig': {
'ForwardWhenQueryArgProfileIsUnknown': True|False,
'QueryArgProfiles': {
'Quantity': 123,
'Items': [
{
'QueryArg': 'string',
'ProfileId': 'string'
},
]
}
},
'ContentTypeProfileConfig': {
'ForwardWhenContentTypeIsUnknown': True|False,
'ContentTypeProfiles': {
'Quantity': 123,
'Items': [
{
'Format': 'URLEncoded',
'ProfileId': 'string',
'ContentType': 'string'
},
]
}
}
}
)
[REQUIRED]
The request to create a new field-level encryption configuration.
A unique number that ensures the request can't be replayed.
An optional comment about the configuration. The comment cannot be longer than 128 characters.
A complex data type that specifies when to forward content if a profile isn't found and the profile that can be provided as a query argument in a request.
Flag to set if you want a request to be forwarded to the origin even if the profile specified by the field-level encryption query argument, fle-profile, is unknown.
Profiles specified for query argument-profile mapping for field-level encryption.
Number of profiles for query argument-profile mapping for field-level encryption.
Number of items for query argument-profile mapping for field-level encryption.
Query argument-profile mapping for field-level encryption.
Query argument for field-level encryption query argument-profile mapping.
ID of profile to use for field-level encryption query argument-profile mapping
A complex data type that specifies when to forward content if a content type isn't recognized and profiles to use as by default in a request if a query argument doesn't specify a profile to use.
The setting in a field-level encryption content type-profile mapping that specifies what to do when an unknown content type is provided for the profile. If true, content is forwarded without being encrypted when the content type is unknown. If false (the default), an error is returned when the content type is unknown.
The configuration for a field-level encryption content type-profile.
The number of field-level encryption content type-profile mappings.
Items in a field-level encryption content type-profile mapping.
A field-level encryption content type profile.
The format for a field-level encryption content type-profile mapping.
The profile ID for a field-level encryption content type-profile mapping.
The content type for a field-level encryption content type-profile mapping.
{
'FieldLevelEncryption': {
'Id': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'FieldLevelEncryptionConfig': {
'CallerReference': 'string',
'Comment': 'string',
'QueryArgProfileConfig': {
'ForwardWhenQueryArgProfileIsUnknown': True|False,
'QueryArgProfiles': {
'Quantity': 123,
'Items': [
{
'QueryArg': 'string',
'ProfileId': 'string'
},
]
}
},
'ContentTypeProfileConfig': {
'ForwardWhenContentTypeIsUnknown': True|False,
'ContentTypeProfiles': {
'Quantity': 123,
'Items': [
{
'Format': 'URLEncoded',
'ProfileId': 'string',
'ContentType': 'string'
},
]
}
}
}
},
'Location': 'string',
'ETag': 'string'
}
Response Structure
Returned when you create a new field-level encryption configuration.
The configuration ID for a field-level encryption configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.
The last time the field-level encryption configuration was changed.
A complex data type that includes the profile configurations specified for field-level encryption.
A unique number that ensures the request can't be replayed.
An optional comment about the configuration. The comment cannot be longer than 128 characters.
A complex data type that specifies when to forward content if a profile isn't found and the profile that can be provided as a query argument in a request.
Flag to set if you want a request to be forwarded to the origin even if the profile specified by the field-level encryption query argument, fle-profile, is unknown.
Profiles specified for query argument-profile mapping for field-level encryption.
Number of profiles for query argument-profile mapping for field-level encryption.
Number of items for query argument-profile mapping for field-level encryption.
Query argument-profile mapping for field-level encryption.
Query argument for field-level encryption query argument-profile mapping.
ID of profile to use for field-level encryption query argument-profile mapping
A complex data type that specifies when to forward content if a content type isn't recognized and profiles to use as by default in a request if a query argument doesn't specify a profile to use.
The setting in a field-level encryption content type-profile mapping that specifies what to do when an unknown content type is provided for the profile. If true, content is forwarded without being encrypted when the content type is unknown. If false (the default), an error is returned when the content type is unknown.
The configuration for a field-level encryption content type-profile.
The number of field-level encryption content type-profile mappings.
Items in a field-level encryption content type-profile mapping.
A field-level encryption content type profile.
The format for a field-level encryption content type-profile mapping.
The profile ID for a field-level encryption content type-profile mapping.
The content type for a field-level encryption content type-profile mapping.
The fully qualified URI of the new configuration resource just created.
The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL .
Exceptions
CloudFront.Client.exceptions.InconsistentQuantitiesCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.NoSuchFieldLevelEncryptionProfileCloudFront.Client.exceptions.FieldLevelEncryptionConfigAlreadyExistsCloudFront.Client.exceptions.TooManyFieldLevelEncryptionConfigsCloudFront.Client.exceptions.TooManyFieldLevelEncryptionQueryArgProfilesCloudFront.Client.exceptions.TooManyFieldLevelEncryptionContentTypeProfilesCloudFront.Client.exceptions.QueryArgProfileEmptycreate_field_level_encryption_profile(**kwargs)¶Create a field-level encryption profile.
See also: AWS API Documentation
Request Syntax
response = client.create_field_level_encryption_profile(
FieldLevelEncryptionProfileConfig={
'Name': 'string',
'CallerReference': 'string',
'Comment': 'string',
'EncryptionEntities': {
'Quantity': 123,
'Items': [
{
'PublicKeyId': 'string',
'ProviderId': 'string',
'FieldPatterns': {
'Quantity': 123,
'Items': [
'string',
]
}
},
]
}
}
)
[REQUIRED]
The request to create a field-level encryption profile.
Profile name for the field-level encryption profile.
A unique number that ensures that the request can't be replayed.
An optional comment for the field-level encryption profile. The comment cannot be longer than 128 characters.
A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.
Number of field pattern items in a field-level encryption content type-profile mapping.
An array of field patterns in a field-level encryption content type-profile mapping.
Complex data type for field-level encryption profiles that includes the encryption key and field pattern specifications.
The public key associated with a set of field-level encryption patterns, to be used when encrypting the fields that match the patterns.
The provider associated with the public key being used for encryption. This value must also be provided with the private key for applications to be able to decrypt data.
Field patterns in a field-level encryption content type profile specify the fields that you want to be encrypted. You can provide the full field name, or any beginning characters followed by a wildcard (*). You can't overlap field patterns. For example, you can't have both ABC* and AB*. Note that field patterns are case-sensitive.
The number of field-level encryption field patterns.
An array of the field-level encryption field patterns.
{
'FieldLevelEncryptionProfile': {
'Id': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'FieldLevelEncryptionProfileConfig': {
'Name': 'string',
'CallerReference': 'string',
'Comment': 'string',
'EncryptionEntities': {
'Quantity': 123,
'Items': [
{
'PublicKeyId': 'string',
'ProviderId': 'string',
'FieldPatterns': {
'Quantity': 123,
'Items': [
'string',
]
}
},
]
}
}
},
'Location': 'string',
'ETag': 'string'
}
Response Structure
Returned when you create a new field-level encryption profile.
The ID for a field-level encryption profile configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.
The last time the field-level encryption profile was updated.
A complex data type that includes the profile name and the encryption entities for the field-level encryption profile.
Profile name for the field-level encryption profile.
A unique number that ensures that the request can't be replayed.
An optional comment for the field-level encryption profile. The comment cannot be longer than 128 characters.
A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.
Number of field pattern items in a field-level encryption content type-profile mapping.
An array of field patterns in a field-level encryption content type-profile mapping.
Complex data type for field-level encryption profiles that includes the encryption key and field pattern specifications.
The public key associated with a set of field-level encryption patterns, to be used when encrypting the fields that match the patterns.
The provider associated with the public key being used for encryption. This value must also be provided with the private key for applications to be able to decrypt data.
Field patterns in a field-level encryption content type profile specify the fields that you want to be encrypted. You can provide the full field name, or any beginning characters followed by a wildcard (*). You can't overlap field patterns. For example, you can't have both ABC* and AB*. Note that field patterns are case-sensitive.
The number of field-level encryption field patterns.
An array of the field-level encryption field patterns.
The fully qualified URI of the new profile resource just created.
The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL .
Exceptions
CloudFront.Client.exceptions.InconsistentQuantitiesCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.NoSuchPublicKeyCloudFront.Client.exceptions.FieldLevelEncryptionProfileAlreadyExistsCloudFront.Client.exceptions.FieldLevelEncryptionProfileSizeExceededCloudFront.Client.exceptions.TooManyFieldLevelEncryptionProfilesCloudFront.Client.exceptions.TooManyFieldLevelEncryptionEncryptionEntitiesCloudFront.Client.exceptions.TooManyFieldLevelEncryptionFieldPatternscreate_function(**kwargs)¶Creates a CloudFront function.
To create a function, you provide the function code and some configuration information about the function. The response contains an Amazon Resource Name (ARN) that uniquely identifies the function.
When you create a function, it’s in the DEVELOPMENT stage. In this stage, you can test the function with TestFunction , and update it with UpdateFunction .
When you’re ready to use your function with a CloudFront distribution, use PublishFunction to copy the function from the DEVELOPMENT stage to LIVE . When it’s live, you can attach the function to a distribution’s cache behavior, using the function’s ARN.
See also: AWS API Documentation
Request Syntax
response = client.create_function(
Name='string',
FunctionConfig={
'Comment': 'string',
'Runtime': 'cloudfront-js-1.0'
},
FunctionCode=b'bytes'
)
[REQUIRED]
A name to identify the function.
[REQUIRED]
Configuration information about the function, including an optional comment and the function’s runtime.
A comment to describe the function.
The function’s runtime environment. The only valid value is cloudfront-js-1.0 .
[REQUIRED]
The function code. For more information about writing a CloudFront function, see Writing function code for CloudFront Functions in the Amazon CloudFront Developer Guide .
dict
Response Syntax
{
'FunctionSummary': {
'Name': 'string',
'Status': 'string',
'FunctionConfig': {
'Comment': 'string',
'Runtime': 'cloudfront-js-1.0'
},
'FunctionMetadata': {
'FunctionARN': 'string',
'Stage': 'DEVELOPMENT'|'LIVE',
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1)
}
},
'Location': 'string',
'ETag': 'string'
}
Response Structure
(dict) --
FunctionSummary (dict) --
Contains configuration information and metadata about a CloudFront function.
Name (string) --
The name of the CloudFront function.
Status (string) --
The status of the CloudFront function.
FunctionConfig (dict) --
Contains configuration information about a CloudFront function.
Comment (string) --
A comment to describe the function.
Runtime (string) --
The function’s runtime environment. The only valid value is cloudfront-js-1.0 .
FunctionMetadata (dict) --
Contains metadata about a CloudFront function.
FunctionARN (string) --
The Amazon Resource Name (ARN) of the function. The ARN uniquely identifies the function.
Stage (string) --
The stage that the function is in, either DEVELOPMENT or LIVE .
When a function is in the DEVELOPMENT stage, you can test the function with TestFunction , and update it with UpdateFunction .
When a function is in the LIVE stage, you can attach the function to a distribution’s cache behavior, using the function’s ARN.
CreatedTime (datetime) --
The date and time when the function was created.
LastModifiedTime (datetime) --
The date and time when the function was most recently updated.
Location (string) --
The URL of the CloudFront function. Use the URL to manage the function with the CloudFront API.
ETag (string) --
The version identifier for the current version of the CloudFront function.
Exceptions
CloudFront.Client.exceptions.TooManyFunctionsCloudFront.Client.exceptions.FunctionAlreadyExistsCloudFront.Client.exceptions.FunctionSizeLimitExceededCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.UnsupportedOperationcreate_invalidation(**kwargs)¶Create a new invalidation.
See also: AWS API Documentation
Request Syntax
response = client.create_invalidation(
DistributionId='string',
InvalidationBatch={
'Paths': {
'Quantity': 123,
'Items': [
'string',
]
},
'CallerReference': 'string'
}
)
[REQUIRED]
The distribution's id.
[REQUIRED]
The batch information for the invalidation.
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 .
The number of invalidation paths specified for the objects that you want to invalidate.
A complex type that contains a list of the paths that you want to invalidate.
A value that you specify to uniquely identify an invalidation request. CloudFront uses the value to prevent you from accidentally resubmitting an identical request. Whenever you create a new invalidation request, you must specify a new value for CallerReference and change other values in the request as applicable. One way to ensure that the value of CallerReference is unique is to use a timestamp , for example, 20120301090000 .
If you make a second invalidation request with the same value for CallerReference , and if the rest of the request is the same, CloudFront doesn't create a new invalidation request. Instead, CloudFront returns information about the invalidation request that you previously created with the same CallerReference .
If CallerReference is a value you already sent in a previous invalidation batch request but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error.
dict
Response Syntax
{
'Location': 'string',
'Invalidation': {
'Id': 'string',
'Status': 'string',
'CreateTime': datetime(2015, 1, 1),
'InvalidationBatch': {
'Paths': {
'Quantity': 123,
'Items': [
'string',
]
},
'CallerReference': 'string'
}
}
}
Response Structure
(dict) --
The returned result of the corresponding request.
Location (string) --
The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID .
Invalidation (dict) --
The invalidation's information.
Id (string) --
The identifier for the invalidation request. For example: IDFDVBD632BHDS5 .
Status (string) --
The status of the invalidation request. When the invalidation batch is finished, the status is Completed .
CreateTime (datetime) --
The date and time the invalidation request was first made.
InvalidationBatch (dict) --
The current invalidation information for the batch request.
Paths (dict) --
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 .
Quantity (integer) --
The number of invalidation paths specified for the objects that you want to invalidate.
Items (list) --
A complex type that contains a list of the paths that you want to invalidate.
CallerReference (string) --
A value that you specify to uniquely identify an invalidation request. CloudFront uses the value to prevent you from accidentally resubmitting an identical request. Whenever you create a new invalidation request, you must specify a new value for CallerReference and change other values in the request as applicable. One way to ensure that the value of CallerReference is unique is to use a timestamp , for example, 20120301090000 .
If you make a second invalidation request with the same value for CallerReference , and if the rest of the request is the same, CloudFront doesn't create a new invalidation request. Instead, CloudFront returns information about the invalidation request that you previously created with the same CallerReference .
If CallerReference is a value you already sent in a previous invalidation batch request but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error.
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.MissingBodyCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.NoSuchDistributionCloudFront.Client.exceptions.BatchTooLargeCloudFront.Client.exceptions.TooManyInvalidationsInProgressCloudFront.Client.exceptions.InconsistentQuantitiescreate_key_group(**kwargs)¶Creates a key group that you can use with CloudFront signed URLs and signed cookies .
To create a key group, you must specify at least one public key for the key group. After you create a key group, you can reference it from one or more cache behaviors. When you reference a key group in a cache behavior, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_key_group(
KeyGroupConfig={
'Name': 'string',
'Items': [
'string',
],
'Comment': 'string'
}
)
[REQUIRED]
A key group configuration.
A name to identify the key group.
A list of the identifiers of the public keys in the key group.
A comment to describe the key group. The comment cannot be longer than 128 characters.
{
'KeyGroup': {
'Id': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'KeyGroupConfig': {
'Name': 'string',
'Items': [
'string',
],
'Comment': 'string'
}
},
'Location': 'string',
'ETag': 'string'
}
Response Structure
The key group that was just created.
The identifier for the key group.
The date and time when the key group was last modified.
The key group configuration.
A name to identify the key group.
A list of the identifiers of the public keys in the key group.
A comment to describe the key group. The comment cannot be longer than 128 characters.
The URL of the key group.
The identifier for this version of the key group.
Exceptions
CloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.KeyGroupAlreadyExistsCloudFront.Client.exceptions.TooManyKeyGroupsCloudFront.Client.exceptions.TooManyPublicKeysInKeyGroupcreate_monitoring_subscription(**kwargs)¶Enables additional CloudWatch metrics for the specified CloudFront distribution. The additional metrics incur an additional cost.
For more information, see Viewing additional CloudFront distribution metrics in the Amazon CloudFront Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_monitoring_subscription(
DistributionId='string',
MonitoringSubscription={
'RealtimeMetricsSubscriptionConfig': {
'RealtimeMetricsSubscriptionStatus': 'Enabled'|'Disabled'
}
}
)
[REQUIRED]
The ID of the distribution that you are enabling metrics for.
[REQUIRED]
A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
A subscription configuration for additional CloudWatch metrics.
A flag that indicates whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
dict
Response Syntax
{
'MonitoringSubscription': {
'RealtimeMetricsSubscriptionConfig': {
'RealtimeMetricsSubscriptionStatus': 'Enabled'|'Disabled'
}
}
}
Response Structure
(dict) --
MonitoringSubscription (dict) --
A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
RealtimeMetricsSubscriptionConfig (dict) --
A subscription configuration for additional CloudWatch metrics.
RealtimeMetricsSubscriptionStatus (string) --
A flag that indicates whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.NoSuchDistributionCloudFront.Client.exceptions.MonitoringSubscriptionAlreadyExistsCloudFront.Client.exceptions.UnsupportedOperationcreate_origin_access_control(**kwargs)¶Creates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin.
For an Amazon S3 origin, this makes it possible to block public access to the Amazon S3 bucket so that viewers (users) can access the content in the bucket only through CloudFront.
For more information about using a CloudFront origin access control, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_origin_access_control(
OriginAccessControlConfig={
'Name': 'string',
'Description': 'string',
'SigningProtocol': 'sigv4',
'SigningBehavior': 'never'|'always'|'no-override',
'OriginAccessControlOriginType': 's3'
}
)
[REQUIRED]
Contains the origin access control.
A name to identify the origin access control.
A description of the origin access control.
The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is sigv4 .
Specifies which requests CloudFront signs (adds authentication information to). Specify always for the most common use case. For more information, see origin access control advanced settings in the Amazon CloudFront Developer Guide .
This field can have one of the following values:
always – CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if one exists.never – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control.no-override – If the viewer request doesn't contain the Authorization header, then CloudFront signs the origin request. If the viewer request contains the Authorization header, then CloudFront doesn't sign the origin request and instead passes along the Authorization header from the viewer request. WARNING: To pass along the ``Authorization`` header from the viewer request, you *must* add the ``Authorization`` header to a `cache policy <https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html>`__ for all cache behaviors that use origins associated with this origin access control.The type of origin that this origin access control is for. The only valid value is s3 .
{
'OriginAccessControl': {
'Id': 'string',
'OriginAccessControlConfig': {
'Name': 'string',
'Description': 'string',
'SigningProtocol': 'sigv4',
'SigningBehavior': 'never'|'always'|'no-override',
'OriginAccessControlOriginType': 's3'
}
},
'Location': 'string',
'ETag': 'string'
}
Response Structure
Contains an origin access control.
The unique identifier of the origin access control.
The origin access control.
A name to identify the origin access control.
A description of the origin access control.
The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is sigv4 .
Specifies which requests CloudFront signs (adds authentication information to). Specify always for the most common use case. For more information, see origin access control advanced settings in the Amazon CloudFront Developer Guide .
This field can have one of the following values:
always – CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if one exists.never – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control.no-override – If the viewer request doesn't contain the Authorization header, then CloudFront signs the origin request. If the viewer request contains the Authorization header, then CloudFront doesn't sign the origin request and instead passes along the Authorization header from the viewer request. WARNING: To pass along the ``Authorization`` header from the viewer request, you *must* add the ``Authorization`` header to a `cache policy <https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html>`__ for all cache behaviors that use origins associated with this origin access control.The type of origin that this origin access control is for. The only valid value is s3 .
The URL of the origin access control.
The version identifier for the current version of the origin access control.
Exceptions
CloudFront.Client.exceptions.OriginAccessControlAlreadyExistsCloudFront.Client.exceptions.TooManyOriginAccessControlsCloudFront.Client.exceptions.InvalidArgumentcreate_origin_request_policy(**kwargs)¶Creates an origin request policy.
After you create an origin request policy, you can attach it to one or more cache behaviors. 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:
Host , User-Agent , and X-Amz-Cf-Id .CloudFront sends a request when it can’t find a valid 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 .
For more information about origin request policies, see Controlling origin requests in the Amazon CloudFront Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_origin_request_policy(
OriginRequestPolicyConfig={
'Comment': 'string',
'Name': 'string',
'HeadersConfig': {
'HeaderBehavior': 'none'|'whitelist'|'allViewer'|'allViewerAndWhitelistCloudFront',
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'CookiesConfig': {
'CookieBehavior': 'none'|'whitelist'|'all',
'Cookies': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'QueryStringsConfig': {
'QueryStringBehavior': 'none'|'whitelist'|'all',
'QueryStrings': {
'Quantity': 123,
'Items': [
'string',
]
}
}
}
)
[REQUIRED]
An origin request policy configuration.
A comment to describe the origin request policy. The comment cannot be longer than 128 characters.
A unique name to identify the origin request policy.
The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.
Determines whether any HTTP headers are included in requests that CloudFront sends to the origin. Valid values are:
none – HTTP headers are not included in requests that CloudFront sends to the origin. Even when this field is set to none , any headers that are listed in a CachePolicy are included in origin requests.whitelist – The HTTP headers that are listed in the Headers type are included in requests that CloudFront sends to the origin.allViewer – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin.allViewerAndWhitelistCloudFront – All HTTP headers in viewer requests and the additional CloudFront headers that are listed in the Headers type are included in requests that CloudFront sends to the origin. The additional headers are added by CloudFront.Contains a list of HTTP header names.
The number of header names in the Items list.
A list of HTTP header names.
The cookies from viewer requests to include in origin requests.
Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:
none – Cookies in viewer requests are not included in requests that CloudFront sends to the origin. Even when this field is set to none , any cookies that are listed in a CachePolicy are included in origin requests.whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in requests that CloudFront sends to the origin.all – All cookies in viewer requests are included in requests that CloudFront sends to the origin.Contains a list of cookie names.
The number of cookie names in the Items list.
A list of cookie names.
The URL query strings from viewer requests to include in origin requests.
Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:
none – Query strings in viewer requests are not included in requests that CloudFront sends to the origin. Even when this field is set to none , any query strings that are listed in a CachePolicy are included in origin requests.whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in requests that CloudFront sends to the origin.all – All query strings in viewer requests are included in requests that CloudFront sends to the origin.Contains a list of the query strings in viewer requests that are included in requests that CloudFront sends to the origin.
The number of query string names in the Items list.
A list of query string names.
{
'OriginRequestPolicy': {
'Id': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'OriginRequestPolicyConfig': {
'Comment': 'string',
'Name': 'string',
'HeadersConfig': {
'HeaderBehavior': 'none'|'whitelist'|'allViewer'|'allViewerAndWhitelistCloudFront',
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'CookiesConfig': {
'CookieBehavior': 'none'|'whitelist'|'all',
'Cookies': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'QueryStringsConfig': {
'QueryStringBehavior': 'none'|'whitelist'|'all',
'QueryStrings': {
'Quantity': 123,
'Items': [
'string',
]
}
}
}
},
'Location': 'string',
'ETag': 'string'
}
Response Structure
An origin request policy.
The unique identifier for the origin request policy.
The date and time when the origin request policy was last modified.
The origin request policy configuration.
A comment to describe the origin request policy. The comment cannot be longer than 128 characters.
A unique name to identify the origin request policy.
The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.
Determines whether any HTTP headers are included in requests that CloudFront sends to the origin. Valid values are:
none – HTTP headers are not included in requests that CloudFront sends to the origin. Even when this field is set to none , any headers that are listed in a CachePolicy are included in origin requests.whitelist – The HTTP headers that are listed in the Headers type are included in requests that CloudFront sends to the origin.allViewer – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin.allViewerAndWhitelistCloudFront – All HTTP headers in viewer requests and the additional CloudFront headers that are listed in the Headers type are included in requests that CloudFront sends to the origin. The additional headers are added by CloudFront.Contains a list of HTTP header names.
The number of header names in the Items list.
A list of HTTP header names.
The cookies from viewer requests to include in origin requests.
Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:
none – Cookies in viewer requests are not included in requests that CloudFront sends to the origin. Even when this field is set to none , any cookies that are listed in a CachePolicy are included in origin requests.whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in requests that CloudFront sends to the origin.all – All cookies in viewer requests are included in requests that CloudFront sends to the origin.Contains a list of cookie names.
The number of cookie names in the Items list.
A list of cookie names.
The URL query strings from viewer requests to include in origin requests.
Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:
none – Query strings in viewer requests are not included in requests that CloudFront sends to the origin. Even when this field is set to none , any query strings that are listed in a CachePolicy are included in origin requests.whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in requests that CloudFront sends to the origin.all – All query strings in viewer requests are included in requests that CloudFront sends to the origin.Contains a list of the query strings in viewer requests that are included in requests that CloudFront sends to the origin.
The number of query string names in the Items list.
A list of query string names.
The fully qualified URI of the origin request policy just created.
The current version of the origin request policy.
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.InconsistentQuantitiesCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.OriginRequestPolicyAlreadyExistsCloudFront.Client.exceptions.TooManyOriginRequestPoliciesCloudFront.Client.exceptions.TooManyHeadersInOriginRequestPolicyCloudFront.Client.exceptions.TooManyCookiesInOriginRequestPolicyCloudFront.Client.exceptions.TooManyQueryStringsInOriginRequestPolicycreate_public_key(**kwargs)¶Uploads a public key to CloudFront that you can use with signed URLs and signed cookies , or with field-level encryption .
See also: AWS API Documentation
Request Syntax
response = client.create_public_key(
PublicKeyConfig={
'CallerReference': 'string',
'Name': 'string',
'EncodedKey': 'string',
'Comment': 'string'
}
)
[REQUIRED]
A CloudFront public key configuration.
A string included in the request to help make sure that the request can’t be replayed.
A name to help identify the public key.
The public key that you can use with signed URLs and signed cookies , or with field-level encryption .
A comment to describe the public key. The comment cannot be longer than 128 characters.
{
'PublicKey': {
'Id': 'string',
'CreatedTime': datetime(2015, 1, 1),
'PublicKeyConfig': {
'CallerReference': 'string',
'Name': 'string',
'EncodedKey': 'string',
'Comment': 'string'
}
},
'Location': 'string',
'ETag': 'string'
}
Response Structure
The public key.
The identifier of the public key.
The date and time when the public key was uploaded.
Configuration information about a public key that you can use with signed URLs and signed cookies , or with field-level encryption .
A string included in the request to help make sure that the request can’t be replayed.
A name to help identify the public key.
The public key that you can use with signed URLs and signed cookies , or with field-level encryption .
A comment to describe the public key. The comment cannot be longer than 128 characters.
The URL of the public key.
The identifier for this version of the public key.
Exceptions
CloudFront.Client.exceptions.PublicKeyAlreadyExistsCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.TooManyPublicKeyscreate_realtime_log_config(**kwargs)¶Creates a real-time log configuration.
After you create a real-time log configuration, you can attach it to one or more cache behaviors to send real-time log data to the specified Amazon Kinesis data stream.
For more information about real-time log configurations, see Real-time logs in the Amazon CloudFront Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_realtime_log_config(
EndPoints=[
{
'StreamType': 'string',
'KinesisStreamConfig': {
'RoleARN': 'string',
'StreamARN': 'string'
}
},
],
Fields=[
'string',
],
Name='string',
SamplingRate=123
)
[REQUIRED]
Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
Contains information about the Amazon Kinesis data stream where you are sending real-time log data in a real-time log configuration.
The type of data stream where you are sending real-time log data. The only valid value is Kinesis .
Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFront can use to send real-time log data to your Kinesis data stream.
For more information the IAM role, see Real-time log configuration IAM role in the Amazon CloudFront Developer Guide .
The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data.
[REQUIRED]
A list of fields to include in each real-time log record.
For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide .
[REQUIRED]
A unique name to identify this real-time log configuration.
[REQUIRED]
The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. You must provide an integer between 1 and 100, inclusive.
dict
Response Syntax
{
'RealtimeLogConfig': {
'ARN': 'string',
'Name': 'string',
'SamplingRate': 123,
'EndPoints': [
{
'StreamType': 'string',
'KinesisStreamConfig': {
'RoleARN': 'string',
'StreamARN': 'string'
}
},
],
'Fields': [
'string',
]
}
}
Response Structure
(dict) --
RealtimeLogConfig (dict) --
A real-time log configuration.
ARN (string) --
The Amazon Resource Name (ARN) of this real-time log configuration.
Name (string) --
The unique name of this real-time log configuration.
SamplingRate (integer) --
The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. The sampling rate is an integer between 1 and 100, inclusive.
EndPoints (list) --
Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.
(dict) --
Contains information about the Amazon Kinesis data stream where you are sending real-time log data in a real-time log configuration.
StreamType (string) --
The type of data stream where you are sending real-time log data. The only valid value is Kinesis .
KinesisStreamConfig (dict) --
Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
RoleARN (string) --
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFront can use to send real-time log data to your Kinesis data stream.
For more information the IAM role, see Real-time log configuration IAM role in the Amazon CloudFront Developer Guide .
StreamARN (string) --
The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data.
Fields (list) --
A list of fields that are included in each real-time log record. In an API response, the fields are provided in the same order in which they are sent to the Amazon Kinesis data stream.
For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide .
Exceptions
CloudFront.Client.exceptions.RealtimeLogConfigAlreadyExistsCloudFront.Client.exceptions.TooManyRealtimeLogConfigsCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.AccessDeniedcreate_response_headers_policy(**kwargs)¶Creates a response headers policy.
A response headers policy contains information about a set of HTTP response headers and their values. To create a response headers policy, you provide some metadata about the policy, and a set of configurations that specify the response headers.
After you create a response headers policy, you can use its ID to attach it to one or more cache behaviors in a CloudFront distribution. When it’s attached to a cache behavior, CloudFront adds the headers in the policy to HTTP responses that it sends for requests that match the cache behavior.
See also: AWS API Documentation
Request Syntax
response = client.create_response_headers_policy(
ResponseHeadersPolicyConfig={
'Comment': 'string',
'Name': 'string',
'CorsConfig': {
'AccessControlAllowOrigins': {
'Quantity': 123,
'Items': [
'string',
]
},
'AccessControlAllowHeaders': {
'Quantity': 123,
'Items': [
'string',
]
},
'AccessControlAllowMethods': {
'Quantity': 123,
'Items': [
'GET'|'POST'|'OPTIONS'|'PUT'|'DELETE'|'PATCH'|'HEAD'|'ALL',
]
},
'AccessControlAllowCredentials': True|False,
'AccessControlExposeHeaders': {
'Quantity': 123,
'Items': [
'string',
]
},
'AccessControlMaxAgeSec': 123,
'OriginOverride': True|False
},
'SecurityHeadersConfig': {
'XSSProtection': {
'Override': True|False,
'Protection': True|False,
'ModeBlock': True|False,
'ReportUri': 'string'
},
'FrameOptions': {
'Override': True|False,
'FrameOption': 'DENY'|'SAMEORIGIN'
},
'ReferrerPolicy': {
'Override': True|False,
'ReferrerPolicy': 'no-referrer'|'no-referrer-when-downgrade'|'origin'|'origin-when-cross-origin'|'same-origin'|'strict-origin'|'strict-origin-when-cross-origin'|'unsafe-url'
},
'ContentSecurityPolicy': {
'Override': True|False,
'ContentSecurityPolicy': 'string'
},
'ContentTypeOptions': {
'Override': True|False
},
'StrictTransportSecurity': {
'Override': True|False,
'IncludeSubdomains': True|False,
'Preload': True|False,
'AccessControlMaxAgeSec': 123
}
},
'ServerTimingHeadersConfig': {
'Enabled': True|False,
'SamplingRate': 123.0
},
'CustomHeadersConfig': {
'Quantity': 123,
'Items': [
{
'Header': 'string',
'Value': 'string',
'Override': True|False
},
]
}
}
)
[REQUIRED]
Contains metadata about the response headers policy, and a set of configurations that specify the response headers.
A comment to describe the response headers policy.
The comment cannot be longer than 128 characters.
A name to identify the response headers policy.
The name must be unique for response headers policies in this Amazon Web Services account.
A configuration for a set of HTTP response headers that are used for cross-origin resource sharing (CORS).
A list of origins (domain names) that CloudFront can use as the value for the Access-Control-Allow-Origin HTTP response header.
For more information about the Access-Control-Allow-Origin HTTP response header, see Access-Control-Allow-Origin in the MDN Web Docs.
The number of origins in the list.
The list of origins (domain names). You can specify * to allow all origins.
A list of HTTP header names that CloudFront includes as values for the Access-Control-Allow-Headers HTTP response header.
For more information about the Access-Control-Allow-Headers HTTP response header, see Access-Control-Allow-Headers in the MDN Web Docs.
The number of HTTP header names in the list.
The list of HTTP header names. You can specify * to allow all headers.
A list of HTTP methods that CloudFront includes as values for the Access-Control-Allow-Methods HTTP response header.
For more information about the Access-Control-Allow-Methods HTTP response header, see Access-Control-Allow-Methods in the MDN Web Docs.
The number of HTTP methods in the list.
The list of HTTP methods. Valid values are:
GETDELETEHEADOPTIONSPATCHPOSTPUTALLALLis a special value that includes all of the listed HTTP methods.
A Boolean that CloudFront uses as the value for the Access-Control-Allow-Credentials HTTP response header.
For more information about the Access-Control-Allow-Credentials HTTP response header, see Access-Control-Allow-Credentials in the MDN Web Docs.
A list of HTTP headers that CloudFront includes as values for the Access-Control-Expose-Headers HTTP response header.
For more information about the Access-Control-Expose-Headers HTTP response header, see Access-Control-Expose-Headers in the MDN Web Docs.
The number of HTTP headers in the list.
The list of HTTP headers. You can specify * to expose all headers.
A number that CloudFront uses as the value for the Access-Control-Max-Age HTTP response header.
For more information about the Access-Control-Max-Age HTTP response header, see Access-Control-Max-Age in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides HTTP response headers received from the origin with the ones specified in this response headers policy.
A configuration for a set of security-related HTTP response headers.
Determines whether CloudFront includes the X-XSS-Protection HTTP response header and the header’s value.
For more information about the X-XSS-Protection HTTP response header, see X-XSS-Protection in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the X-XSS-Protection HTTP response header received from the origin with the one specified in this response headers policy.
A Boolean that determines the value of the X-XSS-Protection HTTP response header. When this setting is true , the value of the X-XSS-Protection header is 1 . When this setting is false , the value of the X-XSS-Protection header is 0 .
For more information about these settings, see X-XSS-Protection in the MDN Web Docs.
A Boolean that determines whether CloudFront includes the mode=block directive in the X-XSS-Protection header.
For more information about this directive, see X-XSS-Protection in the MDN Web Docs.
A reporting URI, which CloudFront uses as the value of the report directive in the X-XSS-Protection header.
You cannot specify a ReportUri when ModeBlock is true .
For more information about using a reporting URL, see X-XSS-Protection in the MDN Web Docs.
Determines whether CloudFront includes the X-Frame-Options HTTP response header and the header’s value.
For more information about the X-Frame-Options HTTP response header, see X-Frame-Options in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the X-Frame-Options HTTP response header received from the origin with the one specified in this response headers policy.
The value of the X-Frame-Options HTTP response header. Valid values are DENY and SAMEORIGIN .
For more information about these values, see X-Frame-Options in the MDN Web Docs.
Determines whether CloudFront includes the Referrer-Policy HTTP response header and the header’s value.
For more information about the Referrer-Policy HTTP response header, see Referrer-Policy in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the Referrer-Policy HTTP response header received from the origin with the one specified in this response headers policy.
The value of the Referrer-Policy HTTP response header. Valid values are:
no-referrerno-referrer-when-downgradeoriginorigin-when-cross-originsame-originstrict-originstrict-origin-when-cross-originunsafe-urlFor more information about these values, see Referrer-Policy in the MDN Web Docs.
The policy directives and their values that CloudFront includes as values for the Content-Security-Policy HTTP response header.
For more information about the Content-Security-Policy HTTP response header, see Content-Security-Policy in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the Content-Security-Policy HTTP response header received from the origin with the one specified in this response headers policy.
The policy directives and their values that CloudFront includes as values for the Content-Security-Policy HTTP response header.
Determines whether CloudFront includes the X-Content-Type-Options HTTP response header with its value set to nosniff .
For more information about the X-Content-Type-Options HTTP response header, see X-Content-Type-Options in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the X-Content-Type-Options HTTP response header received from the origin with the one specified in this response headers policy.
Determines whether CloudFront includes the Strict-Transport-Security HTTP response header and the header’s value.
For more information about the Strict-Transport-Security HTTP response header, see Strict-Transport-Security in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the Strict-Transport-Security HTTP response header received from the origin with the one specified in this response headers policy.
A Boolean that determines whether CloudFront includes the includeSubDomains directive in the Strict-Transport-Security HTTP response header.
A Boolean that determines whether CloudFront includes the preload directive in the Strict-Transport-Security HTTP response header.
A number that CloudFront uses as the value for the max-age directive in the Strict-Transport-Security HTTP response header.
A configuration for enabling the Server-Timing header in HTTP responses sent from CloudFront.
A Boolean that determines whether CloudFront adds the Server-Timing header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy.
A number 0–100 (inclusive) that specifies the percentage of responses that you want CloudFront to add the Server-Timing header to. When you set the sampling rate to 100, CloudFront adds the Server-Timing header to the HTTP response for every request that matches the cache behavior that this response headers policy is attached to. When you set it to 50, CloudFront adds the header to 50% of the responses for requests that match the cache behavior. You can set the sampling rate to any number 0–100 with up to four decimal places.
A configuration for a set of custom HTTP response headers.
The number of HTTP response headers in the list.
The list of HTTP response headers and their values.
An HTTP response header name and its value. CloudFront includes this header in HTTP responses that it sends for requests that match a cache behavior that’s associated with this response headers policy.
The HTTP response header name.
The value for the HTTP response header.
A Boolean that determines whether CloudFront overrides a response header with the same name received from the origin with the header specified here.
{
'ResponseHeadersPolicy': {
'Id': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'ResponseHeadersPolicyConfig': {
'Comment': 'string',
'Name': 'string',
'CorsConfig': {
'AccessControlAllowOrigins': {
'Quantity': 123,
'Items': [
'string',
]
},
'AccessControlAllowHeaders': {
'Quantity': 123,
'Items': [
'string',
]
},
'AccessControlAllowMethods': {
'Quantity': 123,
'Items': [
'GET'|'POST'|'OPTIONS'|'PUT'|'DELETE'|'PATCH'|'HEAD'|'ALL',
]
},
'AccessControlAllowCredentials': True|False,
'AccessControlExposeHeaders': {
'Quantity': 123,
'Items': [
'string',
]
},
'AccessControlMaxAgeSec': 123,
'OriginOverride': True|False
},
'SecurityHeadersConfig': {
'XSSProtection': {
'Override': True|False,
'Protection': True|False,
'ModeBlock': True|False,
'ReportUri': 'string'
},
'FrameOptions': {
'Override': True|False,
'FrameOption': 'DENY'|'SAMEORIGIN'
},
'ReferrerPolicy': {
'Override': True|False,
'ReferrerPolicy': 'no-referrer'|'no-referrer-when-downgrade'|'origin'|'origin-when-cross-origin'|'same-origin'|'strict-origin'|'strict-origin-when-cross-origin'|'unsafe-url'
},
'ContentSecurityPolicy': {
'Override': True|False,
'ContentSecurityPolicy': 'string'
},
'ContentTypeOptions': {
'Override': True|False
},
'StrictTransportSecurity': {
'Override': True|False,
'IncludeSubdomains': True|False,
'Preload': True|False,
'AccessControlMaxAgeSec': 123
}
},
'ServerTimingHeadersConfig': {
'Enabled': True|False,
'SamplingRate': 123.0
},
'CustomHeadersConfig': {
'Quantity': 123,
'Items': [
{
'Header': 'string',
'Value': 'string',
'Override': True|False
},
]
}
}
},
'Location': 'string',
'ETag': 'string'
}
Response Structure
Contains a response headers policy.
The identifier for the response headers policy.
The date and time when the response headers policy was last modified.
A response headers policy configuration.
A response headers policy contains information about a set of HTTP response headers and their values. CloudFront adds the headers in the policy to HTTP responses that it sends for requests that match a cache behavior that’s associated with the policy.
A comment to describe the response headers policy.
The comment cannot be longer than 128 characters.
A name to identify the response headers policy.
The name must be unique for response headers policies in this Amazon Web Services account.
A configuration for a set of HTTP response headers that are used for cross-origin resource sharing (CORS).
A list of origins (domain names) that CloudFront can use as the value for the Access-Control-Allow-Origin HTTP response header.
For more information about the Access-Control-Allow-Origin HTTP response header, see Access-Control-Allow-Origin in the MDN Web Docs.
The number of origins in the list.
The list of origins (domain names). You can specify * to allow all origins.
A list of HTTP header names that CloudFront includes as values for the Access-Control-Allow-Headers HTTP response header.
For more information about the Access-Control-Allow-Headers HTTP response header, see Access-Control-Allow-Headers in the MDN Web Docs.
The number of HTTP header names in the list.
The list of HTTP header names. You can specify * to allow all headers.
A list of HTTP methods that CloudFront includes as values for the Access-Control-Allow-Methods HTTP response header.
For more information about the Access-Control-Allow-Methods HTTP response header, see Access-Control-Allow-Methods in the MDN Web Docs.
The number of HTTP methods in the list.
The list of HTTP methods. Valid values are:
GETDELETEHEADOPTIONSPATCHPOSTPUTALLALLis a special value that includes all of the listed HTTP methods.
A Boolean that CloudFront uses as the value for the Access-Control-Allow-Credentials HTTP response header.
For more information about the Access-Control-Allow-Credentials HTTP response header, see Access-Control-Allow-Credentials in the MDN Web Docs.
A list of HTTP headers that CloudFront includes as values for the Access-Control-Expose-Headers HTTP response header.
For more information about the Access-Control-Expose-Headers HTTP response header, see Access-Control-Expose-Headers in the MDN Web Docs.
The number of HTTP headers in the list.
The list of HTTP headers. You can specify * to expose all headers.
A number that CloudFront uses as the value for the Access-Control-Max-Age HTTP response header.
For more information about the Access-Control-Max-Age HTTP response header, see Access-Control-Max-Age in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides HTTP response headers received from the origin with the ones specified in this response headers policy.
A configuration for a set of security-related HTTP response headers.
Determines whether CloudFront includes the X-XSS-Protection HTTP response header and the header’s value.
For more information about the X-XSS-Protection HTTP response header, see X-XSS-Protection in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the X-XSS-Protection HTTP response header received from the origin with the one specified in this response headers policy.
A Boolean that determines the value of the X-XSS-Protection HTTP response header. When this setting is true , the value of the X-XSS-Protection header is 1 . When this setting is false , the value of the X-XSS-Protection header is 0 .
For more information about these settings, see X-XSS-Protection in the MDN Web Docs.
A Boolean that determines whether CloudFront includes the mode=block directive in the X-XSS-Protection header.
For more information about this directive, see X-XSS-Protection in the MDN Web Docs.
A reporting URI, which CloudFront uses as the value of the report directive in the X-XSS-Protection header.
You cannot specify a ReportUri when ModeBlock is true .
For more information about using a reporting URL, see X-XSS-Protection in the MDN Web Docs.
Determines whether CloudFront includes the X-Frame-Options HTTP response header and the header’s value.
For more information about the X-Frame-Options HTTP response header, see X-Frame-Options in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the X-Frame-Options HTTP response header received from the origin with the one specified in this response headers policy.
The value of the X-Frame-Options HTTP response header. Valid values are DENY and SAMEORIGIN .
For more information about these values, see X-Frame-Options in the MDN Web Docs.
Determines whether CloudFront includes the Referrer-Policy HTTP response header and the header’s value.
For more information about the Referrer-Policy HTTP response header, see Referrer-Policy in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the Referrer-Policy HTTP response header received from the origin with the one specified in this response headers policy.
The value of the Referrer-Policy HTTP response header. Valid values are:
no-referrerno-referrer-when-downgradeoriginorigin-when-cross-originsame-originstrict-originstrict-origin-when-cross-originunsafe-urlFor more information about these values, see Referrer-Policy in the MDN Web Docs.
The policy directives and their values that CloudFront includes as values for the Content-Security-Policy HTTP response header.
For more information about the Content-Security-Policy HTTP response header, see Content-Security-Policy in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the Content-Security-Policy HTTP response header received from the origin with the one specified in this response headers policy.
The policy directives and their values that CloudFront includes as values for the Content-Security-Policy HTTP response header.
Determines whether CloudFront includes the X-Content-Type-Options HTTP response header with its value set to nosniff .
For more information about the X-Content-Type-Options HTTP response header, see X-Content-Type-Options in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the X-Content-Type-Options HTTP response header received from the origin with the one specified in this response headers policy.
Determines whether CloudFront includes the Strict-Transport-Security HTTP response header and the header’s value.
For more information about the Strict-Transport-Security HTTP response header, see Strict-Transport-Security in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the Strict-Transport-Security HTTP response header received from the origin with the one specified in this response headers policy.
A Boolean that determines whether CloudFront includes the includeSubDomains directive in the Strict-Transport-Security HTTP response header.
A Boolean that determines whether CloudFront includes the preload directive in the Strict-Transport-Security HTTP response header.
A number that CloudFront uses as the value for the max-age directive in the Strict-Transport-Security HTTP response header.
A configuration for enabling the Server-Timing header in HTTP responses sent from CloudFront.
A Boolean that determines whether CloudFront adds the Server-Timing header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy.
A number 0–100 (inclusive) that specifies the percentage of responses that you want CloudFront to add the Server-Timing header to. When you set the sampling rate to 100, CloudFront adds the Server-Timing header to the HTTP response for every request that matches the cache behavior that this response headers policy is attached to. When you set it to 50, CloudFront adds the header to 50% of the responses for requests that match the cache behavior. You can set the sampling rate to any number 0–100 with up to four decimal places.
A configuration for a set of custom HTTP response headers.
The number of HTTP response headers in the list.
The list of HTTP response headers and their values.
An HTTP response header name and its value. CloudFront includes this header in HTTP responses that it sends for requests that match a cache behavior that’s associated with this response headers policy.
The HTTP response header name.
The value for the HTTP response header.
A Boolean that determines whether CloudFront overrides a response header with the same name received from the origin with the header specified here.
The URL of the response headers policy.
The version identifier for the current version of the response headers policy.
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.InconsistentQuantitiesCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.ResponseHeadersPolicyAlreadyExistsCloudFront.Client.exceptions.TooManyResponseHeadersPoliciesCloudFront.Client.exceptions.TooManyCustomHeadersInResponseHeadersPolicyCloudFront.Client.exceptions.TooLongCSPInResponseHeadersPolicycreate_streaming_distribution(**kwargs)¶This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.
See also: AWS API Documentation
Request Syntax
response = client.create_streaming_distribution(
StreamingDistributionConfig={
'CallerReference': 'string',
'S3Origin': {
'DomainName': 'string',
'OriginAccessIdentity': 'string'
},
'Aliases': {
'Quantity': 123,
'Items': [
'string',
]
},
'Comment': 'string',
'Logging': {
'Enabled': True|False,
'Bucket': 'string',
'Prefix': 'string'
},
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'PriceClass': 'PriceClass_100'|'PriceClass_200'|'PriceClass_All',
'Enabled': True|False
}
)
[REQUIRED]
The streaming distribution's configuration information.
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of CallerReference is new (regardless of the content of the StreamingDistributionConfig object), CloudFront creates a new distribution.
If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.
A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.
The DNS name of the Amazon S3 origin.
The CloudFront origin access identity to associate with the distribution. Use an origin access identity to configure the distribution 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.
For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon CloudFront Developer Guide .
A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.
The number of CNAME aliases, if any, that you want to associate with this distribution.
A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
Any comments you want to include about the streaming distribution.
A complex type that controls whether access logs are written for the streaming distribution.
Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't 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.
The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com .
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 don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.
A complex type that specifies any Amazon Web Services accounts that you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services account identifiers.
A complex type that contains information about price class for this streaming distribution.
Whether the streaming distribution is enabled to accept user requests for content.
{
'StreamingDistribution': {
'Id': 'string',
'ARN': 'string',
'Status': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'DomainName': 'string',
'ActiveTrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
{
'AwsAccountNumber': 'string',
'KeyPairIds': {
'Quantity': 123,
'Items': [
'string',
]
}
},
]
},
'StreamingDistributionConfig': {
'CallerReference': 'string',
'S3Origin': {
'DomainName': 'string',
'OriginAccessIdentity': 'string'
},
'Aliases': {
'Quantity': 123,
'Items': [
'string',
]
},
'Comment': 'string',
'Logging': {
'Enabled': True|False,
'Bucket': 'string',
'Prefix': 'string'
},
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'PriceClass': 'PriceClass_100'|'PriceClass_200'|'PriceClass_All',
'Enabled': True|False
}
},
'Location': 'string',
'ETag': 'string'
}
Response Structure
The returned result of the corresponding request.
The streaming distribution's information.
The identifier for the RTMP distribution. For example: EGTXBD79EXAMPLE .
The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5 , where 123456789012 is your Amazon Web Services account ID.
The current status of the RTMP distribution. When the status is Deployed , the distribution's information is propagated to all CloudFront edge locations.
The date and time that the distribution was last modified.
The domain name that corresponds to the streaming distribution, for example, s5c39gqb8ow64r.cloudfront.net .
A complex type that lists the Amazon Web Services accounts, if any, that you included in the TrustedSigners complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.
The Signer complex type lists the Amazon Web Services account number of the trusted signer or self if the signer is the Amazon Web Services account that created the distribution. The Signer element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's Amazon Web Services account. If no KeyPairId element appears for a Signer , that signer can't create signed URLs.
For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
This field is true if any of the Amazon Web Services accounts in the list have active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services accounts and the identifiers of active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.
A list of Amazon Web Services accounts and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.
An Amazon Web Services account number that contains active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If the Amazon Web Services account that owns the key pairs is the same account that owns the CloudFront distribution, the value of this field is self .
A list of CloudFront key pair identifiers.
The number of key pair identifiers in the list.
A list of CloudFront key pair identifiers.
The current configuration information for the RTMP distribution.
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of CallerReference is new (regardless of the content of the StreamingDistributionConfig object), CloudFront creates a new distribution.
If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.
A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.
The DNS name of the Amazon S3 origin.
The CloudFront origin access identity to associate with the distribution. Use an origin access identity to configure the distribution 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.
For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon CloudFront Developer Guide .
A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.
The number of CNAME aliases, if any, that you want to associate with this distribution.
A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
Any comments you want to include about the streaming distribution.
A complex type that controls whether access logs are written for the streaming distribution.
Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't 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.
The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com .
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 don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.
A complex type that specifies any Amazon Web Services accounts that you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services account identifiers.
A complex type that contains information about price class for this streaming distribution.
Whether the streaming distribution is enabled to accept user requests for content.
The fully qualified URI of the new streaming distribution resource just created.
The current version of the streaming distribution created.
Exceptions
CloudFront.Client.exceptions.CNAMEAlreadyExistsCloudFront.Client.exceptions.StreamingDistributionAlreadyExistsCloudFront.Client.exceptions.InvalidOriginCloudFront.Client.exceptions.InvalidOriginAccessIdentityCloudFront.Client.exceptions.InvalidOriginAccessControlCloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.TooManyTrustedSignersCloudFront.Client.exceptions.TrustedSignerDoesNotExistCloudFront.Client.exceptions.MissingBodyCloudFront.Client.exceptions.TooManyStreamingDistributionCNAMEsCloudFront.Client.exceptions.TooManyStreamingDistributionsCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.InconsistentQuantitiesThis API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.
See also: AWS API Documentation
Request Syntax
response = client.create_streaming_distribution_with_tags(
StreamingDistributionConfigWithTags={
'StreamingDistributionConfig': {
'CallerReference': 'string',
'S3Origin': {
'DomainName': 'string',
'OriginAccessIdentity': 'string'
},
'Aliases': {
'Quantity': 123,
'Items': [
'string',
]
},
'Comment': 'string',
'Logging': {
'Enabled': True|False,
'Bucket': 'string',
'Prefix': 'string'
},
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'PriceClass': 'PriceClass_100'|'PriceClass_200'|'PriceClass_All',
'Enabled': True|False
},
'Tags': {
'Items': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
)
[REQUIRED]
The streaming distribution's configuration information.
A streaming distribution Configuration.
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of CallerReference is new (regardless of the content of the StreamingDistributionConfig object), CloudFront creates a new distribution.
If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.
A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.
The DNS name of the Amazon S3 origin.
The CloudFront origin access identity to associate with the distribution. Use an origin access identity to configure the distribution 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.
For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon CloudFront Developer Guide .
A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.
The number of CNAME aliases, if any, that you want to associate with this distribution.
A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
Any comments you want to include about the streaming distribution.
A complex type that controls whether access logs are written for the streaming distribution.
Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't 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.
The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com .
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 don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.
A complex type that specifies any Amazon Web Services accounts that you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services account identifiers.
A complex type that contains information about price class for this streaming distribution.
Whether the streaming distribution is enabled to accept user requests for content.
A complex type that contains zero or more Tag elements.
A complex type that contains Tag elements.
A complex type that contains Tag key and Tag value.
A string that contains Tag key.
The string length should be between 1 and 128 characters. Valid characters include a-z , A-Z , 0-9 , space, and the special characters _ - . : / = + @ .
A string that contains an optional Tag value.
The string length should be between 0 and 256 characters. Valid characters include a-z , A-Z , 0-9 , space, and the special characters _ - . : / = + @ .
{
'StreamingDistribution': {
'Id': 'string',
'ARN': 'string',
'Status': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'DomainName': 'string',
'ActiveTrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
{
'AwsAccountNumber': 'string',
'KeyPairIds': {
'Quantity': 123,
'Items': [
'string',
]
}
},
]
},
'StreamingDistributionConfig': {
'CallerReference': 'string',
'S3Origin': {
'DomainName': 'string',
'OriginAccessIdentity': 'string'
},
'Aliases': {
'Quantity': 123,
'Items': [
'string',
]
},
'Comment': 'string',
'Logging': {
'Enabled': True|False,
'Bucket': 'string',
'Prefix': 'string'
},
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'PriceClass': 'PriceClass_100'|'PriceClass_200'|'PriceClass_All',
'Enabled': True|False
}
},
'Location': 'string',
'ETag': 'string'
}
Response Structure
The returned result of the corresponding request.
The streaming distribution's information.
The identifier for the RTMP distribution. For example: EGTXBD79EXAMPLE .
The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5 , where 123456789012 is your Amazon Web Services account ID.
The current status of the RTMP distribution. When the status is Deployed , the distribution's information is propagated to all CloudFront edge locations.
The date and time that the distribution was last modified.
The domain name that corresponds to the streaming distribution, for example, s5c39gqb8ow64r.cloudfront.net .
A complex type that lists the Amazon Web Services accounts, if any, that you included in the TrustedSigners complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.
The Signer complex type lists the Amazon Web Services account number of the trusted signer or self if the signer is the Amazon Web Services account that created the distribution. The Signer element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's Amazon Web Services account. If no KeyPairId element appears for a Signer , that signer can't create signed URLs.
For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
This field is true if any of the Amazon Web Services accounts in the list have active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services accounts and the identifiers of active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.
A list of Amazon Web Services accounts and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.
An Amazon Web Services account number that contains active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If the Amazon Web Services account that owns the key pairs is the same account that owns the CloudFront distribution, the value of this field is self .
A list of CloudFront key pair identifiers.
The number of key pair identifiers in the list.
A list of CloudFront key pair identifiers.
The current configuration information for the RTMP distribution.
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of CallerReference is new (regardless of the content of the StreamingDistributionConfig object), CloudFront creates a new distribution.
If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.
A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.
The DNS name of the Amazon S3 origin.
The CloudFront origin access identity to associate with the distribution. Use an origin access identity to configure the distribution 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.
For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon CloudFront Developer Guide .
A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.
The number of CNAME aliases, if any, that you want to associate with this distribution.
A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
Any comments you want to include about the streaming distribution.
A complex type that controls whether access logs are written for the streaming distribution.
Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't 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.
The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com .
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 don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.
A complex type that specifies any Amazon Web Services accounts that you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services account identifiers.
A complex type that contains information about price class for this streaming distribution.
Whether the streaming distribution is enabled to accept user requests for content.
The fully qualified URI of the new streaming distribution resource just created.
The current version of the distribution created.
Exceptions
CloudFront.Client.exceptions.CNAMEAlreadyExistsCloudFront.Client.exceptions.StreamingDistributionAlreadyExistsCloudFront.Client.exceptions.InvalidOriginCloudFront.Client.exceptions.InvalidOriginAccessIdentityCloudFront.Client.exceptions.InvalidOriginAccessControlCloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.TooManyTrustedSignersCloudFront.Client.exceptions.TrustedSignerDoesNotExistCloudFront.Client.exceptions.MissingBodyCloudFront.Client.exceptions.TooManyStreamingDistributionCNAMEsCloudFront.Client.exceptions.TooManyStreamingDistributionsCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.InconsistentQuantitiesCloudFront.Client.exceptions.InvalidTaggingdelete_cache_policy(**kwargs)¶Deletes a cache policy.
You cannot delete a cache policy if it’s attached to a cache behavior. First update your distributions to remove the cache policy from all cache behaviors, then delete the cache policy.
To delete a cache policy, you must provide the policy’s identifier and version. To get these values, you can use ListCachePolicies or GetCachePolicy .
See also: AWS API Documentation
Request Syntax
response = client.delete_cache_policy(
Id='string',
IfMatch='string'
)
[REQUIRED]
The unique identifier for the cache policy that you are deleting. To get the identifier, you can use ListCachePolicies .
ETag value, which you can get using ListCachePolicies , GetCachePolicy , or GetCachePolicyConfig .None
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.InvalidIfMatchVersionCloudFront.Client.exceptions.NoSuchCachePolicyCloudFront.Client.exceptions.PreconditionFailedCloudFront.Client.exceptions.IllegalDeleteCloudFront.Client.exceptions.CachePolicyInUsedelete_cloud_front_origin_access_identity(**kwargs)¶Delete an origin access identity.
See also: AWS API Documentation
Request Syntax
response = client.delete_cloud_front_origin_access_identity(
Id='string',
IfMatch='string'
)
[REQUIRED]
The origin access identity's ID.
ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL .None
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.InvalidIfMatchVersionCloudFront.Client.exceptions.NoSuchCloudFrontOriginAccessIdentityCloudFront.Client.exceptions.PreconditionFailedCloudFront.Client.exceptions.CloudFrontOriginAccessIdentityInUsedelete_distribution(**kwargs)¶Delete a distribution.
See also: AWS API Documentation
Request Syntax
response = client.delete_distribution(
Id='string',
IfMatch='string'
)
[REQUIRED]
The distribution ID.
ETag header that you received when you disabled the distribution. For example: E2QWRUHAPOMQZL .None
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.DistributionNotDisabledCloudFront.Client.exceptions.InvalidIfMatchVersionCloudFront.Client.exceptions.NoSuchDistributionCloudFront.Client.exceptions.PreconditionFaileddelete_field_level_encryption_config(**kwargs)¶Remove a field-level encryption configuration.
See also: AWS API Documentation
Request Syntax
response = client.delete_field_level_encryption_config(
Id='string',
IfMatch='string'
)
[REQUIRED]
The ID of the configuration you want to delete from CloudFront.
ETag header that you received when retrieving the configuration identity to delete. For example: E2QWRUHAPOMQZL .None
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.InvalidIfMatchVersionCloudFront.Client.exceptions.NoSuchFieldLevelEncryptionConfigCloudFront.Client.exceptions.PreconditionFailedCloudFront.Client.exceptions.FieldLevelEncryptionConfigInUsedelete_field_level_encryption_profile(**kwargs)¶Remove a field-level encryption profile.
See also: AWS API Documentation
Request Syntax
response = client.delete_field_level_encryption_profile(
Id='string',
IfMatch='string'
)
[REQUIRED]
Request the ID of the profile you want to delete from CloudFront.
ETag header that you received when retrieving the profile to delete. For example: E2QWRUHAPOMQZL .None
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.InvalidIfMatchVersionCloudFront.Client.exceptions.NoSuchFieldLevelEncryptionProfileCloudFront.Client.exceptions.PreconditionFailedCloudFront.Client.exceptions.FieldLevelEncryptionProfileInUsedelete_function(**kwargs)¶Deletes a CloudFront function.
You cannot delete a function if it’s associated with a cache behavior. First, update your distributions to remove the function association from all cache behaviors, then delete the function.
To delete a function, you must provide the function’s name and version (ETag value). To get these values, you can use ListFunctions and DescribeFunction .
See also: AWS API Documentation
Request Syntax
response = client.delete_function(
Name='string',
IfMatch='string'
)
[REQUIRED]
The name of the function that you are deleting.
[REQUIRED]
The current version (ETag value) of the function that you are deleting, which you can get using DescribeFunction .
None
Exceptions
CloudFront.Client.exceptions.InvalidIfMatchVersionCloudFront.Client.exceptions.NoSuchFunctionExistsCloudFront.Client.exceptions.FunctionInUseCloudFront.Client.exceptions.PreconditionFailedCloudFront.Client.exceptions.UnsupportedOperationdelete_key_group(**kwargs)¶Deletes a key group.
You cannot delete a key group that is referenced in a cache behavior. First update your distributions to remove the key group from all cache behaviors, then delete the key group.
To delete a key group, you must provide the key group’s identifier and version. To get these values, use ListKeyGroups followed by GetKeyGroup or GetKeyGroupConfig .
See also: AWS API Documentation
Request Syntax
response = client.delete_key_group(
Id='string',
IfMatch='string'
)
[REQUIRED]
The identifier of the key group that you are deleting. To get the identifier, use ListKeyGroups .
ETag value. To get the ETag , use GetKeyGroup or GetKeyGroupConfig .None
Exceptions
CloudFront.Client.exceptions.InvalidIfMatchVersionCloudFront.Client.exceptions.NoSuchResourceCloudFront.Client.exceptions.PreconditionFailedCloudFront.Client.exceptions.ResourceInUsedelete_monitoring_subscription(**kwargs)¶Disables additional CloudWatch metrics for the specified CloudFront distribution.
See also: AWS API Documentation
Request Syntax
response = client.delete_monitoring_subscription(
DistributionId='string'
)
[REQUIRED]
The ID of the distribution that you are disabling metrics for.
{}
Response Structure
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.NoSuchDistributionCloudFront.Client.exceptions.NoSuchMonitoringSubscriptionCloudFront.Client.exceptions.UnsupportedOperationdelete_origin_access_control(**kwargs)¶Deletes a CloudFront origin access control.
You cannot delete an origin access control if it's in use. First, update all distributions to remove the origin access control from all origins, then delete the origin access control.
See also: AWS API Documentation
Request Syntax
response = client.delete_origin_access_control(
Id='string',
IfMatch='string'
)
[REQUIRED]
The unique identifier of the origin access control that you are deleting.
ETag value) of the origin access control that you are deleting.None
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.InvalidIfMatchVersionCloudFront.Client.exceptions.NoSuchOriginAccessControlCloudFront.Client.exceptions.PreconditionFailedCloudFront.Client.exceptions.OriginAccessControlInUsedelete_origin_request_policy(**kwargs)¶Deletes an origin request policy.
You cannot delete an origin request policy if it’s attached to any cache behaviors. First update your distributions to remove the origin request policy from all cache behaviors, then delete the origin request policy.
To delete an origin request policy, you must provide the policy’s identifier and version. To get the identifier, you can use ListOriginRequestPolicies or GetOriginRequestPolicy .
See also: AWS API Documentation
Request Syntax
response = client.delete_origin_request_policy(
Id='string',
IfMatch='string'
)
[REQUIRED]
The unique identifier for the origin request policy that you are deleting. To get the identifier, you can use ListOriginRequestPolicies .
ETag value, which you can get using ListOriginRequestPolicies , GetOriginRequestPolicy , or GetOriginRequestPolicyConfig .None
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.InvalidIfMatchVersionCloudFront.Client.exceptions.NoSuchOriginRequestPolicyCloudFront.Client.exceptions.PreconditionFailedCloudFront.Client.exceptions.IllegalDeleteCloudFront.Client.exceptions.OriginRequestPolicyInUsedelete_public_key(**kwargs)¶Remove a public key you previously added to CloudFront.
See also: AWS API Documentation
Request Syntax
response = client.delete_public_key(
Id='string',
IfMatch='string'
)
[REQUIRED]
The ID of the public key you want to remove from CloudFront.
ETag header that you received when retrieving the public key identity to delete. For example: E2QWRUHAPOMQZL .None
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.PublicKeyInUseCloudFront.Client.exceptions.InvalidIfMatchVersionCloudFront.Client.exceptions.NoSuchPublicKeyCloudFront.Client.exceptions.PreconditionFaileddelete_realtime_log_config(**kwargs)¶Deletes a real-time log configuration.
You cannot delete a real-time log configuration if it’s attached to a cache behavior. First update your distributions to remove the real-time log configuration from all cache behaviors, then delete the real-time log configuration.
To delete a real-time log configuration, you can provide the configuration’s name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to delete.
See also: AWS API Documentation
Request Syntax
response = client.delete_realtime_log_config(
Name='string',
ARN='string'
)
None
Exceptions
CloudFront.Client.exceptions.NoSuchRealtimeLogConfigCloudFront.Client.exceptions.RealtimeLogConfigInUseCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.AccessDenieddelete_response_headers_policy(**kwargs)¶Deletes a response headers policy.
You cannot delete a response headers policy if it’s attached to a cache behavior. First update your distributions to remove the response headers policy from all cache behaviors, then delete the response headers policy.
To delete a response headers policy, you must provide the policy’s identifier and version. To get these values, you can use ListResponseHeadersPolicies or GetResponseHeadersPolicy .
See also: AWS API Documentation
Request Syntax
response = client.delete_response_headers_policy(
Id='string',
IfMatch='string'
)
[REQUIRED]
The identifier for the response headers policy that you are deleting.
To get the identifier, you can use ListResponseHeadersPolicies .
The version of the response headers policy that you are deleting.
The version is the response headers policy’s ETag value, which you can get using ListResponseHeadersPolicies , GetResponseHeadersPolicy , or GetResponseHeadersPolicyConfig .
None
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.InvalidIfMatchVersionCloudFront.Client.exceptions.NoSuchResponseHeadersPolicyCloudFront.Client.exceptions.PreconditionFailedCloudFront.Client.exceptions.IllegalDeleteCloudFront.Client.exceptions.ResponseHeadersPolicyInUsedelete_streaming_distribution(**kwargs)¶Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.
To delete an RTMP distribution using the CloudFront API :
GET Streaming Distribution Config request to get the current configuration and the Etag header for the distribution.GET Streaming Distribution Config request to change the value of Enabled to false .PUT Streaming Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.PUT Streaming Distribution Config request to confirm that the distribution was successfully disabled.GET Streaming Distribution Config request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed .DELETE Streaming 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 Streaming Distribution Config request in Step 2.DELETE Streaming 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 .
See also: AWS API Documentation
Request Syntax
response = client.delete_streaming_distribution(
Id='string',
IfMatch='string'
)
[REQUIRED]
The distribution ID.
ETag header that you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL .None
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.StreamingDistributionNotDisabledCloudFront.Client.exceptions.InvalidIfMatchVersionCloudFront.Client.exceptions.NoSuchStreamingDistributionCloudFront.Client.exceptions.PreconditionFaileddescribe_function(**kwargs)¶Gets configuration information and metadata about a CloudFront function, but not the function’s code. To get a function’s code, use GetFunction .
To get configuration information and metadata about a function, you must provide the function’s name and stage. To get these values, you can use ListFunctions .
See also: AWS API Documentation
Request Syntax
response = client.describe_function(
Name='string',
Stage='DEVELOPMENT'|'LIVE'
)
[REQUIRED]
The name of the function that you are getting information about.
DEVELOPMENT or LIVE .dict
Response Syntax
{
'FunctionSummary': {
'Name': 'string',
'Status': 'string',
'FunctionConfig': {
'Comment': 'string',
'Runtime': 'cloudfront-js-1.0'
},
'FunctionMetadata': {
'FunctionARN': 'string',
'Stage': 'DEVELOPMENT'|'LIVE',
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1)
}
},
'ETag': 'string'
}
Response Structure
(dict) --
FunctionSummary (dict) --
Contains configuration information and metadata about a CloudFront function.
Name (string) --
The name of the CloudFront function.
Status (string) --
The status of the CloudFront function.
FunctionConfig (dict) --
Contains configuration information about a CloudFront function.
Comment (string) --
A comment to describe the function.
Runtime (string) --
The function’s runtime environment. The only valid value is cloudfront-js-1.0 .
FunctionMetadata (dict) --
Contains metadata about a CloudFront function.
FunctionARN (string) --
The Amazon Resource Name (ARN) of the function. The ARN uniquely identifies the function.
Stage (string) --
The stage that the function is in, either DEVELOPMENT or LIVE .
When a function is in the DEVELOPMENT stage, you can test the function with TestFunction , and update it with UpdateFunction .
When a function is in the LIVE stage, you can attach the function to a distribution’s cache behavior, using the function’s ARN.
CreatedTime (datetime) --
The date and time when the function was created.
LastModifiedTime (datetime) --
The date and time when the function was most recently updated.
ETag (string) --
The version identifier for the current version of the CloudFront function.
Exceptions
CloudFront.Client.exceptions.NoSuchFunctionExistsCloudFront.Client.exceptions.UnsupportedOperationget_cache_policy(**kwargs)¶Gets a cache policy, including the following metadata:
To get a cache policy, you must provide the policy’s identifier. If the cache policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution . If the cache policy is not attached to a cache behavior, you can get the identifier using ListCachePolicies .
See also: AWS API Documentation
Request Syntax
response = client.get_cache_policy(
Id='string'
)
[REQUIRED]
The unique identifier for the cache policy. If the cache policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution . If the cache policy is not attached to a cache behavior, you can get the identifier using ListCachePolicies .
{
'CachePolicy': {
'Id': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'CachePolicyConfig': {
'Comment': 'string',
'Name': 'string',
'DefaultTTL': 123,
'MaxTTL': 123,
'MinTTL': 123,
'ParametersInCacheKeyAndForwardedToOrigin': {
'EnableAcceptEncodingGzip': True|False,
'EnableAcceptEncodingBrotli': True|False,
'HeadersConfig': {
'HeaderBehavior': 'none'|'whitelist',
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'CookiesConfig': {
'CookieBehavior': 'none'|'whitelist'|'allExcept'|'all',
'Cookies': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'QueryStringsConfig': {
'QueryStringBehavior': 'none'|'whitelist'|'allExcept'|'all',
'QueryStrings': {
'Quantity': 123,
'Items': [
'string',
]
}
}
}
}
},
'ETag': 'string'
}
Response Structure
The cache policy.
The unique identifier for the cache policy.
The date and time when the cache policy was last modified.
The cache policy configuration.
A comment to describe the cache policy. The comment cannot be longer than 128 characters.
A unique name to identify the cache policy.
The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value as the object’s time to live (TTL) only when the origin does not send Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
The default value for this field is 86400 seconds (one day). If the value of MinTTL is more than 86400 seconds, then the default value for this field is the same as the value of MinTTL .
The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value only when the origin sends Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
The default value for this field is 31536000 seconds (one year). If the value of MinTTL or DefaultTTL is more than 31536000 seconds, then the default value for this field is the same as the value of DefaultTTL .
The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are automatically included in requests that CloudFront sends to the origin.
A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
This field is related to the EnableAcceptEncodingBrotli field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
Accept-Encoding headerFor more information, see Compression support in the Amazon CloudFront Developer Guide .
If you set this value to true , and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true , so including this header in an origin request policy has no effect.
If both of these fields are false , then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.
A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
This field is related to the EnableAcceptEncodingGzip field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
Accept-Encoding headerFor more information, see Compression support in the Amazon CloudFront Developer Guide .
If you set this value to true , and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true , so including this header in an origin request policy has no effect.
If both of these fields are false , then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.
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.
Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
none – HTTP headers are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any headers that are listed in an OriginRequestPolicy are included in origin requests.whitelist – The HTTP headers that are listed in the Headers type are included in the cache key and are automatically included in requests that CloudFront sends to the origin.Contains a list of HTTP header names.
The number of header names in the Items list.
A list of HTTP header names.
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.
Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
none – Cookies in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any cookies that are listed in an OriginRequestPolicy are included in origin requests.whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.allExcept – All cookies in viewer requests that are * not * listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.all – All cookies in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.Contains a list of cookie names.
The number of cookie names in the Items list.
A list of cookie names.
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.
Determines whether any URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
none – Query strings in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any query strings that are listed in an OriginRequestPolicy are included in origin requests.whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.allExcept – All query strings in viewer requests that are * not * listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.all – All query strings in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.Contains the specific query strings in viewer requests that either * are * or * are not * included in the cache key and automatically included in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the CachePolicyQueryStringsConfig type is set to whitelist (the listed query strings * are * included) or allExcept (the listed query strings * are not * included, but all other query strings are).
The number of query string names in the Items list.
A list of query string names.
The current version of the cache policy.
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.NoSuchCachePolicyget_cache_policy_config(**kwargs)¶Gets a cache policy configuration.
To get a cache policy configuration, you must provide the policy’s identifier. If the cache policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution . If the cache policy is not attached to a cache behavior, you can get the identifier using ListCachePolicies .
See also: AWS API Documentation
Request Syntax
response = client.get_cache_policy_config(
Id='string'
)
[REQUIRED]
The unique identifier for the cache policy. If the cache policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution . If the cache policy is not attached to a cache behavior, you can get the identifier using ListCachePolicies .
{
'CachePolicyConfig': {
'Comment': 'string',
'Name': 'string',
'DefaultTTL': 123,
'MaxTTL': 123,
'MinTTL': 123,
'ParametersInCacheKeyAndForwardedToOrigin': {
'EnableAcceptEncodingGzip': True|False,
'EnableAcceptEncodingBrotli': True|False,
'HeadersConfig': {
'HeaderBehavior': 'none'|'whitelist',
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'CookiesConfig': {
'CookieBehavior': 'none'|'whitelist'|'allExcept'|'all',
'Cookies': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'QueryStringsConfig': {
'QueryStringBehavior': 'none'|'whitelist'|'allExcept'|'all',
'QueryStrings': {
'Quantity': 123,
'Items': [
'string',
]
}
}
}
},
'ETag': 'string'
}
Response Structure
The cache policy configuration.
A comment to describe the cache policy. The comment cannot be longer than 128 characters.
A unique name to identify the cache policy.
The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value as the object’s time to live (TTL) only when the origin does not send Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
The default value for this field is 86400 seconds (one day). If the value of MinTTL is more than 86400 seconds, then the default value for this field is the same as the value of MinTTL .
The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value only when the origin sends Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
The default value for this field is 31536000 seconds (one year). If the value of MinTTL or DefaultTTL is more than 31536000 seconds, then the default value for this field is the same as the value of DefaultTTL .
The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are automatically included in requests that CloudFront sends to the origin.
A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
This field is related to the EnableAcceptEncodingBrotli field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
Accept-Encoding headerFor more information, see Compression support in the Amazon CloudFront Developer Guide .
If you set this value to true , and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true , so including this header in an origin request policy has no effect.
If both of these fields are false , then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.
A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
This field is related to the EnableAcceptEncodingGzip field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
Accept-Encoding headerFor more information, see Compression support in the Amazon CloudFront Developer Guide .
If you set this value to true , and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true , so including this header in an origin request policy has no effect.
If both of these fields are false , then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.
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.
Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
none – HTTP headers are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any headers that are listed in an OriginRequestPolicy are included in origin requests.whitelist – The HTTP headers that are listed in the Headers type are included in the cache key and are automatically included in requests that CloudFront sends to the origin.Contains a list of HTTP header names.
The number of header names in the Items list.
A list of HTTP header names.
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.
Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
none – Cookies in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any cookies that are listed in an OriginRequestPolicy are included in origin requests.whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.allExcept – All cookies in viewer requests that are * not * listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.all – All cookies in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.Contains a list of cookie names.
The number of cookie names in the Items list.
A list of cookie names.
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.
Determines whether any URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
none – Query strings in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any query strings that are listed in an OriginRequestPolicy are included in origin requests.whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.allExcept – All query strings in viewer requests that are * not * listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.all – All query strings in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.Contains the specific query strings in viewer requests that either * are * or * are not * included in the cache key and automatically included in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the CachePolicyQueryStringsConfig type is set to whitelist (the listed query strings * are * included) or allExcept (the listed query strings * are not * included, but all other query strings are).
The number of query string names in the Items list.
A list of query string names.
The current version of the cache policy.
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.NoSuchCachePolicyget_cloud_front_origin_access_identity(**kwargs)¶Get the information about an origin access identity.
See also: AWS API Documentation
Request Syntax
response = client.get_cloud_front_origin_access_identity(
Id='string'
)
[REQUIRED]
The identity's ID.
{
'CloudFrontOriginAccessIdentity': {
'Id': 'string',
'S3CanonicalUserId': 'string',
'CloudFrontOriginAccessIdentityConfig': {
'CallerReference': 'string',
'Comment': 'string'
}
},
'ETag': 'string'
}
Response Structure
The returned result of the corresponding request.
The origin access identity's information.
The ID for the origin access identity, for example, E74FTE3AJFJ256A .
The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3.
The current configuration information for the identity.
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of CallerReference is new (regardless of the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created.
If the CallerReference is a value already sent in a previous identity request, 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.
A comment to describe the origin access identity. The comment cannot be longer than 128 characters.
The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL .
Exceptions
CloudFront.Client.exceptions.NoSuchCloudFrontOriginAccessIdentityCloudFront.Client.exceptions.AccessDeniedget_cloud_front_origin_access_identity_config(**kwargs)¶Get the configuration information about an origin access identity.
See also: AWS API Documentation
Request Syntax
response = client.get_cloud_front_origin_access_identity_config(
Id='string'
)
[REQUIRED]
The identity's ID.
{
'CloudFrontOriginAccessIdentityConfig': {
'CallerReference': 'string',
'Comment': 'string'
},
'ETag': 'string'
}
Response Structure
The returned result of the corresponding request.
The origin access identity's configuration information.
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of CallerReference is new (regardless of the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created.
If the CallerReference is a value already sent in a previous identity request, 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.
A comment to describe the origin access identity. The comment cannot be longer than 128 characters.
The current version of the configuration. For example: E2QWRUHAPOMQZL .
Exceptions
CloudFront.Client.exceptions.NoSuchCloudFrontOriginAccessIdentityCloudFront.Client.exceptions.AccessDeniedget_distribution(**kwargs)¶Get the information about a distribution.
See also: AWS API Documentation
Request Syntax
response = client.get_distribution(
Id='string'
)
[REQUIRED]
The distribution's ID. If the ID is empty, an empty distribution configuration is returned.
{
'Distribution': {
'Id': 'string',
'ARN': 'string',
'Status': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'InProgressInvalidationBatches': 123,
'DomainName': 'string',
'ActiveTrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
{
'AwsAccountNumber': 'string',
'KeyPairIds': {
'Quantity': 123,
'Items': [
'string',
]
}
},
]
},
'ActiveTrustedKeyGroups': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
{
'KeyGroupId': 'string',
'KeyPairIds': {
'Quantity': 123,
'Items': [
'string',
]
}
},
]
},
'DistributionConfig': {
'CallerReference': 'string',
'Aliases': {
'Quantity': 123,
'Items': [
'string',
]
},
'DefaultRootObject': 'string',
'Origins': {
'Quantity': 123,
'Items': [
{
'Id': 'string',
'DomainName': 'string',
'OriginPath': 'string',
'CustomHeaders': {
'Quantity': 123,
'Items': [
{
'HeaderName': 'string',
'HeaderValue': 'string'
},
]
},
'S3OriginConfig': {
'OriginAccessIdentity': 'string'
},
'CustomOriginConfig': {
'HTTPPort': 123,
'HTTPSPort': 123,
'OriginProtocolPolicy': 'http-only'|'match-viewer'|'https-only',
'OriginSslProtocols': {
'Quantity': 123,
'Items': [
'SSLv3'|'TLSv1'|'TLSv1.1'|'TLSv1.2',
]
},
'OriginReadTimeout': 123,
'OriginKeepaliveTimeout': 123
},
'ConnectionAttempts': 123,
'ConnectionTimeout': 123,
'OriginShield': {
'Enabled': True|False,
'OriginShieldRegion': 'string'
},
'OriginAccessControlId': 'string'
},
]
},
'OriginGroups': {
'Quantity': 123,
'Items': [
{
'Id': 'string',
'FailoverCriteria': {
'StatusCodes': {
'Quantity': 123,
'Items': [
123,
]
}
},
'Members': {
'Quantity': 123,
'Items': [
{
'OriginId': 'string'
},
]
}
},
]
},
'DefaultCacheBehavior': {
'TargetOriginId': 'string',
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'TrustedKeyGroups': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'ViewerProtocolPolicy': 'allow-all'|'https-only'|'redirect-to-https',
'AllowedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
],
'CachedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
]
}
},
'SmoothStreaming': True|False,
'Compress': True|False,
'LambdaFunctionAssociations': {
'Quantity': 123,
'Items': [
{
'LambdaFunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response',
'IncludeBody': True|False
},
]
},
'FunctionAssociations': {
'Quantity': 123,
'Items': [
{
'FunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response'
},
]
},
'FieldLevelEncryptionId': 'string',
'RealtimeLogConfigArn': 'string',
'CachePolicyId': 'string',
'OriginRequestPolicyId': 'string',
'ResponseHeadersPolicyId': 'string',
'ForwardedValues': {
'QueryString': True|False,
'Cookies': {
'Forward': 'none'|'whitelist'|'all',
'WhitelistedNames': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
},
'QueryStringCacheKeys': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'MinTTL': 123,
'DefaultTTL': 123,
'MaxTTL': 123
},
'CacheBehaviors': {
'Quantity': 123,
'Items': [
{
'PathPattern': 'string',
'TargetOriginId': 'string',
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'TrustedKeyGroups': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'ViewerProtocolPolicy': 'allow-all'|'https-only'|'redirect-to-https',
'AllowedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
],
'CachedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
]
}
},
'SmoothStreaming': True|False,
'Compress': True|False,
'LambdaFunctionAssociations': {
'Quantity': 123,
'Items': [
{
'LambdaFunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response',
'IncludeBody': True|False
},
]
},
'FunctionAssociations': {
'Quantity': 123,
'Items': [
{
'FunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response'
},
]
},
'FieldLevelEncryptionId': 'string',
'RealtimeLogConfigArn': 'string',
'CachePolicyId': 'string',
'OriginRequestPolicyId': 'string',
'ResponseHeadersPolicyId': 'string',
'ForwardedValues': {
'QueryString': True|False,
'Cookies': {
'Forward': 'none'|'whitelist'|'all',
'WhitelistedNames': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
},
'QueryStringCacheKeys': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'MinTTL': 123,
'DefaultTTL': 123,
'MaxTTL': 123
},
]
},
'CustomErrorResponses': {
'Quantity': 123,
'Items': [
{
'ErrorCode': 123,
'ResponsePagePath': 'string',
'ResponseCode': 'string',
'ErrorCachingMinTTL': 123
},
]
},
'Comment': 'string',
'Logging': {
'Enabled': True|False,
'IncludeCookies': True|False,
'Bucket': 'string',
'Prefix': 'string'
},
'PriceClass': 'PriceClass_100'|'PriceClass_200'|'PriceClass_All',
'Enabled': True|False,
'ViewerCertificate': {
'CloudFrontDefaultCertificate': True|False,
'IAMCertificateId': 'string',
'ACMCertificateArn': 'string',
'SSLSupportMethod': 'sni-only'|'vip'|'static-ip',
'MinimumProtocolVersion': 'SSLv3'|'TLSv1'|'TLSv1_2016'|'TLSv1.1_2016'|'TLSv1.2_2018'|'TLSv1.2_2019'|'TLSv1.2_2021',
'Certificate': 'string',
'CertificateSource': 'cloudfront'|'iam'|'acm'
},
'Restrictions': {
'GeoRestriction': {
'RestrictionType': 'blacklist'|'whitelist'|'none',
'Quantity': 123,
'Items': [
'string',
]
}
},
'WebACLId': 'string',
'HttpVersion': 'http1.1'|'http2'|'http3'|'http2and3',
'IsIPV6Enabled': True|False
},
'AliasICPRecordals': [
{
'CNAME': 'string',
'ICPRecordalStatus': 'APPROVED'|'SUSPENDED'|'PENDING'
},
]
},
'ETag': 'string'
}
Response Structure
The returned result of the corresponding request.
The distribution's information.
The identifier for the distribution. For example: EDFDVBD632BHDS5 .
The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5 , where 123456789012 is your Amazon Web Services account ID.
This response element indicates the current status of the distribution. When the status is Deployed , the distribution's information is fully propagated to all CloudFront edge locations.
The date and time the distribution was last modified.
The number of invalidation batches currently in progress.
The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net .
Warning
We recommend using TrustedKeyGroups instead of TrustedSigners .
CloudFront automatically adds this field to the response if you’ve configured a cache behavior in this distribution to serve private content using trusted signers. This field contains a list of Amazon Web Services account IDs and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs or signed cookies.
This field is true if any of the Amazon Web Services accounts in the list have active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services accounts and the identifiers of active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.
A list of Amazon Web Services accounts and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.
An Amazon Web Services account number that contains active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If the Amazon Web Services account that owns the key pairs is the same account that owns the CloudFront distribution, the value of this field is self .
A list of CloudFront key pair identifiers.
The number of key pair identifiers in the list.
A list of CloudFront key pair identifiers.
CloudFront automatically adds this field to the response if you’ve configured a cache behavior in this distribution to serve private content using key groups. This field contains a list of key groups and the public keys in each key group that CloudFront can use to verify the signatures of signed URLs or signed cookies.
This field is true if any of the key groups have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of key groups in the list.
A list of key groups, including the identifiers of the public keys in each key group that CloudFront can use to verify the signatures of signed URLs and signed cookies.
A list of identifiers for the public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies.
The identifier of the key group that contains the public keys.
A list of CloudFront key pair identifiers.
The number of key pair identifiers in the list.
A list of CloudFront key pair identifiers.
The current configuration information for the distribution. Send a GET request to the /*CloudFront API version* /distribution ID/config resource.
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of CallerReference is new (regardless of the content of the DistributionConfig object), CloudFront creates a new distribution.
If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
The number of CNAME aliases, if any, that you want to associate with this distribution.
A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
The object that you want CloudFront to request from your origin (for example, index.html ) when a viewer requests the root URL for your distribution (http://www.example.com ) instead of an object in your distribution (http://www.example.com/product-description.html ). Specifying a default root object avoids exposing the contents of your distribution.
Specify only the object name, for example, index.html . Don't add a / before the object name.
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.
For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide .
A complex type that contains information about origins for this distribution.
The number of origins for this distribution.
A list of origins.
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:
S3OriginConfig to specify an Amazon S3 bucket that is not configured with static website hosting.CustomOriginConfig to specify all other kinds of origins, including: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).
A unique identifier for the origin. This value must be unique within the distribution.
Use this value to specify the TargetOriginId in a CacheBehavior or DefaultCacheBehavior .
The domain name for the origin.
For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide .
An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
For more information, see Origin Path in the Amazon CloudFront Developer Guide .
A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.
For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .
The number of custom headers, if any, for this distribution.
Optional : A list that contains oneOriginCustomHeaderelement for each custom header that you want CloudFront to forward to the origin. If Quantity is0, omitItems.
A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution.
The name of a header that you want CloudFront to send to your origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .
The value for the header that you specified in the HeaderName field.
Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the CustomOriginConfig type instead.
The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
origin-access-identity/cloudfront/ID-of-origin-access-identity
where `` ID-of-origin-access-identity `` is the value that CloudFront returned in the ID element when you created the origin access identity.
If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.
To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.
To replace the origin access identity, update the distribution configuration and specify the new origin access identity.
For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.
The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:
http-only – CloudFront always uses HTTP to connect to the origin.match-viewer – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.https-only – CloudFront always uses HTTPS to connect to the origin.Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include SSLv3 , TLSv1 , TLSv1.1 , and TLSv1.2 .
For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide .
The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.
A list that contains allowed SSL/TLS protocols for this distribution.
Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout . The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 30 seconds.
For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide .
Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 5 seconds.
For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide .
The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don’t specify otherwise) is 3.
For a custom origin (including an Amazon S3 bucket that’s configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout .
For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide .
The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don’t specify otherwise) is 10 seconds.
For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide .
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 .
A flag that specifies whether Origin Shield is enabled.
When it’s enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it’s disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.
The Amazon Web Services Region for Origin Shield.
Specify the Amazon Web Services Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as us-east-2 .
When you enable CloudFront Origin Shield, you must specify the Amazon Web Services Region for Origin Shield. For the list of Amazon Web Services Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the Amazon Web Services Region for Origin Shield in the Amazon CloudFront Developer Guide .
The unique identifier of an origin access control for this origin.
For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide .
A complex type that contains information about origin groups for this distribution.
The number of origin groups.
The items (origin groups) in a distribution.
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.
The origin group's ID.
A complex type that contains information about the failover criteria for an origin group.
The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.
The number of status codes.
The items (status codes) for an origin group.
A complex type that contains information about the origins in an origin group.
The number of origins in an origin group.
Items (origins) in an origin group.
An origin in an origin group.
The ID for an origin in an origin group.
A complex type that describes the default cache behavior if you don't 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.
The value of ID for the origin that you want CloudFront to route requests to when they use the default cache behavior.
Warning
We recommend using TrustedKeyGroups instead of TrustedSigners .
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer’s Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services account identifiers.
A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of key groups in the list.
A list of key groups identifiers.
The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern . You can specify the following options:
allow-all : Viewers can use HTTP or HTTPS.redirect-to-https : If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only : If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide .
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:
GET and HEAD requests.GET , HEAD , and OPTIONS requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
GET and HEAD requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true ; if not, specify false . If you specify true for SmoothStreaming , you can still distribute other content using this cache behavior if the content matches the value of PathPattern .
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true ; if not, specify false . For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
The number of Lambda@Edge function associations for this cache behavior.
Optional : A complex type that containsLambdaFunctionAssociationitems for this cache behavior. IfQuantityis0, you can omitItems.
A complex type that contains a Lambda@Edge function association.
The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request : The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request : The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response : The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response : The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.
The number of CloudFront functions in the list.
The 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.
A CloudFront function that is associated with a cache behavior in a CloudFront distribution.
The Amazon Resource Name (ARN) of the function.
The event type of the function, either viewer-request or viewer-response . You cannot use origin-facing event types (origin-request and origin-response ) with a CloudFront function.
The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior.
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide .
The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
The identifier for a response headers policy.
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide .
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed 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 or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 .
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys , if any:
If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
If you specify false for QueryString , CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 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 How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide .
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.
Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 .
Required if you specify whitelist for the value of Forward . A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.
If you specify all or none for the value of Forward , omit WhitelistedNames . If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.
For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference .
The number of cookie names in the Items list.
A list of cookie names.
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 headers 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 headers 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 the Headers , if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.
For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide .
The number of header names in the Items list.
A list of HTTP header names.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
The number of whitelisted query string parameters for a cache behavior.
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items .
This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers , if you specify 1 for Quantity and * for Name ).
This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The default amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The maximum amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
A complex type that contains zero or more CacheBehavior elements.
The number of cache behaviors for this distribution.
Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0 , you can omit Items .
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 .
The pattern (for example, images/*.jpg ) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.
Note
You can optionally include a slash (/ ) at the beginning of the path pattern. For example, /images/*.jpg . CloudFront behavior is the same with or without the leading / .
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.
For more information, see Path Pattern in the Amazon CloudFront Developer Guide .
The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.
Warning
We recommend using TrustedKeyGroups instead of TrustedSigners .
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer’s Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services account identifiers.
A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of key groups in the list.
A list of key groups identifiers.
The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern . You can specify the following options:
allow-all : Viewers can use HTTP or HTTPS.redirect-to-https : If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only : If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide .
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:
GET and HEAD requests.GET , HEAD , and OPTIONS requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
GET and HEAD requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true ; if not, specify false . If you specify true for SmoothStreaming , you can still distribute other content using this cache behavior if the content matches the value of PathPattern .
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
The number of Lambda@Edge function associations for this cache behavior.
Optional : A complex type that containsLambdaFunctionAssociationitems for this cache behavior. IfQuantityis0, you can omitItems.
A complex type that contains a Lambda@Edge function association.
The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request : The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request : The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response : The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response : The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.
The number of CloudFront functions in the list.
The 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.
A CloudFront function that is associated with a cache behavior in a CloudFront distribution.
The Amazon Resource Name (ARN) of the function.
The event type of the function, either viewer-request or viewer-response . You cannot use origin-facing event types (origin-request and origin-response ) with a CloudFront function.
The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide .
The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
A CacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
The identifier for a response headers policy.
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide .
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed 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 or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
A CacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 .
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys , if any:
If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
If you specify false for QueryString , CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 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 How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide .
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.
Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 .
Required if you specify whitelist for the value of Forward . A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.
If you specify all or none for the value of Forward , omit WhitelistedNames . If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.
For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference .
The number of cookie names in the Items list.
A list of cookie names.
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 headers 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 headers 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 the Headers , if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.
For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide .
The number of header names in the Items list.
A list of HTTP header names.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
The number of whitelisted query string parameters for a cache behavior.
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items .
This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers , if you specify 1 for Quantity and * for Name ).
This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The default amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The maximum amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
A complex type that controls the following:
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0 , you can omit Items .
A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration.
A complex type that controls:
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
The HTTP status code for which you want to specify a custom error page and/or a caching duration.
The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode , for example, /4xx-errors/403-forbidden.html . If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:
PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors . Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, /4xx-errors/* .TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages.If you specify a value for ResponsePagePath , you must also specify a value for ResponseCode .
We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.
The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:
200 , the response typically won't be intercepted.400 or 500 as the ResponseCode for all 4xx or 5xx errors.200 status code (OK) and static website so your customers don't know that your website is down.If you specify a value for ResponseCode , you must also specify a value for ResponsePagePath .
The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode . When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.
For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
An optional comment to describe the distribution. The comment cannot be longer than 128 characters.
A complex type that controls whether access logs are written for the distribution.
For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide .
Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't 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.
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 don't 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 .
The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com .
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 don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.
The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All , CloudFront responds to requests for your objects from all CloudFront edge locations.
If you specify a price class other than PriceClass_All , CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.
For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide . For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing .
From this field, you can enable or disable the selected distribution.
A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net , set this field to true .
If the distribution uses Aliases (alternate domain names or CNAMEs), set this field to false and specify values for the following fields:
ACMCertificateArn or IAMCertificateId (specify a value for one, not both)MinimumProtocolVersionSSLSupportMethodIf the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Identity and Access Management (IAM) , provide the ID of the IAM certificate.
If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVersion and SSLSupportMethod .
If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Certificate Manager (ACM) , provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (us-east-1 ).
If you specify an ACM certificate ARN, you must also specify values for MinimumProtocolVersion and SSLSupportMethod .
If the distribution uses Aliases (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.
sni-only – The distribution accepts HTTPS connections from only viewers that support server name indication (SNI) . This is recommended. Most browsers and clients support SNI.vip – The distribution accepts HTTPS connections from all viewers including those that don’t support SNI. This is not recommended, and results in additional monthly charges from CloudFront.static-ip - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the Amazon Web Services Support Center .If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net , don’t set a value for this field.
If the distribution uses Aliases (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:
For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
On the CloudFront console, this setting is called Security Policy .
When you’re using SNI only (you set SSLSupportMethod to sni-only ), you must specify TLSv1 or higher.
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net (you set CloudFrontDefaultCertificate to true ), CloudFront automatically sets the security policy to TLSv1 regardless of the value that you set here.
This field is deprecated. Use one of the following fields instead:
ACMCertificateArnIAMCertificateIdCloudFrontDefaultCertificateThis field is deprecated. Use one of the following fields instead:
ACMCertificateArnIAMCertificateIdCloudFrontDefaultCertificateA complex type that identifies ways in which you want to restrict distribution of your content.
A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.
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 don't want CloudFront to distribute your content.whitelist : The Location elements specify the countries in which you want CloudFront to distribute your content.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 .
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 on the CloudFront console, which includes both country names and codes.
A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a . To specify a web ACL created using WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a .
WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the WAF Developer Guide .
(Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2 . Viewers that don't support HTTP/2 automatically use an earlier HTTP version.
For viewers and CloudFront to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI).
For viewers and CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CloudFront supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see Connection Migration at RFC 9000. For more information about supported TLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront .
If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true . If you specify false , CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.
In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide .
If you're using an Route 53 Amazon Web Services Integration alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:
For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Route 53 Amazon Web Services Integration Developer Guide .
If you created a CNAME resource record set, either with Route 53 Amazon Web Services Integration or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.
Amazon Web Services 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.
For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China .
Amazon Web Services 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 Amazon Web Services services in China .
A domain name associated with a distribution.
The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in regions outside of China.
The status values returned are the following:
The current version of the distribution's information. For example: E2QWRUHAPOMQZL .
Exceptions
CloudFront.Client.exceptions.NoSuchDistributionCloudFront.Client.exceptions.AccessDeniedget_distribution_config(**kwargs)¶Get the configuration information about a distribution.
See also: AWS API Documentation
Request Syntax
response = client.get_distribution_config(
Id='string'
)
[REQUIRED]
The distribution's ID. If the ID is empty, an empty distribution configuration is returned.
{
'DistributionConfig': {
'CallerReference': 'string',
'Aliases': {
'Quantity': 123,
'Items': [
'string',
]
},
'DefaultRootObject': 'string',
'Origins': {
'Quantity': 123,
'Items': [
{
'Id': 'string',
'DomainName': 'string',
'OriginPath': 'string',
'CustomHeaders': {
'Quantity': 123,
'Items': [
{
'HeaderName': 'string',
'HeaderValue': 'string'
},
]
},
'S3OriginConfig': {
'OriginAccessIdentity': 'string'
},
'CustomOriginConfig': {
'HTTPPort': 123,
'HTTPSPort': 123,
'OriginProtocolPolicy': 'http-only'|'match-viewer'|'https-only',
'OriginSslProtocols': {
'Quantity': 123,
'Items': [
'SSLv3'|'TLSv1'|'TLSv1.1'|'TLSv1.2',
]
},
'OriginReadTimeout': 123,
'OriginKeepaliveTimeout': 123
},
'ConnectionAttempts': 123,
'ConnectionTimeout': 123,
'OriginShield': {
'Enabled': True|False,
'OriginShieldRegion': 'string'
},
'OriginAccessControlId': 'string'
},
]
},
'OriginGroups': {
'Quantity': 123,
'Items': [
{
'Id': 'string',
'FailoverCriteria': {
'StatusCodes': {
'Quantity': 123,
'Items': [
123,
]
}
},
'Members': {
'Quantity': 123,
'Items': [
{
'OriginId': 'string'
},
]
}
},
]
},
'DefaultCacheBehavior': {
'TargetOriginId': 'string',
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'TrustedKeyGroups': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'ViewerProtocolPolicy': 'allow-all'|'https-only'|'redirect-to-https',
'AllowedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
],
'CachedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
]
}
},
'SmoothStreaming': True|False,
'Compress': True|False,
'LambdaFunctionAssociations': {
'Quantity': 123,
'Items': [
{
'LambdaFunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response',
'IncludeBody': True|False
},
]
},
'FunctionAssociations': {
'Quantity': 123,
'Items': [
{
'FunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response'
},
]
},
'FieldLevelEncryptionId': 'string',
'RealtimeLogConfigArn': 'string',
'CachePolicyId': 'string',
'OriginRequestPolicyId': 'string',
'ResponseHeadersPolicyId': 'string',
'ForwardedValues': {
'QueryString': True|False,
'Cookies': {
'Forward': 'none'|'whitelist'|'all',
'WhitelistedNames': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
},
'QueryStringCacheKeys': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'MinTTL': 123,
'DefaultTTL': 123,
'MaxTTL': 123
},
'CacheBehaviors': {
'Quantity': 123,
'Items': [
{
'PathPattern': 'string',
'TargetOriginId': 'string',
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'TrustedKeyGroups': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'ViewerProtocolPolicy': 'allow-all'|'https-only'|'redirect-to-https',
'AllowedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
],
'CachedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
]
}
},
'SmoothStreaming': True|False,
'Compress': True|False,
'LambdaFunctionAssociations': {
'Quantity': 123,
'Items': [
{
'LambdaFunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response',
'IncludeBody': True|False
},
]
},
'FunctionAssociations': {
'Quantity': 123,
'Items': [
{
'FunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response'
},
]
},
'FieldLevelEncryptionId': 'string',
'RealtimeLogConfigArn': 'string',
'CachePolicyId': 'string',
'OriginRequestPolicyId': 'string',
'ResponseHeadersPolicyId': 'string',
'ForwardedValues': {
'QueryString': True|False,
'Cookies': {
'Forward': 'none'|'whitelist'|'all',
'WhitelistedNames': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
},
'QueryStringCacheKeys': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'MinTTL': 123,
'DefaultTTL': 123,
'MaxTTL': 123
},
]
},
'CustomErrorResponses': {
'Quantity': 123,
'Items': [
{
'ErrorCode': 123,
'ResponsePagePath': 'string',
'ResponseCode': 'string',
'ErrorCachingMinTTL': 123
},
]
},
'Comment': 'string',
'Logging': {
'Enabled': True|False,
'IncludeCookies': True|False,
'Bucket': 'string',
'Prefix': 'string'
},
'PriceClass': 'PriceClass_100'|'PriceClass_200'|'PriceClass_All',
'Enabled': True|False,
'ViewerCertificate': {
'CloudFrontDefaultCertificate': True|False,
'IAMCertificateId': 'string',
'ACMCertificateArn': 'string',
'SSLSupportMethod': 'sni-only'|'vip'|'static-ip',
'MinimumProtocolVersion': 'SSLv3'|'TLSv1'|'TLSv1_2016'|'TLSv1.1_2016'|'TLSv1.2_2018'|'TLSv1.2_2019'|'TLSv1.2_2021',
'Certificate': 'string',
'CertificateSource': 'cloudfront'|'iam'|'acm'
},
'Restrictions': {
'GeoRestriction': {
'RestrictionType': 'blacklist'|'whitelist'|'none',
'Quantity': 123,
'Items': [
'string',
]
}
},
'WebACLId': 'string',
'HttpVersion': 'http1.1'|'http2'|'http3'|'http2and3',
'IsIPV6Enabled': True|False
},
'ETag': 'string'
}
Response Structure
The returned result of the corresponding request.
The distribution's configuration information.
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of CallerReference is new (regardless of the content of the DistributionConfig object), CloudFront creates a new distribution.
If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
The number of CNAME aliases, if any, that you want to associate with this distribution.
A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
The object that you want CloudFront to request from your origin (for example, index.html ) when a viewer requests the root URL for your distribution (http://www.example.com ) instead of an object in your distribution (http://www.example.com/product-description.html ). Specifying a default root object avoids exposing the contents of your distribution.
Specify only the object name, for example, index.html . Don't add a / before the object name.
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.
For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide .
A complex type that contains information about origins for this distribution.
The number of origins for this distribution.
A list of origins.
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:
S3OriginConfig to specify an Amazon S3 bucket that is not configured with static website hosting.CustomOriginConfig to specify all other kinds of origins, including: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).
A unique identifier for the origin. This value must be unique within the distribution.
Use this value to specify the TargetOriginId in a CacheBehavior or DefaultCacheBehavior .
The domain name for the origin.
For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide .
An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
For more information, see Origin Path in the Amazon CloudFront Developer Guide .
A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.
For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .
The number of custom headers, if any, for this distribution.
Optional : A list that contains oneOriginCustomHeaderelement for each custom header that you want CloudFront to forward to the origin. If Quantity is0, omitItems.
A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution.
The name of a header that you want CloudFront to send to your origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .
The value for the header that you specified in the HeaderName field.
Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the CustomOriginConfig type instead.
The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
origin-access-identity/cloudfront/ID-of-origin-access-identity
where `` ID-of-origin-access-identity `` is the value that CloudFront returned in the ID element when you created the origin access identity.
If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.
To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.
To replace the origin access identity, update the distribution configuration and specify the new origin access identity.
For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.
The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:
http-only – CloudFront always uses HTTP to connect to the origin.match-viewer – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.https-only – CloudFront always uses HTTPS to connect to the origin.Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include SSLv3 , TLSv1 , TLSv1.1 , and TLSv1.2 .
For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide .
The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.
A list that contains allowed SSL/TLS protocols for this distribution.
Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout . The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 30 seconds.
For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide .
Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 5 seconds.
For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide .
The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don’t specify otherwise) is 3.
For a custom origin (including an Amazon S3 bucket that’s configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout .
For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide .
The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don’t specify otherwise) is 10 seconds.
For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide .
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 .
A flag that specifies whether Origin Shield is enabled.
When it’s enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it’s disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.
The Amazon Web Services Region for Origin Shield.
Specify the Amazon Web Services Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as us-east-2 .
When you enable CloudFront Origin Shield, you must specify the Amazon Web Services Region for Origin Shield. For the list of Amazon Web Services Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the Amazon Web Services Region for Origin Shield in the Amazon CloudFront Developer Guide .
The unique identifier of an origin access control for this origin.
For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide .
A complex type that contains information about origin groups for this distribution.
The number of origin groups.
The items (origin groups) in a distribution.
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.
The origin group's ID.
A complex type that contains information about the failover criteria for an origin group.
The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.
The number of status codes.
The items (status codes) for an origin group.
A complex type that contains information about the origins in an origin group.
The number of origins in an origin group.
Items (origins) in an origin group.
An origin in an origin group.
The ID for an origin in an origin group.
A complex type that describes the default cache behavior if you don't 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.
The value of ID for the origin that you want CloudFront to route requests to when they use the default cache behavior.
Warning
We recommend using TrustedKeyGroups instead of TrustedSigners .
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer’s Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services account identifiers.
A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of key groups in the list.
A list of key groups identifiers.
The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern . You can specify the following options:
allow-all : Viewers can use HTTP or HTTPS.redirect-to-https : If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only : If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide .
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:
GET and HEAD requests.GET , HEAD , and OPTIONS requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
GET and HEAD requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true ; if not, specify false . If you specify true for SmoothStreaming , you can still distribute other content using this cache behavior if the content matches the value of PathPattern .
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true ; if not, specify false . For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
The number of Lambda@Edge function associations for this cache behavior.
Optional : A complex type that containsLambdaFunctionAssociationitems for this cache behavior. IfQuantityis0, you can omitItems.
A complex type that contains a Lambda@Edge function association.
The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request : The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request : The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response : The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response : The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.
The number of CloudFront functions in the list.
The 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.
A CloudFront function that is associated with a cache behavior in a CloudFront distribution.
The Amazon Resource Name (ARN) of the function.
The event type of the function, either viewer-request or viewer-response . You cannot use origin-facing event types (origin-request and origin-response ) with a CloudFront function.
The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior.
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide .
The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
The identifier for a response headers policy.
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide .
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed 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 or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 .
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys , if any:
If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
If you specify false for QueryString , CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 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 How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide .
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.
Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 .
Required if you specify whitelist for the value of Forward . A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.
If you specify all or none for the value of Forward , omit WhitelistedNames . If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.
For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference .
The number of cookie names in the Items list.
A list of cookie names.
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 headers 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 headers 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 the Headers , if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.
For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide .
The number of header names in the Items list.
A list of HTTP header names.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
The number of whitelisted query string parameters for a cache behavior.
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items .
This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers , if you specify 1 for Quantity and * for Name ).
This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The default amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The maximum amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
A complex type that contains zero or more CacheBehavior elements.
The number of cache behaviors for this distribution.
Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0 , you can omit Items .
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 .
The pattern (for example, images/*.jpg ) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.
Note
You can optionally include a slash (/ ) at the beginning of the path pattern. For example, /images/*.jpg . CloudFront behavior is the same with or without the leading / .
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.
For more information, see Path Pattern in the Amazon CloudFront Developer Guide .
The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.
Warning
We recommend using TrustedKeyGroups instead of TrustedSigners .
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer’s Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services account identifiers.
A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of key groups in the list.
A list of key groups identifiers.
The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern . You can specify the following options:
allow-all : Viewers can use HTTP or HTTPS.redirect-to-https : If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only : If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide .
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:
GET and HEAD requests.GET , HEAD , and OPTIONS requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
GET and HEAD requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true ; if not, specify false . If you specify true for SmoothStreaming , you can still distribute other content using this cache behavior if the content matches the value of PathPattern .
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
The number of Lambda@Edge function associations for this cache behavior.
Optional : A complex type that containsLambdaFunctionAssociationitems for this cache behavior. IfQuantityis0, you can omitItems.
A complex type that contains a Lambda@Edge function association.
The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request : The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request : The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response : The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response : The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.
The number of CloudFront functions in the list.
The 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.
A CloudFront function that is associated with a cache behavior in a CloudFront distribution.
The Amazon Resource Name (ARN) of the function.
The event type of the function, either viewer-request or viewer-response . You cannot use origin-facing event types (origin-request and origin-response ) with a CloudFront function.
The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide .
The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
A CacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
The identifier for a response headers policy.
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide .
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed 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 or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
A CacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 .
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys , if any:
If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
If you specify false for QueryString , CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 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 How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide .
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.
Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 .
Required if you specify whitelist for the value of Forward . A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.
If you specify all or none for the value of Forward , omit WhitelistedNames . If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.
For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference .
The number of cookie names in the Items list.
A list of cookie names.
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 headers 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 headers 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 the Headers , if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.
For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide .
The number of header names in the Items list.
A list of HTTP header names.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
The number of whitelisted query string parameters for a cache behavior.
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items .
This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers , if you specify 1 for Quantity and * for Name ).
This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The default amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The maximum amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
A complex type that controls the following:
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0 , you can omit Items .
A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration.
A complex type that controls:
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
The HTTP status code for which you want to specify a custom error page and/or a caching duration.
The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode , for example, /4xx-errors/403-forbidden.html . If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:
PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors . Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, /4xx-errors/* .TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages.If you specify a value for ResponsePagePath , you must also specify a value for ResponseCode .
We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.
The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:
200 , the response typically won't be intercepted.400 or 500 as the ResponseCode for all 4xx or 5xx errors.200 status code (OK) and static website so your customers don't know that your website is down.If you specify a value for ResponseCode , you must also specify a value for ResponsePagePath .
The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode . When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.
For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
An optional comment to describe the distribution. The comment cannot be longer than 128 characters.
A complex type that controls whether access logs are written for the distribution.
For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide .
Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't 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.
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 don't 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 .
The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com .
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 don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.
The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All , CloudFront responds to requests for your objects from all CloudFront edge locations.
If you specify a price class other than PriceClass_All , CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.
For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide . For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing .
From this field, you can enable or disable the selected distribution.
A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net , set this field to true .
If the distribution uses Aliases (alternate domain names or CNAMEs), set this field to false and specify values for the following fields:
ACMCertificateArn or IAMCertificateId (specify a value for one, not both)MinimumProtocolVersionSSLSupportMethodIf the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Identity and Access Management (IAM) , provide the ID of the IAM certificate.
If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVersion and SSLSupportMethod .
If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Certificate Manager (ACM) , provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (us-east-1 ).
If you specify an ACM certificate ARN, you must also specify values for MinimumProtocolVersion and SSLSupportMethod .
If the distribution uses Aliases (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.
sni-only – The distribution accepts HTTPS connections from only viewers that support server name indication (SNI) . This is recommended. Most browsers and clients support SNI.vip – The distribution accepts HTTPS connections from all viewers including those that don’t support SNI. This is not recommended, and results in additional monthly charges from CloudFront.static-ip - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the Amazon Web Services Support Center .If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net , don’t set a value for this field.
If the distribution uses Aliases (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:
For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
On the CloudFront console, this setting is called Security Policy .
When you’re using SNI only (you set SSLSupportMethod to sni-only ), you must specify TLSv1 or higher.
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net (you set CloudFrontDefaultCertificate to true ), CloudFront automatically sets the security policy to TLSv1 regardless of the value that you set here.
This field is deprecated. Use one of the following fields instead:
ACMCertificateArnIAMCertificateIdCloudFrontDefaultCertificateThis field is deprecated. Use one of the following fields instead:
ACMCertificateArnIAMCertificateIdCloudFrontDefaultCertificateA complex type that identifies ways in which you want to restrict distribution of your content.
A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.
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 don't want CloudFront to distribute your content.whitelist : The Location elements specify the countries in which you want CloudFront to distribute your content.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 .
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 on the CloudFront console, which includes both country names and codes.
A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a . To specify a web ACL created using WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a .
WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the WAF Developer Guide .
(Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2 . Viewers that don't support HTTP/2 automatically use an earlier HTTP version.
For viewers and CloudFront to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI).
For viewers and CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CloudFront supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see Connection Migration at RFC 9000. For more information about supported TLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront .
If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true . If you specify false , CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.
In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide .
If you're using an Route 53 Amazon Web Services Integration alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:
For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Route 53 Amazon Web Services Integration Developer Guide .
If you created a CNAME resource record set, either with Route 53 Amazon Web Services Integration or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.
The current version of the configuration. For example: E2QWRUHAPOMQZL .
Exceptions
CloudFront.Client.exceptions.NoSuchDistributionCloudFront.Client.exceptions.AccessDeniedget_field_level_encryption(**kwargs)¶Get the field-level encryption configuration information.
See also: AWS API Documentation
Request Syntax
response = client.get_field_level_encryption(
Id='string'
)
[REQUIRED]
Request the ID for the field-level encryption configuration information.
{
'FieldLevelEncryption': {
'Id': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'FieldLevelEncryptionConfig': {
'CallerReference': 'string',
'Comment': 'string',
'QueryArgProfileConfig': {
'ForwardWhenQueryArgProfileIsUnknown': True|False,
'QueryArgProfiles': {
'Quantity': 123,
'Items': [
{
'QueryArg': 'string',
'ProfileId': 'string'
},
]
}
},
'ContentTypeProfileConfig': {
'ForwardWhenContentTypeIsUnknown': True|False,
'ContentTypeProfiles': {
'Quantity': 123,
'Items': [
{
'Format': 'URLEncoded',
'ProfileId': 'string',
'ContentType': 'string'
},
]
}
}
}
},
'ETag': 'string'
}
Response Structure
Return the field-level encryption configuration information.
The configuration ID for a field-level encryption configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.
The last time the field-level encryption configuration was changed.
A complex data type that includes the profile configurations specified for field-level encryption.
A unique number that ensures the request can't be replayed.
An optional comment about the configuration. The comment cannot be longer than 128 characters.
A complex data type that specifies when to forward content if a profile isn't found and the profile that can be provided as a query argument in a request.
Flag to set if you want a request to be forwarded to the origin even if the profile specified by the field-level encryption query argument, fle-profile, is unknown.
Profiles specified for query argument-profile mapping for field-level encryption.
Number of profiles for query argument-profile mapping for field-level encryption.
Number of items for query argument-profile mapping for field-level encryption.
Query argument-profile mapping for field-level encryption.
Query argument for field-level encryption query argument-profile mapping.
ID of profile to use for field-level encryption query argument-profile mapping
A complex data type that specifies when to forward content if a content type isn't recognized and profiles to use as by default in a request if a query argument doesn't specify a profile to use.
The setting in a field-level encryption content type-profile mapping that specifies what to do when an unknown content type is provided for the profile. If true, content is forwarded without being encrypted when the content type is unknown. If false (the default), an error is returned when the content type is unknown.
The configuration for a field-level encryption content type-profile.
The number of field-level encryption content type-profile mappings.
Items in a field-level encryption content type-profile mapping.
A field-level encryption content type profile.
The format for a field-level encryption content type-profile mapping.
The profile ID for a field-level encryption content type-profile mapping.
The content type for a field-level encryption content type-profile mapping.
The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL .
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.NoSuchFieldLevelEncryptionConfigget_field_level_encryption_config(**kwargs)¶Get the field-level encryption configuration information.
See also: AWS API Documentation
Request Syntax
response = client.get_field_level_encryption_config(
Id='string'
)
[REQUIRED]
Request the ID for the field-level encryption configuration information.
{
'FieldLevelEncryptionConfig': {
'CallerReference': 'string',
'Comment': 'string',
'QueryArgProfileConfig': {
'ForwardWhenQueryArgProfileIsUnknown': True|False,
'QueryArgProfiles': {
'Quantity': 123,
'Items': [
{
'QueryArg': 'string',
'ProfileId': 'string'
},
]
}
},
'ContentTypeProfileConfig': {
'ForwardWhenContentTypeIsUnknown': True|False,
'ContentTypeProfiles': {
'Quantity': 123,
'Items': [
{
'Format': 'URLEncoded',
'ProfileId': 'string',
'ContentType': 'string'
},
]
}
}
},
'ETag': 'string'
}
Response Structure
Return the field-level encryption configuration information.
A unique number that ensures the request can't be replayed.
An optional comment about the configuration. The comment cannot be longer than 128 characters.
A complex data type that specifies when to forward content if a profile isn't found and the profile that can be provided as a query argument in a request.
Flag to set if you want a request to be forwarded to the origin even if the profile specified by the field-level encryption query argument, fle-profile, is unknown.
Profiles specified for query argument-profile mapping for field-level encryption.
Number of profiles for query argument-profile mapping for field-level encryption.
Number of items for query argument-profile mapping for field-level encryption.
Query argument-profile mapping for field-level encryption.
Query argument for field-level encryption query argument-profile mapping.
ID of profile to use for field-level encryption query argument-profile mapping
A complex data type that specifies when to forward content if a content type isn't recognized and profiles to use as by default in a request if a query argument doesn't specify a profile to use.
The setting in a field-level encryption content type-profile mapping that specifies what to do when an unknown content type is provided for the profile. If true, content is forwarded without being encrypted when the content type is unknown. If false (the default), an error is returned when the content type is unknown.
The configuration for a field-level encryption content type-profile.
The number of field-level encryption content type-profile mappings.
Items in a field-level encryption content type-profile mapping.
A field-level encryption content type profile.
The format for a field-level encryption content type-profile mapping.
The profile ID for a field-level encryption content type-profile mapping.
The content type for a field-level encryption content type-profile mapping.
The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL .
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.NoSuchFieldLevelEncryptionConfigget_field_level_encryption_profile(**kwargs)¶Get the field-level encryption profile information.
See also: AWS API Documentation
Request Syntax
response = client.get_field_level_encryption_profile(
Id='string'
)
[REQUIRED]
Get the ID for the field-level encryption profile information.
{
'FieldLevelEncryptionProfile': {
'Id': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'FieldLevelEncryptionProfileConfig': {
'Name': 'string',
'CallerReference': 'string',
'Comment': 'string',
'EncryptionEntities': {
'Quantity': 123,
'Items': [
{
'PublicKeyId': 'string',
'ProviderId': 'string',
'FieldPatterns': {
'Quantity': 123,
'Items': [
'string',
]
}
},
]
}
}
},
'ETag': 'string'
}
Response Structure
Return the field-level encryption profile information.
The ID for a field-level encryption profile configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.
The last time the field-level encryption profile was updated.
A complex data type that includes the profile name and the encryption entities for the field-level encryption profile.
Profile name for the field-level encryption profile.
A unique number that ensures that the request can't be replayed.
An optional comment for the field-level encryption profile. The comment cannot be longer than 128 characters.
A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.
Number of field pattern items in a field-level encryption content type-profile mapping.
An array of field patterns in a field-level encryption content type-profile mapping.
Complex data type for field-level encryption profiles that includes the encryption key and field pattern specifications.
The public key associated with a set of field-level encryption patterns, to be used when encrypting the fields that match the patterns.
The provider associated with the public key being used for encryption. This value must also be provided with the private key for applications to be able to decrypt data.
Field patterns in a field-level encryption content type profile specify the fields that you want to be encrypted. You can provide the full field name, or any beginning characters followed by a wildcard (*). You can't overlap field patterns. For example, you can't have both ABC* and AB*. Note that field patterns are case-sensitive.
The number of field-level encryption field patterns.
An array of the field-level encryption field patterns.
The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL .
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.NoSuchFieldLevelEncryptionProfileget_field_level_encryption_profile_config(**kwargs)¶Get the field-level encryption profile configuration information.
See also: AWS API Documentation
Request Syntax
response = client.get_field_level_encryption_profile_config(
Id='string'
)
[REQUIRED]
Get the ID for the field-level encryption profile configuration information.
{
'FieldLevelEncryptionProfileConfig': {
'Name': 'string',
'CallerReference': 'string',
'Comment': 'string',
'EncryptionEntities': {
'Quantity': 123,
'Items': [
{
'PublicKeyId': 'string',
'ProviderId': 'string',
'FieldPatterns': {
'Quantity': 123,
'Items': [
'string',
]
}
},
]
}
},
'ETag': 'string'
}
Response Structure
Return the field-level encryption profile configuration information.
Profile name for the field-level encryption profile.
A unique number that ensures that the request can't be replayed.
An optional comment for the field-level encryption profile. The comment cannot be longer than 128 characters.
A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.
Number of field pattern items in a field-level encryption content type-profile mapping.
An array of field patterns in a field-level encryption content type-profile mapping.
Complex data type for field-level encryption profiles that includes the encryption key and field pattern specifications.
The public key associated with a set of field-level encryption patterns, to be used when encrypting the fields that match the patterns.
The provider associated with the public key being used for encryption. This value must also be provided with the private key for applications to be able to decrypt data.
Field patterns in a field-level encryption content type profile specify the fields that you want to be encrypted. You can provide the full field name, or any beginning characters followed by a wildcard (*). You can't overlap field patterns. For example, you can't have both ABC* and AB*. Note that field patterns are case-sensitive.
The number of field-level encryption field patterns.
An array of the field-level encryption field patterns.
The current version of the field-level encryption profile configuration result. For example: E2QWRUHAPOMQZL .
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.NoSuchFieldLevelEncryptionProfileget_function(**kwargs)¶Gets the code of a CloudFront function. To get configuration information and metadata about a function, use DescribeFunction .
To get a function’s code, you must provide the function’s name and stage. To get these values, you can use ListFunctions .
See also: AWS API Documentation
Request Syntax
response = client.get_function(
Name='string',
Stage='DEVELOPMENT'|'LIVE'
)
[REQUIRED]
The name of the function whose code you are getting.
DEVELOPMENT or LIVE .dict
Response Syntax
{
'FunctionCode': StreamingBody(),
'ETag': 'string',
'ContentType': 'string'
}
Response Structure
(dict) --
FunctionCode (StreamingBody) --
The function code of a CloudFront function.
ETag (string) --
The version identifier for the current version of the CloudFront function.
ContentType (string) --
The content type (media type) of the response.
Exceptions
CloudFront.Client.exceptions.NoSuchFunctionExistsCloudFront.Client.exceptions.UnsupportedOperationget_invalidation(**kwargs)¶Get the information about an invalidation.
See also: AWS API Documentation
Request Syntax
response = client.get_invalidation(
DistributionId='string',
Id='string'
)
[REQUIRED]
The distribution's ID.
[REQUIRED]
The identifier for the invalidation request, for example, IDFDVBD632BHDS5 .
dict
Response Syntax
{
'Invalidation': {
'Id': 'string',
'Status': 'string',
'CreateTime': datetime(2015, 1, 1),
'InvalidationBatch': {
'Paths': {
'Quantity': 123,
'Items': [
'string',
]
},
'CallerReference': 'string'
}
}
}
Response Structure
(dict) --
The returned result of the corresponding request.
Invalidation (dict) --
The invalidation's information. For more information, see Invalidation Complex Type .
Id (string) --
The identifier for the invalidation request. For example: IDFDVBD632BHDS5 .
Status (string) --
The status of the invalidation request. When the invalidation batch is finished, the status is Completed .
CreateTime (datetime) --
The date and time the invalidation request was first made.
InvalidationBatch (dict) --
The current invalidation information for the batch request.
Paths (dict) --
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 .
Quantity (integer) --
The number of invalidation paths specified for the objects that you want to invalidate.
Items (list) --
A complex type that contains a list of the paths that you want to invalidate.
CallerReference (string) --
A value that you specify to uniquely identify an invalidation request. CloudFront uses the value to prevent you from accidentally resubmitting an identical request. Whenever you create a new invalidation request, you must specify a new value for CallerReference and change other values in the request as applicable. One way to ensure that the value of CallerReference is unique is to use a timestamp , for example, 20120301090000 .
If you make a second invalidation request with the same value for CallerReference , and if the rest of the request is the same, CloudFront doesn't create a new invalidation request. Instead, CloudFront returns information about the invalidation request that you previously created with the same CallerReference .
If CallerReference is a value you already sent in a previous invalidation batch request but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error.
Exceptions
CloudFront.Client.exceptions.NoSuchInvalidationCloudFront.Client.exceptions.NoSuchDistributionCloudFront.Client.exceptions.AccessDeniedget_key_group(**kwargs)¶Gets a key group, including the date and time when the key group was last modified.
To get a key group, you must provide the key group’s identifier. If the key group is referenced in a distribution’s cache behavior, you can get the key group’s identifier using ListDistributions or GetDistribution . If the key group is not referenced in a cache behavior, you can get the identifier using ListKeyGroups .
See also: AWS API Documentation
Request Syntax
response = client.get_key_group(
Id='string'
)
[REQUIRED]
The identifier of the key group that you are getting. To get the identifier, use ListKeyGroups .
{
'KeyGroup': {
'Id': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'KeyGroupConfig': {
'Name': 'string',
'Items': [
'string',
],
'Comment': 'string'
}
},
'ETag': 'string'
}
Response Structure
The key group.
The identifier for the key group.
The date and time when the key group was last modified.
The key group configuration.
A name to identify the key group.
A list of the identifiers of the public keys in the key group.
A comment to describe the key group. The comment cannot be longer than 128 characters.
The identifier for this version of the key group.
Exceptions
CloudFront.Client.exceptions.NoSuchResourceget_key_group_config(**kwargs)¶Gets a key group configuration.
To get a key group configuration, you must provide the key group’s identifier. If the key group is referenced in a distribution’s cache behavior, you can get the key group’s identifier using ListDistributions or GetDistribution . If the key group is not referenced in a cache behavior, you can get the identifier using ListKeyGroups .
See also: AWS API Documentation
Request Syntax
response = client.get_key_group_config(
Id='string'
)
[REQUIRED]
The identifier of the key group whose configuration you are getting. To get the identifier, use ListKeyGroups .
{
'KeyGroupConfig': {
'Name': 'string',
'Items': [
'string',
],
'Comment': 'string'
},
'ETag': 'string'
}
Response Structure
The key group configuration.
A name to identify the key group.
A list of the identifiers of the public keys in the key group.
A comment to describe the key group. The comment cannot be longer than 128 characters.
The identifier for this version of the key group.
Exceptions
CloudFront.Client.exceptions.NoSuchResourceget_monitoring_subscription(**kwargs)¶Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.
See also: AWS API Documentation
Request Syntax
response = client.get_monitoring_subscription(
DistributionId='string'
)
[REQUIRED]
The ID of the distribution that you are getting metrics information for.
{
'MonitoringSubscription': {
'RealtimeMetricsSubscriptionConfig': {
'RealtimeMetricsSubscriptionStatus': 'Enabled'|'Disabled'
}
}
}
Response Structure
A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
A subscription configuration for additional CloudWatch metrics.
A flag that indicates whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.NoSuchDistributionCloudFront.Client.exceptions.NoSuchMonitoringSubscriptionCloudFront.Client.exceptions.UnsupportedOperationget_origin_access_control(**kwargs)¶Gets a CloudFront origin access control, including its unique identifier.
See also: AWS API Documentation
Request Syntax
response = client.get_origin_access_control(
Id='string'
)
[REQUIRED]
The unique identifier of the origin access control.
{
'OriginAccessControl': {
'Id': 'string',
'OriginAccessControlConfig': {
'Name': 'string',
'Description': 'string',
'SigningProtocol': 'sigv4',
'SigningBehavior': 'never'|'always'|'no-override',
'OriginAccessControlOriginType': 's3'
}
},
'ETag': 'string'
}
Response Structure
Contains an origin access control, including its unique identifier.
The unique identifier of the origin access control.
The origin access control.
A name to identify the origin access control.
A description of the origin access control.
The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is sigv4 .
Specifies which requests CloudFront signs (adds authentication information to). Specify always for the most common use case. For more information, see origin access control advanced settings in the Amazon CloudFront Developer Guide .
This field can have one of the following values:
always – CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if one exists.never – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control.no-override – If the viewer request doesn't contain the Authorization header, then CloudFront signs the origin request. If the viewer request contains the Authorization header, then CloudFront doesn't sign the origin request and instead passes along the Authorization header from the viewer request. WARNING: To pass along the ``Authorization`` header from the viewer request, you *must* add the ``Authorization`` header to a `cache policy <https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html>`__ for all cache behaviors that use origins associated with this origin access control.The type of origin that this origin access control is for. The only valid value is s3 .
The version identifier for the current version of the origin access control.
Exceptions
CloudFront.Client.exceptions.NoSuchOriginAccessControlCloudFront.Client.exceptions.AccessDeniedget_origin_access_control_config(**kwargs)¶Gets a CloudFront origin access control configuration.
See also: AWS API Documentation
Request Syntax
response = client.get_origin_access_control_config(
Id='string'
)
[REQUIRED]
The unique identifier of the origin access control.
{
'OriginAccessControlConfig': {
'Name': 'string',
'Description': 'string',
'SigningProtocol': 'sigv4',
'SigningBehavior': 'never'|'always'|'no-override',
'OriginAccessControlOriginType': 's3'
},
'ETag': 'string'
}
Response Structure
Contains an origin access control configuration.
A name to identify the origin access control.
A description of the origin access control.
The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is sigv4 .
Specifies which requests CloudFront signs (adds authentication information to). Specify always for the most common use case. For more information, see origin access control advanced settings in the Amazon CloudFront Developer Guide .
This field can have one of the following values:
always – CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if one exists.never – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control.no-override – If the viewer request doesn't contain the Authorization header, then CloudFront signs the origin request. If the viewer request contains the Authorization header, then CloudFront doesn't sign the origin request and instead passes along the Authorization header from the viewer request. WARNING: To pass along the ``Authorization`` header from the viewer request, you *must* add the ``Authorization`` header to a `cache policy <https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html>`__ for all cache behaviors that use origins associated with this origin access control.The type of origin that this origin access control is for. The only valid value is s3 .
The version identifier for the current version of the origin access control.
Exceptions
CloudFront.Client.exceptions.NoSuchOriginAccessControlCloudFront.Client.exceptions.AccessDeniedget_origin_request_policy(**kwargs)¶Gets an origin request policy, including the following metadata:
To get an origin request policy, you must provide the policy’s identifier. If the origin request policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution . If the origin request policy is not attached to a cache behavior, you can get the identifier using ListOriginRequestPolicies .
See also: AWS API Documentation
Request Syntax
response = client.get_origin_request_policy(
Id='string'
)
[REQUIRED]
The unique identifier for the origin request policy. If the origin request policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution . If the origin request policy is not attached to a cache behavior, you can get the identifier using ListOriginRequestPolicies .
{
'OriginRequestPolicy': {
'Id': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'OriginRequestPolicyConfig': {
'Comment': 'string',
'Name': 'string',
'HeadersConfig': {
'HeaderBehavior': 'none'|'whitelist'|'allViewer'|'allViewerAndWhitelistCloudFront',
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'CookiesConfig': {
'CookieBehavior': 'none'|'whitelist'|'all',
'Cookies': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'QueryStringsConfig': {
'QueryStringBehavior': 'none'|'whitelist'|'all',
'QueryStrings': {
'Quantity': 123,
'Items': [
'string',
]
}
}
}
},
'ETag': 'string'
}
Response Structure
The origin request policy.
The unique identifier for the origin request policy.
The date and time when the origin request policy was last modified.
The origin request policy configuration.
A comment to describe the origin request policy. The comment cannot be longer than 128 characters.
A unique name to identify the origin request policy.
The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.
Determines whether any HTTP headers are included in requests that CloudFront sends to the origin. Valid values are:
none – HTTP headers are not included in requests that CloudFront sends to the origin. Even when this field is set to none , any headers that are listed in a CachePolicy are included in origin requests.whitelist – The HTTP headers that are listed in the Headers type are included in requests that CloudFront sends to the origin.allViewer – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin.allViewerAndWhitelistCloudFront – All HTTP headers in viewer requests and the additional CloudFront headers that are listed in the Headers type are included in requests that CloudFront sends to the origin. The additional headers are added by CloudFront.Contains a list of HTTP header names.
The number of header names in the Items list.
A list of HTTP header names.
The cookies from viewer requests to include in origin requests.
Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:
none – Cookies in viewer requests are not included in requests that CloudFront sends to the origin. Even when this field is set to none , any cookies that are listed in a CachePolicy are included in origin requests.whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in requests that CloudFront sends to the origin.all – All cookies in viewer requests are included in requests that CloudFront sends to the origin.Contains a list of cookie names.
The number of cookie names in the Items list.
A list of cookie names.
The URL query strings from viewer requests to include in origin requests.
Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:
none – Query strings in viewer requests are not included in requests that CloudFront sends to the origin. Even when this field is set to none , any query strings that are listed in a CachePolicy are included in origin requests.whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in requests that CloudFront sends to the origin.all – All query strings in viewer requests are included in requests that CloudFront sends to the origin.Contains a list of the query strings in viewer requests that are included in requests that CloudFront sends to the origin.
The number of query string names in the Items list.
A list of query string names.
The current version of the origin request policy.
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.NoSuchOriginRequestPolicyget_origin_request_policy_config(**kwargs)¶Gets an origin request policy configuration.
To get an origin request policy configuration, you must provide the policy’s identifier. If the origin request policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution . If the origin request policy is not attached to a cache behavior, you can get the identifier using ListOriginRequestPolicies .
See also: AWS API Documentation
Request Syntax
response = client.get_origin_request_policy_config(
Id='string'
)
[REQUIRED]
The unique identifier for the origin request policy. If the origin request policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution . If the origin request policy is not attached to a cache behavior, you can get the identifier using ListOriginRequestPolicies .
{
'OriginRequestPolicyConfig': {
'Comment': 'string',
'Name': 'string',
'HeadersConfig': {
'HeaderBehavior': 'none'|'whitelist'|'allViewer'|'allViewerAndWhitelistCloudFront',
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'CookiesConfig': {
'CookieBehavior': 'none'|'whitelist'|'all',
'Cookies': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'QueryStringsConfig': {
'QueryStringBehavior': 'none'|'whitelist'|'all',
'QueryStrings': {
'Quantity': 123,
'Items': [
'string',
]
}
}
},
'ETag': 'string'
}
Response Structure
The origin request policy configuration.
A comment to describe the origin request policy. The comment cannot be longer than 128 characters.
A unique name to identify the origin request policy.
The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.
Determines whether any HTTP headers are included in requests that CloudFront sends to the origin. Valid values are:
none – HTTP headers are not included in requests that CloudFront sends to the origin. Even when this field is set to none , any headers that are listed in a CachePolicy are included in origin requests.whitelist – The HTTP headers that are listed in the Headers type are included in requests that CloudFront sends to the origin.allViewer – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin.allViewerAndWhitelistCloudFront – All HTTP headers in viewer requests and the additional CloudFront headers that are listed in the Headers type are included in requests that CloudFront sends to the origin. The additional headers are added by CloudFront.Contains a list of HTTP header names.
The number of header names in the Items list.
A list of HTTP header names.
The cookies from viewer requests to include in origin requests.
Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:
none – Cookies in viewer requests are not included in requests that CloudFront sends to the origin. Even when this field is set to none , any cookies that are listed in a CachePolicy are included in origin requests.whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in requests that CloudFront sends to the origin.all – All cookies in viewer requests are included in requests that CloudFront sends to the origin.Contains a list of cookie names.
The number of cookie names in the Items list.
A list of cookie names.
The URL query strings from viewer requests to include in origin requests.
Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:
none – Query strings in viewer requests are not included in requests that CloudFront sends to the origin. Even when this field is set to none , any query strings that are listed in a CachePolicy are included in origin requests.whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in requests that CloudFront sends to the origin.all – All query strings in viewer requests are included in requests that CloudFront sends to the origin.Contains a list of the query strings in viewer requests that are included in requests that CloudFront sends to the origin.
The number of query string names in the Items list.
A list of query string names.
The current version of the origin request policy.
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.NoSuchOriginRequestPolicyget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_public_key(**kwargs)¶Gets a public key.
See also: AWS API Documentation
Request Syntax
response = client.get_public_key(
Id='string'
)
[REQUIRED]
The identifier of the public key you are getting.
{
'PublicKey': {
'Id': 'string',
'CreatedTime': datetime(2015, 1, 1),
'PublicKeyConfig': {
'CallerReference': 'string',
'Name': 'string',
'EncodedKey': 'string',
'Comment': 'string'
}
},
'ETag': 'string'
}
Response Structure
The public key.
The identifier of the public key.
The date and time when the public key was uploaded.
Configuration information about a public key that you can use with signed URLs and signed cookies , or with field-level encryption .
A string included in the request to help make sure that the request can’t be replayed.
A name to help identify the public key.
The public key that you can use with signed URLs and signed cookies , or with field-level encryption .
A comment to describe the public key. The comment cannot be longer than 128 characters.
The identifier for this version of the public key.
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.NoSuchPublicKeyget_public_key_config(**kwargs)¶Gets a public key configuration.
See also: AWS API Documentation
Request Syntax
response = client.get_public_key_config(
Id='string'
)
[REQUIRED]
The identifier of the public key whose configuration you are getting.
{
'PublicKeyConfig': {
'CallerReference': 'string',
'Name': 'string',
'EncodedKey': 'string',
'Comment': 'string'
},
'ETag': 'string'
}
Response Structure
A public key configuration.
A string included in the request to help make sure that the request can’t be replayed.
A name to help identify the public key.
The public key that you can use with signed URLs and signed cookies , or with field-level encryption .
A comment to describe the public key. The comment cannot be longer than 128 characters.
The identifier for this version of the public key configuration.
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.NoSuchPublicKeyget_realtime_log_config(**kwargs)¶Gets a real-time log configuration.
To get a real-time log configuration, you can provide the configuration’s name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to get.
See also: AWS API Documentation
Request Syntax
response = client.get_realtime_log_config(
Name='string',
ARN='string'
)
dict
Response Syntax
{
'RealtimeLogConfig': {
'ARN': 'string',
'Name': 'string',
'SamplingRate': 123,
'EndPoints': [
{
'StreamType': 'string',
'KinesisStreamConfig': {
'RoleARN': 'string',
'StreamARN': 'string'
}
},
],
'Fields': [
'string',
]
}
}
Response Structure
(dict) --
RealtimeLogConfig (dict) --
A real-time log configuration.
ARN (string) --
The Amazon Resource Name (ARN) of this real-time log configuration.
Name (string) --
The unique name of this real-time log configuration.
SamplingRate (integer) --
The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. The sampling rate is an integer between 1 and 100, inclusive.
EndPoints (list) --
Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.
(dict) --
Contains information about the Amazon Kinesis data stream where you are sending real-time log data in a real-time log configuration.
StreamType (string) --
The type of data stream where you are sending real-time log data. The only valid value is Kinesis .
KinesisStreamConfig (dict) --
Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
RoleARN (string) --
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFront can use to send real-time log data to your Kinesis data stream.
For more information the IAM role, see Real-time log configuration IAM role in the Amazon CloudFront Developer Guide .
StreamARN (string) --
The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data.
Fields (list) --
A list of fields that are included in each real-time log record. In an API response, the fields are provided in the same order in which they are sent to the Amazon Kinesis data stream.
For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide .
Exceptions
CloudFront.Client.exceptions.NoSuchRealtimeLogConfigCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.AccessDeniedget_response_headers_policy(**kwargs)¶Gets a response headers policy, including metadata (the policy’s identifier and the date and time when the policy was last modified).
To get a response headers policy, you must provide the policy’s identifier. If the response headers policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution . If the response headers policy is not attached to a cache behavior, you can get the identifier using ListResponseHeadersPolicies .
See also: AWS API Documentation
Request Syntax
response = client.get_response_headers_policy(
Id='string'
)
[REQUIRED]
The identifier for the response headers policy.
If the response headers policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution . If the response headers policy is not attached to a cache behavior, you can get the identifier using ListResponseHeadersPolicies .
{
'ResponseHeadersPolicy': {
'Id': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'ResponseHeadersPolicyConfig': {
'Comment': 'string',
'Name': 'string',
'CorsConfig': {
'AccessControlAllowOrigins': {
'Quantity': 123,
'Items': [
'string',
]
},
'AccessControlAllowHeaders': {
'Quantity': 123,
'Items': [
'string',
]
},
'AccessControlAllowMethods': {
'Quantity': 123,
'Items': [
'GET'|'POST'|'OPTIONS'|'PUT'|'DELETE'|'PATCH'|'HEAD'|'ALL',
]
},
'AccessControlAllowCredentials': True|False,
'AccessControlExposeHeaders': {
'Quantity': 123,
'Items': [
'string',
]
},
'AccessControlMaxAgeSec': 123,
'OriginOverride': True|False
},
'SecurityHeadersConfig': {
'XSSProtection': {
'Override': True|False,
'Protection': True|False,
'ModeBlock': True|False,
'ReportUri': 'string'
},
'FrameOptions': {
'Override': True|False,
'FrameOption': 'DENY'|'SAMEORIGIN'
},
'ReferrerPolicy': {
'Override': True|False,
'ReferrerPolicy': 'no-referrer'|'no-referrer-when-downgrade'|'origin'|'origin-when-cross-origin'|'same-origin'|'strict-origin'|'strict-origin-when-cross-origin'|'unsafe-url'
},
'ContentSecurityPolicy': {
'Override': True|False,
'ContentSecurityPolicy': 'string'
},
'ContentTypeOptions': {
'Override': True|False
},
'StrictTransportSecurity': {
'Override': True|False,
'IncludeSubdomains': True|False,
'Preload': True|False,
'AccessControlMaxAgeSec': 123
}
},
'ServerTimingHeadersConfig': {
'Enabled': True|False,
'SamplingRate': 123.0
},
'CustomHeadersConfig': {
'Quantity': 123,
'Items': [
{
'Header': 'string',
'Value': 'string',
'Override': True|False
},
]
}
}
},
'ETag': 'string'
}
Response Structure
Contains a response headers policy.
The identifier for the response headers policy.
The date and time when the response headers policy was last modified.
A response headers policy configuration.
A response headers policy contains information about a set of HTTP response headers and their values. CloudFront adds the headers in the policy to HTTP responses that it sends for requests that match a cache behavior that’s associated with the policy.
A comment to describe the response headers policy.
The comment cannot be longer than 128 characters.
A name to identify the response headers policy.
The name must be unique for response headers policies in this Amazon Web Services account.
A configuration for a set of HTTP response headers that are used for cross-origin resource sharing (CORS).
A list of origins (domain names) that CloudFront can use as the value for the Access-Control-Allow-Origin HTTP response header.
For more information about the Access-Control-Allow-Origin HTTP response header, see Access-Control-Allow-Origin in the MDN Web Docs.
The number of origins in the list.
The list of origins (domain names). You can specify * to allow all origins.
A list of HTTP header names that CloudFront includes as values for the Access-Control-Allow-Headers HTTP response header.
For more information about the Access-Control-Allow-Headers HTTP response header, see Access-Control-Allow-Headers in the MDN Web Docs.
The number of HTTP header names in the list.
The list of HTTP header names. You can specify * to allow all headers.
A list of HTTP methods that CloudFront includes as values for the Access-Control-Allow-Methods HTTP response header.
For more information about the Access-Control-Allow-Methods HTTP response header, see Access-Control-Allow-Methods in the MDN Web Docs.
The number of HTTP methods in the list.
The list of HTTP methods. Valid values are:
GETDELETEHEADOPTIONSPATCHPOSTPUTALLALLis a special value that includes all of the listed HTTP methods.
A Boolean that CloudFront uses as the value for the Access-Control-Allow-Credentials HTTP response header.
For more information about the Access-Control-Allow-Credentials HTTP response header, see Access-Control-Allow-Credentials in the MDN Web Docs.
A list of HTTP headers that CloudFront includes as values for the Access-Control-Expose-Headers HTTP response header.
For more information about the Access-Control-Expose-Headers HTTP response header, see Access-Control-Expose-Headers in the MDN Web Docs.
The number of HTTP headers in the list.
The list of HTTP headers. You can specify * to expose all headers.
A number that CloudFront uses as the value for the Access-Control-Max-Age HTTP response header.
For more information about the Access-Control-Max-Age HTTP response header, see Access-Control-Max-Age in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides HTTP response headers received from the origin with the ones specified in this response headers policy.
A configuration for a set of security-related HTTP response headers.
Determines whether CloudFront includes the X-XSS-Protection HTTP response header and the header’s value.
For more information about the X-XSS-Protection HTTP response header, see X-XSS-Protection in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the X-XSS-Protection HTTP response header received from the origin with the one specified in this response headers policy.
A Boolean that determines the value of the X-XSS-Protection HTTP response header. When this setting is true , the value of the X-XSS-Protection header is 1 . When this setting is false , the value of the X-XSS-Protection header is 0 .
For more information about these settings, see X-XSS-Protection in the MDN Web Docs.
A Boolean that determines whether CloudFront includes the mode=block directive in the X-XSS-Protection header.
For more information about this directive, see X-XSS-Protection in the MDN Web Docs.
A reporting URI, which CloudFront uses as the value of the report directive in the X-XSS-Protection header.
You cannot specify a ReportUri when ModeBlock is true .
For more information about using a reporting URL, see X-XSS-Protection in the MDN Web Docs.
Determines whether CloudFront includes the X-Frame-Options HTTP response header and the header’s value.
For more information about the X-Frame-Options HTTP response header, see X-Frame-Options in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the X-Frame-Options HTTP response header received from the origin with the one specified in this response headers policy.
The value of the X-Frame-Options HTTP response header. Valid values are DENY and SAMEORIGIN .
For more information about these values, see X-Frame-Options in the MDN Web Docs.
Determines whether CloudFront includes the Referrer-Policy HTTP response header and the header’s value.
For more information about the Referrer-Policy HTTP response header, see Referrer-Policy in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the Referrer-Policy HTTP response header received from the origin with the one specified in this response headers policy.
The value of the Referrer-Policy HTTP response header. Valid values are:
no-referrerno-referrer-when-downgradeoriginorigin-when-cross-originsame-originstrict-originstrict-origin-when-cross-originunsafe-urlFor more information about these values, see Referrer-Policy in the MDN Web Docs.
The policy directives and their values that CloudFront includes as values for the Content-Security-Policy HTTP response header.
For more information about the Content-Security-Policy HTTP response header, see Content-Security-Policy in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the Content-Security-Policy HTTP response header received from the origin with the one specified in this response headers policy.
The policy directives and their values that CloudFront includes as values for the Content-Security-Policy HTTP response header.
Determines whether CloudFront includes the X-Content-Type-Options HTTP response header with its value set to nosniff .
For more information about the X-Content-Type-Options HTTP response header, see X-Content-Type-Options in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the X-Content-Type-Options HTTP response header received from the origin with the one specified in this response headers policy.
Determines whether CloudFront includes the Strict-Transport-Security HTTP response header and the header’s value.
For more information about the Strict-Transport-Security HTTP response header, see Strict-Transport-Security in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the Strict-Transport-Security HTTP response header received from the origin with the one specified in this response headers policy.
A Boolean that determines whether CloudFront includes the includeSubDomains directive in the Strict-Transport-Security HTTP response header.
A Boolean that determines whether CloudFront includes the preload directive in the Strict-Transport-Security HTTP response header.
A number that CloudFront uses as the value for the max-age directive in the Strict-Transport-Security HTTP response header.
A configuration for enabling the Server-Timing header in HTTP responses sent from CloudFront.
A Boolean that determines whether CloudFront adds the Server-Timing header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy.
A number 0–100 (inclusive) that specifies the percentage of responses that you want CloudFront to add the Server-Timing header to. When you set the sampling rate to 100, CloudFront adds the Server-Timing header to the HTTP response for every request that matches the cache behavior that this response headers policy is attached to. When you set it to 50, CloudFront adds the header to 50% of the responses for requests that match the cache behavior. You can set the sampling rate to any number 0–100 with up to four decimal places.
A configuration for a set of custom HTTP response headers.
The number of HTTP response headers in the list.
The list of HTTP response headers and their values.
An HTTP response header name and its value. CloudFront includes this header in HTTP responses that it sends for requests that match a cache behavior that’s associated with this response headers policy.
The HTTP response header name.
The value for the HTTP response header.
A Boolean that determines whether CloudFront overrides a response header with the same name received from the origin with the header specified here.
The version identifier for the current version of the response headers policy.
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.NoSuchResponseHeadersPolicyget_response_headers_policy_config(**kwargs)¶Gets a response headers policy configuration.
To get a response headers policy configuration, you must provide the policy’s identifier. If the response headers policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution . If the response headers policy is not attached to a cache behavior, you can get the identifier using ListResponseHeadersPolicies .
See also: AWS API Documentation
Request Syntax
response = client.get_response_headers_policy_config(
Id='string'
)
[REQUIRED]
The identifier for the response headers policy.
If the response headers policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution . If the response headers policy is not attached to a cache behavior, you can get the identifier using ListResponseHeadersPolicies .
{
'ResponseHeadersPolicyConfig': {
'Comment': 'string',
'Name': 'string',
'CorsConfig': {
'AccessControlAllowOrigins': {
'Quantity': 123,
'Items': [
'string',
]
},
'AccessControlAllowHeaders': {
'Quantity': 123,
'Items': [
'string',
]
},
'AccessControlAllowMethods': {
'Quantity': 123,
'Items': [
'GET'|'POST'|'OPTIONS'|'PUT'|'DELETE'|'PATCH'|'HEAD'|'ALL',
]
},
'AccessControlAllowCredentials': True|False,
'AccessControlExposeHeaders': {
'Quantity': 123,
'Items': [
'string',
]
},
'AccessControlMaxAgeSec': 123,
'OriginOverride': True|False
},
'SecurityHeadersConfig': {
'XSSProtection': {
'Override': True|False,
'Protection': True|False,
'ModeBlock': True|False,
'ReportUri': 'string'
},
'FrameOptions': {
'Override': True|False,
'FrameOption': 'DENY'|'SAMEORIGIN'
},
'ReferrerPolicy': {
'Override': True|False,
'ReferrerPolicy': 'no-referrer'|'no-referrer-when-downgrade'|'origin'|'origin-when-cross-origin'|'same-origin'|'strict-origin'|'strict-origin-when-cross-origin'|'unsafe-url'
},
'ContentSecurityPolicy': {
'Override': True|False,
'ContentSecurityPolicy': 'string'
},
'ContentTypeOptions': {
'Override': True|False
},
'StrictTransportSecurity': {
'Override': True|False,
'IncludeSubdomains': True|False,
'Preload': True|False,
'AccessControlMaxAgeSec': 123
}
},
'ServerTimingHeadersConfig': {
'Enabled': True|False,
'SamplingRate': 123.0
},
'CustomHeadersConfig': {
'Quantity': 123,
'Items': [
{
'Header': 'string',
'Value': 'string',
'Override': True|False
},
]
}
},
'ETag': 'string'
}
Response Structure
Contains a response headers policy.
A comment to describe the response headers policy.
The comment cannot be longer than 128 characters.
A name to identify the response headers policy.
The name must be unique for response headers policies in this Amazon Web Services account.
A configuration for a set of HTTP response headers that are used for cross-origin resource sharing (CORS).
A list of origins (domain names) that CloudFront can use as the value for the Access-Control-Allow-Origin HTTP response header.
For more information about the Access-Control-Allow-Origin HTTP response header, see Access-Control-Allow-Origin in the MDN Web Docs.
The number of origins in the list.
The list of origins (domain names). You can specify * to allow all origins.
A list of HTTP header names that CloudFront includes as values for the Access-Control-Allow-Headers HTTP response header.
For more information about the Access-Control-Allow-Headers HTTP response header, see Access-Control-Allow-Headers in the MDN Web Docs.
The number of HTTP header names in the list.
The list of HTTP header names. You can specify * to allow all headers.
A list of HTTP methods that CloudFront includes as values for the Access-Control-Allow-Methods HTTP response header.
For more information about the Access-Control-Allow-Methods HTTP response header, see Access-Control-Allow-Methods in the MDN Web Docs.
The number of HTTP methods in the list.
The list of HTTP methods. Valid values are:
GETDELETEHEADOPTIONSPATCHPOSTPUTALLALLis a special value that includes all of the listed HTTP methods.
A Boolean that CloudFront uses as the value for the Access-Control-Allow-Credentials HTTP response header.
For more information about the Access-Control-Allow-Credentials HTTP response header, see Access-Control-Allow-Credentials in the MDN Web Docs.
A list of HTTP headers that CloudFront includes as values for the Access-Control-Expose-Headers HTTP response header.
For more information about the Access-Control-Expose-Headers HTTP response header, see Access-Control-Expose-Headers in the MDN Web Docs.
The number of HTTP headers in the list.
The list of HTTP headers. You can specify * to expose all headers.
A number that CloudFront uses as the value for the Access-Control-Max-Age HTTP response header.
For more information about the Access-Control-Max-Age HTTP response header, see Access-Control-Max-Age in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides HTTP response headers received from the origin with the ones specified in this response headers policy.
A configuration for a set of security-related HTTP response headers.
Determines whether CloudFront includes the X-XSS-Protection HTTP response header and the header’s value.
For more information about the X-XSS-Protection HTTP response header, see X-XSS-Protection in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the X-XSS-Protection HTTP response header received from the origin with the one specified in this response headers policy.
A Boolean that determines the value of the X-XSS-Protection HTTP response header. When this setting is true , the value of the X-XSS-Protection header is 1 . When this setting is false , the value of the X-XSS-Protection header is 0 .
For more information about these settings, see X-XSS-Protection in the MDN Web Docs.
A Boolean that determines whether CloudFront includes the mode=block directive in the X-XSS-Protection header.
For more information about this directive, see X-XSS-Protection in the MDN Web Docs.
A reporting URI, which CloudFront uses as the value of the report directive in the X-XSS-Protection header.
You cannot specify a ReportUri when ModeBlock is true .
For more information about using a reporting URL, see X-XSS-Protection in the MDN Web Docs.
Determines whether CloudFront includes the X-Frame-Options HTTP response header and the header’s value.
For more information about the X-Frame-Options HTTP response header, see X-Frame-Options in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the X-Frame-Options HTTP response header received from the origin with the one specified in this response headers policy.
The value of the X-Frame-Options HTTP response header. Valid values are DENY and SAMEORIGIN .
For more information about these values, see X-Frame-Options in the MDN Web Docs.
Determines whether CloudFront includes the Referrer-Policy HTTP response header and the header’s value.
For more information about the Referrer-Policy HTTP response header, see Referrer-Policy in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the Referrer-Policy HTTP response header received from the origin with the one specified in this response headers policy.
The value of the Referrer-Policy HTTP response header. Valid values are:
no-referrerno-referrer-when-downgradeoriginorigin-when-cross-originsame-originstrict-originstrict-origin-when-cross-originunsafe-urlFor more information about these values, see Referrer-Policy in the MDN Web Docs.
The policy directives and their values that CloudFront includes as values for the Content-Security-Policy HTTP response header.
For more information about the Content-Security-Policy HTTP response header, see Content-Security-Policy in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the Content-Security-Policy HTTP response header received from the origin with the one specified in this response headers policy.
The policy directives and their values that CloudFront includes as values for the Content-Security-Policy HTTP response header.
Determines whether CloudFront includes the X-Content-Type-Options HTTP response header with its value set to nosniff .
For more information about the X-Content-Type-Options HTTP response header, see X-Content-Type-Options in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the X-Content-Type-Options HTTP response header received from the origin with the one specified in this response headers policy.
Determines whether CloudFront includes the Strict-Transport-Security HTTP response header and the header’s value.
For more information about the Strict-Transport-Security HTTP response header, see Strict-Transport-Security in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the Strict-Transport-Security HTTP response header received from the origin with the one specified in this response headers policy.
A Boolean that determines whether CloudFront includes the includeSubDomains directive in the Strict-Transport-Security HTTP response header.
A Boolean that determines whether CloudFront includes the preload directive in the Strict-Transport-Security HTTP response header.
A number that CloudFront uses as the value for the max-age directive in the Strict-Transport-Security HTTP response header.
A configuration for enabling the Server-Timing header in HTTP responses sent from CloudFront.
A Boolean that determines whether CloudFront adds the Server-Timing header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy.
A number 0–100 (inclusive) that specifies the percentage of responses that you want CloudFront to add the Server-Timing header to. When you set the sampling rate to 100, CloudFront adds the Server-Timing header to the HTTP response for every request that matches the cache behavior that this response headers policy is attached to. When you set it to 50, CloudFront adds the header to 50% of the responses for requests that match the cache behavior. You can set the sampling rate to any number 0–100 with up to four decimal places.
A configuration for a set of custom HTTP response headers.
The number of HTTP response headers in the list.
The list of HTTP response headers and their values.
An HTTP response header name and its value. CloudFront includes this header in HTTP responses that it sends for requests that match a cache behavior that’s associated with this response headers policy.
The HTTP response header name.
The value for the HTTP response header.
A Boolean that determines whether CloudFront overrides a response header with the same name received from the origin with the header specified here.
The version identifier for the current version of the response headers policy.
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.NoSuchResponseHeadersPolicyget_streaming_distribution(**kwargs)¶Gets information about a specified RTMP distribution, including the distribution configuration.
See also: AWS API Documentation
Request Syntax
response = client.get_streaming_distribution(
Id='string'
)
[REQUIRED]
The streaming distribution's ID.
{
'StreamingDistribution': {
'Id': 'string',
'ARN': 'string',
'Status': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'DomainName': 'string',
'ActiveTrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
{
'AwsAccountNumber': 'string',
'KeyPairIds': {
'Quantity': 123,
'Items': [
'string',
]
}
},
]
},
'StreamingDistributionConfig': {
'CallerReference': 'string',
'S3Origin': {
'DomainName': 'string',
'OriginAccessIdentity': 'string'
},
'Aliases': {
'Quantity': 123,
'Items': [
'string',
]
},
'Comment': 'string',
'Logging': {
'Enabled': True|False,
'Bucket': 'string',
'Prefix': 'string'
},
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'PriceClass': 'PriceClass_100'|'PriceClass_200'|'PriceClass_All',
'Enabled': True|False
}
},
'ETag': 'string'
}
Response Structure
The returned result of the corresponding request.
The streaming distribution's information.
The identifier for the RTMP distribution. For example: EGTXBD79EXAMPLE .
The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5 , where 123456789012 is your Amazon Web Services account ID.
The current status of the RTMP distribution. When the status is Deployed , the distribution's information is propagated to all CloudFront edge locations.
The date and time that the distribution was last modified.
The domain name that corresponds to the streaming distribution, for example, s5c39gqb8ow64r.cloudfront.net .
A complex type that lists the Amazon Web Services accounts, if any, that you included in the TrustedSigners complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.
The Signer complex type lists the Amazon Web Services account number of the trusted signer or self if the signer is the Amazon Web Services account that created the distribution. The Signer element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's Amazon Web Services account. If no KeyPairId element appears for a Signer , that signer can't create signed URLs.
For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
This field is true if any of the Amazon Web Services accounts in the list have active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services accounts and the identifiers of active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.
A list of Amazon Web Services accounts and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.
An Amazon Web Services account number that contains active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If the Amazon Web Services account that owns the key pairs is the same account that owns the CloudFront distribution, the value of this field is self .
A list of CloudFront key pair identifiers.
The number of key pair identifiers in the list.
A list of CloudFront key pair identifiers.
The current configuration information for the RTMP distribution.
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of CallerReference is new (regardless of the content of the StreamingDistributionConfig object), CloudFront creates a new distribution.
If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.
A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.
The DNS name of the Amazon S3 origin.
The CloudFront origin access identity to associate with the distribution. Use an origin access identity to configure the distribution 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.
For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon CloudFront Developer Guide .
A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.
The number of CNAME aliases, if any, that you want to associate with this distribution.
A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
Any comments you want to include about the streaming distribution.
A complex type that controls whether access logs are written for the streaming distribution.
Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't 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.
The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com .
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 don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.
A complex type that specifies any Amazon Web Services accounts that you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services account identifiers.
A complex type that contains information about price class for this streaming distribution.
Whether the streaming distribution is enabled to accept user requests for content.
The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL .
Exceptions
CloudFront.Client.exceptions.NoSuchStreamingDistributionCloudFront.Client.exceptions.AccessDeniedget_streaming_distribution_config(**kwargs)¶Get the configuration information about a streaming distribution.
See also: AWS API Documentation
Request Syntax
response = client.get_streaming_distribution_config(
Id='string'
)
[REQUIRED]
The streaming distribution's ID.
{
'StreamingDistributionConfig': {
'CallerReference': 'string',
'S3Origin': {
'DomainName': 'string',
'OriginAccessIdentity': 'string'
},
'Aliases': {
'Quantity': 123,
'Items': [
'string',
]
},
'Comment': 'string',
'Logging': {
'Enabled': True|False,
'Bucket': 'string',
'Prefix': 'string'
},
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'PriceClass': 'PriceClass_100'|'PriceClass_200'|'PriceClass_All',
'Enabled': True|False
},
'ETag': 'string'
}
Response Structure
The returned result of the corresponding request.
The streaming distribution's configuration information.
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of CallerReference is new (regardless of the content of the StreamingDistributionConfig object), CloudFront creates a new distribution.
If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.
A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.
The DNS name of the Amazon S3 origin.
The CloudFront origin access identity to associate with the distribution. Use an origin access identity to configure the distribution 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.
For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon CloudFront Developer Guide .
A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.
The number of CNAME aliases, if any, that you want to associate with this distribution.
A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
Any comments you want to include about the streaming distribution.
A complex type that controls whether access logs are written for the streaming distribution.
Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't 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.
The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com .
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 don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.
A complex type that specifies any Amazon Web Services accounts that you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services account identifiers.
A complex type that contains information about price class for this streaming distribution.
Whether the streaming distribution is enabled to accept user requests for content.
The current version of the configuration. For example: E2QWRUHAPOMQZL .
Exceptions
CloudFront.Client.exceptions.NoSuchStreamingDistributionCloudFront.Client.exceptions.AccessDeniedget_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_cache_policies(**kwargs)¶Gets a list of cache policies.
You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
See also: AWS API Documentation
Request Syntax
response = client.list_cache_policies(
Type='managed'|'custom',
Marker='string',
MaxItems='string'
)
A filter to return only the specified kinds of cache policies. Valid values are:
managed – Returns only the managed policies created by Amazon Web Services.custom – Returns only the custom policies created in your Amazon Web Services account.NextMarker from the current page’s response.dict
Response Syntax
{
'CachePolicyList': {
'NextMarker': 'string',
'MaxItems': 123,
'Quantity': 123,
'Items': [
{
'Type': 'managed'|'custom',
'CachePolicy': {
'Id': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'CachePolicyConfig': {
'Comment': 'string',
'Name': 'string',
'DefaultTTL': 123,
'MaxTTL': 123,
'MinTTL': 123,
'ParametersInCacheKeyAndForwardedToOrigin': {
'EnableAcceptEncodingGzip': True|False,
'EnableAcceptEncodingBrotli': True|False,
'HeadersConfig': {
'HeaderBehavior': 'none'|'whitelist',
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'CookiesConfig': {
'CookieBehavior': 'none'|'whitelist'|'allExcept'|'all',
'Cookies': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'QueryStringsConfig': {
'QueryStringBehavior': 'none'|'whitelist'|'allExcept'|'all',
'QueryStrings': {
'Quantity': 123,
'Items': [
'string',
]
}
}
}
}
}
},
]
}
}
Response Structure
(dict) --
CachePolicyList (dict) --
A list of cache policies.
NextMarker (string) --
If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the Marker field of a subsequent request to continue listing cache policies where you left off.
MaxItems (integer) --
The maximum number of cache policies requested.
Quantity (integer) --
The total number of cache policies returned in the response.
Items (list) --
Contains the cache policies in the list.
(dict) --
Contains a cache policy.
Type (string) --
The type of cache policy, either managed (created by Amazon Web Services) or custom (created in this Amazon Web Services account).
CachePolicy (dict) --
The cache policy.
Id (string) --
The unique identifier for the cache policy.
LastModifiedTime (datetime) --
The date and time when the cache policy was last modified.
CachePolicyConfig (dict) --
The cache policy configuration.
Comment (string) --
A comment to describe the cache policy. The comment cannot be longer than 128 characters.
Name (string) --
A unique name to identify the cache policy.
DefaultTTL (integer) --
The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value as the object’s time to live (TTL) only when the origin does not send Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
The default value for this field is 86400 seconds (one day). If the value of MinTTL is more than 86400 seconds, then the default value for this field is the same as the value of MinTTL .
MaxTTL (integer) --
The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value only when the origin sends Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
The default value for this field is 31536000 seconds (one year). If the value of MinTTL or DefaultTTL is more than 31536000 seconds, then the default value for this field is the same as the value of DefaultTTL .
MinTTL (integer) --
The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
ParametersInCacheKeyAndForwardedToOrigin (dict) --
The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are automatically included in requests that CloudFront sends to the origin.
EnableAcceptEncodingGzip (boolean) --
A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
This field is related to the EnableAcceptEncodingBrotli field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
Accept-Encoding headerFor more information, see Compression support in the Amazon CloudFront Developer Guide .
If you set this value to true , and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true , so including this header in an origin request policy has no effect.
If both of these fields are false , then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.
EnableAcceptEncodingBrotli (boolean) --
A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
This field is related to the EnableAcceptEncodingGzip field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
Accept-Encoding headerFor more information, see Compression support in the Amazon CloudFront Developer Guide .
If you set this value to true , and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true , so including this header in an origin request policy has no effect.
If both of these fields are false , then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.
HeadersConfig (dict) --
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.
HeaderBehavior (string) --
Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
none – HTTP headers are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any headers that are listed in an OriginRequestPolicy are included in origin requests.whitelist – The HTTP headers that are listed in the Headers type are included in the cache key and are automatically included in requests that CloudFront sends to the origin.Headers (dict) --
Contains a list of HTTP header names.
Quantity (integer) --
The number of header names in the Items list.
Items (list) --
A list of HTTP header names.
CookiesConfig (dict) --
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.
CookieBehavior (string) --
Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
none – Cookies in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any cookies that are listed in an OriginRequestPolicy are included in origin requests.whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.allExcept – All cookies in viewer requests that are * not * listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.all – All cookies in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.Cookies (dict) --
Contains a list of cookie names.
Quantity (integer) --
The number of cookie names in the Items list.
Items (list) --
A list of cookie names.
QueryStringsConfig (dict) --
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.
QueryStringBehavior (string) --
Determines whether any URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
none – Query strings in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any query strings that are listed in an OriginRequestPolicy are included in origin requests.whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.allExcept – All query strings in viewer requests that are * not * listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.all – All query strings in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.QueryStrings (dict) --
Contains the specific query strings in viewer requests that either * are * or * are not * included in the cache key and automatically included in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the CachePolicyQueryStringsConfig type is set to whitelist (the listed query strings * are * included) or allExcept (the listed query strings * are not * included, but all other query strings are).
Quantity (integer) --
The number of query string names in the Items list.
Items (list) --
A list of query string names.
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.NoSuchCachePolicyCloudFront.Client.exceptions.InvalidArgumentlist_cloud_front_origin_access_identities(**kwargs)¶Lists origin access identities.
See also: AWS API Documentation
Request Syntax
response = client.list_cloud_front_origin_access_identities(
Marker='string',
MaxItems='string'
)
Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).dict
Response Syntax
{
'CloudFrontOriginAccessIdentityList': {
'Marker': 'string',
'NextMarker': 'string',
'MaxItems': 123,
'IsTruncated': True|False,
'Quantity': 123,
'Items': [
{
'Id': 'string',
'S3CanonicalUserId': 'string',
'Comment': 'string'
},
]
}
}
Response Structure
(dict) --
The returned result of the corresponding request.
CloudFrontOriginAccessIdentityList (dict) --
The CloudFrontOriginAccessIdentityList type.
Marker (string) --
Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).
NextMarker (string) --
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.
MaxItems (integer) --
The maximum number of origin access identities you want in the response body.
IsTruncated (boolean) --
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.
Quantity (integer) --
The number of CloudFront origin access identities that were created by the current Amazon Web Services account.
Items (list) --
A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current Amazon Web Services account.
(dict) --
Summary of the information about a CloudFront origin access identity.
Id (string) --
The ID for the origin access identity. For example: E74FTE3AJFJ256A .
S3CanonicalUserId (string) --
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.
Comment (string) --
The comment for this origin access identity, as originally specified when created.
Exceptions
CloudFront.Client.exceptions.InvalidArgumentlist_conflicting_aliases(**kwargs)¶Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services accounts for each conflicting alias. In the returned list, the distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don’t own.
Use this operation to find aliases that are in use in CloudFront that conflict or overlap with the provided alias. For example, if you provide www.example.com as input, the returned list can include www.example.com and the overlapping wildcard alternate domain name (*.example.com ), if they exist. If you provide *.example.com as input, the returned list can include *.example.com and any alternate domain names covered by that wildcard (for example, www.example.com , test.example.com , dev.example.com , and so on), if they exist.
To list conflicting aliases, you provide the alias to search and the ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias. For more information, including how to set up the distribution and certificate, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide .
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
See also: AWS API Documentation
Request Syntax
response = client.list_conflicting_aliases(
DistributionId='string',
Alias='string',
Marker='string',
MaxItems=123
)
[REQUIRED]
The ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias.
[REQUIRED]
The alias (also called a CNAME) to search for conflicting aliases.
NextMarker from the current page’s response.dict
Response Syntax
{
'ConflictingAliasesList': {
'NextMarker': 'string',
'MaxItems': 123,
'Quantity': 123,
'Items': [
{
'Alias': 'string',
'DistributionId': 'string',
'AccountId': 'string'
},
]
}
}
Response Structure
(dict) --
ConflictingAliasesList (dict) --
A list of conflicting aliases.
NextMarker (string) --
If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the Marker field of a subsequent request to continue listing conflicting aliases where you left off.
MaxItems (integer) --
The maximum number of conflicting aliases requested.
Quantity (integer) --
The number of conflicting aliases returned in the response.
Items (list) --
Contains the conflicting aliases in the list.
(dict) --
An alias (also called a CNAME) and the CloudFront distribution and Amazon Web Services account ID that it’s associated with. The distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don’t own.
Alias (string) --
An alias (also called a CNAME).
DistributionId (string) --
The (partially hidden) ID of the CloudFront distribution associated with the alias.
AccountId (string) --
The (partially hidden) ID of the Amazon Web Services account that owns the distribution that’s associated with the alias.
Exceptions
CloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.NoSuchDistributionlist_distributions(**kwargs)¶List CloudFront distributions.
See also: AWS API Documentation
Request Syntax
response = client.list_distributions(
Marker='string',
MaxItems='string'
)
Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page).dict
Response Syntax
{
'DistributionList': {
'Marker': 'string',
'NextMarker': 'string',
'MaxItems': 123,
'IsTruncated': True|False,
'Quantity': 123,
'Items': [
{
'Id': 'string',
'ARN': 'string',
'Status': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'DomainName': 'string',
'Aliases': {
'Quantity': 123,
'Items': [
'string',
]
},
'Origins': {
'Quantity': 123,
'Items': [
{
'Id': 'string',
'DomainName': 'string',
'OriginPath': 'string',
'CustomHeaders': {
'Quantity': 123,
'Items': [
{
'HeaderName': 'string',
'HeaderValue': 'string'
},
]
},
'S3OriginConfig': {
'OriginAccessIdentity': 'string'
},
'CustomOriginConfig': {
'HTTPPort': 123,
'HTTPSPort': 123,
'OriginProtocolPolicy': 'http-only'|'match-viewer'|'https-only',
'OriginSslProtocols': {
'Quantity': 123,
'Items': [
'SSLv3'|'TLSv1'|'TLSv1.1'|'TLSv1.2',
]
},
'OriginReadTimeout': 123,
'OriginKeepaliveTimeout': 123
},
'ConnectionAttempts': 123,
'ConnectionTimeout': 123,
'OriginShield': {
'Enabled': True|False,
'OriginShieldRegion': 'string'
},
'OriginAccessControlId': 'string'
},
]
},
'OriginGroups': {
'Quantity': 123,
'Items': [
{
'Id': 'string',
'FailoverCriteria': {
'StatusCodes': {
'Quantity': 123,
'Items': [
123,
]
}
},
'Members': {
'Quantity': 123,
'Items': [
{
'OriginId': 'string'
},
]
}
},
]
},
'DefaultCacheBehavior': {
'TargetOriginId': 'string',
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'TrustedKeyGroups': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'ViewerProtocolPolicy': 'allow-all'|'https-only'|'redirect-to-https',
'AllowedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
],
'CachedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
]
}
},
'SmoothStreaming': True|False,
'Compress': True|False,
'LambdaFunctionAssociations': {
'Quantity': 123,
'Items': [
{
'LambdaFunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response',
'IncludeBody': True|False
},
]
},
'FunctionAssociations': {
'Quantity': 123,
'Items': [
{
'FunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response'
},
]
},
'FieldLevelEncryptionId': 'string',
'RealtimeLogConfigArn': 'string',
'CachePolicyId': 'string',
'OriginRequestPolicyId': 'string',
'ResponseHeadersPolicyId': 'string',
'ForwardedValues': {
'QueryString': True|False,
'Cookies': {
'Forward': 'none'|'whitelist'|'all',
'WhitelistedNames': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
},
'QueryStringCacheKeys': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'MinTTL': 123,
'DefaultTTL': 123,
'MaxTTL': 123
},
'CacheBehaviors': {
'Quantity': 123,
'Items': [
{
'PathPattern': 'string',
'TargetOriginId': 'string',
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'TrustedKeyGroups': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'ViewerProtocolPolicy': 'allow-all'|'https-only'|'redirect-to-https',
'AllowedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
],
'CachedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
]
}
},
'SmoothStreaming': True|False,
'Compress': True|False,
'LambdaFunctionAssociations': {
'Quantity': 123,
'Items': [
{
'LambdaFunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response',
'IncludeBody': True|False
},
]
},
'FunctionAssociations': {
'Quantity': 123,
'Items': [
{
'FunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response'
},
]
},
'FieldLevelEncryptionId': 'string',
'RealtimeLogConfigArn': 'string',
'CachePolicyId': 'string',
'OriginRequestPolicyId': 'string',
'ResponseHeadersPolicyId': 'string',
'ForwardedValues': {
'QueryString': True|False,
'Cookies': {
'Forward': 'none'|'whitelist'|'all',
'WhitelistedNames': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
},
'QueryStringCacheKeys': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'MinTTL': 123,
'DefaultTTL': 123,
'MaxTTL': 123
},
]
},
'CustomErrorResponses': {
'Quantity': 123,
'Items': [
{
'ErrorCode': 123,
'ResponsePagePath': 'string',
'ResponseCode': 'string',
'ErrorCachingMinTTL': 123
},
]
},
'Comment': 'string',
'PriceClass': 'PriceClass_100'|'PriceClass_200'|'PriceClass_All',
'Enabled': True|False,
'ViewerCertificate': {
'CloudFrontDefaultCertificate': True|False,
'IAMCertificateId': 'string',
'ACMCertificateArn': 'string',
'SSLSupportMethod': 'sni-only'|'vip'|'static-ip',
'MinimumProtocolVersion': 'SSLv3'|'TLSv1'|'TLSv1_2016'|'TLSv1.1_2016'|'TLSv1.2_2018'|'TLSv1.2_2019'|'TLSv1.2_2021',
'Certificate': 'string',
'CertificateSource': 'cloudfront'|'iam'|'acm'
},
'Restrictions': {
'GeoRestriction': {
'RestrictionType': 'blacklist'|'whitelist'|'none',
'Quantity': 123,
'Items': [
'string',
]
}
},
'WebACLId': 'string',
'HttpVersion': 'http1.1'|'http2'|'http3'|'http2and3',
'IsIPV6Enabled': True|False,
'AliasICPRecordals': [
{
'CNAME': 'string',
'ICPRecordalStatus': 'APPROVED'|'SUSPENDED'|'PENDING'
},
]
},
]
}
}
Response Structure
(dict) --
The returned result of the corresponding request.
DistributionList (dict) --
The DistributionList type.
Marker (string) --
The value you provided for the Marker request parameter.
NextMarker (string) --
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.
MaxItems (integer) --
The value you provided for the MaxItems request parameter.
IsTruncated (boolean) --
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.
Quantity (integer) --
The number of distributions that were created by the current Amazon Web Services account.
Items (list) --
A complex type that contains one DistributionSummary element for each distribution that was created by the current Amazon Web Services account.
(dict) --
A summary of the information about a CloudFront distribution.
Id (string) --
The identifier for the distribution. For example: EDFDVBD632BHDS5 .
ARN (string) --
The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5 , where 123456789012 is your Amazon Web Services account ID.
Status (string) --
The current status of the distribution. When the status is Deployed , the distribution's information is propagated to all CloudFront edge locations.
LastModifiedTime (datetime) --
The date and time the distribution was last modified.
DomainName (string) --
The domain name that corresponds to the distribution, for example, d111111abcdef8.cloudfront.net .
Aliases (dict) --
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
Quantity (integer) --
The number of CNAME aliases, if any, that you want to associate with this distribution.
Items (list) --
A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
Origins (dict) --
A complex type that contains information about origins for this distribution.
Quantity (integer) --
The number of origins for this distribution.
Items (list) --
A list of origins.
(dict) --
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:
S3OriginConfig to specify an Amazon S3 bucket that is not configured with static website hosting.CustomOriginConfig to specify all other kinds of origins, including: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).
Id (string) --
A unique identifier for the origin. This value must be unique within the distribution.
Use this value to specify the TargetOriginId in a CacheBehavior or DefaultCacheBehavior .
DomainName (string) --
The domain name for the origin.
For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide .
OriginPath (string) --
An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
For more information, see Origin Path in the Amazon CloudFront Developer Guide .
CustomHeaders (dict) --
A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.
For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .
Quantity (integer) --
The number of custom headers, if any, for this distribution.
Items (list) --
Optional : A list that contains one
OriginCustomHeaderelement for each custom header that you want CloudFront to forward to the origin. If Quantity is0, omitItems.
(dict) --
A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution.
HeaderName (string) --
The name of a header that you want CloudFront to send to your origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .
HeaderValue (string) --
The value for the header that you specified in the HeaderName field.
S3OriginConfig (dict) --
Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the CustomOriginConfig type instead.
OriginAccessIdentity (string) --
The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
origin-access-identity/cloudfront/ID-of-origin-access-identity
where `` ID-of-origin-access-identity `` is the value that CloudFront returned in the ID element when you created the origin access identity.
If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.
To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.
To replace the origin access identity, update the distribution configuration and specify the new origin access identity.
For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
CustomOriginConfig (dict) --
Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.
HTTPPort (integer) --
The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
HTTPSPort (integer) --
The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
OriginProtocolPolicy (string) --
Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:
http-only – CloudFront always uses HTTP to connect to the origin.match-viewer – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.https-only – CloudFront always uses HTTPS to connect to the origin.OriginSslProtocols (dict) --
Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include SSLv3 , TLSv1 , TLSv1.1 , and TLSv1.2 .
For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide .
Quantity (integer) --
The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.
Items (list) --
A list that contains allowed SSL/TLS protocols for this distribution.
OriginReadTimeout (integer) --
Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout . The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 30 seconds.
For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide .
OriginKeepaliveTimeout (integer) --
Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 5 seconds.
For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide .
ConnectionAttempts (integer) --
The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don’t specify otherwise) is 3.
For a custom origin (including an Amazon S3 bucket that’s configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout .
For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide .
ConnectionTimeout (integer) --
The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don’t specify otherwise) is 10 seconds.
For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide .
OriginShield (dict) --
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 .
Enabled (boolean) --
A flag that specifies whether Origin Shield is enabled.
When it’s enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it’s disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.
OriginShieldRegion (string) --
The Amazon Web Services Region for Origin Shield.
Specify the Amazon Web Services Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as us-east-2 .
When you enable CloudFront Origin Shield, you must specify the Amazon Web Services Region for Origin Shield. For the list of Amazon Web Services Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the Amazon Web Services Region for Origin Shield in the Amazon CloudFront Developer Guide .
OriginAccessControlId (string) --
The unique identifier of an origin access control for this origin.
For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide .
OriginGroups (dict) --
A complex type that contains information about origin groups for this distribution.
Quantity (integer) --
The number of origin groups.
Items (list) --
The items (origin groups) in a distribution.
(dict) --
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.
Id (string) --
The origin group's ID.
FailoverCriteria (dict) --
A complex type that contains information about the failover criteria for an origin group.
StatusCodes (dict) --
The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.
Quantity (integer) --
The number of status codes.
Items (list) --
The items (status codes) for an origin group.
Members (dict) --
A complex type that contains information about the origins in an origin group.
Quantity (integer) --
The number of origins in an origin group.
Items (list) --
Items (origins) in an origin group.
(dict) --
An origin in an origin group.
OriginId (string) --
The ID for an origin in an origin group.
DefaultCacheBehavior (dict) --
A complex type that describes the default cache behavior if you don't 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.
TargetOriginId (string) --
The value of ID for the origin that you want CloudFront to route requests to when they use the default cache behavior.
TrustedSigners (dict) --
Warning
We recommend using TrustedKeyGroups instead of TrustedSigners .
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer’s Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
Enabled (boolean) --
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
Quantity (integer) --
The number of Amazon Web Services accounts in the list.
Items (list) --
A list of Amazon Web Services account identifiers.
TrustedKeyGroups (dict) --
A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
Enabled (boolean) --
This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
Quantity (integer) --
The number of key groups in the list.
Items (list) --
A list of key groups identifiers.
ViewerProtocolPolicy (string) --
The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern . You can specify the following options:
allow-all : Viewers can use HTTP or HTTPS.redirect-to-https : If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only : If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide .
AllowedMethods (dict) --
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:
GET and HEAD requests.GET , HEAD , and OPTIONS requests.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.
Quantity (integer) --
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).
Items (list) --
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
CachedMethods (dict) --
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
GET and HEAD requests.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.
Quantity (integer) --
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).
Items (list) --
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
SmoothStreaming (boolean) --
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true ; if not, specify false . If you specify true for SmoothStreaming , you can still distribute other content using this cache behavior if the content matches the value of PathPattern .
Compress (boolean) --
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true ; if not, specify false . For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .
LambdaFunctionAssociations (dict) --
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
Quantity (integer) --
The number of Lambda@Edge function associations for this cache behavior.
Items (list) --
Optional : A complex type that contains
LambdaFunctionAssociationitems for this cache behavior. IfQuantityis0, you can omitItems.
(dict) --
A complex type that contains a Lambda@Edge function association.
LambdaFunctionARN (string) --
The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
EventType (string) --
Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request : The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request : The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response : The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response : The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.IncludeBody (boolean) --
A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
FunctionAssociations (dict) --
A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.
Quantity (integer) --
The number of CloudFront functions in the list.
Items (list) --
The 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.
(dict) --
A CloudFront function that is associated with a cache behavior in a CloudFront distribution.
FunctionARN (string) --
The Amazon Resource Name (ARN) of the function.
EventType (string) --
The event type of the function, either viewer-request or viewer-response . You cannot use origin-facing event types (origin-request and origin-response ) with a CloudFront function.
FieldLevelEncryptionId (string) --
The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior.
RealtimeLogConfigArn (string) --
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide .
CachePolicyId (string) --
The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
OriginRequestPolicyId (string) --
The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
ResponseHeadersPolicyId (string) --
The identifier for a response headers policy.
ForwardedValues (dict) --
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide .
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed 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 or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
QueryString (boolean) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 .
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys , if any:
If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
If you specify false for QueryString , CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide .
Cookies (dict) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 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 How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide .
Forward (string) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide .
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.
Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.
WhitelistedNames (dict) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 .
Required if you specify whitelist for the value of Forward . A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.
If you specify all or none for the value of Forward , omit WhitelistedNames . If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.
For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference .
Quantity (integer) --
The number of cookie names in the Items list.
Items (list) --
A list of cookie names.
Headers (dict) --
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 headers 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 headers 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 the Headers , if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.
For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide .
Quantity (integer) --
The number of header names in the Items list.
Items (list) --
A list of HTTP header names.
QueryStringCacheKeys (dict) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
Quantity (integer) --
The number of whitelisted query string parameters for a cache behavior.
Items (list) --
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items .
MinTTL (integer) --
This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers , if you specify 1 for Quantity and * for Name ).
DefaultTTL (integer) --
This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The default amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
MaxTTL (integer) --
This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The maximum amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
CacheBehaviors (dict) --
A complex type that contains zero or more CacheBehavior elements.
Quantity (integer) --
The number of cache behaviors for this distribution.
Items (list) --
Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0 , you can omit Items .
(dict) --
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 .
PathPattern (string) --
The pattern (for example, images/*.jpg ) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.
Note
You can optionally include a slash (/ ) at the beginning of the path pattern. For example, /images/*.jpg . CloudFront behavior is the same with or without the leading / .
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.
For more information, see Path Pattern in the Amazon CloudFront Developer Guide .
TargetOriginId (string) --
The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.
TrustedSigners (dict) --
Warning
We recommend using TrustedKeyGroups instead of TrustedSigners .
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer’s Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
Enabled (boolean) --
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
Quantity (integer) --
The number of Amazon Web Services accounts in the list.
Items (list) --
A list of Amazon Web Services account identifiers.
TrustedKeyGroups (dict) --
A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
Enabled (boolean) --
This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
Quantity (integer) --
The number of key groups in the list.
Items (list) --
A list of key groups identifiers.
ViewerProtocolPolicy (string) --
The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern . You can specify the following options:
allow-all : Viewers can use HTTP or HTTPS.redirect-to-https : If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only : If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide .
AllowedMethods (dict) --
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:
GET and HEAD requests.GET , HEAD , and OPTIONS requests.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.
Quantity (integer) --
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).
Items (list) --
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
CachedMethods (dict) --
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
GET and HEAD requests.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.
Quantity (integer) --
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).
Items (list) --
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
SmoothStreaming (boolean) --
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true ; if not, specify false . If you specify true for SmoothStreaming , you can still distribute other content using this cache behavior if the content matches the value of PathPattern .
Compress (boolean) --
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .
LambdaFunctionAssociations (dict) --
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
Quantity (integer) --
The number of Lambda@Edge function associations for this cache behavior.
Items (list) --
Optional : A complex type that contains
LambdaFunctionAssociationitems for this cache behavior. IfQuantityis0, you can omitItems.
(dict) --
A complex type that contains a Lambda@Edge function association.
LambdaFunctionARN (string) --
The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
EventType (string) --
Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request : The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request : The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response : The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response : The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.IncludeBody (boolean) --
A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
FunctionAssociations (dict) --
A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.
Quantity (integer) --
The number of CloudFront functions in the list.
Items (list) --
The 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.
(dict) --
A CloudFront function that is associated with a cache behavior in a CloudFront distribution.
FunctionARN (string) --
The Amazon Resource Name (ARN) of the function.
EventType (string) --
The event type of the function, either viewer-request or viewer-response . You cannot use origin-facing event types (origin-request and origin-response ) with a CloudFront function.
FieldLevelEncryptionId (string) --
The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.
RealtimeLogConfigArn (string) --
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide .
CachePolicyId (string) --
The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
A CacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
OriginRequestPolicyId (string) --
The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
ResponseHeadersPolicyId (string) --
The identifier for a response headers policy.
ForwardedValues (dict) --
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide .
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed 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 or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
A CacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
QueryString (boolean) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 .
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys , if any:
If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
If you specify false for QueryString , CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide .
Cookies (dict) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 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 How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide .
Forward (string) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide .
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.
Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.
WhitelistedNames (dict) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 .
Required if you specify whitelist for the value of Forward . A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.
If you specify all or none for the value of Forward , omit WhitelistedNames . If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.
For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference .
Quantity (integer) --
The number of cookie names in the Items list.
Items (list) --
A list of cookie names.
Headers (dict) --
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 headers 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 headers 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 the Headers , if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.
For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide .
Quantity (integer) --
The number of header names in the Items list.
Items (list) --
A list of HTTP header names.
QueryStringCacheKeys (dict) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
Quantity (integer) --
The number of whitelisted query string parameters for a cache behavior.
Items (list) --
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items .
MinTTL (integer) --
This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers , if you specify 1 for Quantity and * for Name ).
DefaultTTL (integer) --
This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The default amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
MaxTTL (integer) --
This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The maximum amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
CustomErrorResponses (dict) --
A complex type that contains zero or more CustomErrorResponses elements.
Quantity (integer) --
The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0 , you can omit Items .
Items (list) --
A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration.
(dict) --
A complex type that controls:
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
ErrorCode (integer) --
The HTTP status code for which you want to specify a custom error page and/or a caching duration.
ResponsePagePath (string) --
The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode , for example, /4xx-errors/403-forbidden.html . If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:
PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors . Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, /4xx-errors/* .TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages.If you specify a value for ResponsePagePath , you must also specify a value for ResponseCode .
We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.
ResponseCode (string) --
The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:
200 , the response typically won't be intercepted.400 or 500 as the ResponseCode for all 4xx or 5xx errors.200 status code (OK) and static website so your customers don't know that your website is down.If you specify a value for ResponseCode , you must also specify a value for ResponsePagePath .
ErrorCachingMinTTL (integer) --
The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode . When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.
For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
Comment (string) --
The comment originally specified when this distribution was created.
PriceClass (string) --
A complex type that contains information about price class for this streaming distribution.
Enabled (boolean) --
Whether the distribution is enabled to accept user requests for content.
ViewerCertificate (dict) --
A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.
CloudFrontDefaultCertificate (boolean) --
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net , set this field to true .
If the distribution uses Aliases (alternate domain names or CNAMEs), set this field to false and specify values for the following fields:
ACMCertificateArn or IAMCertificateId (specify a value for one, not both)MinimumProtocolVersionSSLSupportMethodIAMCertificateId (string) --
If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Identity and Access Management (IAM) , provide the ID of the IAM certificate.
If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVersion and SSLSupportMethod .
ACMCertificateArn (string) --
If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Certificate Manager (ACM) , provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (us-east-1 ).
If you specify an ACM certificate ARN, you must also specify values for MinimumProtocolVersion and SSLSupportMethod .
SSLSupportMethod (string) --
If the distribution uses Aliases (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.
sni-only – The distribution accepts HTTPS connections from only viewers that support server name indication (SNI) . This is recommended. Most browsers and clients support SNI.vip – The distribution accepts HTTPS connections from all viewers including those that don’t support SNI. This is not recommended, and results in additional monthly charges from CloudFront.static-ip - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the Amazon Web Services Support Center .If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net , don’t set a value for this field.
MinimumProtocolVersion (string) --
If the distribution uses Aliases (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:
For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
On the CloudFront console, this setting is called Security Policy .
When you’re using SNI only (you set SSLSupportMethod to sni-only ), you must specify TLSv1 or higher.
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net (you set CloudFrontDefaultCertificate to true ), CloudFront automatically sets the security policy to TLSv1 regardless of the value that you set here.
Certificate (string) --
This field is deprecated. Use one of the following fields instead:
ACMCertificateArnIAMCertificateIdCloudFrontDefaultCertificateCertificateSource (string) --
This field is deprecated. Use one of the following fields instead:
ACMCertificateArnIAMCertificateIdCloudFrontDefaultCertificateRestrictions (dict) --
A complex type that identifies ways in which you want to restrict distribution of your content.
GeoRestriction (dict) --
A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.
RestrictionType (string) --
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 don't want CloudFront to distribute your content.whitelist : The Location elements specify the countries in which you want CloudFront to distribute your content.Quantity (integer) --
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 .
Items (list) --
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 on the CloudFront console, which includes both country names and codes.
WebACLId (string) --
The Web ACL Id (if any) associated with the distribution.
HttpVersion (string) --
Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2 . Viewers that don't support HTTP/2 will automatically use an earlier version.
IsIPV6Enabled (boolean) --
Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.
AliasICPRecordals (list) --
Amazon Web Services 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.
For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China .
(dict) --
Amazon Web Services 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 Amazon Web Services services in China .
CNAME (string) --
A domain name associated with a distribution.
ICPRecordalStatus (string) --
The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in regions outside of China.
The status values returned are the following:
Exceptions
CloudFront.Client.exceptions.InvalidArgumentlist_distributions_by_cache_policy_id(**kwargs)¶Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified cache policy.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
See also: AWS API Documentation
Request Syntax
response = client.list_distributions_by_cache_policy_id(
Marker='string',
MaxItems='string',
CachePolicyId='string'
)
NextMarker from the current page’s response.[REQUIRED]
The ID of the cache policy whose associated distribution IDs you want to list.
dict
Response Syntax
{
'DistributionIdList': {
'Marker': 'string',
'NextMarker': 'string',
'MaxItems': 123,
'IsTruncated': True|False,
'Quantity': 123,
'Items': [
'string',
]
}
}
Response Structure
(dict) --
DistributionIdList (dict) --
A list of distribution IDs.
Marker (string) --
The value provided in the Marker request field.
NextMarker (string) --
Contains the value that you should use in the Marker field of a subsequent request to continue listing distribution IDs where you left off.
MaxItems (integer) --
The maximum number of distribution IDs requested.
IsTruncated (boolean) --
A flag that indicates whether more distribution IDs remain to be listed. If your results were truncated, you can make a subsequent request using the Marker request field to retrieve more distribution IDs in the list.
Quantity (integer) --
The total number of distribution IDs returned in the response.
Items (list) --
Contains the distribution IDs in the list.
Exceptions
CloudFront.Client.exceptions.NoSuchCachePolicyCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.AccessDeniedlist_distributions_by_key_group(**kwargs)¶Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
See also: AWS API Documentation
Request Syntax
response = client.list_distributions_by_key_group(
Marker='string',
MaxItems='string',
KeyGroupId='string'
)
NextMarker from the current page’s response.[REQUIRED]
The ID of the key group whose associated distribution IDs you are listing.
dict
Response Syntax
{
'DistributionIdList': {
'Marker': 'string',
'NextMarker': 'string',
'MaxItems': 123,
'IsTruncated': True|False,
'Quantity': 123,
'Items': [
'string',
]
}
}
Response Structure
(dict) --
DistributionIdList (dict) --
A list of distribution IDs.
Marker (string) --
The value provided in the Marker request field.
NextMarker (string) --
Contains the value that you should use in the Marker field of a subsequent request to continue listing distribution IDs where you left off.
MaxItems (integer) --
The maximum number of distribution IDs requested.
IsTruncated (boolean) --
A flag that indicates whether more distribution IDs remain to be listed. If your results were truncated, you can make a subsequent request using the Marker request field to retrieve more distribution IDs in the list.
Quantity (integer) --
The total number of distribution IDs returned in the response.
Items (list) --
Contains the distribution IDs in the list.
Exceptions
CloudFront.Client.exceptions.NoSuchResourceCloudFront.Client.exceptions.InvalidArgumentlist_distributions_by_origin_request_policy_id(**kwargs)¶Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified origin request policy.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
See also: AWS API Documentation
Request Syntax
response = client.list_distributions_by_origin_request_policy_id(
Marker='string',
MaxItems='string',
OriginRequestPolicyId='string'
)
NextMarker from the current page’s response.[REQUIRED]
The ID of the origin request policy whose associated distribution IDs you want to list.
dict
Response Syntax
{
'DistributionIdList': {
'Marker': 'string',
'NextMarker': 'string',
'MaxItems': 123,
'IsTruncated': True|False,
'Quantity': 123,
'Items': [
'string',
]
}
}
Response Structure
(dict) --
DistributionIdList (dict) --
A list of distribution IDs.
Marker (string) --
The value provided in the Marker request field.
NextMarker (string) --
Contains the value that you should use in the Marker field of a subsequent request to continue listing distribution IDs where you left off.
MaxItems (integer) --
The maximum number of distribution IDs requested.
IsTruncated (boolean) --
A flag that indicates whether more distribution IDs remain to be listed. If your results were truncated, you can make a subsequent request using the Marker request field to retrieve more distribution IDs in the list.
Quantity (integer) --
The total number of distribution IDs returned in the response.
Items (list) --
Contains the distribution IDs in the list.
Exceptions
CloudFront.Client.exceptions.NoSuchOriginRequestPolicyCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.AccessDeniedlist_distributions_by_realtime_log_config(**kwargs)¶Gets a list of distributions that have a cache behavior that’s associated with the specified real-time log configuration.
You can specify the real-time log configuration by its name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to list distributions for.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
See also: AWS API Documentation
Request Syntax
response = client.list_distributions_by_realtime_log_config(
Marker='string',
MaxItems='string',
RealtimeLogConfigName='string',
RealtimeLogConfigArn='string'
)
NextMarker from the current page’s response.dict
Response Syntax
{
'DistributionList': {
'Marker': 'string',
'NextMarker': 'string',
'MaxItems': 123,
'IsTruncated': True|False,
'Quantity': 123,
'Items': [
{
'Id': 'string',
'ARN': 'string',
'Status': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'DomainName': 'string',
'Aliases': {
'Quantity': 123,
'Items': [
'string',
]
},
'Origins': {
'Quantity': 123,
'Items': [
{
'Id': 'string',
'DomainName': 'string',
'OriginPath': 'string',
'CustomHeaders': {
'Quantity': 123,
'Items': [
{
'HeaderName': 'string',
'HeaderValue': 'string'
},
]
},
'S3OriginConfig': {
'OriginAccessIdentity': 'string'
},
'CustomOriginConfig': {
'HTTPPort': 123,
'HTTPSPort': 123,
'OriginProtocolPolicy': 'http-only'|'match-viewer'|'https-only',
'OriginSslProtocols': {
'Quantity': 123,
'Items': [
'SSLv3'|'TLSv1'|'TLSv1.1'|'TLSv1.2',
]
},
'OriginReadTimeout': 123,
'OriginKeepaliveTimeout': 123
},
'ConnectionAttempts': 123,
'ConnectionTimeout': 123,
'OriginShield': {
'Enabled': True|False,
'OriginShieldRegion': 'string'
},
'OriginAccessControlId': 'string'
},
]
},
'OriginGroups': {
'Quantity': 123,
'Items': [
{
'Id': 'string',
'FailoverCriteria': {
'StatusCodes': {
'Quantity': 123,
'Items': [
123,
]
}
},
'Members': {
'Quantity': 123,
'Items': [
{
'OriginId': 'string'
},
]
}
},
]
},
'DefaultCacheBehavior': {
'TargetOriginId': 'string',
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'TrustedKeyGroups': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'ViewerProtocolPolicy': 'allow-all'|'https-only'|'redirect-to-https',
'AllowedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
],
'CachedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
]
}
},
'SmoothStreaming': True|False,
'Compress': True|False,
'LambdaFunctionAssociations': {
'Quantity': 123,
'Items': [
{
'LambdaFunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response',
'IncludeBody': True|False
},
]
},
'FunctionAssociations': {
'Quantity': 123,
'Items': [
{
'FunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response'
},
]
},
'FieldLevelEncryptionId': 'string',
'RealtimeLogConfigArn': 'string',
'CachePolicyId': 'string',
'OriginRequestPolicyId': 'string',
'ResponseHeadersPolicyId': 'string',
'ForwardedValues': {
'QueryString': True|False,
'Cookies': {
'Forward': 'none'|'whitelist'|'all',
'WhitelistedNames': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
},
'QueryStringCacheKeys': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'MinTTL': 123,
'DefaultTTL': 123,
'MaxTTL': 123
},
'CacheBehaviors': {
'Quantity': 123,
'Items': [
{
'PathPattern': 'string',
'TargetOriginId': 'string',
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'TrustedKeyGroups': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'ViewerProtocolPolicy': 'allow-all'|'https-only'|'redirect-to-https',
'AllowedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
],
'CachedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
]
}
},
'SmoothStreaming': True|False,
'Compress': True|False,
'LambdaFunctionAssociations': {
'Quantity': 123,
'Items': [
{
'LambdaFunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response',
'IncludeBody': True|False
},
]
},
'FunctionAssociations': {
'Quantity': 123,
'Items': [
{
'FunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response'
},
]
},
'FieldLevelEncryptionId': 'string',
'RealtimeLogConfigArn': 'string',
'CachePolicyId': 'string',
'OriginRequestPolicyId': 'string',
'ResponseHeadersPolicyId': 'string',
'ForwardedValues': {
'QueryString': True|False,
'Cookies': {
'Forward': 'none'|'whitelist'|'all',
'WhitelistedNames': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
},
'QueryStringCacheKeys': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'MinTTL': 123,
'DefaultTTL': 123,
'MaxTTL': 123
},
]
},
'CustomErrorResponses': {
'Quantity': 123,
'Items': [
{
'ErrorCode': 123,
'ResponsePagePath': 'string',
'ResponseCode': 'string',
'ErrorCachingMinTTL': 123
},
]
},
'Comment': 'string',
'PriceClass': 'PriceClass_100'|'PriceClass_200'|'PriceClass_All',
'Enabled': True|False,
'ViewerCertificate': {
'CloudFrontDefaultCertificate': True|False,
'IAMCertificateId': 'string',
'ACMCertificateArn': 'string',
'SSLSupportMethod': 'sni-only'|'vip'|'static-ip',
'MinimumProtocolVersion': 'SSLv3'|'TLSv1'|'TLSv1_2016'|'TLSv1.1_2016'|'TLSv1.2_2018'|'TLSv1.2_2019'|'TLSv1.2_2021',
'Certificate': 'string',
'CertificateSource': 'cloudfront'|'iam'|'acm'
},
'Restrictions': {
'GeoRestriction': {
'RestrictionType': 'blacklist'|'whitelist'|'none',
'Quantity': 123,
'Items': [
'string',
]
}
},
'WebACLId': 'string',
'HttpVersion': 'http1.1'|'http2'|'http3'|'http2and3',
'IsIPV6Enabled': True|False,
'AliasICPRecordals': [
{
'CNAME': 'string',
'ICPRecordalStatus': 'APPROVED'|'SUSPENDED'|'PENDING'
},
]
},
]
}
}
Response Structure
(dict) --
DistributionList (dict) --
A distribution list.
Marker (string) --
The value you provided for the Marker request parameter.
NextMarker (string) --
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.
MaxItems (integer) --
The value you provided for the MaxItems request parameter.
IsTruncated (boolean) --
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.
Quantity (integer) --
The number of distributions that were created by the current Amazon Web Services account.
Items (list) --
A complex type that contains one DistributionSummary element for each distribution that was created by the current Amazon Web Services account.
(dict) --
A summary of the information about a CloudFront distribution.
Id (string) --
The identifier for the distribution. For example: EDFDVBD632BHDS5 .
ARN (string) --
The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5 , where 123456789012 is your Amazon Web Services account ID.
Status (string) --
The current status of the distribution. When the status is Deployed , the distribution's information is propagated to all CloudFront edge locations.
LastModifiedTime (datetime) --
The date and time the distribution was last modified.
DomainName (string) --
The domain name that corresponds to the distribution, for example, d111111abcdef8.cloudfront.net .
Aliases (dict) --
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
Quantity (integer) --
The number of CNAME aliases, if any, that you want to associate with this distribution.
Items (list) --
A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
Origins (dict) --
A complex type that contains information about origins for this distribution.
Quantity (integer) --
The number of origins for this distribution.
Items (list) --
A list of origins.
(dict) --
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:
S3OriginConfig to specify an Amazon S3 bucket that is not configured with static website hosting.CustomOriginConfig to specify all other kinds of origins, including: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).
Id (string) --
A unique identifier for the origin. This value must be unique within the distribution.
Use this value to specify the TargetOriginId in a CacheBehavior or DefaultCacheBehavior .
DomainName (string) --
The domain name for the origin.
For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide .
OriginPath (string) --
An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
For more information, see Origin Path in the Amazon CloudFront Developer Guide .
CustomHeaders (dict) --
A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.
For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .
Quantity (integer) --
The number of custom headers, if any, for this distribution.
Items (list) --
Optional : A list that contains one
OriginCustomHeaderelement for each custom header that you want CloudFront to forward to the origin. If Quantity is0, omitItems.
(dict) --
A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution.
HeaderName (string) --
The name of a header that you want CloudFront to send to your origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .
HeaderValue (string) --
The value for the header that you specified in the HeaderName field.
S3OriginConfig (dict) --
Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the CustomOriginConfig type instead.
OriginAccessIdentity (string) --
The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
origin-access-identity/cloudfront/ID-of-origin-access-identity
where `` ID-of-origin-access-identity `` is the value that CloudFront returned in the ID element when you created the origin access identity.
If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.
To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.
To replace the origin access identity, update the distribution configuration and specify the new origin access identity.
For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
CustomOriginConfig (dict) --
Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.
HTTPPort (integer) --
The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
HTTPSPort (integer) --
The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
OriginProtocolPolicy (string) --
Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:
http-only – CloudFront always uses HTTP to connect to the origin.match-viewer – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.https-only – CloudFront always uses HTTPS to connect to the origin.OriginSslProtocols (dict) --
Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include SSLv3 , TLSv1 , TLSv1.1 , and TLSv1.2 .
For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide .
Quantity (integer) --
The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.
Items (list) --
A list that contains allowed SSL/TLS protocols for this distribution.
OriginReadTimeout (integer) --
Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout . The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 30 seconds.
For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide .
OriginKeepaliveTimeout (integer) --
Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 5 seconds.
For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide .
ConnectionAttempts (integer) --
The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don’t specify otherwise) is 3.
For a custom origin (including an Amazon S3 bucket that’s configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout .
For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide .
ConnectionTimeout (integer) --
The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don’t specify otherwise) is 10 seconds.
For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide .
OriginShield (dict) --
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 .
Enabled (boolean) --
A flag that specifies whether Origin Shield is enabled.
When it’s enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it’s disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.
OriginShieldRegion (string) --
The Amazon Web Services Region for Origin Shield.
Specify the Amazon Web Services Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as us-east-2 .
When you enable CloudFront Origin Shield, you must specify the Amazon Web Services Region for Origin Shield. For the list of Amazon Web Services Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the Amazon Web Services Region for Origin Shield in the Amazon CloudFront Developer Guide .
OriginAccessControlId (string) --
The unique identifier of an origin access control for this origin.
For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide .
OriginGroups (dict) --
A complex type that contains information about origin groups for this distribution.
Quantity (integer) --
The number of origin groups.
Items (list) --
The items (origin groups) in a distribution.
(dict) --
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.
Id (string) --
The origin group's ID.
FailoverCriteria (dict) --
A complex type that contains information about the failover criteria for an origin group.
StatusCodes (dict) --
The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.
Quantity (integer) --
The number of status codes.
Items (list) --
The items (status codes) for an origin group.
Members (dict) --
A complex type that contains information about the origins in an origin group.
Quantity (integer) --
The number of origins in an origin group.
Items (list) --
Items (origins) in an origin group.
(dict) --
An origin in an origin group.
OriginId (string) --
The ID for an origin in an origin group.
DefaultCacheBehavior (dict) --
A complex type that describes the default cache behavior if you don't 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.
TargetOriginId (string) --
The value of ID for the origin that you want CloudFront to route requests to when they use the default cache behavior.
TrustedSigners (dict) --
Warning
We recommend using TrustedKeyGroups instead of TrustedSigners .
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer’s Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
Enabled (boolean) --
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
Quantity (integer) --
The number of Amazon Web Services accounts in the list.
Items (list) --
A list of Amazon Web Services account identifiers.
TrustedKeyGroups (dict) --
A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
Enabled (boolean) --
This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
Quantity (integer) --
The number of key groups in the list.
Items (list) --
A list of key groups identifiers.
ViewerProtocolPolicy (string) --
The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern . You can specify the following options:
allow-all : Viewers can use HTTP or HTTPS.redirect-to-https : If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only : If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide .
AllowedMethods (dict) --
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:
GET and HEAD requests.GET , HEAD , and OPTIONS requests.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.
Quantity (integer) --
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).
Items (list) --
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
CachedMethods (dict) --
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
GET and HEAD requests.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.
Quantity (integer) --
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).
Items (list) --
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
SmoothStreaming (boolean) --
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true ; if not, specify false . If you specify true for SmoothStreaming , you can still distribute other content using this cache behavior if the content matches the value of PathPattern .
Compress (boolean) --
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true ; if not, specify false . For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .
LambdaFunctionAssociations (dict) --
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
Quantity (integer) --
The number of Lambda@Edge function associations for this cache behavior.
Items (list) --
Optional : A complex type that contains
LambdaFunctionAssociationitems for this cache behavior. IfQuantityis0, you can omitItems.
(dict) --
A complex type that contains a Lambda@Edge function association.
LambdaFunctionARN (string) --
The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
EventType (string) --
Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request : The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request : The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response : The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response : The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.IncludeBody (boolean) --
A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
FunctionAssociations (dict) --
A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.
Quantity (integer) --
The number of CloudFront functions in the list.
Items (list) --
The 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.
(dict) --
A CloudFront function that is associated with a cache behavior in a CloudFront distribution.
FunctionARN (string) --
The Amazon Resource Name (ARN) of the function.
EventType (string) --
The event type of the function, either viewer-request or viewer-response . You cannot use origin-facing event types (origin-request and origin-response ) with a CloudFront function.
FieldLevelEncryptionId (string) --
The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior.
RealtimeLogConfigArn (string) --
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide .
CachePolicyId (string) --
The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
OriginRequestPolicyId (string) --
The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
ResponseHeadersPolicyId (string) --
The identifier for a response headers policy.
ForwardedValues (dict) --
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide .
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed 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 or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
QueryString (boolean) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 .
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys , if any:
If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
If you specify false for QueryString , CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide .
Cookies (dict) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 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 How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide .
Forward (string) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide .
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.
Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.
WhitelistedNames (dict) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 .
Required if you specify whitelist for the value of Forward . A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.
If you specify all or none for the value of Forward , omit WhitelistedNames . If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.
For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference .
Quantity (integer) --
The number of cookie names in the Items list.
Items (list) --
A list of cookie names.
Headers (dict) --
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 headers 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 headers 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 the Headers , if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.
For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide .
Quantity (integer) --
The number of header names in the Items list.
Items (list) --
A list of HTTP header names.
QueryStringCacheKeys (dict) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
Quantity (integer) --
The number of whitelisted query string parameters for a cache behavior.
Items (list) --
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items .
MinTTL (integer) --
This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers , if you specify 1 for Quantity and * for Name ).
DefaultTTL (integer) --
This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The default amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
MaxTTL (integer) --
This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The maximum amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
CacheBehaviors (dict) --
A complex type that contains zero or more CacheBehavior elements.
Quantity (integer) --
The number of cache behaviors for this distribution.
Items (list) --
Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0 , you can omit Items .
(dict) --
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 .
PathPattern (string) --
The pattern (for example, images/*.jpg ) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.
Note
You can optionally include a slash (/ ) at the beginning of the path pattern. For example, /images/*.jpg . CloudFront behavior is the same with or without the leading / .
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.
For more information, see Path Pattern in the Amazon CloudFront Developer Guide .
TargetOriginId (string) --
The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.
TrustedSigners (dict) --
Warning
We recommend using TrustedKeyGroups instead of TrustedSigners .
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer’s Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
Enabled (boolean) --
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
Quantity (integer) --
The number of Amazon Web Services accounts in the list.
Items (list) --
A list of Amazon Web Services account identifiers.
TrustedKeyGroups (dict) --
A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
Enabled (boolean) --
This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
Quantity (integer) --
The number of key groups in the list.
Items (list) --
A list of key groups identifiers.
ViewerProtocolPolicy (string) --
The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern . You can specify the following options:
allow-all : Viewers can use HTTP or HTTPS.redirect-to-https : If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only : If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide .
AllowedMethods (dict) --
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:
GET and HEAD requests.GET , HEAD , and OPTIONS requests.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.
Quantity (integer) --
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).
Items (list) --
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
CachedMethods (dict) --
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
GET and HEAD requests.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.
Quantity (integer) --
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).
Items (list) --
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
SmoothStreaming (boolean) --
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true ; if not, specify false . If you specify true for SmoothStreaming , you can still distribute other content using this cache behavior if the content matches the value of PathPattern .
Compress (boolean) --
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .
LambdaFunctionAssociations (dict) --
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
Quantity (integer) --
The number of Lambda@Edge function associations for this cache behavior.
Items (list) --
Optional : A complex type that contains
LambdaFunctionAssociationitems for this cache behavior. IfQuantityis0, you can omitItems.
(dict) --
A complex type that contains a Lambda@Edge function association.
LambdaFunctionARN (string) --
The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
EventType (string) --
Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request : The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request : The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response : The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response : The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.IncludeBody (boolean) --
A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
FunctionAssociations (dict) --
A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.
Quantity (integer) --
The number of CloudFront functions in the list.
Items (list) --
The 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.
(dict) --
A CloudFront function that is associated with a cache behavior in a CloudFront distribution.
FunctionARN (string) --
The Amazon Resource Name (ARN) of the function.
EventType (string) --
The event type of the function, either viewer-request or viewer-response . You cannot use origin-facing event types (origin-request and origin-response ) with a CloudFront function.
FieldLevelEncryptionId (string) --
The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.
RealtimeLogConfigArn (string) --
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide .
CachePolicyId (string) --
The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
A CacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
OriginRequestPolicyId (string) --
The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
ResponseHeadersPolicyId (string) --
The identifier for a response headers policy.
ForwardedValues (dict) --
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide .
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed 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 or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
A CacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
QueryString (boolean) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 .
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys , if any:
If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
If you specify false for QueryString , CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide .
Cookies (dict) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 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 How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide .
Forward (string) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide .
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.
Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.
WhitelistedNames (dict) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 .
Required if you specify whitelist for the value of Forward . A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.
If you specify all or none for the value of Forward , omit WhitelistedNames . If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.
For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference .
Quantity (integer) --
The number of cookie names in the Items list.
Items (list) --
A list of cookie names.
Headers (dict) --
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 headers 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 headers 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 the Headers , if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.
For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide .
Quantity (integer) --
The number of header names in the Items list.
Items (list) --
A list of HTTP header names.
QueryStringCacheKeys (dict) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
Quantity (integer) --
The number of whitelisted query string parameters for a cache behavior.
Items (list) --
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items .
MinTTL (integer) --
This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers , if you specify 1 for Quantity and * for Name ).
DefaultTTL (integer) --
This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The default amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
MaxTTL (integer) --
This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The maximum amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
CustomErrorResponses (dict) --
A complex type that contains zero or more CustomErrorResponses elements.
Quantity (integer) --
The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0 , you can omit Items .
Items (list) --
A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration.
(dict) --
A complex type that controls:
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
ErrorCode (integer) --
The HTTP status code for which you want to specify a custom error page and/or a caching duration.
ResponsePagePath (string) --
The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode , for example, /4xx-errors/403-forbidden.html . If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:
PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors . Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, /4xx-errors/* .TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages.If you specify a value for ResponsePagePath , you must also specify a value for ResponseCode .
We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.
ResponseCode (string) --
The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:
200 , the response typically won't be intercepted.400 or 500 as the ResponseCode for all 4xx or 5xx errors.200 status code (OK) and static website so your customers don't know that your website is down.If you specify a value for ResponseCode , you must also specify a value for ResponsePagePath .
ErrorCachingMinTTL (integer) --
The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode . When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.
For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
Comment (string) --
The comment originally specified when this distribution was created.
PriceClass (string) --
A complex type that contains information about price class for this streaming distribution.
Enabled (boolean) --
Whether the distribution is enabled to accept user requests for content.
ViewerCertificate (dict) --
A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.
CloudFrontDefaultCertificate (boolean) --
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net , set this field to true .
If the distribution uses Aliases (alternate domain names or CNAMEs), set this field to false and specify values for the following fields:
ACMCertificateArn or IAMCertificateId (specify a value for one, not both)MinimumProtocolVersionSSLSupportMethodIAMCertificateId (string) --
If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Identity and Access Management (IAM) , provide the ID of the IAM certificate.
If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVersion and SSLSupportMethod .
ACMCertificateArn (string) --
If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Certificate Manager (ACM) , provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (us-east-1 ).
If you specify an ACM certificate ARN, you must also specify values for MinimumProtocolVersion and SSLSupportMethod .
SSLSupportMethod (string) --
If the distribution uses Aliases (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.
sni-only – The distribution accepts HTTPS connections from only viewers that support server name indication (SNI) . This is recommended. Most browsers and clients support SNI.vip – The distribution accepts HTTPS connections from all viewers including those that don’t support SNI. This is not recommended, and results in additional monthly charges from CloudFront.static-ip - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the Amazon Web Services Support Center .If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net , don’t set a value for this field.
MinimumProtocolVersion (string) --
If the distribution uses Aliases (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:
For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
On the CloudFront console, this setting is called Security Policy .
When you’re using SNI only (you set SSLSupportMethod to sni-only ), you must specify TLSv1 or higher.
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net (you set CloudFrontDefaultCertificate to true ), CloudFront automatically sets the security policy to TLSv1 regardless of the value that you set here.
Certificate (string) --
This field is deprecated. Use one of the following fields instead:
ACMCertificateArnIAMCertificateIdCloudFrontDefaultCertificateCertificateSource (string) --
This field is deprecated. Use one of the following fields instead:
ACMCertificateArnIAMCertificateIdCloudFrontDefaultCertificateRestrictions (dict) --
A complex type that identifies ways in which you want to restrict distribution of your content.
GeoRestriction (dict) --
A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.
RestrictionType (string) --
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 don't want CloudFront to distribute your content.whitelist : The Location elements specify the countries in which you want CloudFront to distribute your content.Quantity (integer) --
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 .
Items (list) --
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 on the CloudFront console, which includes both country names and codes.
WebACLId (string) --
The Web ACL Id (if any) associated with the distribution.
HttpVersion (string) --
Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2 . Viewers that don't support HTTP/2 will automatically use an earlier version.
IsIPV6Enabled (boolean) --
Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.
AliasICPRecordals (list) --
Amazon Web Services 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.
For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China .
(dict) --
Amazon Web Services 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 Amazon Web Services services in China .
CNAME (string) --
A domain name associated with a distribution.
ICPRecordalStatus (string) --
The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in regions outside of China.
The status values returned are the following:
Exceptions
CloudFront.Client.exceptions.InvalidArgumentlist_distributions_by_response_headers_policy_id(**kwargs)¶Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified response headers policy.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
See also: AWS API Documentation
Request Syntax
response = client.list_distributions_by_response_headers_policy_id(
Marker='string',
MaxItems='string',
ResponseHeadersPolicyId='string'
)
NextMarker from the current page’s response.[REQUIRED]
The ID of the response headers policy whose associated distribution IDs you want to list.
dict
Response Syntax
{
'DistributionIdList': {
'Marker': 'string',
'NextMarker': 'string',
'MaxItems': 123,
'IsTruncated': True|False,
'Quantity': 123,
'Items': [
'string',
]
}
}
Response Structure
(dict) --
DistributionIdList (dict) --
A list of distribution IDs.
Marker (string) --
The value provided in the Marker request field.
NextMarker (string) --
Contains the value that you should use in the Marker field of a subsequent request to continue listing distribution IDs where you left off.
MaxItems (integer) --
The maximum number of distribution IDs requested.
IsTruncated (boolean) --
A flag that indicates whether more distribution IDs remain to be listed. If your results were truncated, you can make a subsequent request using the Marker request field to retrieve more distribution IDs in the list.
Quantity (integer) --
The total number of distribution IDs returned in the response.
Items (list) --
Contains the distribution IDs in the list.
Exceptions
CloudFront.Client.exceptions.NoSuchResponseHeadersPolicyCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.AccessDeniedlist_distributions_by_web_acl_id(**kwargs)¶List the distributions that are associated with a specified WAF web ACL.
See also: AWS API Documentation
Request Syntax
response = client.list_distributions_by_web_acl_id(
Marker='string',
MaxItems='string',
WebACLId='string'
)
Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker , specify the value of NextMarker from the last response. (For the first request, omit Marker .)[REQUIRED]
The ID of the WAF web ACL that you want to list the associated distributions. If you specify "null" for the ID, the request returns a list of the distributions that aren't associated with a web ACL.
dict
Response Syntax
{
'DistributionList': {
'Marker': 'string',
'NextMarker': 'string',
'MaxItems': 123,
'IsTruncated': True|False,
'Quantity': 123,
'Items': [
{
'Id': 'string',
'ARN': 'string',
'Status': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'DomainName': 'string',
'Aliases': {
'Quantity': 123,
'Items': [
'string',
]
},
'Origins': {
'Quantity': 123,
'Items': [
{
'Id': 'string',
'DomainName': 'string',
'OriginPath': 'string',
'CustomHeaders': {
'Quantity': 123,
'Items': [
{
'HeaderName': 'string',
'HeaderValue': 'string'
},
]
},
'S3OriginConfig': {
'OriginAccessIdentity': 'string'
},
'CustomOriginConfig': {
'HTTPPort': 123,
'HTTPSPort': 123,
'OriginProtocolPolicy': 'http-only'|'match-viewer'|'https-only',
'OriginSslProtocols': {
'Quantity': 123,
'Items': [
'SSLv3'|'TLSv1'|'TLSv1.1'|'TLSv1.2',
]
},
'OriginReadTimeout': 123,
'OriginKeepaliveTimeout': 123
},
'ConnectionAttempts': 123,
'ConnectionTimeout': 123,
'OriginShield': {
'Enabled': True|False,
'OriginShieldRegion': 'string'
},
'OriginAccessControlId': 'string'
},
]
},
'OriginGroups': {
'Quantity': 123,
'Items': [
{
'Id': 'string',
'FailoverCriteria': {
'StatusCodes': {
'Quantity': 123,
'Items': [
123,
]
}
},
'Members': {
'Quantity': 123,
'Items': [
{
'OriginId': 'string'
},
]
}
},
]
},
'DefaultCacheBehavior': {
'TargetOriginId': 'string',
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'TrustedKeyGroups': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'ViewerProtocolPolicy': 'allow-all'|'https-only'|'redirect-to-https',
'AllowedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
],
'CachedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
]
}
},
'SmoothStreaming': True|False,
'Compress': True|False,
'LambdaFunctionAssociations': {
'Quantity': 123,
'Items': [
{
'LambdaFunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response',
'IncludeBody': True|False
},
]
},
'FunctionAssociations': {
'Quantity': 123,
'Items': [
{
'FunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response'
},
]
},
'FieldLevelEncryptionId': 'string',
'RealtimeLogConfigArn': 'string',
'CachePolicyId': 'string',
'OriginRequestPolicyId': 'string',
'ResponseHeadersPolicyId': 'string',
'ForwardedValues': {
'QueryString': True|False,
'Cookies': {
'Forward': 'none'|'whitelist'|'all',
'WhitelistedNames': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
},
'QueryStringCacheKeys': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'MinTTL': 123,
'DefaultTTL': 123,
'MaxTTL': 123
},
'CacheBehaviors': {
'Quantity': 123,
'Items': [
{
'PathPattern': 'string',
'TargetOriginId': 'string',
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'TrustedKeyGroups': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'ViewerProtocolPolicy': 'allow-all'|'https-only'|'redirect-to-https',
'AllowedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
],
'CachedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
]
}
},
'SmoothStreaming': True|False,
'Compress': True|False,
'LambdaFunctionAssociations': {
'Quantity': 123,
'Items': [
{
'LambdaFunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response',
'IncludeBody': True|False
},
]
},
'FunctionAssociations': {
'Quantity': 123,
'Items': [
{
'FunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response'
},
]
},
'FieldLevelEncryptionId': 'string',
'RealtimeLogConfigArn': 'string',
'CachePolicyId': 'string',
'OriginRequestPolicyId': 'string',
'ResponseHeadersPolicyId': 'string',
'ForwardedValues': {
'QueryString': True|False,
'Cookies': {
'Forward': 'none'|'whitelist'|'all',
'WhitelistedNames': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
},
'QueryStringCacheKeys': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'MinTTL': 123,
'DefaultTTL': 123,
'MaxTTL': 123
},
]
},
'CustomErrorResponses': {
'Quantity': 123,
'Items': [
{
'ErrorCode': 123,
'ResponsePagePath': 'string',
'ResponseCode': 'string',
'ErrorCachingMinTTL': 123
},
]
},
'Comment': 'string',
'PriceClass': 'PriceClass_100'|'PriceClass_200'|'PriceClass_All',
'Enabled': True|False,
'ViewerCertificate': {
'CloudFrontDefaultCertificate': True|False,
'IAMCertificateId': 'string',
'ACMCertificateArn': 'string',
'SSLSupportMethod': 'sni-only'|'vip'|'static-ip',
'MinimumProtocolVersion': 'SSLv3'|'TLSv1'|'TLSv1_2016'|'TLSv1.1_2016'|'TLSv1.2_2018'|'TLSv1.2_2019'|'TLSv1.2_2021',
'Certificate': 'string',
'CertificateSource': 'cloudfront'|'iam'|'acm'
},
'Restrictions': {
'GeoRestriction': {
'RestrictionType': 'blacklist'|'whitelist'|'none',
'Quantity': 123,
'Items': [
'string',
]
}
},
'WebACLId': 'string',
'HttpVersion': 'http1.1'|'http2'|'http3'|'http2and3',
'IsIPV6Enabled': True|False,
'AliasICPRecordals': [
{
'CNAME': 'string',
'ICPRecordalStatus': 'APPROVED'|'SUSPENDED'|'PENDING'
},
]
},
]
}
}
Response Structure
(dict) --
The response to a request to list the distributions that are associated with a specified WAF web ACL.
DistributionList (dict) --
The DistributionList type.
Marker (string) --
The value you provided for the Marker request parameter.
NextMarker (string) --
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.
MaxItems (integer) --
The value you provided for the MaxItems request parameter.
IsTruncated (boolean) --
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.
Quantity (integer) --
The number of distributions that were created by the current Amazon Web Services account.
Items (list) --
A complex type that contains one DistributionSummary element for each distribution that was created by the current Amazon Web Services account.
(dict) --
A summary of the information about a CloudFront distribution.
Id (string) --
The identifier for the distribution. For example: EDFDVBD632BHDS5 .
ARN (string) --
The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5 , where 123456789012 is your Amazon Web Services account ID.
Status (string) --
The current status of the distribution. When the status is Deployed , the distribution's information is propagated to all CloudFront edge locations.
LastModifiedTime (datetime) --
The date and time the distribution was last modified.
DomainName (string) --
The domain name that corresponds to the distribution, for example, d111111abcdef8.cloudfront.net .
Aliases (dict) --
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
Quantity (integer) --
The number of CNAME aliases, if any, that you want to associate with this distribution.
Items (list) --
A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
Origins (dict) --
A complex type that contains information about origins for this distribution.
Quantity (integer) --
The number of origins for this distribution.
Items (list) --
A list of origins.
(dict) --
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:
S3OriginConfig to specify an Amazon S3 bucket that is not configured with static website hosting.CustomOriginConfig to specify all other kinds of origins, including: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).
Id (string) --
A unique identifier for the origin. This value must be unique within the distribution.
Use this value to specify the TargetOriginId in a CacheBehavior or DefaultCacheBehavior .
DomainName (string) --
The domain name for the origin.
For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide .
OriginPath (string) --
An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
For more information, see Origin Path in the Amazon CloudFront Developer Guide .
CustomHeaders (dict) --
A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.
For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .
Quantity (integer) --
The number of custom headers, if any, for this distribution.
Items (list) --
Optional : A list that contains one
OriginCustomHeaderelement for each custom header that you want CloudFront to forward to the origin. If Quantity is0, omitItems.
(dict) --
A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution.
HeaderName (string) --
The name of a header that you want CloudFront to send to your origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .
HeaderValue (string) --
The value for the header that you specified in the HeaderName field.
S3OriginConfig (dict) --
Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the CustomOriginConfig type instead.
OriginAccessIdentity (string) --
The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
origin-access-identity/cloudfront/ID-of-origin-access-identity
where `` ID-of-origin-access-identity `` is the value that CloudFront returned in the ID element when you created the origin access identity.
If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.
To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.
To replace the origin access identity, update the distribution configuration and specify the new origin access identity.
For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
CustomOriginConfig (dict) --
Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.
HTTPPort (integer) --
The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
HTTPSPort (integer) --
The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
OriginProtocolPolicy (string) --
Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:
http-only – CloudFront always uses HTTP to connect to the origin.match-viewer – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.https-only – CloudFront always uses HTTPS to connect to the origin.OriginSslProtocols (dict) --
Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include SSLv3 , TLSv1 , TLSv1.1 , and TLSv1.2 .
For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide .
Quantity (integer) --
The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.
Items (list) --
A list that contains allowed SSL/TLS protocols for this distribution.
OriginReadTimeout (integer) --
Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout . The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 30 seconds.
For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide .
OriginKeepaliveTimeout (integer) --
Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 5 seconds.
For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide .
ConnectionAttempts (integer) --
The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don’t specify otherwise) is 3.
For a custom origin (including an Amazon S3 bucket that’s configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout .
For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide .
ConnectionTimeout (integer) --
The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don’t specify otherwise) is 10 seconds.
For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide .
OriginShield (dict) --
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 .
Enabled (boolean) --
A flag that specifies whether Origin Shield is enabled.
When it’s enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it’s disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.
OriginShieldRegion (string) --
The Amazon Web Services Region for Origin Shield.
Specify the Amazon Web Services Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as us-east-2 .
When you enable CloudFront Origin Shield, you must specify the Amazon Web Services Region for Origin Shield. For the list of Amazon Web Services Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the Amazon Web Services Region for Origin Shield in the Amazon CloudFront Developer Guide .
OriginAccessControlId (string) --
The unique identifier of an origin access control for this origin.
For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide .
OriginGroups (dict) --
A complex type that contains information about origin groups for this distribution.
Quantity (integer) --
The number of origin groups.
Items (list) --
The items (origin groups) in a distribution.
(dict) --
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.
Id (string) --
The origin group's ID.
FailoverCriteria (dict) --
A complex type that contains information about the failover criteria for an origin group.
StatusCodes (dict) --
The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.
Quantity (integer) --
The number of status codes.
Items (list) --
The items (status codes) for an origin group.
Members (dict) --
A complex type that contains information about the origins in an origin group.
Quantity (integer) --
The number of origins in an origin group.
Items (list) --
Items (origins) in an origin group.
(dict) --
An origin in an origin group.
OriginId (string) --
The ID for an origin in an origin group.
DefaultCacheBehavior (dict) --
A complex type that describes the default cache behavior if you don't 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.
TargetOriginId (string) --
The value of ID for the origin that you want CloudFront to route requests to when they use the default cache behavior.
TrustedSigners (dict) --
Warning
We recommend using TrustedKeyGroups instead of TrustedSigners .
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer’s Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
Enabled (boolean) --
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
Quantity (integer) --
The number of Amazon Web Services accounts in the list.
Items (list) --
A list of Amazon Web Services account identifiers.
TrustedKeyGroups (dict) --
A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
Enabled (boolean) --
This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
Quantity (integer) --
The number of key groups in the list.
Items (list) --
A list of key groups identifiers.
ViewerProtocolPolicy (string) --
The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern . You can specify the following options:
allow-all : Viewers can use HTTP or HTTPS.redirect-to-https : If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only : If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide .
AllowedMethods (dict) --
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:
GET and HEAD requests.GET , HEAD , and OPTIONS requests.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.
Quantity (integer) --
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).
Items (list) --
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
CachedMethods (dict) --
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
GET and HEAD requests.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.
Quantity (integer) --
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).
Items (list) --
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
SmoothStreaming (boolean) --
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true ; if not, specify false . If you specify true for SmoothStreaming , you can still distribute other content using this cache behavior if the content matches the value of PathPattern .
Compress (boolean) --
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true ; if not, specify false . For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .
LambdaFunctionAssociations (dict) --
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
Quantity (integer) --
The number of Lambda@Edge function associations for this cache behavior.
Items (list) --
Optional : A complex type that contains
LambdaFunctionAssociationitems for this cache behavior. IfQuantityis0, you can omitItems.
(dict) --
A complex type that contains a Lambda@Edge function association.
LambdaFunctionARN (string) --
The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
EventType (string) --
Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request : The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request : The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response : The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response : The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.IncludeBody (boolean) --
A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
FunctionAssociations (dict) --
A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.
Quantity (integer) --
The number of CloudFront functions in the list.
Items (list) --
The 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.
(dict) --
A CloudFront function that is associated with a cache behavior in a CloudFront distribution.
FunctionARN (string) --
The Amazon Resource Name (ARN) of the function.
EventType (string) --
The event type of the function, either viewer-request or viewer-response . You cannot use origin-facing event types (origin-request and origin-response ) with a CloudFront function.
FieldLevelEncryptionId (string) --
The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior.
RealtimeLogConfigArn (string) --
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide .
CachePolicyId (string) --
The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
OriginRequestPolicyId (string) --
The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
ResponseHeadersPolicyId (string) --
The identifier for a response headers policy.
ForwardedValues (dict) --
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide .
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed 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 or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
QueryString (boolean) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 .
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys , if any:
If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
If you specify false for QueryString , CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide .
Cookies (dict) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 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 How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide .
Forward (string) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide .
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.
Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.
WhitelistedNames (dict) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 .
Required if you specify whitelist for the value of Forward . A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.
If you specify all or none for the value of Forward , omit WhitelistedNames . If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.
For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference .
Quantity (integer) --
The number of cookie names in the Items list.
Items (list) --
A list of cookie names.
Headers (dict) --
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 headers 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 headers 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 the Headers , if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.
For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide .
Quantity (integer) --
The number of header names in the Items list.
Items (list) --
A list of HTTP header names.
QueryStringCacheKeys (dict) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
Quantity (integer) --
The number of whitelisted query string parameters for a cache behavior.
Items (list) --
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items .
MinTTL (integer) --
This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers , if you specify 1 for Quantity and * for Name ).
DefaultTTL (integer) --
This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The default amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
MaxTTL (integer) --
This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The maximum amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
CacheBehaviors (dict) --
A complex type that contains zero or more CacheBehavior elements.
Quantity (integer) --
The number of cache behaviors for this distribution.
Items (list) --
Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0 , you can omit Items .
(dict) --
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 .
PathPattern (string) --
The pattern (for example, images/*.jpg ) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.
Note
You can optionally include a slash (/ ) at the beginning of the path pattern. For example, /images/*.jpg . CloudFront behavior is the same with or without the leading / .
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.
For more information, see Path Pattern in the Amazon CloudFront Developer Guide .
TargetOriginId (string) --
The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.
TrustedSigners (dict) --
Warning
We recommend using TrustedKeyGroups instead of TrustedSigners .
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer’s Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
Enabled (boolean) --
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
Quantity (integer) --
The number of Amazon Web Services accounts in the list.
Items (list) --
A list of Amazon Web Services account identifiers.
TrustedKeyGroups (dict) --
A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
Enabled (boolean) --
This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
Quantity (integer) --
The number of key groups in the list.
Items (list) --
A list of key groups identifiers.
ViewerProtocolPolicy (string) --
The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern . You can specify the following options:
allow-all : Viewers can use HTTP or HTTPS.redirect-to-https : If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only : If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide .
AllowedMethods (dict) --
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:
GET and HEAD requests.GET , HEAD , and OPTIONS requests.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.
Quantity (integer) --
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).
Items (list) --
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
CachedMethods (dict) --
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
GET and HEAD requests.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.
Quantity (integer) --
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).
Items (list) --
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
SmoothStreaming (boolean) --
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true ; if not, specify false . If you specify true for SmoothStreaming , you can still distribute other content using this cache behavior if the content matches the value of PathPattern .
Compress (boolean) --
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .
LambdaFunctionAssociations (dict) --
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
Quantity (integer) --
The number of Lambda@Edge function associations for this cache behavior.
Items (list) --
Optional : A complex type that contains
LambdaFunctionAssociationitems for this cache behavior. IfQuantityis0, you can omitItems.
(dict) --
A complex type that contains a Lambda@Edge function association.
LambdaFunctionARN (string) --
The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
EventType (string) --
Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request : The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request : The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response : The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response : The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.IncludeBody (boolean) --
A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
FunctionAssociations (dict) --
A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.
Quantity (integer) --
The number of CloudFront functions in the list.
Items (list) --
The 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.
(dict) --
A CloudFront function that is associated with a cache behavior in a CloudFront distribution.
FunctionARN (string) --
The Amazon Resource Name (ARN) of the function.
EventType (string) --
The event type of the function, either viewer-request or viewer-response . You cannot use origin-facing event types (origin-request and origin-response ) with a CloudFront function.
FieldLevelEncryptionId (string) --
The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.
RealtimeLogConfigArn (string) --
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide .
CachePolicyId (string) --
The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
A CacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
OriginRequestPolicyId (string) --
The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
ResponseHeadersPolicyId (string) --
The identifier for a response headers policy.
ForwardedValues (dict) --
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide .
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed 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 or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
A CacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
QueryString (boolean) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 .
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys , if any:
If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
If you specify false for QueryString , CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide .
Cookies (dict) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 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 How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide .
Forward (string) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide .
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.
Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.
WhitelistedNames (dict) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 .
Required if you specify whitelist for the value of Forward . A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.
If you specify all or none for the value of Forward , omit WhitelistedNames . If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.
For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference .
Quantity (integer) --
The number of cookie names in the Items list.
Items (list) --
A list of cookie names.
Headers (dict) --
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 headers 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 headers 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 the Headers , if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.
For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide .
Quantity (integer) --
The number of header names in the Items list.
Items (list) --
A list of HTTP header names.
QueryStringCacheKeys (dict) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
Quantity (integer) --
The number of whitelisted query string parameters for a cache behavior.
Items (list) --
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items .
MinTTL (integer) --
This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers , if you specify 1 for Quantity and * for Name ).
DefaultTTL (integer) --
This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The default amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
MaxTTL (integer) --
This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The maximum amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
CustomErrorResponses (dict) --
A complex type that contains zero or more CustomErrorResponses elements.
Quantity (integer) --
The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0 , you can omit Items .
Items (list) --
A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration.
(dict) --
A complex type that controls:
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
ErrorCode (integer) --
The HTTP status code for which you want to specify a custom error page and/or a caching duration.
ResponsePagePath (string) --
The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode , for example, /4xx-errors/403-forbidden.html . If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:
PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors . Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, /4xx-errors/* .TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages.If you specify a value for ResponsePagePath , you must also specify a value for ResponseCode .
We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.
ResponseCode (string) --
The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:
200 , the response typically won't be intercepted.400 or 500 as the ResponseCode for all 4xx or 5xx errors.200 status code (OK) and static website so your customers don't know that your website is down.If you specify a value for ResponseCode , you must also specify a value for ResponsePagePath .
ErrorCachingMinTTL (integer) --
The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode . When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.
For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
Comment (string) --
The comment originally specified when this distribution was created.
PriceClass (string) --
A complex type that contains information about price class for this streaming distribution.
Enabled (boolean) --
Whether the distribution is enabled to accept user requests for content.
ViewerCertificate (dict) --
A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.
CloudFrontDefaultCertificate (boolean) --
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net , set this field to true .
If the distribution uses Aliases (alternate domain names or CNAMEs), set this field to false and specify values for the following fields:
ACMCertificateArn or IAMCertificateId (specify a value for one, not both)MinimumProtocolVersionSSLSupportMethodIAMCertificateId (string) --
If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Identity and Access Management (IAM) , provide the ID of the IAM certificate.
If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVersion and SSLSupportMethod .
ACMCertificateArn (string) --
If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Certificate Manager (ACM) , provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (us-east-1 ).
If you specify an ACM certificate ARN, you must also specify values for MinimumProtocolVersion and SSLSupportMethod .
SSLSupportMethod (string) --
If the distribution uses Aliases (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.
sni-only – The distribution accepts HTTPS connections from only viewers that support server name indication (SNI) . This is recommended. Most browsers and clients support SNI.vip – The distribution accepts HTTPS connections from all viewers including those that don’t support SNI. This is not recommended, and results in additional monthly charges from CloudFront.static-ip - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the Amazon Web Services Support Center .If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net , don’t set a value for this field.
MinimumProtocolVersion (string) --
If the distribution uses Aliases (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:
For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
On the CloudFront console, this setting is called Security Policy .
When you’re using SNI only (you set SSLSupportMethod to sni-only ), you must specify TLSv1 or higher.
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net (you set CloudFrontDefaultCertificate to true ), CloudFront automatically sets the security policy to TLSv1 regardless of the value that you set here.
Certificate (string) --
This field is deprecated. Use one of the following fields instead:
ACMCertificateArnIAMCertificateIdCloudFrontDefaultCertificateCertificateSource (string) --
This field is deprecated. Use one of the following fields instead:
ACMCertificateArnIAMCertificateIdCloudFrontDefaultCertificateRestrictions (dict) --
A complex type that identifies ways in which you want to restrict distribution of your content.
GeoRestriction (dict) --
A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.
RestrictionType (string) --
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 don't want CloudFront to distribute your content.whitelist : The Location elements specify the countries in which you want CloudFront to distribute your content.Quantity (integer) --
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 .
Items (list) --
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 on the CloudFront console, which includes both country names and codes.
WebACLId (string) --
The Web ACL Id (if any) associated with the distribution.
HttpVersion (string) --
Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2 . Viewers that don't support HTTP/2 will automatically use an earlier version.
IsIPV6Enabled (boolean) --
Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.
AliasICPRecordals (list) --
Amazon Web Services 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.
For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China .
(dict) --
Amazon Web Services 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 Amazon Web Services services in China .
CNAME (string) --
A domain name associated with a distribution.
ICPRecordalStatus (string) --
The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in regions outside of China.
The status values returned are the following:
Exceptions
CloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.InvalidWebACLIdlist_field_level_encryption_configs(**kwargs)¶List all field-level encryption configurations that have been created in CloudFront for this account.
See also: AWS API Documentation
Request Syntax
response = client.list_field_level_encryption_configs(
Marker='string',
MaxItems='string'
)
Marker to the value of the NextMarker from the current page's response (which is also the ID of the last configuration on that page).dict
Response Syntax
{
'FieldLevelEncryptionList': {
'NextMarker': 'string',
'MaxItems': 123,
'Quantity': 123,
'Items': [
{
'Id': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'Comment': 'string',
'QueryArgProfileConfig': {
'ForwardWhenQueryArgProfileIsUnknown': True|False,
'QueryArgProfiles': {
'Quantity': 123,
'Items': [
{
'QueryArg': 'string',
'ProfileId': 'string'
},
]
}
},
'ContentTypeProfileConfig': {
'ForwardWhenContentTypeIsUnknown': True|False,
'ContentTypeProfiles': {
'Quantity': 123,
'Items': [
{
'Format': 'URLEncoded',
'ProfileId': 'string',
'ContentType': 'string'
},
]
}
}
},
]
}
}
Response Structure
(dict) --
FieldLevelEncryptionList (dict) --
Returns a list of all field-level encryption configurations that have been created in CloudFront for this account.
NextMarker (string) --
If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your configurations where you left off.
MaxItems (integer) --
The maximum number of elements you want in the response body.
Quantity (integer) --
The number of field-level encryption items.
Items (list) --
An array of field-level encryption items.
(dict) --
A summary of a field-level encryption item.
Id (string) --
The unique ID of a field-level encryption item.
LastModifiedTime (datetime) --
The last time that the summary of field-level encryption items was modified.
Comment (string) --
An optional comment about the field-level encryption item. The comment cannot be longer than 128 characters.
QueryArgProfileConfig (dict) --
A summary of a query argument-profile mapping.
ForwardWhenQueryArgProfileIsUnknown (boolean) --
Flag to set if you want a request to be forwarded to the origin even if the profile specified by the field-level encryption query argument, fle-profile, is unknown.
QueryArgProfiles (dict) --
Profiles specified for query argument-profile mapping for field-level encryption.
Quantity (integer) --
Number of profiles for query argument-profile mapping for field-level encryption.
Items (list) --
Number of items for query argument-profile mapping for field-level encryption.
(dict) --
Query argument-profile mapping for field-level encryption.
QueryArg (string) --
Query argument for field-level encryption query argument-profile mapping.
ProfileId (string) --
ID of profile to use for field-level encryption query argument-profile mapping
ContentTypeProfileConfig (dict) --
A summary of a content type-profile mapping.
ForwardWhenContentTypeIsUnknown (boolean) --
The setting in a field-level encryption content type-profile mapping that specifies what to do when an unknown content type is provided for the profile. If true, content is forwarded without being encrypted when the content type is unknown. If false (the default), an error is returned when the content type is unknown.
ContentTypeProfiles (dict) --
The configuration for a field-level encryption content type-profile.
Quantity (integer) --
The number of field-level encryption content type-profile mappings.
Items (list) --
Items in a field-level encryption content type-profile mapping.
(dict) --
A field-level encryption content type profile.
Format (string) --
The format for a field-level encryption content type-profile mapping.
ProfileId (string) --
The profile ID for a field-level encryption content type-profile mapping.
ContentType (string) --
The content type for a field-level encryption content type-profile mapping.
Exceptions
CloudFront.Client.exceptions.InvalidArgumentlist_field_level_encryption_profiles(**kwargs)¶Request a list of field-level encryption profiles that have been created in CloudFront for this account.
See also: AWS API Documentation
Request Syntax
response = client.list_field_level_encryption_profiles(
Marker='string',
MaxItems='string'
)
Marker to the value of the NextMarker from the current page's response (which is also the ID of the last profile on that page).dict
Response Syntax
{
'FieldLevelEncryptionProfileList': {
'NextMarker': 'string',
'MaxItems': 123,
'Quantity': 123,
'Items': [
{
'Id': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'Name': 'string',
'EncryptionEntities': {
'Quantity': 123,
'Items': [
{
'PublicKeyId': 'string',
'ProviderId': 'string',
'FieldPatterns': {
'Quantity': 123,
'Items': [
'string',
]
}
},
]
},
'Comment': 'string'
},
]
}
}
Response Structure
(dict) --
FieldLevelEncryptionProfileList (dict) --
Returns a list of the field-level encryption profiles that have been created in CloudFront for this account.
NextMarker (string) --
If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your profiles where you left off.
MaxItems (integer) --
The maximum number of field-level encryption profiles you want in the response body.
Quantity (integer) --
The number of field-level encryption profiles.
Items (list) --
The field-level encryption profile items.
(dict) --
The field-level encryption profile summary.
Id (string) --
ID for the field-level encryption profile summary.
LastModifiedTime (datetime) --
The time when the the field-level encryption profile summary was last updated.
Name (string) --
Name for the field-level encryption profile summary.
EncryptionEntities (dict) --
A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.
Quantity (integer) --
Number of field pattern items in a field-level encryption content type-profile mapping.
Items (list) --
An array of field patterns in a field-level encryption content type-profile mapping.
(dict) --
Complex data type for field-level encryption profiles that includes the encryption key and field pattern specifications.
PublicKeyId (string) --
The public key associated with a set of field-level encryption patterns, to be used when encrypting the fields that match the patterns.
ProviderId (string) --
The provider associated with the public key being used for encryption. This value must also be provided with the private key for applications to be able to decrypt data.
FieldPatterns (dict) --
Field patterns in a field-level encryption content type profile specify the fields that you want to be encrypted. You can provide the full field name, or any beginning characters followed by a wildcard (*). You can't overlap field patterns. For example, you can't have both ABC* and AB*. Note that field patterns are case-sensitive.
Quantity (integer) --
The number of field-level encryption field patterns.
Items (list) --
An array of the field-level encryption field patterns.
Comment (string) --
An optional comment for the field-level encryption profile summary. The comment cannot be longer than 128 characters.
Exceptions
CloudFront.Client.exceptions.InvalidArgumentlist_functions(**kwargs)¶Gets a list of all CloudFront functions in your Amazon Web Services account.
You can optionally apply a filter to return only the functions that are in the specified stage, either DEVELOPMENT or LIVE .
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
See also: AWS API Documentation
Request Syntax
response = client.list_functions(
Marker='string',
MaxItems='string',
Stage='DEVELOPMENT'|'LIVE'
)
NextMarker from the current page’s response.DEVELOPMENT or LIVE .dict
Response Syntax
{
'FunctionList': {
'NextMarker': 'string',
'MaxItems': 123,
'Quantity': 123,
'Items': [
{
'Name': 'string',
'Status': 'string',
'FunctionConfig': {
'Comment': 'string',
'Runtime': 'cloudfront-js-1.0'
},
'FunctionMetadata': {
'FunctionARN': 'string',
'Stage': 'DEVELOPMENT'|'LIVE',
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1)
}
},
]
}
}
Response Structure
(dict) --
FunctionList (dict) --
A list of CloudFront functions.
NextMarker (string) --
If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the Marker field of a subsequent request to continue listing functions where you left off.
MaxItems (integer) --
The maximum number of functions requested.
Quantity (integer) --
The number of functions returned in the response.
Items (list) --
Contains the functions in the list.
(dict) --
Contains configuration information and metadata about a CloudFront function.
Name (string) --
The name of the CloudFront function.
Status (string) --
The status of the CloudFront function.
FunctionConfig (dict) --
Contains configuration information about a CloudFront function.
Comment (string) --
A comment to describe the function.
Runtime (string) --
The function’s runtime environment. The only valid value is cloudfront-js-1.0 .
FunctionMetadata (dict) --
Contains metadata about a CloudFront function.
FunctionARN (string) --
The Amazon Resource Name (ARN) of the function. The ARN uniquely identifies the function.
Stage (string) --
The stage that the function is in, either DEVELOPMENT or LIVE .
When a function is in the DEVELOPMENT stage, you can test the function with TestFunction , and update it with UpdateFunction .
When a function is in the LIVE stage, you can attach the function to a distribution’s cache behavior, using the function’s ARN.
CreatedTime (datetime) --
The date and time when the function was created.
LastModifiedTime (datetime) --
The date and time when the function was most recently updated.
Exceptions
CloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.UnsupportedOperationlist_invalidations(**kwargs)¶Lists invalidation batches.
See also: AWS API Documentation
Request Syntax
response = client.list_invalidations(
DistributionId='string',
Marker='string',
MaxItems='string'
)
[REQUIRED]
The distribution's ID.
Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.dict
Response Syntax
{
'InvalidationList': {
'Marker': 'string',
'NextMarker': 'string',
'MaxItems': 123,
'IsTruncated': True|False,
'Quantity': 123,
'Items': [
{
'Id': 'string',
'CreateTime': datetime(2015, 1, 1),
'Status': 'string'
},
]
}
}
Response Structure
(dict) --
The returned result of the corresponding request.
InvalidationList (dict) --
Information about invalidation batches.
Marker (string) --
The value that you provided for the Marker request parameter.
NextMarker (string) --
If IsTruncated is true , this element is present and contains the value that you can use for the Marker request parameter to continue listing your invalidation batches where they left off.
MaxItems (integer) --
The value that you provided for the MaxItems request parameter.
IsTruncated (boolean) --
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.
Quantity (integer) --
The number of invalidation batches that were created by the current Amazon Web Services account.
Items (list) --
A complex type that contains one InvalidationSummary element for each invalidation batch created by the current Amazon Web Services account.
(dict) --
A summary of an invalidation request.
Id (string) --
The unique ID for an invalidation request.
CreateTime (datetime) --
The time that an invalidation request was created.
Status (string) --
The status of an invalidation request.
Exceptions
CloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.NoSuchDistributionCloudFront.Client.exceptions.AccessDeniedlist_key_groups(**kwargs)¶Gets a list of key groups.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
See also: AWS API Documentation
Request Syntax
response = client.list_key_groups(
Marker='string',
MaxItems='string'
)
NextMarker from the current page’s response.dict
Response Syntax
{
'KeyGroupList': {
'NextMarker': 'string',
'MaxItems': 123,
'Quantity': 123,
'Items': [
{
'KeyGroup': {
'Id': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'KeyGroupConfig': {
'Name': 'string',
'Items': [
'string',
],
'Comment': 'string'
}
}
},
]
}
}
Response Structure
(dict) --
KeyGroupList (dict) --
A list of key groups.
NextMarker (string) --
If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the Marker field of a subsequent request to continue listing key groups.
MaxItems (integer) --
The maximum number of key groups requested.
Quantity (integer) --
The number of key groups returned in the response.
Items (list) --
A list of key groups.
(dict) --
Contains information about a key group.
KeyGroup (dict) --
A key group.
Id (string) --
The identifier for the key group.
LastModifiedTime (datetime) --
The date and time when the key group was last modified.
KeyGroupConfig (dict) --
The key group configuration.
Name (string) --
A name to identify the key group.
Items (list) --
A list of the identifiers of the public keys in the key group.
Comment (string) --
A comment to describe the key group. The comment cannot be longer than 128 characters.
Exceptions
CloudFront.Client.exceptions.InvalidArgumentlist_origin_access_controls(**kwargs)¶Gets the list of CloudFront origin access controls in this Amazon Web Services account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send another request that specifies the NextMarker value from the current response as the Marker value in the next request.
See also: AWS API Documentation
Request Syntax
response = client.list_origin_access_controls(
Marker='string',
MaxItems='string'
)
NextMarker from the current page's response.dict
Response Syntax
{
'OriginAccessControlList': {
'Marker': 'string',
'NextMarker': 'string',
'MaxItems': 123,
'IsTruncated': True|False,
'Quantity': 123,
'Items': [
{
'Id': 'string',
'Description': 'string',
'Name': 'string',
'SigningProtocol': 'sigv4',
'SigningBehavior': 'never'|'always'|'no-override',
'OriginAccessControlOriginType': 's3'
},
]
}
}
Response Structure
(dict) --
OriginAccessControlList (dict) --
A list of origin access controls.
Marker (string) --
The value of the Marker field that was provided in the request.
NextMarker (string) --
If there are more items in the list than are in this response, this element is present. It contains the value to use in the Marker field of another request to continue listing origin access controls.
MaxItems (integer) --
The maximum number of origin access controls requested.
IsTruncated (boolean) --
If there are more items in the list than are in this response, this value is true .
Quantity (integer) --
The number of origin access controls returned in the response.
Items (list) --
Contains the origin access controls in the list.
(dict) --
A CloudFront origin access control.
Id (string) --
The unique identifier of the origin access control.
Description (string) --
A description of the origin access control.
Name (string) --
A unique name that identifies the origin access control.
SigningProtocol (string) --
The signing protocol of the origin access control. The signing protocol determines how CloudFront signs (authenticates) requests. The only valid value is sigv4 .
SigningBehavior (string) --
A value that specifies which requests CloudFront signs (adds authentication information to). This field can have one of the following values:
never – CloudFront doesn't sign any origin requests.always – CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if necessary.no-override – If the viewer request doesn't contain the Authorization header, CloudFront signs the origin request. If the viewer request contains the Authorization header, CloudFront doesn't sign the origin request, but instead passes along the Authorization header that it received in the viewer request.OriginAccessControlOriginType (string) --
The type of origin that this origin access control is for. The only valid value is s3 .
Exceptions
CloudFront.Client.exceptions.InvalidArgumentlist_origin_request_policies(**kwargs)¶Gets a list of origin request policies.
You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
See also: AWS API Documentation
Request Syntax
response = client.list_origin_request_policies(
Type='managed'|'custom',
Marker='string',
MaxItems='string'
)
A filter to return only the specified kinds of origin request policies. Valid values are:
managed – Returns only the managed policies created by Amazon Web Services.custom – Returns only the custom policies created in your Amazon Web Services account.NextMarker from the current page’s response.dict
Response Syntax
{
'OriginRequestPolicyList': {
'NextMarker': 'string',
'MaxItems': 123,
'Quantity': 123,
'Items': [
{
'Type': 'managed'|'custom',
'OriginRequestPolicy': {
'Id': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'OriginRequestPolicyConfig': {
'Comment': 'string',
'Name': 'string',
'HeadersConfig': {
'HeaderBehavior': 'none'|'whitelist'|'allViewer'|'allViewerAndWhitelistCloudFront',
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'CookiesConfig': {
'CookieBehavior': 'none'|'whitelist'|'all',
'Cookies': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'QueryStringsConfig': {
'QueryStringBehavior': 'none'|'whitelist'|'all',
'QueryStrings': {
'Quantity': 123,
'Items': [
'string',
]
}
}
}
}
},
]
}
}
Response Structure
(dict) --
OriginRequestPolicyList (dict) --
A list of origin request policies.
NextMarker (string) --
If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the Marker field of a subsequent request to continue listing origin request policies where you left off.
MaxItems (integer) --
The maximum number of origin request policies requested.
Quantity (integer) --
The total number of origin request policies returned in the response.
Items (list) --
Contains the origin request policies in the list.
(dict) --
Contains an origin request policy.
Type (string) --
The type of origin request policy, either managed (created by Amazon Web Services) or custom (created in this Amazon Web Services account).
OriginRequestPolicy (dict) --
The origin request policy.
Id (string) --
The unique identifier for the origin request policy.
LastModifiedTime (datetime) --
The date and time when the origin request policy was last modified.
OriginRequestPolicyConfig (dict) --
The origin request policy configuration.
Comment (string) --
A comment to describe the origin request policy. The comment cannot be longer than 128 characters.
Name (string) --
A unique name to identify the origin request policy.
HeadersConfig (dict) --
The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.
HeaderBehavior (string) --
Determines whether any HTTP headers are included in requests that CloudFront sends to the origin. Valid values are:
none – HTTP headers are not included in requests that CloudFront sends to the origin. Even when this field is set to none , any headers that are listed in a CachePolicy are included in origin requests.whitelist – The HTTP headers that are listed in the Headers type are included in requests that CloudFront sends to the origin.allViewer – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin.allViewerAndWhitelistCloudFront – All HTTP headers in viewer requests and the additional CloudFront headers that are listed in the Headers type are included in requests that CloudFront sends to the origin. The additional headers are added by CloudFront.Headers (dict) --
Contains a list of HTTP header names.
Quantity (integer) --
The number of header names in the Items list.
Items (list) --
A list of HTTP header names.
CookiesConfig (dict) --
The cookies from viewer requests to include in origin requests.
CookieBehavior (string) --
Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:
none – Cookies in viewer requests are not included in requests that CloudFront sends to the origin. Even when this field is set to none , any cookies that are listed in a CachePolicy are included in origin requests.whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in requests that CloudFront sends to the origin.all – All cookies in viewer requests are included in requests that CloudFront sends to the origin.Cookies (dict) --
Contains a list of cookie names.
Quantity (integer) --
The number of cookie names in the Items list.
Items (list) --
A list of cookie names.
QueryStringsConfig (dict) --
The URL query strings from viewer requests to include in origin requests.
QueryStringBehavior (string) --
Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:
none – Query strings in viewer requests are not included in requests that CloudFront sends to the origin. Even when this field is set to none , any query strings that are listed in a CachePolicy are included in origin requests.whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in requests that CloudFront sends to the origin.all – All query strings in viewer requests are included in requests that CloudFront sends to the origin.QueryStrings (dict) --
Contains a list of the query strings in viewer requests that are included in requests that CloudFront sends to the origin.
Quantity (integer) --
The number of query string names in the Items list.
Items (list) --
A list of query string names.
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.NoSuchOriginRequestPolicyCloudFront.Client.exceptions.InvalidArgumentlist_public_keys(**kwargs)¶List all public keys that have been added to CloudFront for this account.
See also: AWS API Documentation
Request Syntax
response = client.list_public_keys(
Marker='string',
MaxItems='string'
)
Marker to the value of the NextMarker from the current page's response (which is also the ID of the last public key on that page).dict
Response Syntax
{
'PublicKeyList': {
'NextMarker': 'string',
'MaxItems': 123,
'Quantity': 123,
'Items': [
{
'Id': 'string',
'Name': 'string',
'CreatedTime': datetime(2015, 1, 1),
'EncodedKey': 'string',
'Comment': 'string'
},
]
}
}
Response Structure
(dict) --
PublicKeyList (dict) --
Returns a list of all public keys that have been added to CloudFront for this account.
NextMarker (string) --
If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your public keys where you left off.
MaxItems (integer) --
The maximum number of public keys you want in the response.
Quantity (integer) --
The number of public keys in the list.
Items (list) --
A list of public keys.
(dict) --
Contains information about a public key.
Id (string) --
The identifier of the public key.
Name (string) --
A name to help identify the public key.
CreatedTime (datetime) --
The date and time when the public key was uploaded.
EncodedKey (string) --
The public key.
Comment (string) --
A comment to describe the public key. The comment cannot be longer than 128 characters.
Exceptions
CloudFront.Client.exceptions.InvalidArgumentlist_realtime_log_configs(**kwargs)¶Gets a list of real-time log configurations.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
See also: AWS API Documentation
Request Syntax
response = client.list_realtime_log_configs(
MaxItems='string',
Marker='string'
)
NextMarker from the current page’s response.dict
Response Syntax
{
'RealtimeLogConfigs': {
'MaxItems': 123,
'Items': [
{
'ARN': 'string',
'Name': 'string',
'SamplingRate': 123,
'EndPoints': [
{
'StreamType': 'string',
'KinesisStreamConfig': {
'RoleARN': 'string',
'StreamARN': 'string'
}
},
],
'Fields': [
'string',
]
},
],
'IsTruncated': True|False,
'Marker': 'string',
'NextMarker': 'string'
}
}
Response Structure
(dict) --
RealtimeLogConfigs (dict) --
A list of real-time log configurations.
MaxItems (integer) --
The maximum number of real-time log configurations requested.
Items (list) --
Contains the list of real-time log configurations.
(dict) --
A real-time log configuration.
ARN (string) --
The Amazon Resource Name (ARN) of this real-time log configuration.
Name (string) --
The unique name of this real-time log configuration.
SamplingRate (integer) --
The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. The sampling rate is an integer between 1 and 100, inclusive.
EndPoints (list) --
Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.
(dict) --
Contains information about the Amazon Kinesis data stream where you are sending real-time log data in a real-time log configuration.
StreamType (string) --
The type of data stream where you are sending real-time log data. The only valid value is Kinesis .
KinesisStreamConfig (dict) --
Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
RoleARN (string) --
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFront can use to send real-time log data to your Kinesis data stream.
For more information the IAM role, see Real-time log configuration IAM role in the Amazon CloudFront Developer Guide .
StreamARN (string) --
The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data.
Fields (list) --
A list of fields that are included in each real-time log record. In an API response, the fields are provided in the same order in which they are sent to the Amazon Kinesis data stream.
For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide .
IsTruncated (boolean) --
A flag that indicates whether there are more real-time log configurations than are contained in this list.
Marker (string) --
This parameter indicates where this list of real-time log configurations begins. This list includes real-time log configurations that occur after the marker.
NextMarker (string) --
If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the Marker field of a subsequent request to continue listing real-time log configurations where you left off.
Exceptions
CloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.NoSuchRealtimeLogConfiglist_response_headers_policies(**kwargs)¶Gets a list of response headers policies.
You can optionally apply a filter to get only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
See also: AWS API Documentation
Request Syntax
response = client.list_response_headers_policies(
Type='managed'|'custom',
Marker='string',
MaxItems='string'
)
A filter to get only the specified kind of response headers policies. Valid values are:
managed – Gets only the managed policies created by Amazon Web Services.custom – Gets only the custom policies created in your Amazon Web Services account.NextMarker from the current page’s response.dict
Response Syntax
{
'ResponseHeadersPolicyList': {
'NextMarker': 'string',
'MaxItems': 123,
'Quantity': 123,
'Items': [
{
'Type': 'managed'|'custom',
'ResponseHeadersPolicy': {
'Id': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'ResponseHeadersPolicyConfig': {
'Comment': 'string',
'Name': 'string',
'CorsConfig': {
'AccessControlAllowOrigins': {
'Quantity': 123,
'Items': [
'string',
]
},
'AccessControlAllowHeaders': {
'Quantity': 123,
'Items': [
'string',
]
},
'AccessControlAllowMethods': {
'Quantity': 123,
'Items': [
'GET'|'POST'|'OPTIONS'|'PUT'|'DELETE'|'PATCH'|'HEAD'|'ALL',
]
},
'AccessControlAllowCredentials': True|False,
'AccessControlExposeHeaders': {
'Quantity': 123,
'Items': [
'string',
]
},
'AccessControlMaxAgeSec': 123,
'OriginOverride': True|False
},
'SecurityHeadersConfig': {
'XSSProtection': {
'Override': True|False,
'Protection': True|False,
'ModeBlock': True|False,
'ReportUri': 'string'
},
'FrameOptions': {
'Override': True|False,
'FrameOption': 'DENY'|'SAMEORIGIN'
},
'ReferrerPolicy': {
'Override': True|False,
'ReferrerPolicy': 'no-referrer'|'no-referrer-when-downgrade'|'origin'|'origin-when-cross-origin'|'same-origin'|'strict-origin'|'strict-origin-when-cross-origin'|'unsafe-url'
},
'ContentSecurityPolicy': {
'Override': True|False,
'ContentSecurityPolicy': 'string'
},
'ContentTypeOptions': {
'Override': True|False
},
'StrictTransportSecurity': {
'Override': True|False,
'IncludeSubdomains': True|False,
'Preload': True|False,
'AccessControlMaxAgeSec': 123
}
},
'ServerTimingHeadersConfig': {
'Enabled': True|False,
'SamplingRate': 123.0
},
'CustomHeadersConfig': {
'Quantity': 123,
'Items': [
{
'Header': 'string',
'Value': 'string',
'Override': True|False
},
]
}
}
}
},
]
}
}
Response Structure
(dict) --
ResponseHeadersPolicyList (dict) --
A list of response headers policies.
NextMarker (string) --
If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the Marker field of a subsequent request to continue listing response headers policies where you left off.
MaxItems (integer) --
The maximum number of response headers policies requested.
Quantity (integer) --
The number of response headers policies returned.
Items (list) --
The response headers policies in the list.
(dict) --
Contains a response headers policy.
Type (string) --
The type of response headers policy, either managed (created by Amazon Web Services) or custom (created in this Amazon Web Services account).
ResponseHeadersPolicy (dict) --
The response headers policy.
Id (string) --
The identifier for the response headers policy.
LastModifiedTime (datetime) --
The date and time when the response headers policy was last modified.
ResponseHeadersPolicyConfig (dict) --
A response headers policy configuration.
A response headers policy contains information about a set of HTTP response headers and their values. CloudFront adds the headers in the policy to HTTP responses that it sends for requests that match a cache behavior that’s associated with the policy.
Comment (string) --
A comment to describe the response headers policy.
The comment cannot be longer than 128 characters.
Name (string) --
A name to identify the response headers policy.
The name must be unique for response headers policies in this Amazon Web Services account.
CorsConfig (dict) --
A configuration for a set of HTTP response headers that are used for cross-origin resource sharing (CORS).
AccessControlAllowOrigins (dict) --
A list of origins (domain names) that CloudFront can use as the value for the Access-Control-Allow-Origin HTTP response header.
For more information about the Access-Control-Allow-Origin HTTP response header, see Access-Control-Allow-Origin in the MDN Web Docs.
Quantity (integer) --
The number of origins in the list.
Items (list) --
The list of origins (domain names). You can specify * to allow all origins.
AccessControlAllowHeaders (dict) --
A list of HTTP header names that CloudFront includes as values for the Access-Control-Allow-Headers HTTP response header.
For more information about the Access-Control-Allow-Headers HTTP response header, see Access-Control-Allow-Headers in the MDN Web Docs.
Quantity (integer) --
The number of HTTP header names in the list.
Items (list) --
The list of HTTP header names. You can specify * to allow all headers.
AccessControlAllowMethods (dict) --
A list of HTTP methods that CloudFront includes as values for the Access-Control-Allow-Methods HTTP response header.
For more information about the Access-Control-Allow-Methods HTTP response header, see Access-Control-Allow-Methods in the MDN Web Docs.
Quantity (integer) --
The number of HTTP methods in the list.
Items (list) --
The list of HTTP methods. Valid values are:
GETDELETEHEADOPTIONSPATCHPOSTPUTALL
ALLis a special value that includes all of the listed HTTP methods.
AccessControlAllowCredentials (boolean) --
A Boolean that CloudFront uses as the value for the Access-Control-Allow-Credentials HTTP response header.
For more information about the Access-Control-Allow-Credentials HTTP response header, see Access-Control-Allow-Credentials in the MDN Web Docs.
AccessControlExposeHeaders (dict) --
A list of HTTP headers that CloudFront includes as values for the Access-Control-Expose-Headers HTTP response header.
For more information about the Access-Control-Expose-Headers HTTP response header, see Access-Control-Expose-Headers in the MDN Web Docs.
Quantity (integer) --
The number of HTTP headers in the list.
Items (list) --
The list of HTTP headers. You can specify * to expose all headers.
AccessControlMaxAgeSec (integer) --
A number that CloudFront uses as the value for the Access-Control-Max-Age HTTP response header.
For more information about the Access-Control-Max-Age HTTP response header, see Access-Control-Max-Age in the MDN Web Docs.
OriginOverride (boolean) --
A Boolean that determines whether CloudFront overrides HTTP response headers received from the origin with the ones specified in this response headers policy.
SecurityHeadersConfig (dict) --
A configuration for a set of security-related HTTP response headers.
XSSProtection (dict) --
Determines whether CloudFront includes the X-XSS-Protection HTTP response header and the header’s value.
For more information about the X-XSS-Protection HTTP response header, see X-XSS-Protection in the MDN Web Docs.
Override (boolean) --
A Boolean that determines whether CloudFront overrides the X-XSS-Protection HTTP response header received from the origin with the one specified in this response headers policy.
Protection (boolean) --
A Boolean that determines the value of the X-XSS-Protection HTTP response header. When this setting is true , the value of the X-XSS-Protection header is 1 . When this setting is false , the value of the X-XSS-Protection header is 0 .
For more information about these settings, see X-XSS-Protection in the MDN Web Docs.
ModeBlock (boolean) --
A Boolean that determines whether CloudFront includes the mode=block directive in the X-XSS-Protection header.
For more information about this directive, see X-XSS-Protection in the MDN Web Docs.
ReportUri (string) --
A reporting URI, which CloudFront uses as the value of the report directive in the X-XSS-Protection header.
You cannot specify a ReportUri when ModeBlock is true .
For more information about using a reporting URL, see X-XSS-Protection in the MDN Web Docs.
FrameOptions (dict) --
Determines whether CloudFront includes the X-Frame-Options HTTP response header and the header’s value.
For more information about the X-Frame-Options HTTP response header, see X-Frame-Options in the MDN Web Docs.
Override (boolean) --
A Boolean that determines whether CloudFront overrides the X-Frame-Options HTTP response header received from the origin with the one specified in this response headers policy.
FrameOption (string) --
The value of the X-Frame-Options HTTP response header. Valid values are DENY and SAMEORIGIN .
For more information about these values, see X-Frame-Options in the MDN Web Docs.
ReferrerPolicy (dict) --
Determines whether CloudFront includes the Referrer-Policy HTTP response header and the header’s value.
For more information about the Referrer-Policy HTTP response header, see Referrer-Policy in the MDN Web Docs.
Override (boolean) --
A Boolean that determines whether CloudFront overrides the Referrer-Policy HTTP response header received from the origin with the one specified in this response headers policy.
ReferrerPolicy (string) --
The value of the Referrer-Policy HTTP response header. Valid values are:
no-referrerno-referrer-when-downgradeoriginorigin-when-cross-originsame-originstrict-originstrict-origin-when-cross-originunsafe-urlFor more information about these values, see Referrer-Policy in the MDN Web Docs.
ContentSecurityPolicy (dict) --
The policy directives and their values that CloudFront includes as values for the Content-Security-Policy HTTP response header.
For more information about the Content-Security-Policy HTTP response header, see Content-Security-Policy in the MDN Web Docs.
Override (boolean) --
A Boolean that determines whether CloudFront overrides the Content-Security-Policy HTTP response header received from the origin with the one specified in this response headers policy.
ContentSecurityPolicy (string) --
The policy directives and their values that CloudFront includes as values for the Content-Security-Policy HTTP response header.
ContentTypeOptions (dict) --
Determines whether CloudFront includes the X-Content-Type-Options HTTP response header with its value set to nosniff .
For more information about the X-Content-Type-Options HTTP response header, see X-Content-Type-Options in the MDN Web Docs.
Override (boolean) --
A Boolean that determines whether CloudFront overrides the X-Content-Type-Options HTTP response header received from the origin with the one specified in this response headers policy.
StrictTransportSecurity (dict) --
Determines whether CloudFront includes the Strict-Transport-Security HTTP response header and the header’s value.
For more information about the Strict-Transport-Security HTTP response header, see Strict-Transport-Security in the MDN Web Docs.
Override (boolean) --
A Boolean that determines whether CloudFront overrides the Strict-Transport-Security HTTP response header received from the origin with the one specified in this response headers policy.
IncludeSubdomains (boolean) --
A Boolean that determines whether CloudFront includes the includeSubDomains directive in the Strict-Transport-Security HTTP response header.
Preload (boolean) --
A Boolean that determines whether CloudFront includes the preload directive in the Strict-Transport-Security HTTP response header.
AccessControlMaxAgeSec (integer) --
A number that CloudFront uses as the value for the max-age directive in the Strict-Transport-Security HTTP response header.
ServerTimingHeadersConfig (dict) --
A configuration for enabling the Server-Timing header in HTTP responses sent from CloudFront.
Enabled (boolean) --
A Boolean that determines whether CloudFront adds the Server-Timing header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy.
SamplingRate (float) --
A number 0–100 (inclusive) that specifies the percentage of responses that you want CloudFront to add the Server-Timing header to. When you set the sampling rate to 100, CloudFront adds the Server-Timing header to the HTTP response for every request that matches the cache behavior that this response headers policy is attached to. When you set it to 50, CloudFront adds the header to 50% of the responses for requests that match the cache behavior. You can set the sampling rate to any number 0–100 with up to four decimal places.
CustomHeadersConfig (dict) --
A configuration for a set of custom HTTP response headers.
Quantity (integer) --
The number of HTTP response headers in the list.
Items (list) --
The list of HTTP response headers and their values.
(dict) --
An HTTP response header name and its value. CloudFront includes this header in HTTP responses that it sends for requests that match a cache behavior that’s associated with this response headers policy.
Header (string) --
The HTTP response header name.
Value (string) --
The value for the HTTP response header.
Override (boolean) --
A Boolean that determines whether CloudFront overrides a response header with the same name received from the origin with the header specified here.
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.NoSuchResponseHeadersPolicyCloudFront.Client.exceptions.InvalidArgumentlist_streaming_distributions(**kwargs)¶List streaming distributions.
See also: AWS API Documentation
Request Syntax
response = client.list_streaming_distributions(
Marker='string',
MaxItems='string'
)
Marker request parameter.MaxItems request parameter.dict
Response Syntax
{
'StreamingDistributionList': {
'Marker': 'string',
'NextMarker': 'string',
'MaxItems': 123,
'IsTruncated': True|False,
'Quantity': 123,
'Items': [
{
'Id': 'string',
'ARN': 'string',
'Status': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'DomainName': 'string',
'S3Origin': {
'DomainName': 'string',
'OriginAccessIdentity': 'string'
},
'Aliases': {
'Quantity': 123,
'Items': [
'string',
]
},
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'Comment': 'string',
'PriceClass': 'PriceClass_100'|'PriceClass_200'|'PriceClass_All',
'Enabled': True|False
},
]
}
}
Response Structure
(dict) --
The returned result of the corresponding request.
StreamingDistributionList (dict) --
The StreamingDistributionList type.
Marker (string) --
The value you provided for the Marker request parameter.
NextMarker (string) --
If IsTruncated is true , this element is present and contains the value you can use for the Marker request parameter to continue listing your RTMP distributions where they left off.
MaxItems (integer) --
The value you provided for the MaxItems request parameter.
IsTruncated (boolean) --
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.
Quantity (integer) --
The number of streaming distributions that were created by the current Amazon Web Services account.
Items (list) --
A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current Amazon Web Services account.
(dict) --
A summary of the information for a CloudFront streaming distribution.
Id (string) --
The identifier for the distribution, for example, EDFDVBD632BHDS5 .
ARN (string) --
The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5 , where 123456789012 is your Amazon Web Services account ID.
Status (string) --
Indicates the current status of the distribution. When the status is Deployed , the distribution's information is fully propagated throughout the Amazon CloudFront system.
LastModifiedTime (datetime) --
The date and time the distribution was last modified.
DomainName (string) --
The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net .
S3Origin (dict) --
A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.
DomainName (string) --
The DNS name of the Amazon S3 origin.
OriginAccessIdentity (string) --
The CloudFront origin access identity to associate with the distribution. Use an origin access identity to configure the distribution 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.
For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon CloudFront Developer Guide .
Aliases (dict) --
A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.
Quantity (integer) --
The number of CNAME aliases, if any, that you want to associate with this distribution.
Items (list) --
A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
TrustedSigners (dict) --
A complex type that specifies the Amazon Web Services 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 .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.
For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
Enabled (boolean) --
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
Quantity (integer) --
The number of Amazon Web Services accounts in the list.
Items (list) --
A list of Amazon Web Services account identifiers.
Comment (string) --
The comment originally specified when this distribution was created.
PriceClass (string) --
A complex type that contains information about price class for this streaming distribution.
Enabled (boolean) --
Whether the distribution is enabled to accept end user requests for content.
Exceptions
CloudFront.Client.exceptions.InvalidArgumentList tags for a CloudFront resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
Resource='string'
)
[REQUIRED]
An ARN of a CloudFront resource.
{
'Tags': {
'Items': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
The returned result of the corresponding request.
A complex type that contains zero or more Tag elements.
A complex type that contains Tag elements.
A complex type that contains Tag key and Tag value.
A string that contains Tag key.
The string length should be between 1 and 128 characters. Valid characters include a-z , A-Z , 0-9 , space, and the special characters _ - . : / = + @ .
A string that contains an optional Tag value.
The string length should be between 0 and 256 characters. Valid characters include a-z , A-Z , 0-9 , space, and the special characters _ - . : / = + @ .
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.InvalidTaggingCloudFront.Client.exceptions.NoSuchResourcepublish_function(**kwargs)¶Publishes a CloudFront function by copying the function code from the DEVELOPMENT stage to LIVE . This automatically updates all cache behaviors that are using this function to use the newly published copy in the LIVE stage.
When a function is published to the LIVE stage, you can attach the function to a distribution’s cache behavior, using the function’s Amazon Resource Name (ARN).
To publish a function, you must provide the function’s name and version (ETag value). To get these values, you can use ListFunctions and DescribeFunction .
See also: AWS API Documentation
Request Syntax
response = client.publish_function(
Name='string',
IfMatch='string'
)
[REQUIRED]
The name of the function that you are publishing.
[REQUIRED]
The current version (ETag value) of the function that you are publishing, which you can get using DescribeFunction .
dict
Response Syntax
{
'FunctionSummary': {
'Name': 'string',
'Status': 'string',
'FunctionConfig': {
'Comment': 'string',
'Runtime': 'cloudfront-js-1.0'
},
'FunctionMetadata': {
'FunctionARN': 'string',
'Stage': 'DEVELOPMENT'|'LIVE',
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1)
}
}
}
Response Structure
(dict) --
FunctionSummary (dict) --
Contains configuration information and metadata about a CloudFront function.
Name (string) --
The name of the CloudFront function.
Status (string) --
The status of the CloudFront function.
FunctionConfig (dict) --
Contains configuration information about a CloudFront function.
Comment (string) --
A comment to describe the function.
Runtime (string) --
The function’s runtime environment. The only valid value is cloudfront-js-1.0 .
FunctionMetadata (dict) --
Contains metadata about a CloudFront function.
FunctionARN (string) --
The Amazon Resource Name (ARN) of the function. The ARN uniquely identifies the function.
Stage (string) --
The stage that the function is in, either DEVELOPMENT or LIVE .
When a function is in the DEVELOPMENT stage, you can test the function with TestFunction , and update it with UpdateFunction .
When a function is in the LIVE stage, you can attach the function to a distribution’s cache behavior, using the function’s ARN.
CreatedTime (datetime) --
The date and time when the function was created.
LastModifiedTime (datetime) --
The date and time when the function was most recently updated.
Exceptions
CloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.InvalidIfMatchVersionCloudFront.Client.exceptions.NoSuchFunctionExistsCloudFront.Client.exceptions.PreconditionFailedCloudFront.Client.exceptions.UnsupportedOperationtag_resource(**kwargs)¶Add tags to a CloudFront resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
Resource='string',
Tags={
'Items': [
{
'Key': 'string',
'Value': 'string'
},
]
}
)
[REQUIRED]
An ARN of a CloudFront resource.
[REQUIRED]
A complex type that contains zero or more Tag elements.
A complex type that contains Tag elements.
A complex type that contains Tag key and Tag value.
A string that contains Tag key.
The string length should be between 1 and 128 characters. Valid characters include a-z , A-Z , 0-9 , space, and the special characters _ - . : / = + @ .
A string that contains an optional Tag value.
The string length should be between 0 and 256 characters. Valid characters include a-z , A-Z , 0-9 , space, and the special characters _ - . : / = + @ .
None
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.InvalidTaggingCloudFront.Client.exceptions.NoSuchResourcetest_function(**kwargs)¶Tests a CloudFront function.
To test a function, you provide an event object that represents an HTTP request or response that your CloudFront distribution could receive in production. CloudFront runs the function, passing it the event object that you provided, and returns the function’s result (the modified event object) in the response. The response also contains function logs and error messages, if any exist. For more information about testing functions, see Testing functions in the Amazon CloudFront Developer Guide .
To test a function, you provide the function’s name and version (ETag value) along with the event object. To get the function’s name and version, you can use ListFunctions and DescribeFunction .
See also: AWS API Documentation
Request Syntax
response = client.test_function(
Name='string',
IfMatch='string',
Stage='DEVELOPMENT'|'LIVE',
EventObject=b'bytes'
)
[REQUIRED]
The name of the function that you are testing.
[REQUIRED]
The current version (ETag value) of the function that you are testing, which you can get using DescribeFunction .
DEVELOPMENT or LIVE .[REQUIRED]
The event object to test the function with. For more information about the structure of the event object, see Testing functions in the Amazon CloudFront Developer Guide .
dict
Response Syntax
{
'TestResult': {
'FunctionSummary': {
'Name': 'string',
'Status': 'string',
'FunctionConfig': {
'Comment': 'string',
'Runtime': 'cloudfront-js-1.0'
},
'FunctionMetadata': {
'FunctionARN': 'string',
'Stage': 'DEVELOPMENT'|'LIVE',
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1)
}
},
'ComputeUtilization': 'string',
'FunctionExecutionLogs': [
'string',
],
'FunctionErrorMessage': 'string',
'FunctionOutput': 'string'
}
}
Response Structure
(dict) --
TestResult (dict) --
An object that represents the result of running the function with the provided event object.
FunctionSummary (dict) --
Contains configuration information and metadata about the CloudFront function that was tested.
Name (string) --
The name of the CloudFront function.
Status (string) --
The status of the CloudFront function.
FunctionConfig (dict) --
Contains configuration information about a CloudFront function.
Comment (string) --
A comment to describe the function.
Runtime (string) --
The function’s runtime environment. The only valid value is cloudfront-js-1.0 .
FunctionMetadata (dict) --
Contains metadata about a CloudFront function.
FunctionARN (string) --
The Amazon Resource Name (ARN) of the function. The ARN uniquely identifies the function.
Stage (string) --
The stage that the function is in, either DEVELOPMENT or LIVE .
When a function is in the DEVELOPMENT stage, you can test the function with TestFunction , and update it with UpdateFunction .
When a function is in the LIVE stage, you can attach the function to a distribution’s cache behavior, using the function’s ARN.
CreatedTime (datetime) --
The date and time when the function was created.
LastModifiedTime (datetime) --
The date and time when the function was most recently updated.
ComputeUtilization (string) --
The amount of time that the function took to run as a percentage of the maximum allowed time. For example, a compute utilization of 35 means that the function completed in 35% of the maximum allowed time.
FunctionExecutionLogs (list) --
Contains the log lines that the function wrote (if any) when running the test.
FunctionErrorMessage (string) --
If the result of testing the function was an error, this field contains the error message.
FunctionOutput (string) --
The event object returned by the function. For more information about the structure of the event object, see Event object structure in the Amazon CloudFront Developer Guide .
Exceptions
CloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.InvalidIfMatchVersionCloudFront.Client.exceptions.NoSuchFunctionExistsCloudFront.Client.exceptions.TestFunctionFailedCloudFront.Client.exceptions.UnsupportedOperationuntag_resource(**kwargs)¶Remove tags from a CloudFront resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
Resource='string',
TagKeys={
'Items': [
'string',
]
}
)
[REQUIRED]
An ARN of a CloudFront resource.
[REQUIRED]
A complex type that contains zero or more Tag key elements.
A complex type that contains Tag key elements.
A string that contains Tag key.
The string length should be between 1 and 128 characters. Valid characters include a-z , A-Z , 0-9 , space, and the special characters _ - . : / = + @ .
None
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.InvalidTaggingCloudFront.Client.exceptions.NoSuchResourceupdate_cache_policy(**kwargs)¶Updates a cache policy configuration.
When you update a cache policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a cache policy configuration:
GetCachePolicyConfig to get the current configuration.UpdateCachePolicy by providing the entire cache policy configuration, including the fields that you modified and those that you didn’t.See also: AWS API Documentation
Request Syntax
response = client.update_cache_policy(
CachePolicyConfig={
'Comment': 'string',
'Name': 'string',
'DefaultTTL': 123,
'MaxTTL': 123,
'MinTTL': 123,
'ParametersInCacheKeyAndForwardedToOrigin': {
'EnableAcceptEncodingGzip': True|False,
'EnableAcceptEncodingBrotli': True|False,
'HeadersConfig': {
'HeaderBehavior': 'none'|'whitelist',
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'CookiesConfig': {
'CookieBehavior': 'none'|'whitelist'|'allExcept'|'all',
'Cookies': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'QueryStringsConfig': {
'QueryStringBehavior': 'none'|'whitelist'|'allExcept'|'all',
'QueryStrings': {
'Quantity': 123,
'Items': [
'string',
]
}
}
}
},
Id='string',
IfMatch='string'
)
[REQUIRED]
A cache policy configuration.
A comment to describe the cache policy. The comment cannot be longer than 128 characters.
A unique name to identify the cache policy.
The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value as the object’s time to live (TTL) only when the origin does not send Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
The default value for this field is 86400 seconds (one day). If the value of MinTTL is more than 86400 seconds, then the default value for this field is the same as the value of MinTTL .
The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value only when the origin sends Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
The default value for this field is 31536000 seconds (one year). If the value of MinTTL or DefaultTTL is more than 31536000 seconds, then the default value for this field is the same as the value of DefaultTTL .
The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are automatically included in requests that CloudFront sends to the origin.
A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
This field is related to the EnableAcceptEncodingBrotli field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
Accept-Encoding headerFor more information, see Compression support in the Amazon CloudFront Developer Guide .
If you set this value to true , and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true , so including this header in an origin request policy has no effect.
If both of these fields are false , then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.
A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
This field is related to the EnableAcceptEncodingGzip field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
Accept-Encoding headerFor more information, see Compression support in the Amazon CloudFront Developer Guide .
If you set this value to true , and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true , so including this header in an origin request policy has no effect.
If both of these fields are false , then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.
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.
Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
none – HTTP headers are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any headers that are listed in an OriginRequestPolicy are included in origin requests.whitelist – The HTTP headers that are listed in the Headers type are included in the cache key and are automatically included in requests that CloudFront sends to the origin.Contains a list of HTTP header names.
The number of header names in the Items list.
A list of HTTP header names.
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.
Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
none – Cookies in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any cookies that are listed in an OriginRequestPolicy are included in origin requests.whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.allExcept – All cookies in viewer requests that are * not * listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.all – All cookies in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.Contains a list of cookie names.
The number of cookie names in the Items list.
A list of cookie names.
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.
Determines whether any URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
none – Query strings in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any query strings that are listed in an OriginRequestPolicy are included in origin requests.whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.allExcept – All query strings in viewer requests that are * not * listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.all – All query strings in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.Contains the specific query strings in viewer requests that either * are * or * are not * included in the cache key and automatically included in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the CachePolicyQueryStringsConfig type is set to whitelist (the listed query strings * are * included) or allExcept (the listed query strings * are not * included, but all other query strings are).
The number of query string names in the Items list.
A list of query string names.
[REQUIRED]
The unique identifier for the cache policy that you are updating. The identifier is returned in a cache behavior’s CachePolicyId field in the response to GetDistributionConfig .
ETag field in the response to GetCachePolicyConfig .dict
Response Syntax
{
'CachePolicy': {
'Id': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'CachePolicyConfig': {
'Comment': 'string',
'Name': 'string',
'DefaultTTL': 123,
'MaxTTL': 123,
'MinTTL': 123,
'ParametersInCacheKeyAndForwardedToOrigin': {
'EnableAcceptEncodingGzip': True|False,
'EnableAcceptEncodingBrotli': True|False,
'HeadersConfig': {
'HeaderBehavior': 'none'|'whitelist',
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'CookiesConfig': {
'CookieBehavior': 'none'|'whitelist'|'allExcept'|'all',
'Cookies': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'QueryStringsConfig': {
'QueryStringBehavior': 'none'|'whitelist'|'allExcept'|'all',
'QueryStrings': {
'Quantity': 123,
'Items': [
'string',
]
}
}
}
}
},
'ETag': 'string'
}
Response Structure
(dict) --
CachePolicy (dict) --
A cache policy.
Id (string) --
The unique identifier for the cache policy.
LastModifiedTime (datetime) --
The date and time when the cache policy was last modified.
CachePolicyConfig (dict) --
The cache policy configuration.
Comment (string) --
A comment to describe the cache policy. The comment cannot be longer than 128 characters.
Name (string) --
A unique name to identify the cache policy.
DefaultTTL (integer) --
The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value as the object’s time to live (TTL) only when the origin does not send Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
The default value for this field is 86400 seconds (one day). If the value of MinTTL is more than 86400 seconds, then the default value for this field is the same as the value of MinTTL .
MaxTTL (integer) --
The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value only when the origin sends Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
The default value for this field is 31536000 seconds (one year). If the value of MinTTL or DefaultTTL is more than 31536000 seconds, then the default value for this field is the same as the value of DefaultTTL .
MinTTL (integer) --
The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
ParametersInCacheKeyAndForwardedToOrigin (dict) --
The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are automatically included in requests that CloudFront sends to the origin.
EnableAcceptEncodingGzip (boolean) --
A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
This field is related to the EnableAcceptEncodingBrotli field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
Accept-Encoding headerFor more information, see Compression support in the Amazon CloudFront Developer Guide .
If you set this value to true , and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true , so including this header in an origin request policy has no effect.
If both of these fields are false , then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.
EnableAcceptEncodingBrotli (boolean) --
A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
This field is related to the EnableAcceptEncodingGzip field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
Accept-Encoding headerFor more information, see Compression support in the Amazon CloudFront Developer Guide .
If you set this value to true , and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true , so including this header in an origin request policy has no effect.
If both of these fields are false , then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.
HeadersConfig (dict) --
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.
HeaderBehavior (string) --
Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
none – HTTP headers are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any headers that are listed in an OriginRequestPolicy are included in origin requests.whitelist – The HTTP headers that are listed in the Headers type are included in the cache key and are automatically included in requests that CloudFront sends to the origin.Headers (dict) --
Contains a list of HTTP header names.
Quantity (integer) --
The number of header names in the Items list.
Items (list) --
A list of HTTP header names.
CookiesConfig (dict) --
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.
CookieBehavior (string) --
Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
none – Cookies in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any cookies that are listed in an OriginRequestPolicy are included in origin requests.whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.allExcept – All cookies in viewer requests that are * not * listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.all – All cookies in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.Cookies (dict) --
Contains a list of cookie names.
Quantity (integer) --
The number of cookie names in the Items list.
Items (list) --
A list of cookie names.
QueryStringsConfig (dict) --
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.
QueryStringBehavior (string) --
Determines whether any URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
none – Query strings in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any query strings that are listed in an OriginRequestPolicy are included in origin requests.whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.allExcept – All query strings in viewer requests that are * not * listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.all – All query strings in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.QueryStrings (dict) --
Contains the specific query strings in viewer requests that either * are * or * are not * included in the cache key and automatically included in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the CachePolicyQueryStringsConfig type is set to whitelist (the listed query strings * are * included) or allExcept (the listed query strings * are not * included, but all other query strings are).
Quantity (integer) --
The number of query string names in the Items list.
Items (list) --
A list of query string names.
ETag (string) --
The current version of the cache policy.
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.IllegalUpdateCloudFront.Client.exceptions.InconsistentQuantitiesCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.InvalidIfMatchVersionCloudFront.Client.exceptions.NoSuchCachePolicyCloudFront.Client.exceptions.PreconditionFailedCloudFront.Client.exceptions.CachePolicyAlreadyExistsCloudFront.Client.exceptions.TooManyHeadersInCachePolicyCloudFront.Client.exceptions.TooManyCookiesInCachePolicyCloudFront.Client.exceptions.TooManyQueryStringsInCachePolicyupdate_cloud_front_origin_access_identity(**kwargs)¶Update an origin access identity.
See also: AWS API Documentation
Request Syntax
response = client.update_cloud_front_origin_access_identity(
CloudFrontOriginAccessIdentityConfig={
'CallerReference': 'string',
'Comment': 'string'
},
Id='string',
IfMatch='string'
)
[REQUIRED]
The identity's configuration information.
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of CallerReference is new (regardless of the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created.
If the CallerReference is a value already sent in a previous identity request, 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.
A comment to describe the origin access identity. The comment cannot be longer than 128 characters.
[REQUIRED]
The identity's id.
ETag header that you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL .dict
Response Syntax
{
'CloudFrontOriginAccessIdentity': {
'Id': 'string',
'S3CanonicalUserId': 'string',
'CloudFrontOriginAccessIdentityConfig': {
'CallerReference': 'string',
'Comment': 'string'
}
},
'ETag': 'string'
}
Response Structure
(dict) --
The returned result of the corresponding request.
CloudFrontOriginAccessIdentity (dict) --
The origin access identity's information.
Id (string) --
The ID for the origin access identity, for example, E74FTE3AJFJ256A .
S3CanonicalUserId (string) --
The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3.
CloudFrontOriginAccessIdentityConfig (dict) --
The current configuration information for the identity.
CallerReference (string) --
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of CallerReference is new (regardless of the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created.
If the CallerReference is a value already sent in a previous identity request, 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.
Comment (string) --
A comment to describe the origin access identity. The comment cannot be longer than 128 characters.
ETag (string) --
The current version of the configuration. For example: E2QWRUHAPOMQZL .
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.IllegalUpdateCloudFront.Client.exceptions.InvalidIfMatchVersionCloudFront.Client.exceptions.MissingBodyCloudFront.Client.exceptions.NoSuchCloudFrontOriginAccessIdentityCloudFront.Client.exceptions.PreconditionFailedCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.InconsistentQuantitiesupdate_distribution(**kwargs)¶Updates the configuration for a web distribution.
Warning
When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using this API action, follow the steps here to get the current configuration and then make your updates, to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide .
The update process includes getting the current distribution configuration, updating the XML document that is returned to make your changes, and then submitting an UpdateDistribution request to make the updates.
For information about updating a distribution using the CloudFront console instead, see Creating a Distribution in the Amazon CloudFront Developer Guide .
To update a web distribution using the CloudFront API
Etag header for the distribution.Note
If you update the distribution again, you must get a new Etag header.
GetDistributionConfig request to include your changes.Warning
When you edit the XML file, be aware of the following:
- You must strip out the ETag parameter that is returned.
- Additional fields are required when you update a distribution. There may be fields included in the XML file for features that you haven't configured for your distribution. This is expected and required to successfully update the distribution.
- You can't change the value of
CallerReference. If you try to change this value, CloudFront returns anIllegalUpdateerror.- The new configuration replaces the existing configuration; the values that you specify in an
UpdateDistributionrequest are not merged into your existing configuration. When you add, delete, or replace values in an element that allows multiple values (for example,CNAME), you must specify all of the values that you want to appear in the updated distribution. In addition, you must update the correspondingQuantityelement.
UpdateDistribution request to update the configuration for your distribution:DistributionConfig element.If-Match header to the value of the ETag header that CloudFront returned when you submitted the GetDistributionConfig request in Step 1.UpdateDistribution request to confirm that the configuration was successfully updated.Status is Deployed .See also: AWS API Documentation
Request Syntax
response = client.update_distribution(
DistributionConfig={
'CallerReference': 'string',
'Aliases': {
'Quantity': 123,
'Items': [
'string',
]
},
'DefaultRootObject': 'string',
'Origins': {
'Quantity': 123,
'Items': [
{
'Id': 'string',
'DomainName': 'string',
'OriginPath': 'string',
'CustomHeaders': {
'Quantity': 123,
'Items': [
{
'HeaderName': 'string',
'HeaderValue': 'string'
},
]
},
'S3OriginConfig': {
'OriginAccessIdentity': 'string'
},
'CustomOriginConfig': {
'HTTPPort': 123,
'HTTPSPort': 123,
'OriginProtocolPolicy': 'http-only'|'match-viewer'|'https-only',
'OriginSslProtocols': {
'Quantity': 123,
'Items': [
'SSLv3'|'TLSv1'|'TLSv1.1'|'TLSv1.2',
]
},
'OriginReadTimeout': 123,
'OriginKeepaliveTimeout': 123
},
'ConnectionAttempts': 123,
'ConnectionTimeout': 123,
'OriginShield': {
'Enabled': True|False,
'OriginShieldRegion': 'string'
},
'OriginAccessControlId': 'string'
},
]
},
'OriginGroups': {
'Quantity': 123,
'Items': [
{
'Id': 'string',
'FailoverCriteria': {
'StatusCodes': {
'Quantity': 123,
'Items': [
123,
]
}
},
'Members': {
'Quantity': 123,
'Items': [
{
'OriginId': 'string'
},
]
}
},
]
},
'DefaultCacheBehavior': {
'TargetOriginId': 'string',
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'TrustedKeyGroups': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'ViewerProtocolPolicy': 'allow-all'|'https-only'|'redirect-to-https',
'AllowedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
],
'CachedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
]
}
},
'SmoothStreaming': True|False,
'Compress': True|False,
'LambdaFunctionAssociations': {
'Quantity': 123,
'Items': [
{
'LambdaFunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response',
'IncludeBody': True|False
},
]
},
'FunctionAssociations': {
'Quantity': 123,
'Items': [
{
'FunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response'
},
]
},
'FieldLevelEncryptionId': 'string',
'RealtimeLogConfigArn': 'string',
'CachePolicyId': 'string',
'OriginRequestPolicyId': 'string',
'ResponseHeadersPolicyId': 'string',
'ForwardedValues': {
'QueryString': True|False,
'Cookies': {
'Forward': 'none'|'whitelist'|'all',
'WhitelistedNames': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
},
'QueryStringCacheKeys': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'MinTTL': 123,
'DefaultTTL': 123,
'MaxTTL': 123
},
'CacheBehaviors': {
'Quantity': 123,
'Items': [
{
'PathPattern': 'string',
'TargetOriginId': 'string',
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'TrustedKeyGroups': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'ViewerProtocolPolicy': 'allow-all'|'https-only'|'redirect-to-https',
'AllowedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
],
'CachedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
]
}
},
'SmoothStreaming': True|False,
'Compress': True|False,
'LambdaFunctionAssociations': {
'Quantity': 123,
'Items': [
{
'LambdaFunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response',
'IncludeBody': True|False
},
]
},
'FunctionAssociations': {
'Quantity': 123,
'Items': [
{
'FunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response'
},
]
},
'FieldLevelEncryptionId': 'string',
'RealtimeLogConfigArn': 'string',
'CachePolicyId': 'string',
'OriginRequestPolicyId': 'string',
'ResponseHeadersPolicyId': 'string',
'ForwardedValues': {
'QueryString': True|False,
'Cookies': {
'Forward': 'none'|'whitelist'|'all',
'WhitelistedNames': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
},
'QueryStringCacheKeys': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'MinTTL': 123,
'DefaultTTL': 123,
'MaxTTL': 123
},
]
},
'CustomErrorResponses': {
'Quantity': 123,
'Items': [
{
'ErrorCode': 123,
'ResponsePagePath': 'string',
'ResponseCode': 'string',
'ErrorCachingMinTTL': 123
},
]
},
'Comment': 'string',
'Logging': {
'Enabled': True|False,
'IncludeCookies': True|False,
'Bucket': 'string',
'Prefix': 'string'
},
'PriceClass': 'PriceClass_100'|'PriceClass_200'|'PriceClass_All',
'Enabled': True|False,
'ViewerCertificate': {
'CloudFrontDefaultCertificate': True|False,
'IAMCertificateId': 'string',
'ACMCertificateArn': 'string',
'SSLSupportMethod': 'sni-only'|'vip'|'static-ip',
'MinimumProtocolVersion': 'SSLv3'|'TLSv1'|'TLSv1_2016'|'TLSv1.1_2016'|'TLSv1.2_2018'|'TLSv1.2_2019'|'TLSv1.2_2021',
'Certificate': 'string',
'CertificateSource': 'cloudfront'|'iam'|'acm'
},
'Restrictions': {
'GeoRestriction': {
'RestrictionType': 'blacklist'|'whitelist'|'none',
'Quantity': 123,
'Items': [
'string',
]
}
},
'WebACLId': 'string',
'HttpVersion': 'http1.1'|'http2'|'http3'|'http2and3',
'IsIPV6Enabled': True|False
},
Id='string',
IfMatch='string'
)
[REQUIRED]
The distribution's configuration information.
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of CallerReference is new (regardless of the content of the DistributionConfig object), CloudFront creates a new distribution.
If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
The number of CNAME aliases, if any, that you want to associate with this distribution.
A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
The object that you want CloudFront to request from your origin (for example, index.html ) when a viewer requests the root URL for your distribution (http://www.example.com ) instead of an object in your distribution (http://www.example.com/product-description.html ). Specifying a default root object avoids exposing the contents of your distribution.
Specify only the object name, for example, index.html . Don't add a / before the object name.
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.
For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide .
A complex type that contains information about origins for this distribution.
The number of origins for this distribution.
A list of origins.
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:
S3OriginConfig to specify an Amazon S3 bucket that is not configured with static website hosting.CustomOriginConfig to specify all other kinds of origins, including: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).
A unique identifier for the origin. This value must be unique within the distribution.
Use this value to specify the TargetOriginId in a CacheBehavior or DefaultCacheBehavior .
The domain name for the origin.
For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide .
An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
For more information, see Origin Path in the Amazon CloudFront Developer Guide .
A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.
For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .
The number of custom headers, if any, for this distribution.
Optional : A list that contains oneOriginCustomHeaderelement for each custom header that you want CloudFront to forward to the origin. If Quantity is0, omitItems.
A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution.
The name of a header that you want CloudFront to send to your origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .
The value for the header that you specified in the HeaderName field.
Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the CustomOriginConfig type instead.
The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
origin-access-identity/cloudfront/ID-of-origin-access-identity
where `` ID-of-origin-access-identity `` is the value that CloudFront returned in the ID element when you created the origin access identity.
If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.
To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.
To replace the origin access identity, update the distribution configuration and specify the new origin access identity.
For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.
The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:
http-only – CloudFront always uses HTTP to connect to the origin.match-viewer – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.https-only – CloudFront always uses HTTPS to connect to the origin.Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include SSLv3 , TLSv1 , TLSv1.1 , and TLSv1.2 .
For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide .
The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.
A list that contains allowed SSL/TLS protocols for this distribution.
Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout . The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 30 seconds.
For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide .
Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 5 seconds.
For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide .
The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don’t specify otherwise) is 3.
For a custom origin (including an Amazon S3 bucket that’s configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout .
For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide .
The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don’t specify otherwise) is 10 seconds.
For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide .
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 .
A flag that specifies whether Origin Shield is enabled.
When it’s enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it’s disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.
The Amazon Web Services Region for Origin Shield.
Specify the Amazon Web Services Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as us-east-2 .
When you enable CloudFront Origin Shield, you must specify the Amazon Web Services Region for Origin Shield. For the list of Amazon Web Services Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the Amazon Web Services Region for Origin Shield in the Amazon CloudFront Developer Guide .
The unique identifier of an origin access control for this origin.
For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide .
A complex type that contains information about origin groups for this distribution.
The number of origin groups.
The items (origin groups) in a distribution.
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.
The origin group's ID.
A complex type that contains information about the failover criteria for an origin group.
The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.
The number of status codes.
The items (status codes) for an origin group.
A complex type that contains information about the origins in an origin group.
The number of origins in an origin group.
Items (origins) in an origin group.
An origin in an origin group.
The ID for an origin in an origin group.
A complex type that describes the default cache behavior if you don't 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.
The value of ID for the origin that you want CloudFront to route requests to when they use the default cache behavior.
Warning
We recommend using TrustedKeyGroups instead of TrustedSigners .
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer’s Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services account identifiers.
A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of key groups in the list.
A list of key groups identifiers.
The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern . You can specify the following options:
allow-all : Viewers can use HTTP or HTTPS.redirect-to-https : If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only : If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide .
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:
GET and HEAD requests.GET , HEAD , and OPTIONS requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
GET and HEAD requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true ; if not, specify false . If you specify true for SmoothStreaming , you can still distribute other content using this cache behavior if the content matches the value of PathPattern .
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true ; if not, specify false . For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
The number of Lambda@Edge function associations for this cache behavior.
Optional : A complex type that containsLambdaFunctionAssociationitems for this cache behavior. IfQuantityis0, you can omitItems.
A complex type that contains a Lambda@Edge function association.
The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request : The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request : The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response : The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response : The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.
The number of CloudFront functions in the list.
The 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.
A CloudFront function that is associated with a cache behavior in a CloudFront distribution.
The Amazon Resource Name (ARN) of the function.
The event type of the function, either viewer-request or viewer-response . You cannot use origin-facing event types (origin-request and origin-response ) with a CloudFront function.
The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior.
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide .
The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
The identifier for a response headers policy.
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide .
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed 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 or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 .
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys , if any:
If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
If you specify false for QueryString , CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 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 How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide .
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.
Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 .
Required if you specify whitelist for the value of Forward . A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.
If you specify all or none for the value of Forward , omit WhitelistedNames . If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.
For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference .
The number of cookie names in the Items list.
A list of cookie names.
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 headers 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 headers 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 the Headers , if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.
For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide .
The number of header names in the Items list.
A list of HTTP header names.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
The number of whitelisted query string parameters for a cache behavior.
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items .
This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers , if you specify 1 for Quantity and * for Name ).
This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The default amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The maximum amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
A complex type that contains zero or more CacheBehavior elements.
The number of cache behaviors for this distribution.
Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0 , you can omit Items .
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 .
The pattern (for example, images/*.jpg ) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.
Note
You can optionally include a slash (/ ) at the beginning of the path pattern. For example, /images/*.jpg . CloudFront behavior is the same with or without the leading / .
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.
For more information, see Path Pattern in the Amazon CloudFront Developer Guide .
The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.
Warning
We recommend using TrustedKeyGroups instead of TrustedSigners .
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer’s Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services account identifiers.
A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of key groups in the list.
A list of key groups identifiers.
The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern . You can specify the following options:
allow-all : Viewers can use HTTP or HTTPS.redirect-to-https : If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only : If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide .
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:
GET and HEAD requests.GET , HEAD , and OPTIONS requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
GET and HEAD requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true ; if not, specify false . If you specify true for SmoothStreaming , you can still distribute other content using this cache behavior if the content matches the value of PathPattern .
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
The number of Lambda@Edge function associations for this cache behavior.
Optional : A complex type that containsLambdaFunctionAssociationitems for this cache behavior. IfQuantityis0, you can omitItems.
A complex type that contains a Lambda@Edge function association.
The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request : The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request : The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response : The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response : The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.
The number of CloudFront functions in the list.
The 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.
A CloudFront function that is associated with a cache behavior in a CloudFront distribution.
The Amazon Resource Name (ARN) of the function.
The event type of the function, either viewer-request or viewer-response . You cannot use origin-facing event types (origin-request and origin-response ) with a CloudFront function.
The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide .
The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
A CacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
The identifier for a response headers policy.
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide .
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed 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 or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
A CacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 .
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys , if any:
If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
If you specify false for QueryString , CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 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 How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide .
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.
Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 .
Required if you specify whitelist for the value of Forward . A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.
If you specify all or none for the value of Forward , omit WhitelistedNames . If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.
For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference .
The number of cookie names in the Items list.
A list of cookie names.
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 headers 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 headers 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 the Headers , if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.
For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide .
The number of header names in the Items list.
A list of HTTP header names.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
The number of whitelisted query string parameters for a cache behavior.
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items .
This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers , if you specify 1 for Quantity and * for Name ).
This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The default amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The maximum amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
A complex type that controls the following:
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0 , you can omit Items .
A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration.
A complex type that controls:
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
The HTTP status code for which you want to specify a custom error page and/or a caching duration.
The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode , for example, /4xx-errors/403-forbidden.html . If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:
PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors . Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, /4xx-errors/* .TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages.If you specify a value for ResponsePagePath , you must also specify a value for ResponseCode .
We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.
The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:
200 , the response typically won't be intercepted.400 or 500 as the ResponseCode for all 4xx or 5xx errors.200 status code (OK) and static website so your customers don't know that your website is down.If you specify a value for ResponseCode , you must also specify a value for ResponsePagePath .
The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode . When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.
For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
An optional comment to describe the distribution. The comment cannot be longer than 128 characters.
A complex type that controls whether access logs are written for the distribution.
For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide .
Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't 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.
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 don't 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 .
The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com .
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 don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.
The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All , CloudFront responds to requests for your objects from all CloudFront edge locations.
If you specify a price class other than PriceClass_All , CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.
For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide . For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing .
From this field, you can enable or disable the selected distribution.
A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net , set this field to true .
If the distribution uses Aliases (alternate domain names or CNAMEs), set this field to false and specify values for the following fields:
ACMCertificateArn or IAMCertificateId (specify a value for one, not both)MinimumProtocolVersionSSLSupportMethodIf the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Identity and Access Management (IAM) , provide the ID of the IAM certificate.
If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVersion and SSLSupportMethod .
If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Certificate Manager (ACM) , provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (us-east-1 ).
If you specify an ACM certificate ARN, you must also specify values for MinimumProtocolVersion and SSLSupportMethod .
If the distribution uses Aliases (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.
sni-only – The distribution accepts HTTPS connections from only viewers that support server name indication (SNI) . This is recommended. Most browsers and clients support SNI.vip – The distribution accepts HTTPS connections from all viewers including those that don’t support SNI. This is not recommended, and results in additional monthly charges from CloudFront.static-ip - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the Amazon Web Services Support Center .If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net , don’t set a value for this field.
If the distribution uses Aliases (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:
For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
On the CloudFront console, this setting is called Security Policy .
When you’re using SNI only (you set SSLSupportMethod to sni-only ), you must specify TLSv1 or higher.
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net (you set CloudFrontDefaultCertificate to true ), CloudFront automatically sets the security policy to TLSv1 regardless of the value that you set here.
This field is deprecated. Use one of the following fields instead:
ACMCertificateArnIAMCertificateIdCloudFrontDefaultCertificateThis field is deprecated. Use one of the following fields instead:
ACMCertificateArnIAMCertificateIdCloudFrontDefaultCertificateA complex type that identifies ways in which you want to restrict distribution of your content.
A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.
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 don't want CloudFront to distribute your content.whitelist : The Location elements specify the countries in which you want CloudFront to distribute your content.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 .
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 on the CloudFront console, which includes both country names and codes.
A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a . To specify a web ACL created using WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a .
WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the WAF Developer Guide .
(Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2 . Viewers that don't support HTTP/2 automatically use an earlier HTTP version.
For viewers and CloudFront to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI).
For viewers and CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CloudFront supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see Connection Migration at RFC 9000. For more information about supported TLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront .
If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true . If you specify false , CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.
In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide .
If you're using an Route 53 Amazon Web Services Integration alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:
For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Route 53 Amazon Web Services Integration Developer Guide .
If you created a CNAME resource record set, either with Route 53 Amazon Web Services Integration or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.
[REQUIRED]
The distribution's id.
ETag header that you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL .dict
Response Syntax
{
'Distribution': {
'Id': 'string',
'ARN': 'string',
'Status': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'InProgressInvalidationBatches': 123,
'DomainName': 'string',
'ActiveTrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
{
'AwsAccountNumber': 'string',
'KeyPairIds': {
'Quantity': 123,
'Items': [
'string',
]
}
},
]
},
'ActiveTrustedKeyGroups': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
{
'KeyGroupId': 'string',
'KeyPairIds': {
'Quantity': 123,
'Items': [
'string',
]
}
},
]
},
'DistributionConfig': {
'CallerReference': 'string',
'Aliases': {
'Quantity': 123,
'Items': [
'string',
]
},
'DefaultRootObject': 'string',
'Origins': {
'Quantity': 123,
'Items': [
{
'Id': 'string',
'DomainName': 'string',
'OriginPath': 'string',
'CustomHeaders': {
'Quantity': 123,
'Items': [
{
'HeaderName': 'string',
'HeaderValue': 'string'
},
]
},
'S3OriginConfig': {
'OriginAccessIdentity': 'string'
},
'CustomOriginConfig': {
'HTTPPort': 123,
'HTTPSPort': 123,
'OriginProtocolPolicy': 'http-only'|'match-viewer'|'https-only',
'OriginSslProtocols': {
'Quantity': 123,
'Items': [
'SSLv3'|'TLSv1'|'TLSv1.1'|'TLSv1.2',
]
},
'OriginReadTimeout': 123,
'OriginKeepaliveTimeout': 123
},
'ConnectionAttempts': 123,
'ConnectionTimeout': 123,
'OriginShield': {
'Enabled': True|False,
'OriginShieldRegion': 'string'
},
'OriginAccessControlId': 'string'
},
]
},
'OriginGroups': {
'Quantity': 123,
'Items': [
{
'Id': 'string',
'FailoverCriteria': {
'StatusCodes': {
'Quantity': 123,
'Items': [
123,
]
}
},
'Members': {
'Quantity': 123,
'Items': [
{
'OriginId': 'string'
},
]
}
},
]
},
'DefaultCacheBehavior': {
'TargetOriginId': 'string',
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'TrustedKeyGroups': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'ViewerProtocolPolicy': 'allow-all'|'https-only'|'redirect-to-https',
'AllowedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
],
'CachedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
]
}
},
'SmoothStreaming': True|False,
'Compress': True|False,
'LambdaFunctionAssociations': {
'Quantity': 123,
'Items': [
{
'LambdaFunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response',
'IncludeBody': True|False
},
]
},
'FunctionAssociations': {
'Quantity': 123,
'Items': [
{
'FunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response'
},
]
},
'FieldLevelEncryptionId': 'string',
'RealtimeLogConfigArn': 'string',
'CachePolicyId': 'string',
'OriginRequestPolicyId': 'string',
'ResponseHeadersPolicyId': 'string',
'ForwardedValues': {
'QueryString': True|False,
'Cookies': {
'Forward': 'none'|'whitelist'|'all',
'WhitelistedNames': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
},
'QueryStringCacheKeys': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'MinTTL': 123,
'DefaultTTL': 123,
'MaxTTL': 123
},
'CacheBehaviors': {
'Quantity': 123,
'Items': [
{
'PathPattern': 'string',
'TargetOriginId': 'string',
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'TrustedKeyGroups': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'ViewerProtocolPolicy': 'allow-all'|'https-only'|'redirect-to-https',
'AllowedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
],
'CachedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
]
}
},
'SmoothStreaming': True|False,
'Compress': True|False,
'LambdaFunctionAssociations': {
'Quantity': 123,
'Items': [
{
'LambdaFunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response',
'IncludeBody': True|False
},
]
},
'FunctionAssociations': {
'Quantity': 123,
'Items': [
{
'FunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response'
},
]
},
'FieldLevelEncryptionId': 'string',
'RealtimeLogConfigArn': 'string',
'CachePolicyId': 'string',
'OriginRequestPolicyId': 'string',
'ResponseHeadersPolicyId': 'string',
'ForwardedValues': {
'QueryString': True|False,
'Cookies': {
'Forward': 'none'|'whitelist'|'all',
'WhitelistedNames': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
},
'QueryStringCacheKeys': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'MinTTL': 123,
'DefaultTTL': 123,
'MaxTTL': 123
},
]
},
'CustomErrorResponses': {
'Quantity': 123,
'Items': [
{
'ErrorCode': 123,
'ResponsePagePath': 'string',
'ResponseCode': 'string',
'ErrorCachingMinTTL': 123
},
]
},
'Comment': 'string',
'Logging': {
'Enabled': True|False,
'IncludeCookies': True|False,
'Bucket': 'string',
'Prefix': 'string'
},
'PriceClass': 'PriceClass_100'|'PriceClass_200'|'PriceClass_All',
'Enabled': True|False,
'ViewerCertificate': {
'CloudFrontDefaultCertificate': True|False,
'IAMCertificateId': 'string',
'ACMCertificateArn': 'string',
'SSLSupportMethod': 'sni-only'|'vip'|'static-ip',
'MinimumProtocolVersion': 'SSLv3'|'TLSv1'|'TLSv1_2016'|'TLSv1.1_2016'|'TLSv1.2_2018'|'TLSv1.2_2019'|'TLSv1.2_2021',
'Certificate': 'string',
'CertificateSource': 'cloudfront'|'iam'|'acm'
},
'Restrictions': {
'GeoRestriction': {
'RestrictionType': 'blacklist'|'whitelist'|'none',
'Quantity': 123,
'Items': [
'string',
]
}
},
'WebACLId': 'string',
'HttpVersion': 'http1.1'|'http2'|'http3'|'http2and3',
'IsIPV6Enabled': True|False
},
'AliasICPRecordals': [
{
'CNAME': 'string',
'ICPRecordalStatus': 'APPROVED'|'SUSPENDED'|'PENDING'
},
]
},
'ETag': 'string'
}
Response Structure
(dict) --
The returned result of the corresponding request.
Distribution (dict) --
The distribution's information.
Id (string) --
The identifier for the distribution. For example: EDFDVBD632BHDS5 .
ARN (string) --
The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5 , where 123456789012 is your Amazon Web Services account ID.
Status (string) --
This response element indicates the current status of the distribution. When the status is Deployed , the distribution's information is fully propagated to all CloudFront edge locations.
LastModifiedTime (datetime) --
The date and time the distribution was last modified.
InProgressInvalidationBatches (integer) --
The number of invalidation batches currently in progress.
DomainName (string) --
The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net .
ActiveTrustedSigners (dict) --
Warning
We recommend using TrustedKeyGroups instead of TrustedSigners .
CloudFront automatically adds this field to the response if you’ve configured a cache behavior in this distribution to serve private content using trusted signers. This field contains a list of Amazon Web Services account IDs and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs or signed cookies.
Enabled (boolean) --
This field is true if any of the Amazon Web Services accounts in the list have active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
Quantity (integer) --
The number of Amazon Web Services accounts in the list.
Items (list) --
A list of Amazon Web Services accounts and the identifiers of active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.
(dict) --
A list of Amazon Web Services accounts and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.
AwsAccountNumber (string) --
An Amazon Web Services account number that contains active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If the Amazon Web Services account that owns the key pairs is the same account that owns the CloudFront distribution, the value of this field is self .
KeyPairIds (dict) --
A list of CloudFront key pair identifiers.
Quantity (integer) --
The number of key pair identifiers in the list.
Items (list) --
A list of CloudFront key pair identifiers.
ActiveTrustedKeyGroups (dict) --
CloudFront automatically adds this field to the response if you’ve configured a cache behavior in this distribution to serve private content using key groups. This field contains a list of key groups and the public keys in each key group that CloudFront can use to verify the signatures of signed URLs or signed cookies.
Enabled (boolean) --
This field is true if any of the key groups have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
Quantity (integer) --
The number of key groups in the list.
Items (list) --
A list of key groups, including the identifiers of the public keys in each key group that CloudFront can use to verify the signatures of signed URLs and signed cookies.
(dict) --
A list of identifiers for the public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies.
KeyGroupId (string) --
The identifier of the key group that contains the public keys.
KeyPairIds (dict) --
A list of CloudFront key pair identifiers.
Quantity (integer) --
The number of key pair identifiers in the list.
Items (list) --
A list of CloudFront key pair identifiers.
DistributionConfig (dict) --
The current configuration information for the distribution. Send a GET request to the /*CloudFront API version* /distribution ID/config resource.
CallerReference (string) --
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of CallerReference is new (regardless of the content of the DistributionConfig object), CloudFront creates a new distribution.
If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.
Aliases (dict) --
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
Quantity (integer) --
The number of CNAME aliases, if any, that you want to associate with this distribution.
Items (list) --
A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
DefaultRootObject (string) --
The object that you want CloudFront to request from your origin (for example, index.html ) when a viewer requests the root URL for your distribution (http://www.example.com ) instead of an object in your distribution (http://www.example.com/product-description.html ). Specifying a default root object avoids exposing the contents of your distribution.
Specify only the object name, for example, index.html . Don't add a / before the object name.
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.
For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide .
Origins (dict) --
A complex type that contains information about origins for this distribution.
Quantity (integer) --
The number of origins for this distribution.
Items (list) --
A list of origins.
(dict) --
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:
S3OriginConfig to specify an Amazon S3 bucket that is not configured with static website hosting.CustomOriginConfig to specify all other kinds of origins, including: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).
Id (string) --
A unique identifier for the origin. This value must be unique within the distribution.
Use this value to specify the TargetOriginId in a CacheBehavior or DefaultCacheBehavior .
DomainName (string) --
The domain name for the origin.
For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide .
OriginPath (string) --
An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
For more information, see Origin Path in the Amazon CloudFront Developer Guide .
CustomHeaders (dict) --
A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.
For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .
Quantity (integer) --
The number of custom headers, if any, for this distribution.
Items (list) --
Optional : A list that contains one
OriginCustomHeaderelement for each custom header that you want CloudFront to forward to the origin. If Quantity is0, omitItems.
(dict) --
A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution.
HeaderName (string) --
The name of a header that you want CloudFront to send to your origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .
HeaderValue (string) --
The value for the header that you specified in the HeaderName field.
S3OriginConfig (dict) --
Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the CustomOriginConfig type instead.
OriginAccessIdentity (string) --
The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
origin-access-identity/cloudfront/ID-of-origin-access-identity
where `` ID-of-origin-access-identity `` is the value that CloudFront returned in the ID element when you created the origin access identity.
If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.
To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.
To replace the origin access identity, update the distribution configuration and specify the new origin access identity.
For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
CustomOriginConfig (dict) --
Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.
HTTPPort (integer) --
The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
HTTPSPort (integer) --
The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
OriginProtocolPolicy (string) --
Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:
http-only – CloudFront always uses HTTP to connect to the origin.match-viewer – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.https-only – CloudFront always uses HTTPS to connect to the origin.OriginSslProtocols (dict) --
Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include SSLv3 , TLSv1 , TLSv1.1 , and TLSv1.2 .
For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide .
Quantity (integer) --
The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.
Items (list) --
A list that contains allowed SSL/TLS protocols for this distribution.
OriginReadTimeout (integer) --
Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout . The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 30 seconds.
For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide .
OriginKeepaliveTimeout (integer) --
Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 5 seconds.
For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide .
ConnectionAttempts (integer) --
The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don’t specify otherwise) is 3.
For a custom origin (including an Amazon S3 bucket that’s configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout .
For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide .
ConnectionTimeout (integer) --
The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don’t specify otherwise) is 10 seconds.
For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide .
OriginShield (dict) --
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 .
Enabled (boolean) --
A flag that specifies whether Origin Shield is enabled.
When it’s enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it’s disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.
OriginShieldRegion (string) --
The Amazon Web Services Region for Origin Shield.
Specify the Amazon Web Services Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as us-east-2 .
When you enable CloudFront Origin Shield, you must specify the Amazon Web Services Region for Origin Shield. For the list of Amazon Web Services Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the Amazon Web Services Region for Origin Shield in the Amazon CloudFront Developer Guide .
OriginAccessControlId (string) --
The unique identifier of an origin access control for this origin.
For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide .
OriginGroups (dict) --
A complex type that contains information about origin groups for this distribution.
Quantity (integer) --
The number of origin groups.
Items (list) --
The items (origin groups) in a distribution.
(dict) --
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.
Id (string) --
The origin group's ID.
FailoverCriteria (dict) --
A complex type that contains information about the failover criteria for an origin group.
StatusCodes (dict) --
The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.
Quantity (integer) --
The number of status codes.
Items (list) --
The items (status codes) for an origin group.
Members (dict) --
A complex type that contains information about the origins in an origin group.
Quantity (integer) --
The number of origins in an origin group.
Items (list) --
Items (origins) in an origin group.
(dict) --
An origin in an origin group.
OriginId (string) --
The ID for an origin in an origin group.
DefaultCacheBehavior (dict) --
A complex type that describes the default cache behavior if you don't 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.
TargetOriginId (string) --
The value of ID for the origin that you want CloudFront to route requests to when they use the default cache behavior.
TrustedSigners (dict) --
Warning
We recommend using TrustedKeyGroups instead of TrustedSigners .
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer’s Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
Enabled (boolean) --
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
Quantity (integer) --
The number of Amazon Web Services accounts in the list.
Items (list) --
A list of Amazon Web Services account identifiers.
TrustedKeyGroups (dict) --
A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
Enabled (boolean) --
This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
Quantity (integer) --
The number of key groups in the list.
Items (list) --
A list of key groups identifiers.
ViewerProtocolPolicy (string) --
The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern . You can specify the following options:
allow-all : Viewers can use HTTP or HTTPS.redirect-to-https : If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only : If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide .
AllowedMethods (dict) --
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:
GET and HEAD requests.GET , HEAD , and OPTIONS requests.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.
Quantity (integer) --
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).
Items (list) --
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
CachedMethods (dict) --
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
GET and HEAD requests.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.
Quantity (integer) --
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).
Items (list) --
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
SmoothStreaming (boolean) --
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true ; if not, specify false . If you specify true for SmoothStreaming , you can still distribute other content using this cache behavior if the content matches the value of PathPattern .
Compress (boolean) --
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true ; if not, specify false . For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .
LambdaFunctionAssociations (dict) --
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
Quantity (integer) --
The number of Lambda@Edge function associations for this cache behavior.
Items (list) --
Optional : A complex type that contains
LambdaFunctionAssociationitems for this cache behavior. IfQuantityis0, you can omitItems.
(dict) --
A complex type that contains a Lambda@Edge function association.
LambdaFunctionARN (string) --
The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
EventType (string) --
Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request : The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request : The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response : The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response : The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.IncludeBody (boolean) --
A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
FunctionAssociations (dict) --
A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.
Quantity (integer) --
The number of CloudFront functions in the list.
Items (list) --
The 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.
(dict) --
A CloudFront function that is associated with a cache behavior in a CloudFront distribution.
FunctionARN (string) --
The Amazon Resource Name (ARN) of the function.
EventType (string) --
The event type of the function, either viewer-request or viewer-response . You cannot use origin-facing event types (origin-request and origin-response ) with a CloudFront function.
FieldLevelEncryptionId (string) --
The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior.
RealtimeLogConfigArn (string) --
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide .
CachePolicyId (string) --
The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
OriginRequestPolicyId (string) --
The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
ResponseHeadersPolicyId (string) --
The identifier for a response headers policy.
ForwardedValues (dict) --
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide .
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed 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 or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
QueryString (boolean) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 .
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys , if any:
If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
If you specify false for QueryString , CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide .
Cookies (dict) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 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 How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide .
Forward (string) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide .
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.
Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.
WhitelistedNames (dict) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 .
Required if you specify whitelist for the value of Forward . A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.
If you specify all or none for the value of Forward , omit WhitelistedNames . If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.
For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference .
Quantity (integer) --
The number of cookie names in the Items list.
Items (list) --
A list of cookie names.
Headers (dict) --
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 headers 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 headers 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 the Headers , if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.
For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide .
Quantity (integer) --
The number of header names in the Items list.
Items (list) --
A list of HTTP header names.
QueryStringCacheKeys (dict) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
Quantity (integer) --
The number of whitelisted query string parameters for a cache behavior.
Items (list) --
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items .
MinTTL (integer) --
This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers , if you specify 1 for Quantity and * for Name ).
DefaultTTL (integer) --
This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The default amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
MaxTTL (integer) --
This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The maximum amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
CacheBehaviors (dict) --
A complex type that contains zero or more CacheBehavior elements.
Quantity (integer) --
The number of cache behaviors for this distribution.
Items (list) --
Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0 , you can omit Items .
(dict) --
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 .
PathPattern (string) --
The pattern (for example, images/*.jpg ) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.
Note
You can optionally include a slash (/ ) at the beginning of the path pattern. For example, /images/*.jpg . CloudFront behavior is the same with or without the leading / .
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.
For more information, see Path Pattern in the Amazon CloudFront Developer Guide .
TargetOriginId (string) --
The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.
TrustedSigners (dict) --
Warning
We recommend using TrustedKeyGroups instead of TrustedSigners .
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer’s Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
Enabled (boolean) --
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
Quantity (integer) --
The number of Amazon Web Services accounts in the list.
Items (list) --
A list of Amazon Web Services account identifiers.
TrustedKeyGroups (dict) --
A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
Enabled (boolean) --
This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
Quantity (integer) --
The number of key groups in the list.
Items (list) --
A list of key groups identifiers.
ViewerProtocolPolicy (string) --
The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern . You can specify the following options:
allow-all : Viewers can use HTTP or HTTPS.redirect-to-https : If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only : If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide .
AllowedMethods (dict) --
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:
GET and HEAD requests.GET , HEAD , and OPTIONS requests.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.
Quantity (integer) --
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).
Items (list) --
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
CachedMethods (dict) --
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
GET and HEAD requests.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.
Quantity (integer) --
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).
Items (list) --
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
SmoothStreaming (boolean) --
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true ; if not, specify false . If you specify true for SmoothStreaming , you can still distribute other content using this cache behavior if the content matches the value of PathPattern .
Compress (boolean) --
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .
LambdaFunctionAssociations (dict) --
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
Quantity (integer) --
The number of Lambda@Edge function associations for this cache behavior.
Items (list) --
Optional : A complex type that contains
LambdaFunctionAssociationitems for this cache behavior. IfQuantityis0, you can omitItems.
(dict) --
A complex type that contains a Lambda@Edge function association.
LambdaFunctionARN (string) --
The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
EventType (string) --
Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request : The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request : The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response : The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response : The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.IncludeBody (boolean) --
A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
FunctionAssociations (dict) --
A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.
Quantity (integer) --
The number of CloudFront functions in the list.
Items (list) --
The 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.
(dict) --
A CloudFront function that is associated with a cache behavior in a CloudFront distribution.
FunctionARN (string) --
The Amazon Resource Name (ARN) of the function.
EventType (string) --
The event type of the function, either viewer-request or viewer-response . You cannot use origin-facing event types (origin-request and origin-response ) with a CloudFront function.
FieldLevelEncryptionId (string) --
The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.
RealtimeLogConfigArn (string) --
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide .
CachePolicyId (string) --
The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
A CacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
OriginRequestPolicyId (string) --
The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
ResponseHeadersPolicyId (string) --
The identifier for a response headers policy.
ForwardedValues (dict) --
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide .
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed 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 or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
A CacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
QueryString (boolean) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 .
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys , if any:
If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
If you specify false for QueryString , CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide .
Cookies (dict) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 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 How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide .
Forward (string) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide .
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.
Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.
WhitelistedNames (dict) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 .
Required if you specify whitelist for the value of Forward . A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.
If you specify all or none for the value of Forward , omit WhitelistedNames . If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.
For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference .
Quantity (integer) --
The number of cookie names in the Items list.
Items (list) --
A list of cookie names.
Headers (dict) --
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 headers 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 headers 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 the Headers , if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.
For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide .
Quantity (integer) --
The number of header names in the Items list.
Items (list) --
A list of HTTP header names.
QueryStringCacheKeys (dict) --
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
Quantity (integer) --
The number of whitelisted query string parameters for a cache behavior.
Items (list) --
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items .
MinTTL (integer) --
This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers , if you specify 1 for Quantity and * for Name ).
DefaultTTL (integer) --
This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The default amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
MaxTTL (integer) --
This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The maximum amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
CustomErrorResponses (dict) --
A complex type that controls the following:
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
Quantity (integer) --
The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0 , you can omit Items .
Items (list) --
A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration.
(dict) --
A complex type that controls:
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
ErrorCode (integer) --
The HTTP status code for which you want to specify a custom error page and/or a caching duration.
ResponsePagePath (string) --
The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode , for example, /4xx-errors/403-forbidden.html . If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:
PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors . Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, /4xx-errors/* .TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages.If you specify a value for ResponsePagePath , you must also specify a value for ResponseCode .
We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.
ResponseCode (string) --
The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:
200 , the response typically won't be intercepted.400 or 500 as the ResponseCode for all 4xx or 5xx errors.200 status code (OK) and static website so your customers don't know that your website is down.If you specify a value for ResponseCode , you must also specify a value for ResponsePagePath .
ErrorCachingMinTTL (integer) --
The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode . When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.
For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
Comment (string) --
An optional comment to describe the distribution. The comment cannot be longer than 128 characters.
Logging (dict) --
A complex type that controls whether access logs are written for the distribution.
For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide .
Enabled (boolean) --
Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't 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.
IncludeCookies (boolean) --
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 don't 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 .
Bucket (string) --
The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com .
Prefix (string) --
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 don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.
PriceClass (string) --
The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All , CloudFront responds to requests for your objects from all CloudFront edge locations.
If you specify a price class other than PriceClass_All , CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.
For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide . For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing .
Enabled (boolean) --
From this field, you can enable or disable the selected distribution.
ViewerCertificate (dict) --
A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.
CloudFrontDefaultCertificate (boolean) --
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net , set this field to true .
If the distribution uses Aliases (alternate domain names or CNAMEs), set this field to false and specify values for the following fields:
ACMCertificateArn or IAMCertificateId (specify a value for one, not both)MinimumProtocolVersionSSLSupportMethodIAMCertificateId (string) --
If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Identity and Access Management (IAM) , provide the ID of the IAM certificate.
If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVersion and SSLSupportMethod .
ACMCertificateArn (string) --
If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Certificate Manager (ACM) , provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (us-east-1 ).
If you specify an ACM certificate ARN, you must also specify values for MinimumProtocolVersion and SSLSupportMethod .
SSLSupportMethod (string) --
If the distribution uses Aliases (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.
sni-only – The distribution accepts HTTPS connections from only viewers that support server name indication (SNI) . This is recommended. Most browsers and clients support SNI.vip – The distribution accepts HTTPS connections from all viewers including those that don’t support SNI. This is not recommended, and results in additional monthly charges from CloudFront.static-ip - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the Amazon Web Services Support Center .If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net , don’t set a value for this field.
MinimumProtocolVersion (string) --
If the distribution uses Aliases (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:
For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
On the CloudFront console, this setting is called Security Policy .
When you’re using SNI only (you set SSLSupportMethod to sni-only ), you must specify TLSv1 or higher.
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net (you set CloudFrontDefaultCertificate to true ), CloudFront automatically sets the security policy to TLSv1 regardless of the value that you set here.
Certificate (string) --
This field is deprecated. Use one of the following fields instead:
ACMCertificateArnIAMCertificateIdCloudFrontDefaultCertificateCertificateSource (string) --
This field is deprecated. Use one of the following fields instead:
ACMCertificateArnIAMCertificateIdCloudFrontDefaultCertificateRestrictions (dict) --
A complex type that identifies ways in which you want to restrict distribution of your content.
GeoRestriction (dict) --
A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.
RestrictionType (string) --
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 don't want CloudFront to distribute your content.whitelist : The Location elements specify the countries in which you want CloudFront to distribute your content.Quantity (integer) --
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 .
Items (list) --
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 on the CloudFront console, which includes both country names and codes.
WebACLId (string) --
A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a . To specify a web ACL created using WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a .
WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the WAF Developer Guide .
HttpVersion (string) --
(Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2 . Viewers that don't support HTTP/2 automatically use an earlier HTTP version.
For viewers and CloudFront to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI).
For viewers and CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CloudFront supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see Connection Migration at RFC 9000. For more information about supported TLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront .
IsIPV6Enabled (boolean) --
If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true . If you specify false , CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.
In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide .
If you're using an Route 53 Amazon Web Services Integration alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:
For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Route 53 Amazon Web Services Integration Developer Guide .
If you created a CNAME resource record set, either with Route 53 Amazon Web Services Integration or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.
AliasICPRecordals (list) --
Amazon Web Services 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.
For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China .
(dict) --
Amazon Web Services 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 Amazon Web Services services in China .
CNAME (string) --
A domain name associated with a distribution.
ICPRecordalStatus (string) --
The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in regions outside of China.
The status values returned are the following:
ETag (string) --
The current version of the configuration. For example: E2QWRUHAPOMQZL .
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.CNAMEAlreadyExistsCloudFront.Client.exceptions.IllegalUpdateCloudFront.Client.exceptions.InvalidIfMatchVersionCloudFront.Client.exceptions.MissingBodyCloudFront.Client.exceptions.NoSuchDistributionCloudFront.Client.exceptions.PreconditionFailedCloudFront.Client.exceptions.TooManyDistributionCNAMEsCloudFront.Client.exceptions.InvalidDefaultRootObjectCloudFront.Client.exceptions.InvalidRelativePathCloudFront.Client.exceptions.InvalidErrorCodeCloudFront.Client.exceptions.InvalidResponseCodeCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.InvalidOriginAccessIdentityCloudFront.Client.exceptions.InvalidOriginAccessControlCloudFront.Client.exceptions.TooManyTrustedSignersCloudFront.Client.exceptions.TrustedSignerDoesNotExistCloudFront.Client.exceptions.InvalidViewerCertificateCloudFront.Client.exceptions.InvalidMinimumProtocolVersionCloudFront.Client.exceptions.InvalidRequiredProtocolCloudFront.Client.exceptions.NoSuchOriginCloudFront.Client.exceptions.TooManyOriginsCloudFront.Client.exceptions.TooManyOriginGroupsPerDistributionCloudFront.Client.exceptions.TooManyCacheBehaviorsCloudFront.Client.exceptions.TooManyCookieNamesInWhiteListCloudFront.Client.exceptions.InvalidForwardCookiesCloudFront.Client.exceptions.TooManyHeadersInForwardedValuesCloudFront.Client.exceptions.InvalidHeadersForS3OriginCloudFront.Client.exceptions.InconsistentQuantitiesCloudFront.Client.exceptions.TooManyCertificatesCloudFront.Client.exceptions.InvalidLocationCodeCloudFront.Client.exceptions.InvalidGeoRestrictionParameterCloudFront.Client.exceptions.InvalidTTLOrderCloudFront.Client.exceptions.InvalidWebACLIdCloudFront.Client.exceptions.TooManyOriginCustomHeadersCloudFront.Client.exceptions.TooManyQueryStringParametersCloudFront.Client.exceptions.InvalidQueryStringParametersCloudFront.Client.exceptions.TooManyDistributionsWithLambdaAssociationsCloudFront.Client.exceptions.TooManyDistributionsWithSingleFunctionARNCloudFront.Client.exceptions.TooManyLambdaFunctionAssociationsCloudFront.Client.exceptions.InvalidLambdaFunctionAssociationCloudFront.Client.exceptions.TooManyDistributionsWithFunctionAssociationsCloudFront.Client.exceptions.TooManyFunctionAssociationsCloudFront.Client.exceptions.InvalidFunctionAssociationCloudFront.Client.exceptions.InvalidOriginReadTimeoutCloudFront.Client.exceptions.InvalidOriginKeepaliveTimeoutCloudFront.Client.exceptions.NoSuchFieldLevelEncryptionConfigCloudFront.Client.exceptions.IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorCloudFront.Client.exceptions.TooManyDistributionsAssociatedToFieldLevelEncryptionConfigCloudFront.Client.exceptions.NoSuchCachePolicyCloudFront.Client.exceptions.TooManyDistributionsAssociatedToCachePolicyCloudFront.Client.exceptions.NoSuchResponseHeadersPolicyCloudFront.Client.exceptions.TooManyDistributionsAssociatedToResponseHeadersPolicyCloudFront.Client.exceptions.NoSuchOriginRequestPolicyCloudFront.Client.exceptions.TooManyDistributionsAssociatedToOriginRequestPolicyCloudFront.Client.exceptions.TooManyDistributionsAssociatedToKeyGroupCloudFront.Client.exceptions.TooManyKeyGroupsAssociatedToDistributionCloudFront.Client.exceptions.TrustedKeyGroupDoesNotExistCloudFront.Client.exceptions.NoSuchRealtimeLogConfigCloudFront.Client.exceptions.RealtimeLogConfigOwnerMismatchCloudFront.Client.exceptions.IllegalOriginAccessConfigurationCloudFront.Client.exceptions.InvalidDomainNameForOriginAccessControlupdate_field_level_encryption_config(**kwargs)¶Update a field-level encryption configuration.
See also: AWS API Documentation
Request Syntax
response = client.update_field_level_encryption_config(
FieldLevelEncryptionConfig={
'CallerReference': 'string',
'Comment': 'string',
'QueryArgProfileConfig': {
'ForwardWhenQueryArgProfileIsUnknown': True|False,
'QueryArgProfiles': {
'Quantity': 123,
'Items': [
{
'QueryArg': 'string',
'ProfileId': 'string'
},
]
}
},
'ContentTypeProfileConfig': {
'ForwardWhenContentTypeIsUnknown': True|False,
'ContentTypeProfiles': {
'Quantity': 123,
'Items': [
{
'Format': 'URLEncoded',
'ProfileId': 'string',
'ContentType': 'string'
},
]
}
}
},
Id='string',
IfMatch='string'
)
[REQUIRED]
Request to update a field-level encryption configuration.
A unique number that ensures the request can't be replayed.
An optional comment about the configuration. The comment cannot be longer than 128 characters.
A complex data type that specifies when to forward content if a profile isn't found and the profile that can be provided as a query argument in a request.
Flag to set if you want a request to be forwarded to the origin even if the profile specified by the field-level encryption query argument, fle-profile, is unknown.
Profiles specified for query argument-profile mapping for field-level encryption.
Number of profiles for query argument-profile mapping for field-level encryption.
Number of items for query argument-profile mapping for field-level encryption.
Query argument-profile mapping for field-level encryption.
Query argument for field-level encryption query argument-profile mapping.
ID of profile to use for field-level encryption query argument-profile mapping
A complex data type that specifies when to forward content if a content type isn't recognized and profiles to use as by default in a request if a query argument doesn't specify a profile to use.
The setting in a field-level encryption content type-profile mapping that specifies what to do when an unknown content type is provided for the profile. If true, content is forwarded without being encrypted when the content type is unknown. If false (the default), an error is returned when the content type is unknown.
The configuration for a field-level encryption content type-profile.
The number of field-level encryption content type-profile mappings.
Items in a field-level encryption content type-profile mapping.
A field-level encryption content type profile.
The format for a field-level encryption content type-profile mapping.
The profile ID for a field-level encryption content type-profile mapping.
The content type for a field-level encryption content type-profile mapping.
[REQUIRED]
The ID of the configuration you want to update.
ETag header that you received when retrieving the configuration identity to update. For example: E2QWRUHAPOMQZL .dict
Response Syntax
{
'FieldLevelEncryption': {
'Id': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'FieldLevelEncryptionConfig': {
'CallerReference': 'string',
'Comment': 'string',
'QueryArgProfileConfig': {
'ForwardWhenQueryArgProfileIsUnknown': True|False,
'QueryArgProfiles': {
'Quantity': 123,
'Items': [
{
'QueryArg': 'string',
'ProfileId': 'string'
},
]
}
},
'ContentTypeProfileConfig': {
'ForwardWhenContentTypeIsUnknown': True|False,
'ContentTypeProfiles': {
'Quantity': 123,
'Items': [
{
'Format': 'URLEncoded',
'ProfileId': 'string',
'ContentType': 'string'
},
]
}
}
}
},
'ETag': 'string'
}
Response Structure
(dict) --
FieldLevelEncryption (dict) --
Return the results of updating the configuration.
Id (string) --
The configuration ID for a field-level encryption configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.
LastModifiedTime (datetime) --
The last time the field-level encryption configuration was changed.
FieldLevelEncryptionConfig (dict) --
A complex data type that includes the profile configurations specified for field-level encryption.
CallerReference (string) --
A unique number that ensures the request can't be replayed.
Comment (string) --
An optional comment about the configuration. The comment cannot be longer than 128 characters.
QueryArgProfileConfig (dict) --
A complex data type that specifies when to forward content if a profile isn't found and the profile that can be provided as a query argument in a request.
ForwardWhenQueryArgProfileIsUnknown (boolean) --
Flag to set if you want a request to be forwarded to the origin even if the profile specified by the field-level encryption query argument, fle-profile, is unknown.
QueryArgProfiles (dict) --
Profiles specified for query argument-profile mapping for field-level encryption.
Quantity (integer) --
Number of profiles for query argument-profile mapping for field-level encryption.
Items (list) --
Number of items for query argument-profile mapping for field-level encryption.
(dict) --
Query argument-profile mapping for field-level encryption.
QueryArg (string) --
Query argument for field-level encryption query argument-profile mapping.
ProfileId (string) --
ID of profile to use for field-level encryption query argument-profile mapping
ContentTypeProfileConfig (dict) --
A complex data type that specifies when to forward content if a content type isn't recognized and profiles to use as by default in a request if a query argument doesn't specify a profile to use.
ForwardWhenContentTypeIsUnknown (boolean) --
The setting in a field-level encryption content type-profile mapping that specifies what to do when an unknown content type is provided for the profile. If true, content is forwarded without being encrypted when the content type is unknown. If false (the default), an error is returned when the content type is unknown.
ContentTypeProfiles (dict) --
The configuration for a field-level encryption content type-profile.
Quantity (integer) --
The number of field-level encryption content type-profile mappings.
Items (list) --
Items in a field-level encryption content type-profile mapping.
(dict) --
A field-level encryption content type profile.
Format (string) --
The format for a field-level encryption content type-profile mapping.
ProfileId (string) --
The profile ID for a field-level encryption content type-profile mapping.
ContentType (string) --
The content type for a field-level encryption content type-profile mapping.
ETag (string) --
The value of the ETag header that you received when updating the configuration. For example: E2QWRUHAPOMQZL .
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.IllegalUpdateCloudFront.Client.exceptions.InconsistentQuantitiesCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.InvalidIfMatchVersionCloudFront.Client.exceptions.NoSuchFieldLevelEncryptionProfileCloudFront.Client.exceptions.NoSuchFieldLevelEncryptionConfigCloudFront.Client.exceptions.PreconditionFailedCloudFront.Client.exceptions.TooManyFieldLevelEncryptionQueryArgProfilesCloudFront.Client.exceptions.TooManyFieldLevelEncryptionContentTypeProfilesCloudFront.Client.exceptions.QueryArgProfileEmptyupdate_field_level_encryption_profile(**kwargs)¶Update a field-level encryption profile.
See also: AWS API Documentation
Request Syntax
response = client.update_field_level_encryption_profile(
FieldLevelEncryptionProfileConfig={
'Name': 'string',
'CallerReference': 'string',
'Comment': 'string',
'EncryptionEntities': {
'Quantity': 123,
'Items': [
{
'PublicKeyId': 'string',
'ProviderId': 'string',
'FieldPatterns': {
'Quantity': 123,
'Items': [
'string',
]
}
},
]
}
},
Id='string',
IfMatch='string'
)
[REQUIRED]
Request to update a field-level encryption profile.
Profile name for the field-level encryption profile.
A unique number that ensures that the request can't be replayed.
An optional comment for the field-level encryption profile. The comment cannot be longer than 128 characters.
A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.
Number of field pattern items in a field-level encryption content type-profile mapping.
An array of field patterns in a field-level encryption content type-profile mapping.
Complex data type for field-level encryption profiles that includes the encryption key and field pattern specifications.
The public key associated with a set of field-level encryption patterns, to be used when encrypting the fields that match the patterns.
The provider associated with the public key being used for encryption. This value must also be provided with the private key for applications to be able to decrypt data.
Field patterns in a field-level encryption content type profile specify the fields that you want to be encrypted. You can provide the full field name, or any beginning characters followed by a wildcard (*). You can't overlap field patterns. For example, you can't have both ABC* and AB*. Note that field patterns are case-sensitive.
The number of field-level encryption field patterns.
An array of the field-level encryption field patterns.
[REQUIRED]
The ID of the field-level encryption profile request.
ETag header that you received when retrieving the profile identity to update. For example: E2QWRUHAPOMQZL .dict
Response Syntax
{
'FieldLevelEncryptionProfile': {
'Id': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'FieldLevelEncryptionProfileConfig': {
'Name': 'string',
'CallerReference': 'string',
'Comment': 'string',
'EncryptionEntities': {
'Quantity': 123,
'Items': [
{
'PublicKeyId': 'string',
'ProviderId': 'string',
'FieldPatterns': {
'Quantity': 123,
'Items': [
'string',
]
}
},
]
}
}
},
'ETag': 'string'
}
Response Structure
(dict) --
FieldLevelEncryptionProfile (dict) --
Return the results of updating the profile.
Id (string) --
The ID for a field-level encryption profile configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.
LastModifiedTime (datetime) --
The last time the field-level encryption profile was updated.
FieldLevelEncryptionProfileConfig (dict) --
A complex data type that includes the profile name and the encryption entities for the field-level encryption profile.
Name (string) --
Profile name for the field-level encryption profile.
CallerReference (string) --
A unique number that ensures that the request can't be replayed.
Comment (string) --
An optional comment for the field-level encryption profile. The comment cannot be longer than 128 characters.
EncryptionEntities (dict) --
A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.
Quantity (integer) --
Number of field pattern items in a field-level encryption content type-profile mapping.
Items (list) --
An array of field patterns in a field-level encryption content type-profile mapping.
(dict) --
Complex data type for field-level encryption profiles that includes the encryption key and field pattern specifications.
PublicKeyId (string) --
The public key associated with a set of field-level encryption patterns, to be used when encrypting the fields that match the patterns.
ProviderId (string) --
The provider associated with the public key being used for encryption. This value must also be provided with the private key for applications to be able to decrypt data.
FieldPatterns (dict) --
Field patterns in a field-level encryption content type profile specify the fields that you want to be encrypted. You can provide the full field name, or any beginning characters followed by a wildcard (*). You can't overlap field patterns. For example, you can't have both ABC* and AB*. Note that field patterns are case-sensitive.
Quantity (integer) --
The number of field-level encryption field patterns.
Items (list) --
An array of the field-level encryption field patterns.
ETag (string) --
The result of the field-level encryption profile request.
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.FieldLevelEncryptionProfileAlreadyExistsCloudFront.Client.exceptions.IllegalUpdateCloudFront.Client.exceptions.InconsistentQuantitiesCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.InvalidIfMatchVersionCloudFront.Client.exceptions.NoSuchPublicKeyCloudFront.Client.exceptions.NoSuchFieldLevelEncryptionProfileCloudFront.Client.exceptions.PreconditionFailedCloudFront.Client.exceptions.FieldLevelEncryptionProfileSizeExceededCloudFront.Client.exceptions.TooManyFieldLevelEncryptionEncryptionEntitiesCloudFront.Client.exceptions.TooManyFieldLevelEncryptionFieldPatternsupdate_function(**kwargs)¶Updates a CloudFront function.
You can update a function’s code or the comment that describes the function. You cannot update a function’s name.
To update a function, you provide the function’s name and version (ETag value) along with the updated function code. To get the name and version, you can use ListFunctions and DescribeFunction .
See also: AWS API Documentation
Request Syntax
response = client.update_function(
Name='string',
IfMatch='string',
FunctionConfig={
'Comment': 'string',
'Runtime': 'cloudfront-js-1.0'
},
FunctionCode=b'bytes'
)
[REQUIRED]
The name of the function that you are updating.
[REQUIRED]
The current version (ETag value) of the function that you are updating, which you can get using DescribeFunction .
[REQUIRED]
Configuration information about the function.
A comment to describe the function.
The function’s runtime environment. The only valid value is cloudfront-js-1.0 .
[REQUIRED]
The function code. For more information about writing a CloudFront function, see Writing function code for CloudFront Functions in the Amazon CloudFront Developer Guide .
dict
Response Syntax
{
'FunctionSummary': {
'Name': 'string',
'Status': 'string',
'FunctionConfig': {
'Comment': 'string',
'Runtime': 'cloudfront-js-1.0'
},
'FunctionMetadata': {
'FunctionARN': 'string',
'Stage': 'DEVELOPMENT'|'LIVE',
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1)
}
},
'ETag': 'string'
}
Response Structure
(dict) --
FunctionSummary (dict) --
Contains configuration information and metadata about a CloudFront function.
Name (string) --
The name of the CloudFront function.
Status (string) --
The status of the CloudFront function.
FunctionConfig (dict) --
Contains configuration information about a CloudFront function.
Comment (string) --
A comment to describe the function.
Runtime (string) --
The function’s runtime environment. The only valid value is cloudfront-js-1.0 .
FunctionMetadata (dict) --
Contains metadata about a CloudFront function.
FunctionARN (string) --
The Amazon Resource Name (ARN) of the function. The ARN uniquely identifies the function.
Stage (string) --
The stage that the function is in, either DEVELOPMENT or LIVE .
When a function is in the DEVELOPMENT stage, you can test the function with TestFunction , and update it with UpdateFunction .
When a function is in the LIVE stage, you can attach the function to a distribution’s cache behavior, using the function’s ARN.
CreatedTime (datetime) --
The date and time when the function was created.
LastModifiedTime (datetime) --
The date and time when the function was most recently updated.
ETag (string) --
The version identifier for the current version of the CloudFront function.
Exceptions
CloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.InvalidIfMatchVersionCloudFront.Client.exceptions.NoSuchFunctionExistsCloudFront.Client.exceptions.PreconditionFailedCloudFront.Client.exceptions.FunctionSizeLimitExceededCloudFront.Client.exceptions.UnsupportedOperationupdate_key_group(**kwargs)¶Updates a key group.
When you update a key group, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a key group:
GetKeyGroup or GetKeyGroupConfig .UpdateKeyGroup with the entire key group object, including the fields that you modified and those that you didn’t.See also: AWS API Documentation
Request Syntax
response = client.update_key_group(
KeyGroupConfig={
'Name': 'string',
'Items': [
'string',
],
'Comment': 'string'
},
Id='string',
IfMatch='string'
)
[REQUIRED]
The key group configuration.
A name to identify the key group.
A list of the identifiers of the public keys in the key group.
A comment to describe the key group. The comment cannot be longer than 128 characters.
[REQUIRED]
The identifier of the key group that you are updating.
ETag value.dict
Response Syntax
{
'KeyGroup': {
'Id': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'KeyGroupConfig': {
'Name': 'string',
'Items': [
'string',
],
'Comment': 'string'
}
},
'ETag': 'string'
}
Response Structure
(dict) --
KeyGroup (dict) --
The key group that was just updated.
Id (string) --
The identifier for the key group.
LastModifiedTime (datetime) --
The date and time when the key group was last modified.
KeyGroupConfig (dict) --
The key group configuration.
Name (string) --
A name to identify the key group.
Items (list) --
A list of the identifiers of the public keys in the key group.
Comment (string) --
A comment to describe the key group. The comment cannot be longer than 128 characters.
ETag (string) --
The identifier for this version of the key group.
Exceptions
CloudFront.Client.exceptions.InvalidIfMatchVersionCloudFront.Client.exceptions.NoSuchResourceCloudFront.Client.exceptions.PreconditionFailedCloudFront.Client.exceptions.KeyGroupAlreadyExistsCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.TooManyPublicKeysInKeyGroupupdate_origin_access_control(**kwargs)¶Updates a CloudFront origin access control.
See also: AWS API Documentation
Request Syntax
response = client.update_origin_access_control(
OriginAccessControlConfig={
'Name': 'string',
'Description': 'string',
'SigningProtocol': 'sigv4',
'SigningBehavior': 'never'|'always'|'no-override',
'OriginAccessControlOriginType': 's3'
},
Id='string',
IfMatch='string'
)
[REQUIRED]
An origin access control.
A name to identify the origin access control.
A description of the origin access control.
The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is sigv4 .
Specifies which requests CloudFront signs (adds authentication information to). Specify always for the most common use case. For more information, see origin access control advanced settings in the Amazon CloudFront Developer Guide .
This field can have one of the following values:
always – CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if one exists.never – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control.no-override – If the viewer request doesn't contain the Authorization header, then CloudFront signs the origin request. If the viewer request contains the Authorization header, then CloudFront doesn't sign the origin request and instead passes along the Authorization header from the viewer request. WARNING: To pass along the ``Authorization`` header from the viewer request, you *must* add the ``Authorization`` header to a `cache policy <https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html>`__ for all cache behaviors that use origins associated with this origin access control.The type of origin that this origin access control is for. The only valid value is s3 .
[REQUIRED]
The unique identifier of the origin access control that you are updating.
ETag value) of the origin access control that you are updating.dict
Response Syntax
{
'OriginAccessControl': {
'Id': 'string',
'OriginAccessControlConfig': {
'Name': 'string',
'Description': 'string',
'SigningProtocol': 'sigv4',
'SigningBehavior': 'never'|'always'|'no-override',
'OriginAccessControlOriginType': 's3'
}
},
'ETag': 'string'
}
Response Structure
(dict) --
OriginAccessControl (dict) --
The origin access control after it has been updated.
Id (string) --
The unique identifier of the origin access control.
OriginAccessControlConfig (dict) --
The origin access control.
Name (string) --
A name to identify the origin access control.
Description (string) --
A description of the origin access control.
SigningProtocol (string) --
The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is sigv4 .
SigningBehavior (string) --
Specifies which requests CloudFront signs (adds authentication information to). Specify always for the most common use case. For more information, see origin access control advanced settings in the Amazon CloudFront Developer Guide .
This field can have one of the following values:
always – CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if one exists.never – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control.no-override – If the viewer request doesn't contain the Authorization header, then CloudFront signs the origin request. If the viewer request contains the Authorization header, then CloudFront doesn't sign the origin request and instead passes along the Authorization header from the viewer request. WARNING: To pass along the ``Authorization`` header from the viewer request, you *must* add the ``Authorization`` header to a `cache policy <https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html>`__ for all cache behaviors that use origins associated with this origin access control.OriginAccessControlOriginType (string) --
The type of origin that this origin access control is for. The only valid value is s3 .
ETag (string) --
The new version of the origin access control after it has been updated.
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.IllegalUpdateCloudFront.Client.exceptions.InvalidIfMatchVersionCloudFront.Client.exceptions.OriginAccessControlAlreadyExistsCloudFront.Client.exceptions.NoSuchOriginAccessControlCloudFront.Client.exceptions.PreconditionFailedCloudFront.Client.exceptions.InvalidArgumentupdate_origin_request_policy(**kwargs)¶Updates an origin request policy configuration.
When you update an origin request policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update an origin request policy configuration:
GetOriginRequestPolicyConfig to get the current configuration.UpdateOriginRequestPolicy by providing the entire origin request policy configuration, including the fields that you modified and those that you didn’t.See also: AWS API Documentation
Request Syntax
response = client.update_origin_request_policy(
OriginRequestPolicyConfig={
'Comment': 'string',
'Name': 'string',
'HeadersConfig': {
'HeaderBehavior': 'none'|'whitelist'|'allViewer'|'allViewerAndWhitelistCloudFront',
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'CookiesConfig': {
'CookieBehavior': 'none'|'whitelist'|'all',
'Cookies': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'QueryStringsConfig': {
'QueryStringBehavior': 'none'|'whitelist'|'all',
'QueryStrings': {
'Quantity': 123,
'Items': [
'string',
]
}
}
},
Id='string',
IfMatch='string'
)
[REQUIRED]
An origin request policy configuration.
A comment to describe the origin request policy. The comment cannot be longer than 128 characters.
A unique name to identify the origin request policy.
The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.
Determines whether any HTTP headers are included in requests that CloudFront sends to the origin. Valid values are:
none – HTTP headers are not included in requests that CloudFront sends to the origin. Even when this field is set to none , any headers that are listed in a CachePolicy are included in origin requests.whitelist – The HTTP headers that are listed in the Headers type are included in requests that CloudFront sends to the origin.allViewer – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin.allViewerAndWhitelistCloudFront – All HTTP headers in viewer requests and the additional CloudFront headers that are listed in the Headers type are included in requests that CloudFront sends to the origin. The additional headers are added by CloudFront.Contains a list of HTTP header names.
The number of header names in the Items list.
A list of HTTP header names.
The cookies from viewer requests to include in origin requests.
Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:
none – Cookies in viewer requests are not included in requests that CloudFront sends to the origin. Even when this field is set to none , any cookies that are listed in a CachePolicy are included in origin requests.whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in requests that CloudFront sends to the origin.all – All cookies in viewer requests are included in requests that CloudFront sends to the origin.Contains a list of cookie names.
The number of cookie names in the Items list.
A list of cookie names.
The URL query strings from viewer requests to include in origin requests.
Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:
none – Query strings in viewer requests are not included in requests that CloudFront sends to the origin. Even when this field is set to none , any query strings that are listed in a CachePolicy are included in origin requests.whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in requests that CloudFront sends to the origin.all – All query strings in viewer requests are included in requests that CloudFront sends to the origin.Contains a list of the query strings in viewer requests that are included in requests that CloudFront sends to the origin.
The number of query string names in the Items list.
A list of query string names.
[REQUIRED]
The unique identifier for the origin request policy that you are updating. The identifier is returned in a cache behavior’s OriginRequestPolicyId field in the response to GetDistributionConfig .
ETag field in the response to GetOriginRequestPolicyConfig .dict
Response Syntax
{
'OriginRequestPolicy': {
'Id': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'OriginRequestPolicyConfig': {
'Comment': 'string',
'Name': 'string',
'HeadersConfig': {
'HeaderBehavior': 'none'|'whitelist'|'allViewer'|'allViewerAndWhitelistCloudFront',
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'CookiesConfig': {
'CookieBehavior': 'none'|'whitelist'|'all',
'Cookies': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'QueryStringsConfig': {
'QueryStringBehavior': 'none'|'whitelist'|'all',
'QueryStrings': {
'Quantity': 123,
'Items': [
'string',
]
}
}
}
},
'ETag': 'string'
}
Response Structure
(dict) --
OriginRequestPolicy (dict) --
An origin request policy.
Id (string) --
The unique identifier for the origin request policy.
LastModifiedTime (datetime) --
The date and time when the origin request policy was last modified.
OriginRequestPolicyConfig (dict) --
The origin request policy configuration.
Comment (string) --
A comment to describe the origin request policy. The comment cannot be longer than 128 characters.
Name (string) --
A unique name to identify the origin request policy.
HeadersConfig (dict) --
The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.
HeaderBehavior (string) --
Determines whether any HTTP headers are included in requests that CloudFront sends to the origin. Valid values are:
none – HTTP headers are not included in requests that CloudFront sends to the origin. Even when this field is set to none , any headers that are listed in a CachePolicy are included in origin requests.whitelist – The HTTP headers that are listed in the Headers type are included in requests that CloudFront sends to the origin.allViewer – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin.allViewerAndWhitelistCloudFront – All HTTP headers in viewer requests and the additional CloudFront headers that are listed in the Headers type are included in requests that CloudFront sends to the origin. The additional headers are added by CloudFront.Headers (dict) --
Contains a list of HTTP header names.
Quantity (integer) --
The number of header names in the Items list.
Items (list) --
A list of HTTP header names.
CookiesConfig (dict) --
The cookies from viewer requests to include in origin requests.
CookieBehavior (string) --
Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:
none – Cookies in viewer requests are not included in requests that CloudFront sends to the origin. Even when this field is set to none , any cookies that are listed in a CachePolicy are included in origin requests.whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in requests that CloudFront sends to the origin.all – All cookies in viewer requests are included in requests that CloudFront sends to the origin.Cookies (dict) --
Contains a list of cookie names.
Quantity (integer) --
The number of cookie names in the Items list.
Items (list) --
A list of cookie names.
QueryStringsConfig (dict) --
The URL query strings from viewer requests to include in origin requests.
QueryStringBehavior (string) --
Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:
none – Query strings in viewer requests are not included in requests that CloudFront sends to the origin. Even when this field is set to none , any query strings that are listed in a CachePolicy are included in origin requests.whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in requests that CloudFront sends to the origin.all – All query strings in viewer requests are included in requests that CloudFront sends to the origin.QueryStrings (dict) --
Contains a list of the query strings in viewer requests that are included in requests that CloudFront sends to the origin.
Quantity (integer) --
The number of query string names in the Items list.
Items (list) --
A list of query string names.
ETag (string) --
The current version of the origin request policy.
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.IllegalUpdateCloudFront.Client.exceptions.InconsistentQuantitiesCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.InvalidIfMatchVersionCloudFront.Client.exceptions.NoSuchOriginRequestPolicyCloudFront.Client.exceptions.PreconditionFailedCloudFront.Client.exceptions.OriginRequestPolicyAlreadyExistsCloudFront.Client.exceptions.TooManyHeadersInOriginRequestPolicyCloudFront.Client.exceptions.TooManyCookiesInOriginRequestPolicyCloudFront.Client.exceptions.TooManyQueryStringsInOriginRequestPolicyupdate_public_key(**kwargs)¶Update public key information. Note that the only value you can change is the comment.
See also: AWS API Documentation
Request Syntax
response = client.update_public_key(
PublicKeyConfig={
'CallerReference': 'string',
'Name': 'string',
'EncodedKey': 'string',
'Comment': 'string'
},
Id='string',
IfMatch='string'
)
[REQUIRED]
A public key configuration.
A string included in the request to help make sure that the request can’t be replayed.
A name to help identify the public key.
The public key that you can use with signed URLs and signed cookies , or with field-level encryption .
A comment to describe the public key. The comment cannot be longer than 128 characters.
[REQUIRED]
The identifier of the public key that you are updating.
ETag header that you received when retrieving the public key to update. For example: E2QWRUHAPOMQZL .dict
Response Syntax
{
'PublicKey': {
'Id': 'string',
'CreatedTime': datetime(2015, 1, 1),
'PublicKeyConfig': {
'CallerReference': 'string',
'Name': 'string',
'EncodedKey': 'string',
'Comment': 'string'
}
},
'ETag': 'string'
}
Response Structure
(dict) --
PublicKey (dict) --
The public key.
Id (string) --
The identifier of the public key.
CreatedTime (datetime) --
The date and time when the public key was uploaded.
PublicKeyConfig (dict) --
Configuration information about a public key that you can use with signed URLs and signed cookies , or with field-level encryption .
CallerReference (string) --
A string included in the request to help make sure that the request can’t be replayed.
Name (string) --
A name to help identify the public key.
EncodedKey (string) --
The public key that you can use with signed URLs and signed cookies , or with field-level encryption .
Comment (string) --
A comment to describe the public key. The comment cannot be longer than 128 characters.
ETag (string) --
The identifier of the current version of the public key.
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.CannotChangeImmutablePublicKeyFieldsCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.InvalidIfMatchVersionCloudFront.Client.exceptions.IllegalUpdateCloudFront.Client.exceptions.NoSuchPublicKeyCloudFront.Client.exceptions.PreconditionFailedupdate_realtime_log_config(**kwargs)¶Updates a real-time log configuration.
When you update a real-time log configuration, all the parameters are updated with the values provided in the request. You cannot update some parameters independent of others. To update a real-time log configuration:
GetRealtimeLogConfig to get the current real-time log configuration.UpdateRealtimeLogConfig ) by providing the entire real-time log configuration, including the parameters that you modified and those that you didn’t.You cannot update a real-time log configuration’s Name or ARN .
See also: AWS API Documentation
Request Syntax
response = client.update_realtime_log_config(
EndPoints=[
{
'StreamType': 'string',
'KinesisStreamConfig': {
'RoleARN': 'string',
'StreamARN': 'string'
}
},
],
Fields=[
'string',
],
Name='string',
ARN='string',
SamplingRate=123
)
Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
Contains information about the Amazon Kinesis data stream where you are sending real-time log data in a real-time log configuration.
The type of data stream where you are sending real-time log data. The only valid value is Kinesis .
Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFront can use to send real-time log data to your Kinesis data stream.
For more information the IAM role, see Real-time log configuration IAM role in the Amazon CloudFront Developer Guide .
The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data.
A list of fields to include in each real-time log record.
For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide .
dict
Response Syntax
{
'RealtimeLogConfig': {
'ARN': 'string',
'Name': 'string',
'SamplingRate': 123,
'EndPoints': [
{
'StreamType': 'string',
'KinesisStreamConfig': {
'RoleARN': 'string',
'StreamARN': 'string'
}
},
],
'Fields': [
'string',
]
}
}
Response Structure
(dict) --
RealtimeLogConfig (dict) --
A real-time log configuration.
ARN (string) --
The Amazon Resource Name (ARN) of this real-time log configuration.
Name (string) --
The unique name of this real-time log configuration.
SamplingRate (integer) --
The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. The sampling rate is an integer between 1 and 100, inclusive.
EndPoints (list) --
Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.
(dict) --
Contains information about the Amazon Kinesis data stream where you are sending real-time log data in a real-time log configuration.
StreamType (string) --
The type of data stream where you are sending real-time log data. The only valid value is Kinesis .
KinesisStreamConfig (dict) --
Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
RoleARN (string) --
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFront can use to send real-time log data to your Kinesis data stream.
For more information the IAM role, see Real-time log configuration IAM role in the Amazon CloudFront Developer Guide .
StreamARN (string) --
The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data.
Fields (list) --
A list of fields that are included in each real-time log record. In an API response, the fields are provided in the same order in which they are sent to the Amazon Kinesis data stream.
For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide .
Exceptions
CloudFront.Client.exceptions.NoSuchRealtimeLogConfigCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.AccessDeniedupdate_response_headers_policy(**kwargs)¶Updates a response headers policy.
When you update a response headers policy, the entire policy is replaced. You cannot update some policy fields independent of others. To update a response headers policy configuration:
GetResponseHeadersPolicyConfig to get the current policy’s configuration.UpdateResponseHeadersPolicy , providing the entire response headers policy configuration, including the fields that you modified and those that you didn’t.See also: AWS API Documentation
Request Syntax
response = client.update_response_headers_policy(
ResponseHeadersPolicyConfig={
'Comment': 'string',
'Name': 'string',
'CorsConfig': {
'AccessControlAllowOrigins': {
'Quantity': 123,
'Items': [
'string',
]
},
'AccessControlAllowHeaders': {
'Quantity': 123,
'Items': [
'string',
]
},
'AccessControlAllowMethods': {
'Quantity': 123,
'Items': [
'GET'|'POST'|'OPTIONS'|'PUT'|'DELETE'|'PATCH'|'HEAD'|'ALL',
]
},
'AccessControlAllowCredentials': True|False,
'AccessControlExposeHeaders': {
'Quantity': 123,
'Items': [
'string',
]
},
'AccessControlMaxAgeSec': 123,
'OriginOverride': True|False
},
'SecurityHeadersConfig': {
'XSSProtection': {
'Override': True|False,
'Protection': True|False,
'ModeBlock': True|False,
'ReportUri': 'string'
},
'FrameOptions': {
'Override': True|False,
'FrameOption': 'DENY'|'SAMEORIGIN'
},
'ReferrerPolicy': {
'Override': True|False,
'ReferrerPolicy': 'no-referrer'|'no-referrer-when-downgrade'|'origin'|'origin-when-cross-origin'|'same-origin'|'strict-origin'|'strict-origin-when-cross-origin'|'unsafe-url'
},
'ContentSecurityPolicy': {
'Override': True|False,
'ContentSecurityPolicy': 'string'
},
'ContentTypeOptions': {
'Override': True|False
},
'StrictTransportSecurity': {
'Override': True|False,
'IncludeSubdomains': True|False,
'Preload': True|False,
'AccessControlMaxAgeSec': 123
}
},
'ServerTimingHeadersConfig': {
'Enabled': True|False,
'SamplingRate': 123.0
},
'CustomHeadersConfig': {
'Quantity': 123,
'Items': [
{
'Header': 'string',
'Value': 'string',
'Override': True|False
},
]
}
},
Id='string',
IfMatch='string'
)
[REQUIRED]
A response headers policy configuration.
A comment to describe the response headers policy.
The comment cannot be longer than 128 characters.
A name to identify the response headers policy.
The name must be unique for response headers policies in this Amazon Web Services account.
A configuration for a set of HTTP response headers that are used for cross-origin resource sharing (CORS).
A list of origins (domain names) that CloudFront can use as the value for the Access-Control-Allow-Origin HTTP response header.
For more information about the Access-Control-Allow-Origin HTTP response header, see Access-Control-Allow-Origin in the MDN Web Docs.
The number of origins in the list.
The list of origins (domain names). You can specify * to allow all origins.
A list of HTTP header names that CloudFront includes as values for the Access-Control-Allow-Headers HTTP response header.
For more information about the Access-Control-Allow-Headers HTTP response header, see Access-Control-Allow-Headers in the MDN Web Docs.
The number of HTTP header names in the list.
The list of HTTP header names. You can specify * to allow all headers.
A list of HTTP methods that CloudFront includes as values for the Access-Control-Allow-Methods HTTP response header.
For more information about the Access-Control-Allow-Methods HTTP response header, see Access-Control-Allow-Methods in the MDN Web Docs.
The number of HTTP methods in the list.
The list of HTTP methods. Valid values are:
GETDELETEHEADOPTIONSPATCHPOSTPUTALLALLis a special value that includes all of the listed HTTP methods.
A Boolean that CloudFront uses as the value for the Access-Control-Allow-Credentials HTTP response header.
For more information about the Access-Control-Allow-Credentials HTTP response header, see Access-Control-Allow-Credentials in the MDN Web Docs.
A list of HTTP headers that CloudFront includes as values for the Access-Control-Expose-Headers HTTP response header.
For more information about the Access-Control-Expose-Headers HTTP response header, see Access-Control-Expose-Headers in the MDN Web Docs.
The number of HTTP headers in the list.
The list of HTTP headers. You can specify * to expose all headers.
A number that CloudFront uses as the value for the Access-Control-Max-Age HTTP response header.
For more information about the Access-Control-Max-Age HTTP response header, see Access-Control-Max-Age in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides HTTP response headers received from the origin with the ones specified in this response headers policy.
A configuration for a set of security-related HTTP response headers.
Determines whether CloudFront includes the X-XSS-Protection HTTP response header and the header’s value.
For more information about the X-XSS-Protection HTTP response header, see X-XSS-Protection in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the X-XSS-Protection HTTP response header received from the origin with the one specified in this response headers policy.
A Boolean that determines the value of the X-XSS-Protection HTTP response header. When this setting is true , the value of the X-XSS-Protection header is 1 . When this setting is false , the value of the X-XSS-Protection header is 0 .
For more information about these settings, see X-XSS-Protection in the MDN Web Docs.
A Boolean that determines whether CloudFront includes the mode=block directive in the X-XSS-Protection header.
For more information about this directive, see X-XSS-Protection in the MDN Web Docs.
A reporting URI, which CloudFront uses as the value of the report directive in the X-XSS-Protection header.
You cannot specify a ReportUri when ModeBlock is true .
For more information about using a reporting URL, see X-XSS-Protection in the MDN Web Docs.
Determines whether CloudFront includes the X-Frame-Options HTTP response header and the header’s value.
For more information about the X-Frame-Options HTTP response header, see X-Frame-Options in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the X-Frame-Options HTTP response header received from the origin with the one specified in this response headers policy.
The value of the X-Frame-Options HTTP response header. Valid values are DENY and SAMEORIGIN .
For more information about these values, see X-Frame-Options in the MDN Web Docs.
Determines whether CloudFront includes the Referrer-Policy HTTP response header and the header’s value.
For more information about the Referrer-Policy HTTP response header, see Referrer-Policy in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the Referrer-Policy HTTP response header received from the origin with the one specified in this response headers policy.
The value of the Referrer-Policy HTTP response header. Valid values are:
no-referrerno-referrer-when-downgradeoriginorigin-when-cross-originsame-originstrict-originstrict-origin-when-cross-originunsafe-urlFor more information about these values, see Referrer-Policy in the MDN Web Docs.
The policy directives and their values that CloudFront includes as values for the Content-Security-Policy HTTP response header.
For more information about the Content-Security-Policy HTTP response header, see Content-Security-Policy in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the Content-Security-Policy HTTP response header received from the origin with the one specified in this response headers policy.
The policy directives and their values that CloudFront includes as values for the Content-Security-Policy HTTP response header.
Determines whether CloudFront includes the X-Content-Type-Options HTTP response header with its value set to nosniff .
For more information about the X-Content-Type-Options HTTP response header, see X-Content-Type-Options in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the X-Content-Type-Options HTTP response header received from the origin with the one specified in this response headers policy.
Determines whether CloudFront includes the Strict-Transport-Security HTTP response header and the header’s value.
For more information about the Strict-Transport-Security HTTP response header, see Strict-Transport-Security in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the Strict-Transport-Security HTTP response header received from the origin with the one specified in this response headers policy.
A Boolean that determines whether CloudFront includes the includeSubDomains directive in the Strict-Transport-Security HTTP response header.
A Boolean that determines whether CloudFront includes the preload directive in the Strict-Transport-Security HTTP response header.
A number that CloudFront uses as the value for the max-age directive in the Strict-Transport-Security HTTP response header.
A configuration for enabling the Server-Timing header in HTTP responses sent from CloudFront.
A Boolean that determines whether CloudFront adds the Server-Timing header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy.
A number 0–100 (inclusive) that specifies the percentage of responses that you want CloudFront to add the Server-Timing header to. When you set the sampling rate to 100, CloudFront adds the Server-Timing header to the HTTP response for every request that matches the cache behavior that this response headers policy is attached to. When you set it to 50, CloudFront adds the header to 50% of the responses for requests that match the cache behavior. You can set the sampling rate to any number 0–100 with up to four decimal places.
A configuration for a set of custom HTTP response headers.
The number of HTTP response headers in the list.
The list of HTTP response headers and their values.
An HTTP response header name and its value. CloudFront includes this header in HTTP responses that it sends for requests that match a cache behavior that’s associated with this response headers policy.
The HTTP response header name.
The value for the HTTP response header.
A Boolean that determines whether CloudFront overrides a response header with the same name received from the origin with the header specified here.
[REQUIRED]
The identifier for the response headers policy that you are updating.
The version of the response headers policy that you are updating.
The version is returned in the cache policy’s ETag field in the response to GetResponseHeadersPolicyConfig .
dict
Response Syntax
{
'ResponseHeadersPolicy': {
'Id': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'ResponseHeadersPolicyConfig': {
'Comment': 'string',
'Name': 'string',
'CorsConfig': {
'AccessControlAllowOrigins': {
'Quantity': 123,
'Items': [
'string',
]
},
'AccessControlAllowHeaders': {
'Quantity': 123,
'Items': [
'string',
]
},
'AccessControlAllowMethods': {
'Quantity': 123,
'Items': [
'GET'|'POST'|'OPTIONS'|'PUT'|'DELETE'|'PATCH'|'HEAD'|'ALL',
]
},
'AccessControlAllowCredentials': True|False,
'AccessControlExposeHeaders': {
'Quantity': 123,
'Items': [
'string',
]
},
'AccessControlMaxAgeSec': 123,
'OriginOverride': True|False
},
'SecurityHeadersConfig': {
'XSSProtection': {
'Override': True|False,
'Protection': True|False,
'ModeBlock': True|False,
'ReportUri': 'string'
},
'FrameOptions': {
'Override': True|False,
'FrameOption': 'DENY'|'SAMEORIGIN'
},
'ReferrerPolicy': {
'Override': True|False,
'ReferrerPolicy': 'no-referrer'|'no-referrer-when-downgrade'|'origin'|'origin-when-cross-origin'|'same-origin'|'strict-origin'|'strict-origin-when-cross-origin'|'unsafe-url'
},
'ContentSecurityPolicy': {
'Override': True|False,
'ContentSecurityPolicy': 'string'
},
'ContentTypeOptions': {
'Override': True|False
},
'StrictTransportSecurity': {
'Override': True|False,
'IncludeSubdomains': True|False,
'Preload': True|False,
'AccessControlMaxAgeSec': 123
}
},
'ServerTimingHeadersConfig': {
'Enabled': True|False,
'SamplingRate': 123.0
},
'CustomHeadersConfig': {
'Quantity': 123,
'Items': [
{
'Header': 'string',
'Value': 'string',
'Override': True|False
},
]
}
}
},
'ETag': 'string'
}
Response Structure
(dict) --
ResponseHeadersPolicy (dict) --
A response headers policy.
Id (string) --
The identifier for the response headers policy.
LastModifiedTime (datetime) --
The date and time when the response headers policy was last modified.
ResponseHeadersPolicyConfig (dict) --
A response headers policy configuration.
A response headers policy contains information about a set of HTTP response headers and their values. CloudFront adds the headers in the policy to HTTP responses that it sends for requests that match a cache behavior that’s associated with the policy.
Comment (string) --
A comment to describe the response headers policy.
The comment cannot be longer than 128 characters.
Name (string) --
A name to identify the response headers policy.
The name must be unique for response headers policies in this Amazon Web Services account.
CorsConfig (dict) --
A configuration for a set of HTTP response headers that are used for cross-origin resource sharing (CORS).
AccessControlAllowOrigins (dict) --
A list of origins (domain names) that CloudFront can use as the value for the Access-Control-Allow-Origin HTTP response header.
For more information about the Access-Control-Allow-Origin HTTP response header, see Access-Control-Allow-Origin in the MDN Web Docs.
Quantity (integer) --
The number of origins in the list.
Items (list) --
The list of origins (domain names). You can specify * to allow all origins.
AccessControlAllowHeaders (dict) --
A list of HTTP header names that CloudFront includes as values for the Access-Control-Allow-Headers HTTP response header.
For more information about the Access-Control-Allow-Headers HTTP response header, see Access-Control-Allow-Headers in the MDN Web Docs.
Quantity (integer) --
The number of HTTP header names in the list.
Items (list) --
The list of HTTP header names. You can specify * to allow all headers.
AccessControlAllowMethods (dict) --
A list of HTTP methods that CloudFront includes as values for the Access-Control-Allow-Methods HTTP response header.
For more information about the Access-Control-Allow-Methods HTTP response header, see Access-Control-Allow-Methods in the MDN Web Docs.
Quantity (integer) --
The number of HTTP methods in the list.
Items (list) --
The list of HTTP methods. Valid values are:
GETDELETEHEADOPTIONSPATCHPOSTPUTALL
ALLis a special value that includes all of the listed HTTP methods.
AccessControlAllowCredentials (boolean) --
A Boolean that CloudFront uses as the value for the Access-Control-Allow-Credentials HTTP response header.
For more information about the Access-Control-Allow-Credentials HTTP response header, see Access-Control-Allow-Credentials in the MDN Web Docs.
AccessControlExposeHeaders (dict) --
A list of HTTP headers that CloudFront includes as values for the Access-Control-Expose-Headers HTTP response header.
For more information about the Access-Control-Expose-Headers HTTP response header, see Access-Control-Expose-Headers in the MDN Web Docs.
Quantity (integer) --
The number of HTTP headers in the list.
Items (list) --
The list of HTTP headers. You can specify * to expose all headers.
AccessControlMaxAgeSec (integer) --
A number that CloudFront uses as the value for the Access-Control-Max-Age HTTP response header.
For more information about the Access-Control-Max-Age HTTP response header, see Access-Control-Max-Age in the MDN Web Docs.
OriginOverride (boolean) --
A Boolean that determines whether CloudFront overrides HTTP response headers received from the origin with the ones specified in this response headers policy.
SecurityHeadersConfig (dict) --
A configuration for a set of security-related HTTP response headers.
XSSProtection (dict) --
Determines whether CloudFront includes the X-XSS-Protection HTTP response header and the header’s value.
For more information about the X-XSS-Protection HTTP response header, see X-XSS-Protection in the MDN Web Docs.
Override (boolean) --
A Boolean that determines whether CloudFront overrides the X-XSS-Protection HTTP response header received from the origin with the one specified in this response headers policy.
Protection (boolean) --
A Boolean that determines the value of the X-XSS-Protection HTTP response header. When this setting is true , the value of the X-XSS-Protection header is 1 . When this setting is false , the value of the X-XSS-Protection header is 0 .
For more information about these settings, see X-XSS-Protection in the MDN Web Docs.
ModeBlock (boolean) --
A Boolean that determines whether CloudFront includes the mode=block directive in the X-XSS-Protection header.
For more information about this directive, see X-XSS-Protection in the MDN Web Docs.
ReportUri (string) --
A reporting URI, which CloudFront uses as the value of the report directive in the X-XSS-Protection header.
You cannot specify a ReportUri when ModeBlock is true .
For more information about using a reporting URL, see X-XSS-Protection in the MDN Web Docs.
FrameOptions (dict) --
Determines whether CloudFront includes the X-Frame-Options HTTP response header and the header’s value.
For more information about the X-Frame-Options HTTP response header, see X-Frame-Options in the MDN Web Docs.
Override (boolean) --
A Boolean that determines whether CloudFront overrides the X-Frame-Options HTTP response header received from the origin with the one specified in this response headers policy.
FrameOption (string) --
The value of the X-Frame-Options HTTP response header. Valid values are DENY and SAMEORIGIN .
For more information about these values, see X-Frame-Options in the MDN Web Docs.
ReferrerPolicy (dict) --
Determines whether CloudFront includes the Referrer-Policy HTTP response header and the header’s value.
For more information about the Referrer-Policy HTTP response header, see Referrer-Policy in the MDN Web Docs.
Override (boolean) --
A Boolean that determines whether CloudFront overrides the Referrer-Policy HTTP response header received from the origin with the one specified in this response headers policy.
ReferrerPolicy (string) --
The value of the Referrer-Policy HTTP response header. Valid values are:
no-referrerno-referrer-when-downgradeoriginorigin-when-cross-originsame-originstrict-originstrict-origin-when-cross-originunsafe-urlFor more information about these values, see Referrer-Policy in the MDN Web Docs.
ContentSecurityPolicy (dict) --
The policy directives and their values that CloudFront includes as values for the Content-Security-Policy HTTP response header.
For more information about the Content-Security-Policy HTTP response header, see Content-Security-Policy in the MDN Web Docs.
Override (boolean) --
A Boolean that determines whether CloudFront overrides the Content-Security-Policy HTTP response header received from the origin with the one specified in this response headers policy.
ContentSecurityPolicy (string) --
The policy directives and their values that CloudFront includes as values for the Content-Security-Policy HTTP response header.
ContentTypeOptions (dict) --
Determines whether CloudFront includes the X-Content-Type-Options HTTP response header with its value set to nosniff .
For more information about the X-Content-Type-Options HTTP response header, see X-Content-Type-Options in the MDN Web Docs.
Override (boolean) --
A Boolean that determines whether CloudFront overrides the X-Content-Type-Options HTTP response header received from the origin with the one specified in this response headers policy.
StrictTransportSecurity (dict) --
Determines whether CloudFront includes the Strict-Transport-Security HTTP response header and the header’s value.
For more information about the Strict-Transport-Security HTTP response header, see Strict-Transport-Security in the MDN Web Docs.
Override (boolean) --
A Boolean that determines whether CloudFront overrides the Strict-Transport-Security HTTP response header received from the origin with the one specified in this response headers policy.
IncludeSubdomains (boolean) --
A Boolean that determines whether CloudFront includes the includeSubDomains directive in the Strict-Transport-Security HTTP response header.
Preload (boolean) --
A Boolean that determines whether CloudFront includes the preload directive in the Strict-Transport-Security HTTP response header.
AccessControlMaxAgeSec (integer) --
A number that CloudFront uses as the value for the max-age directive in the Strict-Transport-Security HTTP response header.
ServerTimingHeadersConfig (dict) --
A configuration for enabling the Server-Timing header in HTTP responses sent from CloudFront.
Enabled (boolean) --
A Boolean that determines whether CloudFront adds the Server-Timing header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy.
SamplingRate (float) --
A number 0–100 (inclusive) that specifies the percentage of responses that you want CloudFront to add the Server-Timing header to. When you set the sampling rate to 100, CloudFront adds the Server-Timing header to the HTTP response for every request that matches the cache behavior that this response headers policy is attached to. When you set it to 50, CloudFront adds the header to 50% of the responses for requests that match the cache behavior. You can set the sampling rate to any number 0–100 with up to four decimal places.
CustomHeadersConfig (dict) --
A configuration for a set of custom HTTP response headers.
Quantity (integer) --
The number of HTTP response headers in the list.
Items (list) --
The list of HTTP response headers and their values.
(dict) --
An HTTP response header name and its value. CloudFront includes this header in HTTP responses that it sends for requests that match a cache behavior that’s associated with this response headers policy.
Header (string) --
The HTTP response header name.
Value (string) --
The value for the HTTP response header.
Override (boolean) --
A Boolean that determines whether CloudFront overrides a response header with the same name received from the origin with the header specified here.
ETag (string) --
The current version of the response headers policy.
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.IllegalUpdateCloudFront.Client.exceptions.InconsistentQuantitiesCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.InvalidIfMatchVersionCloudFront.Client.exceptions.NoSuchResponseHeadersPolicyCloudFront.Client.exceptions.PreconditionFailedCloudFront.Client.exceptions.ResponseHeadersPolicyAlreadyExistsCloudFront.Client.exceptions.TooManyCustomHeadersInResponseHeadersPolicyCloudFront.Client.exceptions.TooLongCSPInResponseHeadersPolicyupdate_streaming_distribution(**kwargs)¶Update a streaming distribution.
See also: AWS API Documentation
Request Syntax
response = client.update_streaming_distribution(
StreamingDistributionConfig={
'CallerReference': 'string',
'S3Origin': {
'DomainName': 'string',
'OriginAccessIdentity': 'string'
},
'Aliases': {
'Quantity': 123,
'Items': [
'string',
]
},
'Comment': 'string',
'Logging': {
'Enabled': True|False,
'Bucket': 'string',
'Prefix': 'string'
},
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'PriceClass': 'PriceClass_100'|'PriceClass_200'|'PriceClass_All',
'Enabled': True|False
},
Id='string',
IfMatch='string'
)
[REQUIRED]
The streaming distribution's configuration information.
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of CallerReference is new (regardless of the content of the StreamingDistributionConfig object), CloudFront creates a new distribution.
If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.
A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.
The DNS name of the Amazon S3 origin.
The CloudFront origin access identity to associate with the distribution. Use an origin access identity to configure the distribution 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.
For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon CloudFront Developer Guide .
A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.
The number of CNAME aliases, if any, that you want to associate with this distribution.
A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
Any comments you want to include about the streaming distribution.
A complex type that controls whether access logs are written for the streaming distribution.
Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't 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.
The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com .
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 don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.
A complex type that specifies any Amazon Web Services accounts that you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services account identifiers.
A complex type that contains information about price class for this streaming distribution.
Whether the streaming distribution is enabled to accept user requests for content.
[REQUIRED]
The streaming distribution's id.
ETag header that you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL .dict
Response Syntax
{
'StreamingDistribution': {
'Id': 'string',
'ARN': 'string',
'Status': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'DomainName': 'string',
'ActiveTrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
{
'AwsAccountNumber': 'string',
'KeyPairIds': {
'Quantity': 123,
'Items': [
'string',
]
}
},
]
},
'StreamingDistributionConfig': {
'CallerReference': 'string',
'S3Origin': {
'DomainName': 'string',
'OriginAccessIdentity': 'string'
},
'Aliases': {
'Quantity': 123,
'Items': [
'string',
]
},
'Comment': 'string',
'Logging': {
'Enabled': True|False,
'Bucket': 'string',
'Prefix': 'string'
},
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'PriceClass': 'PriceClass_100'|'PriceClass_200'|'PriceClass_All',
'Enabled': True|False
}
},
'ETag': 'string'
}
Response Structure
(dict) --
The returned result of the corresponding request.
StreamingDistribution (dict) --
The streaming distribution's information.
Id (string) --
The identifier for the RTMP distribution. For example: EGTXBD79EXAMPLE .
ARN (string) --
The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5 , where 123456789012 is your Amazon Web Services account ID.
Status (string) --
The current status of the RTMP distribution. When the status is Deployed , the distribution's information is propagated to all CloudFront edge locations.
LastModifiedTime (datetime) --
The date and time that the distribution was last modified.
DomainName (string) --
The domain name that corresponds to the streaming distribution, for example, s5c39gqb8ow64r.cloudfront.net .
ActiveTrustedSigners (dict) --
A complex type that lists the Amazon Web Services accounts, if any, that you included in the TrustedSigners complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.
The Signer complex type lists the Amazon Web Services account number of the trusted signer or self if the signer is the Amazon Web Services account that created the distribution. The Signer element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's Amazon Web Services account. If no KeyPairId element appears for a Signer , that signer can't create signed URLs.
For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
Enabled (boolean) --
This field is true if any of the Amazon Web Services accounts in the list have active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
Quantity (integer) --
The number of Amazon Web Services accounts in the list.
Items (list) --
A list of Amazon Web Services accounts and the identifiers of active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.
(dict) --
A list of Amazon Web Services accounts and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.
AwsAccountNumber (string) --
An Amazon Web Services account number that contains active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If the Amazon Web Services account that owns the key pairs is the same account that owns the CloudFront distribution, the value of this field is self .
KeyPairIds (dict) --
A list of CloudFront key pair identifiers.
Quantity (integer) --
The number of key pair identifiers in the list.
Items (list) --
A list of CloudFront key pair identifiers.
StreamingDistributionConfig (dict) --
The current configuration information for the RTMP distribution.
CallerReference (string) --
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of CallerReference is new (regardless of the content of the StreamingDistributionConfig object), CloudFront creates a new distribution.
If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.
S3Origin (dict) --
A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.
DomainName (string) --
The DNS name of the Amazon S3 origin.
OriginAccessIdentity (string) --
The CloudFront origin access identity to associate with the distribution. Use an origin access identity to configure the distribution 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.
For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon CloudFront Developer Guide .
Aliases (dict) --
A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.
Quantity (integer) --
The number of CNAME aliases, if any, that you want to associate with this distribution.
Items (list) --
A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
Comment (string) --
Any comments you want to include about the streaming distribution.
Logging (dict) --
A complex type that controls whether access logs are written for the streaming distribution.
Enabled (boolean) --
Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't 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.
Bucket (string) --
The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com .
Prefix (string) --
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 don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.
TrustedSigners (dict) --
A complex type that specifies any Amazon Web Services accounts that you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
Enabled (boolean) --
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
Quantity (integer) --
The number of Amazon Web Services accounts in the list.
Items (list) --
A list of Amazon Web Services account identifiers.
PriceClass (string) --
A complex type that contains information about price class for this streaming distribution.
Enabled (boolean) --
Whether the streaming distribution is enabled to accept user requests for content.
ETag (string) --
The current version of the configuration. For example: E2QWRUHAPOMQZL .
Exceptions
CloudFront.Client.exceptions.AccessDeniedCloudFront.Client.exceptions.CNAMEAlreadyExistsCloudFront.Client.exceptions.IllegalUpdateCloudFront.Client.exceptions.InvalidIfMatchVersionCloudFront.Client.exceptions.MissingBodyCloudFront.Client.exceptions.NoSuchStreamingDistributionCloudFront.Client.exceptions.PreconditionFailedCloudFront.Client.exceptions.TooManyStreamingDistributionCNAMEsCloudFront.Client.exceptions.InvalidArgumentCloudFront.Client.exceptions.InvalidOriginAccessIdentityCloudFront.Client.exceptions.InvalidOriginAccessControlCloudFront.Client.exceptions.TooManyTrustedSignersCloudFront.Client.exceptions.TrustedSignerDoesNotExistCloudFront.Client.exceptions.InconsistentQuantitiesThe available paginators are:
CloudFront.Paginator.ListCloudFrontOriginAccessIdentitiesCloudFront.Paginator.ListDistributionsCloudFront.Paginator.ListInvalidationsCloudFront.Paginator.ListStreamingDistributionsCloudFront.Paginator.ListCloudFrontOriginAccessIdentities¶paginator = client.get_paginator('list_cloud_front_origin_access_identities')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CloudFront.Client.list_cloud_front_origin_access_identities().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'CloudFrontOriginAccessIdentityList': {
'Marker': 'string',
'NextMarker': 'string',
'MaxItems': 123,
'IsTruncated': True|False,
'Quantity': 123,
'Items': [
{
'Id': 'string',
'S3CanonicalUserId': 'string',
'Comment': 'string'
},
]
},
'NextToken': 'string'
}
Response Structure
The returned result of the corresponding request.
The CloudFrontOriginAccessIdentityList type.
Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).
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.
The maximum number of origin access identities you want in the response body.
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.
The number of CloudFront origin access identities that were created by the current Amazon Web Services account.
A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current Amazon Web Services account.
Summary of the information about a CloudFront origin access identity.
The ID for the origin access identity. For example: E74FTE3AJFJ256A .
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.
The comment for this origin access identity, as originally specified when created.
A token to resume pagination.
CloudFront.Paginator.ListDistributions¶paginator = client.get_paginator('list_distributions')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CloudFront.Client.list_distributions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'DistributionList': {
'Marker': 'string',
'NextMarker': 'string',
'MaxItems': 123,
'IsTruncated': True|False,
'Quantity': 123,
'Items': [
{
'Id': 'string',
'ARN': 'string',
'Status': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'DomainName': 'string',
'Aliases': {
'Quantity': 123,
'Items': [
'string',
]
},
'Origins': {
'Quantity': 123,
'Items': [
{
'Id': 'string',
'DomainName': 'string',
'OriginPath': 'string',
'CustomHeaders': {
'Quantity': 123,
'Items': [
{
'HeaderName': 'string',
'HeaderValue': 'string'
},
]
},
'S3OriginConfig': {
'OriginAccessIdentity': 'string'
},
'CustomOriginConfig': {
'HTTPPort': 123,
'HTTPSPort': 123,
'OriginProtocolPolicy': 'http-only'|'match-viewer'|'https-only',
'OriginSslProtocols': {
'Quantity': 123,
'Items': [
'SSLv3'|'TLSv1'|'TLSv1.1'|'TLSv1.2',
]
},
'OriginReadTimeout': 123,
'OriginKeepaliveTimeout': 123
},
'ConnectionAttempts': 123,
'ConnectionTimeout': 123,
'OriginShield': {
'Enabled': True|False,
'OriginShieldRegion': 'string'
},
'OriginAccessControlId': 'string'
},
]
},
'OriginGroups': {
'Quantity': 123,
'Items': [
{
'Id': 'string',
'FailoverCriteria': {
'StatusCodes': {
'Quantity': 123,
'Items': [
123,
]
}
},
'Members': {
'Quantity': 123,
'Items': [
{
'OriginId': 'string'
},
]
}
},
]
},
'DefaultCacheBehavior': {
'TargetOriginId': 'string',
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'TrustedKeyGroups': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'ViewerProtocolPolicy': 'allow-all'|'https-only'|'redirect-to-https',
'AllowedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
],
'CachedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
]
}
},
'SmoothStreaming': True|False,
'Compress': True|False,
'LambdaFunctionAssociations': {
'Quantity': 123,
'Items': [
{
'LambdaFunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response',
'IncludeBody': True|False
},
]
},
'FunctionAssociations': {
'Quantity': 123,
'Items': [
{
'FunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response'
},
]
},
'FieldLevelEncryptionId': 'string',
'RealtimeLogConfigArn': 'string',
'CachePolicyId': 'string',
'OriginRequestPolicyId': 'string',
'ResponseHeadersPolicyId': 'string',
'ForwardedValues': {
'QueryString': True|False,
'Cookies': {
'Forward': 'none'|'whitelist'|'all',
'WhitelistedNames': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
},
'QueryStringCacheKeys': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'MinTTL': 123,
'DefaultTTL': 123,
'MaxTTL': 123
},
'CacheBehaviors': {
'Quantity': 123,
'Items': [
{
'PathPattern': 'string',
'TargetOriginId': 'string',
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'TrustedKeyGroups': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'ViewerProtocolPolicy': 'allow-all'|'https-only'|'redirect-to-https',
'AllowedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
],
'CachedMethods': {
'Quantity': 123,
'Items': [
'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE',
]
}
},
'SmoothStreaming': True|False,
'Compress': True|False,
'LambdaFunctionAssociations': {
'Quantity': 123,
'Items': [
{
'LambdaFunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response',
'IncludeBody': True|False
},
]
},
'FunctionAssociations': {
'Quantity': 123,
'Items': [
{
'FunctionARN': 'string',
'EventType': 'viewer-request'|'viewer-response'|'origin-request'|'origin-response'
},
]
},
'FieldLevelEncryptionId': 'string',
'RealtimeLogConfigArn': 'string',
'CachePolicyId': 'string',
'OriginRequestPolicyId': 'string',
'ResponseHeadersPolicyId': 'string',
'ForwardedValues': {
'QueryString': True|False,
'Cookies': {
'Forward': 'none'|'whitelist'|'all',
'WhitelistedNames': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'Headers': {
'Quantity': 123,
'Items': [
'string',
]
},
'QueryStringCacheKeys': {
'Quantity': 123,
'Items': [
'string',
]
}
},
'MinTTL': 123,
'DefaultTTL': 123,
'MaxTTL': 123
},
]
},
'CustomErrorResponses': {
'Quantity': 123,
'Items': [
{
'ErrorCode': 123,
'ResponsePagePath': 'string',
'ResponseCode': 'string',
'ErrorCachingMinTTL': 123
},
]
},
'Comment': 'string',
'PriceClass': 'PriceClass_100'|'PriceClass_200'|'PriceClass_All',
'Enabled': True|False,
'ViewerCertificate': {
'CloudFrontDefaultCertificate': True|False,
'IAMCertificateId': 'string',
'ACMCertificateArn': 'string',
'SSLSupportMethod': 'sni-only'|'vip'|'static-ip',
'MinimumProtocolVersion': 'SSLv3'|'TLSv1'|'TLSv1_2016'|'TLSv1.1_2016'|'TLSv1.2_2018'|'TLSv1.2_2019'|'TLSv1.2_2021',
'Certificate': 'string',
'CertificateSource': 'cloudfront'|'iam'|'acm'
},
'Restrictions': {
'GeoRestriction': {
'RestrictionType': 'blacklist'|'whitelist'|'none',
'Quantity': 123,
'Items': [
'string',
]
}
},
'WebACLId': 'string',
'HttpVersion': 'http1.1'|'http2'|'http3'|'http2and3',
'IsIPV6Enabled': True|False,
'AliasICPRecordals': [
{
'CNAME': 'string',
'ICPRecordalStatus': 'APPROVED'|'SUSPENDED'|'PENDING'
},
]
},
]
},
'NextToken': 'string'
}
Response Structure
The returned result of the corresponding request.
The DistributionList type.
The value you provided for the Marker request parameter.
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.
The value you provided for the MaxItems request parameter.
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.
The number of distributions that were created by the current Amazon Web Services account.
A complex type that contains one DistributionSummary element for each distribution that was created by the current Amazon Web Services account.
A summary of the information about a CloudFront distribution.
The identifier for the distribution. For example: EDFDVBD632BHDS5 .
The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5 , where 123456789012 is your Amazon Web Services account ID.
The current status of the distribution. When the status is Deployed , the distribution's information is propagated to all CloudFront edge locations.
The date and time the distribution was last modified.
The domain name that corresponds to the distribution, for example, d111111abcdef8.cloudfront.net .
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
The number of CNAME aliases, if any, that you want to associate with this distribution.
A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
A complex type that contains information about origins for this distribution.
The number of origins for this distribution.
A list of origins.
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:
S3OriginConfig to specify an Amazon S3 bucket that is not configured with static website hosting.CustomOriginConfig to specify all other kinds of origins, including: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).
A unique identifier for the origin. This value must be unique within the distribution.
Use this value to specify the TargetOriginId in a CacheBehavior or DefaultCacheBehavior .
The domain name for the origin.
For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide .
An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
For more information, see Origin Path in the Amazon CloudFront Developer Guide .
A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.
For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .
The number of custom headers, if any, for this distribution.
Optional : A list that contains oneOriginCustomHeaderelement for each custom header that you want CloudFront to forward to the origin. If Quantity is0, omitItems.
A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution.
The name of a header that you want CloudFront to send to your origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide .
The value for the header that you specified in the HeaderName field.
Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the CustomOriginConfig type instead.
The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
origin-access-identity/cloudfront/ID-of-origin-access-identity
where `` ID-of-origin-access-identity `` is the value that CloudFront returned in the ID element when you created the origin access identity.
If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.
To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.
To replace the origin access identity, update the distribution configuration and specify the new origin access identity.
For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.
The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:
http-only – CloudFront always uses HTTP to connect to the origin.match-viewer – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.https-only – CloudFront always uses HTTPS to connect to the origin.Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include SSLv3 , TLSv1 , TLSv1.1 , and TLSv1.2 .
For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide .
The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.
A list that contains allowed SSL/TLS protocols for this distribution.
Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout . The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 30 seconds.
For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide .
Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 5 seconds.
For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide .
The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don’t specify otherwise) is 3.
For a custom origin (including an Amazon S3 bucket that’s configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout .
For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide .
The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don’t specify otherwise) is 10 seconds.
For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide .
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 .
A flag that specifies whether Origin Shield is enabled.
When it’s enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it’s disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.
The Amazon Web Services Region for Origin Shield.
Specify the Amazon Web Services Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as us-east-2 .
When you enable CloudFront Origin Shield, you must specify the Amazon Web Services Region for Origin Shield. For the list of Amazon Web Services Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the Amazon Web Services Region for Origin Shield in the Amazon CloudFront Developer Guide .
The unique identifier of an origin access control for this origin.
For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide .
A complex type that contains information about origin groups for this distribution.
The number of origin groups.
The items (origin groups) in a distribution.
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.
The origin group's ID.
A complex type that contains information about the failover criteria for an origin group.
The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.
The number of status codes.
The items (status codes) for an origin group.
A complex type that contains information about the origins in an origin group.
The number of origins in an origin group.
Items (origins) in an origin group.
An origin in an origin group.
The ID for an origin in an origin group.
A complex type that describes the default cache behavior if you don't 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.
The value of ID for the origin that you want CloudFront to route requests to when they use the default cache behavior.
Warning
We recommend using TrustedKeyGroups instead of TrustedSigners .
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer’s Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services account identifiers.
A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of key groups in the list.
A list of key groups identifiers.
The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern . You can specify the following options:
allow-all : Viewers can use HTTP or HTTPS.redirect-to-https : If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only : If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide .
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:
GET and HEAD requests.GET , HEAD , and OPTIONS requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
GET and HEAD requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true ; if not, specify false . If you specify true for SmoothStreaming , you can still distribute other content using this cache behavior if the content matches the value of PathPattern .
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true ; if not, specify false . For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
The number of Lambda@Edge function associations for this cache behavior.
Optional : A complex type that containsLambdaFunctionAssociationitems for this cache behavior. IfQuantityis0, you can omitItems.
A complex type that contains a Lambda@Edge function association.
The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request : The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request : The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response : The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response : The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.
The number of CloudFront functions in the list.
The 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.
A CloudFront function that is associated with a cache behavior in a CloudFront distribution.
The Amazon Resource Name (ARN) of the function.
The event type of the function, either viewer-request or viewer-response . You cannot use origin-facing event types (origin-request and origin-response ) with a CloudFront function.
The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior.
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide .
The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
The identifier for a response headers policy.
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide .
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed 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 or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 .
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys , if any:
If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
If you specify false for QueryString , CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 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 How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide .
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.
Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 .
Required if you specify whitelist for the value of Forward . A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.
If you specify all or none for the value of Forward , omit WhitelistedNames . If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.
For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference .
The number of cookie names in the Items list.
A list of cookie names.
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 headers 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 headers 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 the Headers , if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.
For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide .
The number of header names in the Items list.
A list of HTTP header names.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
The number of whitelisted query string parameters for a cache behavior.
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items .
This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers , if you specify 1 for Quantity and * for Name ).
This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The default amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The maximum amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
A complex type that contains zero or more CacheBehavior elements.
The number of cache behaviors for this distribution.
Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0 , you can omit Items .
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 .
The pattern (for example, images/*.jpg ) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.
Note
You can optionally include a slash (/ ) at the beginning of the path pattern. For example, /images/*.jpg . CloudFront behavior is the same with or without the leading / .
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.
For more information, see Path Pattern in the Amazon CloudFront Developer Guide .
The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.
Warning
We recommend using TrustedKeyGroups instead of TrustedSigners .
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer’s Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services account identifiers.
A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of key groups in the list.
A list of key groups identifiers.
The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern . You can specify the following options:
allow-all : Viewers can use HTTP or HTTPS.redirect-to-https : If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only : If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide .
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:
GET and HEAD requests.GET , HEAD , and OPTIONS requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
GET and HEAD requests.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.
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).
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true ; if not, specify false . If you specify true for SmoothStreaming , you can still distribute other content using this cache behavior if the content matches the value of PathPattern .
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
The number of Lambda@Edge function associations for this cache behavior.
Optional : A complex type that containsLambdaFunctionAssociationitems for this cache behavior. IfQuantityis0, you can omitItems.
A complex type that contains a Lambda@Edge function association.
The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request : The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.origin-request : The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.origin-response : The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.viewer-response : The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.
The number of CloudFront functions in the list.
The 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.
A CloudFront function that is associated with a cache behavior in a CloudFront distribution.
The Amazon Resource Name (ARN) of the function.
The event type of the function, either viewer-request or viewer-response . You cannot use origin-facing event types (origin-request and origin-response ) with a CloudFront function.
The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide .
The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
A CacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
The identifier for a response headers policy.
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide .
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed 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 or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
A CacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 .
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys , if any:
If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys , CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
If you specify false for QueryString , CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 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 How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide .
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide .
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.
Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send cookies 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 .
Required if you specify whitelist for the value of Forward . A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.
If you specify all or none for the value of Forward , omit WhitelistedNames . If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.
For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference .
The number of cookie names in the Items list.
A list of cookie names.
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 headers 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 headers 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 the Headers , if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.
For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide .
The number of header names in the Items list.
A list of HTTP header names.
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 a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .
If you want to send query strings 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 contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
The number of whitelisted query string parameters for a cache behavior.
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items .
This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers , if you specify 1 for Quantity and * for Name ).
This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The default amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
The maximum amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
A complex type that contains zero or more CustomErrorResponses elements.
The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0 , you can omit Items .
A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration.
A complex type that controls:
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
The HTTP status code for which you want to specify a custom error page and/or a caching duration.
The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode , for example, /4xx-errors/403-forbidden.html . If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:
PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors . Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, /4xx-errors/* .TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages.If you specify a value for ResponsePagePath , you must also specify a value for ResponseCode .
We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.
The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:
200 , the response typically won't be intercepted.400 or 500 as the ResponseCode for all 4xx or 5xx errors.200 status code (OK) and static website so your customers don't know that your website is down.If you specify a value for ResponseCode , you must also specify a value for ResponsePagePath .
The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode . When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.
For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
The comment originally specified when this distribution was created.
A complex type that contains information about price class for this streaming distribution.
Whether the distribution is enabled to accept user requests for content.
A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net , set this field to true .
If the distribution uses Aliases (alternate domain names or CNAMEs), set this field to false and specify values for the following fields:
ACMCertificateArn or IAMCertificateId (specify a value for one, not both)MinimumProtocolVersionSSLSupportMethodIf the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Identity and Access Management (IAM) , provide the ID of the IAM certificate.
If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVersion and SSLSupportMethod .
If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Certificate Manager (ACM) , provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (us-east-1 ).
If you specify an ACM certificate ARN, you must also specify values for MinimumProtocolVersion and SSLSupportMethod .
If the distribution uses Aliases (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.
sni-only – The distribution accepts HTTPS connections from only viewers that support server name indication (SNI) . This is recommended. Most browsers and clients support SNI.vip – The distribution accepts HTTPS connections from all viewers including those that don’t support SNI. This is not recommended, and results in additional monthly charges from CloudFront.static-ip - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the Amazon Web Services Support Center .If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net , don’t set a value for this field.
If the distribution uses Aliases (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:
For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
Note
On the CloudFront console, this setting is called Security Policy .
When you’re using SNI only (you set SSLSupportMethod to sni-only ), you must specify TLSv1 or higher.
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net (you set CloudFrontDefaultCertificate to true ), CloudFront automatically sets the security policy to TLSv1 regardless of the value that you set here.
This field is deprecated. Use one of the following fields instead:
ACMCertificateArnIAMCertificateIdCloudFrontDefaultCertificateThis field is deprecated. Use one of the following fields instead:
ACMCertificateArnIAMCertificateIdCloudFrontDefaultCertificateA complex type that identifies ways in which you want to restrict distribution of your content.
A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.
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 don't want CloudFront to distribute your content.whitelist : The Location elements specify the countries in which you want CloudFront to distribute your content.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 .
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 on the CloudFront console, which includes both country names and codes.
The Web ACL Id (if any) associated with the distribution.
Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2 . Viewers that don't support HTTP/2 will automatically use an earlier version.
Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.
Amazon Web Services 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.
For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China .
Amazon Web Services 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 Amazon Web Services services in China .
A domain name associated with a distribution.
The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in regions outside of China.
The status values returned are the following:
A token to resume pagination.
CloudFront.Paginator.ListInvalidations¶paginator = client.get_paginator('list_invalidations')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CloudFront.Client.list_invalidations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DistributionId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The distribution's ID.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'InvalidationList': {
'Marker': 'string',
'NextMarker': 'string',
'MaxItems': 123,
'IsTruncated': True|False,
'Quantity': 123,
'Items': [
{
'Id': 'string',
'CreateTime': datetime(2015, 1, 1),
'Status': 'string'
},
]
},
'NextToken': 'string'
}
Response Structure
(dict) --
The returned result of the corresponding request.
InvalidationList (dict) --
Information about invalidation batches.
Marker (string) --
The value that you provided for the Marker request parameter.
NextMarker (string) --
If IsTruncated is true , this element is present and contains the value that you can use for the Marker request parameter to continue listing your invalidation batches where they left off.
MaxItems (integer) --
The value that you provided for the MaxItems request parameter.
IsTruncated (boolean) --
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.
Quantity (integer) --
The number of invalidation batches that were created by the current Amazon Web Services account.
Items (list) --
A complex type that contains one InvalidationSummary element for each invalidation batch created by the current Amazon Web Services account.
(dict) --
A summary of an invalidation request.
Id (string) --
The unique ID for an invalidation request.
CreateTime (datetime) --
The time that an invalidation request was created.
Status (string) --
The status of an invalidation request.
NextToken (string) --
A token to resume pagination.
CloudFront.Paginator.ListStreamingDistributions¶paginator = client.get_paginator('list_streaming_distributions')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CloudFront.Client.list_streaming_distributions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'StreamingDistributionList': {
'Marker': 'string',
'NextMarker': 'string',
'MaxItems': 123,
'IsTruncated': True|False,
'Quantity': 123,
'Items': [
{
'Id': 'string',
'ARN': 'string',
'Status': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'DomainName': 'string',
'S3Origin': {
'DomainName': 'string',
'OriginAccessIdentity': 'string'
},
'Aliases': {
'Quantity': 123,
'Items': [
'string',
]
},
'TrustedSigners': {
'Enabled': True|False,
'Quantity': 123,
'Items': [
'string',
]
},
'Comment': 'string',
'PriceClass': 'PriceClass_100'|'PriceClass_200'|'PriceClass_All',
'Enabled': True|False
},
]
},
'NextToken': 'string'
}
Response Structure
The returned result of the corresponding request.
The StreamingDistributionList type.
The value you provided for the Marker request parameter.
If IsTruncated is true , this element is present and contains the value you can use for the Marker request parameter to continue listing your RTMP distributions where they left off.
The value you provided for the MaxItems request parameter.
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.
The number of streaming distributions that were created by the current Amazon Web Services account.
A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current Amazon Web Services account.
A summary of the information for a CloudFront streaming distribution.
The identifier for the distribution, for example, EDFDVBD632BHDS5 .
The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5 , where 123456789012 is your Amazon Web Services account ID.
Indicates the current status of the distribution. When the status is Deployed , the distribution's information is fully propagated throughout the Amazon CloudFront system.
The date and time the distribution was last modified.
The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net .
A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.
The DNS name of the Amazon S3 origin.
The CloudFront origin access identity to associate with the distribution. Use an origin access identity to configure the distribution 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.
For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon CloudFront Developer Guide .
A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.
The number of CNAME aliases, if any, that you want to associate with this distribution.
A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
A complex type that specifies the Amazon Web Services 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 .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.
For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false .
The number of Amazon Web Services accounts in the list.
A list of Amazon Web Services account identifiers.
The comment originally specified when this distribution was created.
A complex type that contains information about price class for this streaming distribution.
Whether the distribution is enabled to accept end user requests for content.
A token to resume pagination.
The available waiters are:
CloudFront.Waiter.DistributionDeployedCloudFront.Waiter.InvalidationCompletedCloudFront.Waiter.StreamingDistributionDeployedCloudFront.Waiter.DistributionDeployed¶waiter = client.get_waiter('distribution_deployed')
wait(**kwargs)¶Polls CloudFront.Client.get_distribution() every 60 seconds until a successful state is reached. An error is returned after 35 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Id='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The distribution's ID. If the ID is empty, an empty distribution configuration is returned.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 60
The maximum number of attempts to be made. Default: 35
None
CloudFront.Waiter.InvalidationCompleted¶waiter = client.get_waiter('invalidation_completed')
wait(**kwargs)¶Polls CloudFront.Client.get_invalidation() every 20 seconds until a successful state is reached. An error is returned after 30 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
DistributionId='string',
Id='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The distribution's ID.
[REQUIRED]
The identifier for the invalidation request, for example, IDFDVBD632BHDS5 .
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 20
The maximum number of attempts to be made. Default: 30
None
CloudFront.Waiter.StreamingDistributionDeployed¶waiter = client.get_waiter('streaming_distribution_deployed')
wait(**kwargs)¶Polls CloudFront.Client.get_streaming_distribution() every 60 seconds until a successful state is reached. An error is returned after 25 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Id='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The streaming distribution's ID.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 60
The maximum number of attempts to be made. Default: 25
None
The following example shows how to generate a signed URL for Amazon CloudFront.
Note that you will need the cryptography library to follow this example:
import datetime
from cryptography.hazmat.backends import default_backend
from cryptography.hazmat.primitives import hashes
from cryptography.hazmat.primitives import serialization
from cryptography.hazmat.primitives.asymmetric import padding
from botocore.signers import CloudFrontSigner
def rsa_signer(message):
with open('path/to/key.pem', 'rb') as key_file:
private_key = serialization.load_pem_private_key(
key_file.read(),
password=None,
backend=default_backend()
)
return private_key.sign(message, padding.PKCS1v15(), hashes.SHA1())
key_id = 'AKIAIOSFODNN7EXAMPLE'
url = 'http://d2949o5mkkp72v.cloudfront.net/hello.txt'
expire_date = datetime.datetime(2017, 1, 1)
cloudfront_signer = CloudFrontSigner(key_id, rsa_signer)
# Create a signed url that will be valid until the specific expiry date
# provided using a canned policy.
signed_url = cloudfront_signer.generate_presigned_url(
url, date_less_than=expire_date)
print(signed_url)