CloudFront ********** Client ====== class 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 * associate_distribution_tenant_web_acl * associate_distribution_web_acl * can_paginate * close * copy_distribution * create_anycast_ip_list * create_cache_policy * create_cloud_front_origin_access_identity * create_connection_group * create_continuous_deployment_policy * create_distribution * create_distribution_tenant * create_distribution_with_tags * create_field_level_encryption_config * create_field_level_encryption_profile * create_function * create_invalidation * create_invalidation_for_distribution_tenant * create_key_group * create_key_value_store * 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 * create_vpc_origin * delete_anycast_ip_list * delete_cache_policy * delete_cloud_front_origin_access_identity * delete_connection_group * delete_continuous_deployment_policy * delete_distribution * delete_distribution_tenant * delete_field_level_encryption_config * delete_field_level_encryption_profile * delete_function * delete_key_group * delete_key_value_store * 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 * delete_vpc_origin * describe_function * describe_key_value_store * disassociate_distribution_tenant_web_acl * disassociate_distribution_web_acl * get_anycast_ip_list * get_cache_policy * get_cache_policy_config * get_cloud_front_origin_access_identity * get_cloud_front_origin_access_identity_config * get_connection_group * get_connection_group_by_routing_endpoint * get_continuous_deployment_policy * get_continuous_deployment_policy_config * get_distribution * get_distribution_config * get_distribution_tenant * get_distribution_tenant_by_domain * 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_invalidation_for_distribution_tenant * get_key_group * get_key_group_config * get_managed_certificate_details * 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_vpc_origin * get_waiter * list_anycast_ip_lists * list_cache_policies * list_cloud_front_origin_access_identities * list_conflicting_aliases * list_connection_groups * list_continuous_deployment_policies * list_distribution_tenants * list_distribution_tenants_by_customization * list_distributions * list_distributions_by_anycast_ip_list_id * list_distributions_by_cache_policy_id * list_distributions_by_connection_mode * 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_vpc_origin_id * list_distributions_by_web_acl_id * list_domain_conflicts * list_field_level_encryption_configs * list_field_level_encryption_profiles * list_functions * list_invalidations * list_invalidations_for_distribution_tenant * list_key_groups * list_key_value_stores * 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 * list_vpc_origins * publish_function * tag_resource * test_function * untag_resource * update_cache_policy * update_cloud_front_origin_access_identity * update_connection_group * update_continuous_deployment_policy * update_distribution * update_distribution_tenant * update_distribution_with_staging_config * update_domain_association * update_field_level_encryption_config * update_field_level_encryption_profile * update_function * update_key_group * update_key_value_store * update_origin_access_control * update_origin_request_policy * update_public_key * update_realtime_log_config * update_response_headers_policy * update_streaming_distribution * update_vpc_origin * verify_dns_configuration Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListCloudFrontOriginAccessIdentities * ListConnectionGroups * ListDistributionTenants * ListDistributionTenantsByCustomization * ListDistributions * ListDistributionsByConnectionMode * ListDomainConflicts * ListInvalidations * ListInvalidationsForDistributionTenant * ListKeyValueStores * ListOriginAccessControls * ListPublicKeys * ListStreamingDistributions Waiters ======= Waiters are available on a client instance via the "get_waiter" method. For more detailed instructions and examples on the usage or waiters, see the waiters user guide. The available waiters are: * DistributionDeployed * InvalidationCompleted * InvalidationForDistributionTenantCompleted * StreamingDistributionDeployed Examples ======== Generate a signed URL for Amazon CloudFront ------------------------------------------- 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) CloudFront / Waiter / DistributionDeployed DistributionDeployed ******************** class CloudFront.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 raised after 35 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( Id='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The distribution's ID. If the ID is empty, an empty distribution configuration is returned. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 60 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 35 Returns: None CloudFront / Waiter / InvalidationForDistributionTenantCompleted InvalidationForDistributionTenantCompleted ****************************************** class CloudFront.Waiter.InvalidationForDistributionTenantCompleted waiter = client.get_waiter('invalidation_for_distribution_tenant_completed') wait(**kwargs) Polls "CloudFront.Client.get_invalidation_for_distribution_tenant()" every 20 seconds until a successful state is reached. An error is raised after 30 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( DistributionTenantId='string', Id='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **DistributionTenantId** (*string*) -- **[REQUIRED]** The ID of the distribution tenant. * **Id** (*string*) -- **[REQUIRED]** The ID of the invalidation to retrieve. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 20 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 30 Returns: None CloudFront / Waiter / InvalidationCompleted InvalidationCompleted ********************* class 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 raised after 30 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( DistributionId='string', Id='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **DistributionId** (*string*) -- **[REQUIRED]** The distribution's ID. * **Id** (*string*) -- **[REQUIRED]** The identifier for the invalidation request, for example, "IDFDVBD632BHDS5". * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 20 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 30 Returns: None CloudFront / Waiter / StreamingDistributionDeployed StreamingDistributionDeployed ***************************** class 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 raised after 25 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( Id='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The streaming distribution's ID. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 60 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 25 Returns: None CloudFront / Paginator / ListOriginAccessControls ListOriginAccessControls ************************ class CloudFront.Paginator.ListOriginAccessControls paginator = client.get_paginator('list_origin_access_controls') paginate(**kwargs) Creates an iterator that will paginate through responses from "CloudFront.Client.list_origin_access_controls()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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'|'mediastore'|'mediapackagev2'|'lambda' }, ] }, 'NextToken': 'string' } **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. * **NextToken** *(string) --* A token to resume pagination. CloudFront / Paginator / ListDistributions ListDistributions ***************** class 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' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'DistributionList': { 'Marker': 'string', 'NextMarker': 'string', 'MaxItems': 123, 'IsTruncated': True|False, 'Quantity': 123, 'Items': [ { 'Id': 'string', 'ARN': 'string', 'ETag': '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', 'OriginReadTimeout': 123 }, '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 }, 'VpcOriginConfig': { 'VpcOriginId': 'string', 'OriginReadTimeout': 123, 'OriginKeepaliveTimeout': 123 }, 'ConnectionAttempts': 123, 'ConnectionTimeout': 123, 'ResponseCompletionTimeout': 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' }, ] }, 'SelectionCriteria': 'default'|'media-quality-based' }, ] }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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'|'None', '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'|'TLSv1.3_2025', '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' }, ], 'Staging': True|False, 'ConnectionMode': 'direct'|'tenant-only', 'AnycastIpListId': 'string' }, ] }, 'NextToken': 'string' } **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::12 3456789012:distribution/EDFDVBD632BHDS5", where "123456789012" is your Amazon Web Services account ID. * **ETag** *(string) --* The current version of the distribution. * **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. * *(string) --* * **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: * Use "S3OriginConfig" to specify an Amazon S3 bucket that is not configured with static website hosting. * Use "VpcOriginConfig" to specify a VPC origin. * Use "CustomOriginConfig" to specify all other kinds of origins, including: * An Amazon S3 bucket that is configured with static website hosting * An Elastic Load Balancing load balancer * An Elemental MediaPackage endpoint * An Elemental MediaStore container * Any other HTTP server, running on an Amazon EC2 instance or any other kind of host For the current maximum number of origins that you can specify per distribution, see General Quotas on Web Distributions in the *Amazon CloudFront Developer Guide* (quotas were formerly referred to as limits). * **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 "OriginCustomHeader" element for each custom header that you want CloudFront to forward to the origin. If Quantity is "0", omit "Items". * *(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) --* Note: If you're using origin access control (OAC) instead of origin access identity, specify an empty "OriginAccessIdentity" element. For more information, see Restricting access to an Amazon Web Services in the *Amazon CloudFront Developer Guide*. 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" The "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*. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see Response timeout 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. * *(string) --* * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) in the *Amazon CloudFront Developer Guide*. * **VpcOriginConfig** *(dict) --* The VPC origin configuration. * **VpcOriginId** *(string) --* The VPC origin ID. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) 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*. * **ResponseCompletionTimeout** *(integer) --* The time (in seconds) that a request from CloudFront to the origin can stay open and wait for a response. If the complete response isn't received from the origin by this time, CloudFront ends the connection. The value for "ResponseCompletionTimeout" must be equal to or greater than the value for "OriginReadTimeout". If you don't set a value for "ResponseCompletionTimeout", CloudFront doesn't enforce a maximum value. For more information, see Response completion 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 secondary 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 specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the secondary origin under the failover conditions that you've chosen. Optionally, you can choose selection criteria for your origin group to specify how your origins are selected when your distribution routes viewer requests. * **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. * *(integer) --* * **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. * **SelectionCriteria** *(string) --* The selection criteria for the origin group. For more information, see Create an origin group in the *Amazon CloudFront Developer Guide*. * **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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **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. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access- Control-Request-Method, Access-Control-Request- Headers, and Origin headers for the responses to be cached correctly. * **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. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(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. Your 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. Your 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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. * *(string) --* * **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. * *(string) --* * **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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **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 specify an empty individual "CacheBehavior" element, because this is invalid. For more information, see CacheBehaviors. 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. Warning: If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the "Cache-Control: no- cache", "no-store", or "private" directives are present in the origin headers. 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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **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. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access- Control-Request-Headers, and Origin headers for the responses to be cached correctly. * **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. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(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. Your 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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. * *(string) --* * **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. * *(string) --* * **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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **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: * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. * How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the *Amazon CloudFront Developer Guide*. * **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: * The value of "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/*". * The value of "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: * Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute "200", the response typically won't be intercepted. * If you don't care about distinguishing among different client errors or server errors, you can specify "400" or "500" as the "ResponseCode" for all 4xx or 5xx errors. * You might want to return a "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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) * "MinimumProtocolVersion" * "SSLSupportMethod" * **IAMCertificateId** *(string) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 ServicesSupport 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: * The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers. * The ciphers that CloudFront can use to encrypt the content that it returns to viewers. 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: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **CertificateSource** *(string) --* This field is deprecated. Use one of the following fields instead: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **Restrictions** *(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. * *(string) --* * **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 Amazon Web Services Regions outside of China. The status values returned are the following: * **APPROVED** indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED, that is, valid to use with the China Regions, a CNAME must have one ICP recordal number associated with it. * **SUSPENDED** indicates that the associated CNAME does not have a valid ICP recordal number. * **PENDING** indicates that CloudFront can't determine the ICP recordal status of the CNAME associated with the distribution because there was an error in trying to determine the status. You can try again to see if the error is resolved in which case CloudFront returns an APPROVED or SUSPENDED status. * **Staging** *(boolean) --* A Boolean that indicates whether this is a staging distribution. When this value is "true", this is a staging distribution. When this value is "false", this is not a staging distribution. * **ConnectionMode** *(string) --* This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only). * **AnycastIpListId** *(string) --* ID of the Anycast static IP list that is associated with the distribution. * **NextToken** *(string) --* A token to resume pagination. CloudFront / Paginator / ListDistributionsByConnectionMode ListDistributionsByConnectionMode ********************************* class CloudFront.Paginator.ListDistributionsByConnectionMode paginator = client.get_paginator('list_distributions_by_connection_mode') paginate(**kwargs) Creates an iterator that will paginate through responses from "CloudFront.Client.list_distributions_by_connection_mode()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ConnectionMode='direct'|'tenant-only', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ConnectionMode** (*string*) -- **[REQUIRED]** This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only). * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'DistributionList': { 'Marker': 'string', 'NextMarker': 'string', 'MaxItems': 123, 'IsTruncated': True|False, 'Quantity': 123, 'Items': [ { 'Id': 'string', 'ARN': 'string', 'ETag': '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', 'OriginReadTimeout': 123 }, '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 }, 'VpcOriginConfig': { 'VpcOriginId': 'string', 'OriginReadTimeout': 123, 'OriginKeepaliveTimeout': 123 }, 'ConnectionAttempts': 123, 'ConnectionTimeout': 123, 'ResponseCompletionTimeout': 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' }, ] }, 'SelectionCriteria': 'default'|'media-quality-based' }, ] }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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'|'None', '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'|'TLSv1.3_2025', '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' }, ], 'Staging': True|False, 'ConnectionMode': 'direct'|'tenant-only', 'AnycastIpListId': 'string' }, ] }, 'NextToken': 'string' } **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::12 3456789012:distribution/EDFDVBD632BHDS5", where "123456789012" is your Amazon Web Services account ID. * **ETag** *(string) --* The current version of the distribution. * **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. * *(string) --* * **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: * Use "S3OriginConfig" to specify an Amazon S3 bucket that is not configured with static website hosting. * Use "VpcOriginConfig" to specify a VPC origin. * Use "CustomOriginConfig" to specify all other kinds of origins, including: * An Amazon S3 bucket that is configured with static website hosting * An Elastic Load Balancing load balancer * An Elemental MediaPackage endpoint * An Elemental MediaStore container * Any other HTTP server, running on an Amazon EC2 instance or any other kind of host For the current maximum number of origins that you can specify per distribution, see General Quotas on Web Distributions in the *Amazon CloudFront Developer Guide* (quotas were formerly referred to as limits). * **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 "OriginCustomHeader" element for each custom header that you want CloudFront to forward to the origin. If Quantity is "0", omit "Items". * *(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) --* Note: If you're using origin access control (OAC) instead of origin access identity, specify an empty "OriginAccessIdentity" element. For more information, see Restricting access to an Amazon Web Services in the *Amazon CloudFront Developer Guide*. 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" The "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*. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see Response timeout 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. * *(string) --* * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) in the *Amazon CloudFront Developer Guide*. * **VpcOriginConfig** *(dict) --* The VPC origin configuration. * **VpcOriginId** *(string) --* The VPC origin ID. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) 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*. * **ResponseCompletionTimeout** *(integer) --* The time (in seconds) that a request from CloudFront to the origin can stay open and wait for a response. If the complete response isn't received from the origin by this time, CloudFront ends the connection. The value for "ResponseCompletionTimeout" must be equal to or greater than the value for "OriginReadTimeout". If you don't set a value for "ResponseCompletionTimeout", CloudFront doesn't enforce a maximum value. For more information, see Response completion 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 secondary 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 specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the secondary origin under the failover conditions that you've chosen. Optionally, you can choose selection criteria for your origin group to specify how your origins are selected when your distribution routes viewer requests. * **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. * *(integer) --* * **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. * **SelectionCriteria** *(string) --* The selection criteria for the origin group. For more information, see Create an origin group in the *Amazon CloudFront Developer Guide*. * **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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **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. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access- Control-Request-Method, Access-Control-Request- Headers, and Origin headers for the responses to be cached correctly. * **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. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(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. Your 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. Your 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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. * *(string) --* * **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. * *(string) --* * **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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **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 specify an empty individual "CacheBehavior" element, because this is invalid. For more information, see CacheBehaviors. 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. Warning: If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the "Cache-Control: no- cache", "no-store", or "private" directives are present in the origin headers. 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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **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. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access- Control-Request-Headers, and Origin headers for the responses to be cached correctly. * **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. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(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. Your 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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. * *(string) --* * **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. * *(string) --* * **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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **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: * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. * How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the *Amazon CloudFront Developer Guide*. * **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: * The value of "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/*". * The value of "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: * Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute "200", the response typically won't be intercepted. * If you don't care about distinguishing among different client errors or server errors, you can specify "400" or "500" as the "ResponseCode" for all 4xx or 5xx errors. * You might want to return a "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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) * "MinimumProtocolVersion" * "SSLSupportMethod" * **IAMCertificateId** *(string) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 ServicesSupport 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: * The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers. * The ciphers that CloudFront can use to encrypt the content that it returns to viewers. 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: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **CertificateSource** *(string) --* This field is deprecated. Use one of the following fields instead: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **Restrictions** *(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. * *(string) --* * **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 Amazon Web Services Regions outside of China. The status values returned are the following: * **APPROVED** indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED, that is, valid to use with the China Regions, a CNAME must have one ICP recordal number associated with it. * **SUSPENDED** indicates that the associated CNAME does not have a valid ICP recordal number. * **PENDING** indicates that CloudFront can't determine the ICP recordal status of the CNAME associated with the distribution because there was an error in trying to determine the status. You can try again to see if the error is resolved in which case CloudFront returns an APPROVED or SUSPENDED status. * **Staging** *(boolean) --* A Boolean that indicates whether this is a staging distribution. When this value is "true", this is a staging distribution. When this value is "false", this is not a staging distribution. * **ConnectionMode** *(string) --* This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only). * **AnycastIpListId** *(string) --* ID of the Anycast static IP list that is associated with the distribution. * **NextToken** *(string) --* A token to resume pagination. CloudFront / Paginator / ListDistributionTenantsByCustomization ListDistributionTenantsByCustomization ************************************** class CloudFront.Paginator.ListDistributionTenantsByCustomization paginator = client.get_paginator('list_distribution_tenants_by_customization') paginate(**kwargs) Creates an iterator that will paginate through responses from " CloudFront.Client.list_distribution_tenants_by_customization()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( WebACLArn='string', CertificateArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **WebACLArn** (*string*) -- Filter by the ARN of the associated WAF web ACL. * **CertificateArn** (*string*) -- Filter by the ARN of the associated ACM certificate. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'DistributionTenantList': [ { 'Id': 'string', 'DistributionId': 'string', 'Name': 'string', 'Arn': 'string', 'Domains': [ { 'Domain': 'string', 'Status': 'active'|'inactive' }, ], 'ConnectionGroupId': 'string', 'Customizations': { 'WebAcl': { 'Action': 'override'|'disable', 'Arn': 'string' }, 'Certificate': { 'Arn': 'string' }, 'GeoRestrictions': { 'RestrictionType': 'blacklist'|'whitelist'|'none', 'Locations': [ 'string', ] } }, 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'ETag': 'string', 'Enabled': True|False, 'Status': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **DistributionTenantList** *(list) --* A list of distribution tenants with the specified customization. * *(dict) --* A summary of the information about a distribution tenant. * **Id** *(string) --* The ID of the distribution tenant. * **DistributionId** *(string) --* The identifier for the multi-tenant distribution. For example: "EDFDVBD632BHDS5". * **Name** *(string) --* The name of the distribution tenant. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the distribution tenant. * **Domains** *(list) --* The domains associated with the distribution tenant. * *(dict) --* The details about the domain result. * **Domain** *(string) --* The specified domain. * **Status** *(string) --* Whether the domain is active or inactive. * **ConnectionGroupId** *(string) --* The ID of the connection group ID for the distribution tenant. If you don't specify a connection group, CloudFront uses the default connection group. * **Customizations** *(dict) --* Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant. * **WebAcl** *(dict) --* The WAF web ACL. * **Action** *(string) --* The action for the WAF web ACL customization. You can specify "override" to specify a separate WAF web ACL for the distribution tenant. If you specify "disable", the distribution tenant won't have WAF web ACL protections and won't inherit from the multi-tenant distribution. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the WAF web ACL. * **Certificate** *(dict) --* The Certificate Manager (ACM) certificate. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the ACM certificate. * **GeoRestrictions** *(dict) --* The geographic restrictions. * **RestrictionType** *(string) --* The method that you want to use to restrict distribution of your content by country: * "none": No geographic 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. * **Locations** *(list) --* The locations for geographic restrictions. * *(string) --* * **CreatedTime** *(datetime) --* The date and time when the distribution tenant was created. * **LastModifiedTime** *(datetime) --* The date and time when the distribution tenant was updated. * **ETag** *(string) --* The current version of the distribution tenant. * **Enabled** *(boolean) --* Indicates whether the distribution tenants are in an enabled state. If disabled, the distribution tenant won't service traffic. * **Status** *(string) --* The status of the distribution tenant. * **NextToken** *(string) --* A token to resume pagination. CloudFront / Paginator / ListKeyValueStores ListKeyValueStores ****************** class CloudFront.Paginator.ListKeyValueStores paginator = client.get_paginator('list_key_value_stores') paginate(**kwargs) Creates an iterator that will paginate through responses from "CloudFront.Client.list_key_value_stores()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Status='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Status** (*string*) -- The status of the request for the key value stores list. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'KeyValueStoreList': { 'NextMarker': 'string', 'MaxItems': 123, 'Quantity': 123, 'Items': [ { 'Name': 'string', 'Id': 'string', 'Comment': 'string', 'ARN': 'string', 'Status': 'string', 'LastModifiedTime': datetime(2015, 1, 1) }, ] }, 'NextToken': 'string' } **Response Structure** * *(dict) --* * **KeyValueStoreList** *(dict) --* The resulting key value stores list. * **NextMarker** *(string) --* The next marker associated with the key value store list. * **MaxItems** *(integer) --* The maximum number of items in the key value store list. * **Quantity** *(integer) --* The quantity of the key value store list. * **Items** *(list) --* The items of the key value store list. * *(dict) --* The key value store. Use this to separate data from function code, allowing you to update data without having to publish a new version of a function. The key value store holds keys and their corresponding values. * **Name** *(string) --* The name of the key value store. * **Id** *(string) --* The unique Id for the key value store. * **Comment** *(string) --* A comment for the key value store. * **ARN** *(string) --* The Amazon Resource Name (ARN) of the key value store. * **Status** *(string) --* The status of the key value store. * **LastModifiedTime** *(datetime) --* The last-modified time of the key value store. * **NextToken** *(string) --* A token to resume pagination. CloudFront / Paginator / ListDomainConflicts ListDomainConflicts ******************* class CloudFront.Paginator.ListDomainConflicts paginator = client.get_paginator('list_domain_conflicts') paginate(**kwargs) Creates an iterator that will paginate through responses from "CloudFront.Client.list_domain_conflicts()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Domain='string', DomainControlValidationResource={ 'DistributionId': 'string', 'DistributionTenantId': 'string' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Domain** (*string*) -- **[REQUIRED]** The domain to check for conflicts. * **DomainControlValidationResource** (*dict*) -- **[REQUIRED]** The distribution resource identifier. This can be the standard distribution or distribution tenant that has a valid certificate, which covers the domain that you specify. * **DistributionId** *(string) --* The ID of the multi-tenant distribution. * **DistributionTenantId** *(string) --* The ID of the distribution tenant. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'DomainConflicts': [ { 'Domain': 'string', 'ResourceType': 'distribution'|'distribution-tenant', 'ResourceId': 'string', 'AccountId': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **DomainConflicts** *(list) --* Contains details about the domain conflicts. * *(dict) --* Contains information about the domain conflict. Use this information to determine the affected domain, the related resource, and the affected Amazon Web Services account. * **Domain** *(string) --* The domain used to find existing conflicts for domain configurations. * **ResourceType** *(string) --* The CloudFront resource type that has a domain conflict. * **ResourceId** *(string) --* The ID of the resource that has a domain conflict. * **AccountId** *(string) --* The ID of the Amazon Web Services account for the domain conflict. * **NextToken** *(string) --* A token to resume pagination. CloudFront / Paginator / ListPublicKeys ListPublicKeys ************** class CloudFront.Paginator.ListPublicKeys paginator = client.get_paginator('list_public_keys') paginate(**kwargs) Creates an iterator that will paginate through responses from "CloudFront.Client.list_public_keys()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'PublicKeyList': { 'NextMarker': 'string', 'MaxItems': 123, 'Quantity': 123, 'Items': [ { 'Id': 'string', 'Name': 'string', 'CreatedTime': datetime(2015, 1, 1), 'EncodedKey': 'string', 'Comment': 'string' }, ] }, 'NextToken': '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. * **NextToken** *(string) --* A token to resume pagination. CloudFront / Paginator / ListInvalidationsForDistributionTenant ListInvalidationsForDistributionTenant ************************************** class CloudFront.Paginator.ListInvalidationsForDistributionTenant paginator = client.get_paginator('list_invalidations_for_distribution_tenant') paginate(**kwargs) Creates an iterator that will paginate through responses from " CloudFront.Client.list_invalidations_for_distribution_tenant()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Id='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The ID of the distribution tenant. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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) --* * **InvalidationList** *(dict) --* The "InvalidationList" complex type describes the list of invalidation objects. For more information about invalidation, see Invalidating Objects (Web Distributions Only) in the *Amazon CloudFront Developer Guide*. * **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 / ListDistributionTenants ListDistributionTenants *********************** class CloudFront.Paginator.ListDistributionTenants paginator = client.get_paginator('list_distribution_tenants') paginate(**kwargs) Creates an iterator that will paginate through responses from "CloudFront.Client.list_distribution_tenants()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AssociationFilter={ 'DistributionId': 'string', 'ConnectionGroupId': 'string' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AssociationFilter** (*dict*) -- Filter by the associated distribution ID or connection group ID. * **DistributionId** *(string) --* The distribution ID to filter by. You can find distribution tenants associated with a specific distribution. * **ConnectionGroupId** *(string) --* The ID of the connection group to filter by. You can find distribution tenants associated with a specific connection group. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'DistributionTenantList': [ { 'Id': 'string', 'DistributionId': 'string', 'Name': 'string', 'Arn': 'string', 'Domains': [ { 'Domain': 'string', 'Status': 'active'|'inactive' }, ], 'ConnectionGroupId': 'string', 'Customizations': { 'WebAcl': { 'Action': 'override'|'disable', 'Arn': 'string' }, 'Certificate': { 'Arn': 'string' }, 'GeoRestrictions': { 'RestrictionType': 'blacklist'|'whitelist'|'none', 'Locations': [ 'string', ] } }, 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'ETag': 'string', 'Enabled': True|False, 'Status': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **DistributionTenantList** *(list) --* The list of distribution tenants that you retrieved. * *(dict) --* A summary of the information about a distribution tenant. * **Id** *(string) --* The ID of the distribution tenant. * **DistributionId** *(string) --* The identifier for the multi-tenant distribution. For example: "EDFDVBD632BHDS5". * **Name** *(string) --* The name of the distribution tenant. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the distribution tenant. * **Domains** *(list) --* The domains associated with the distribution tenant. * *(dict) --* The details about the domain result. * **Domain** *(string) --* The specified domain. * **Status** *(string) --* Whether the domain is active or inactive. * **ConnectionGroupId** *(string) --* The ID of the connection group ID for the distribution tenant. If you don't specify a connection group, CloudFront uses the default connection group. * **Customizations** *(dict) --* Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant. * **WebAcl** *(dict) --* The WAF web ACL. * **Action** *(string) --* The action for the WAF web ACL customization. You can specify "override" to specify a separate WAF web ACL for the distribution tenant. If you specify "disable", the distribution tenant won't have WAF web ACL protections and won't inherit from the multi-tenant distribution. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the WAF web ACL. * **Certificate** *(dict) --* The Certificate Manager (ACM) certificate. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the ACM certificate. * **GeoRestrictions** *(dict) --* The geographic restrictions. * **RestrictionType** *(string) --* The method that you want to use to restrict distribution of your content by country: * "none": No geographic 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. * **Locations** *(list) --* The locations for geographic restrictions. * *(string) --* * **CreatedTime** *(datetime) --* The date and time when the distribution tenant was created. * **LastModifiedTime** *(datetime) --* The date and time when the distribution tenant was updated. * **ETag** *(string) --* The current version of the distribution tenant. * **Enabled** *(boolean) --* Indicates whether the distribution tenants are in an enabled state. If disabled, the distribution tenant won't service traffic. * **Status** *(string) --* The status of the distribution tenant. * **NextToken** *(string) --* A token to resume pagination. CloudFront / Paginator / ListStreamingDistributions ListStreamingDistributions ************************** class 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' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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'|'None', 'Enabled': True|False }, ] }, 'NextToken': 'string' } **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. * *(string) --* * **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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * **NextToken** *(string) --* A token to resume pagination. CloudFront / Paginator / ListCloudFrontOriginAccessIdentities ListCloudFrontOriginAccessIdentities ************************************ class CloudFront.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' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'CloudFrontOriginAccessIdentityList': { 'Marker': 'string', 'NextMarker': 'string', 'MaxItems': 123, 'IsTruncated': True|False, 'Quantity': 123, 'Items': [ { 'Id': 'string', 'S3CanonicalUserId': 'string', 'Comment': 'string' }, ] }, 'NextToken': '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. * **NextToken** *(string) --* A token to resume pagination. CloudFront / Paginator / ListConnectionGroups ListConnectionGroups ******************** class CloudFront.Paginator.ListConnectionGroups paginator = client.get_paginator('list_connection_groups') paginate(**kwargs) Creates an iterator that will paginate through responses from "CloudFront.Client.list_connection_groups()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AssociationFilter={ 'AnycastIpListId': 'string' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AssociationFilter** (*dict*) -- Filter by associated Anycast IP list ID. * **AnycastIpListId** *(string) --* The ID of the Anycast static IP list. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ConnectionGroups': [ { 'Id': 'string', 'Name': 'string', 'Arn': 'string', 'RoutingEndpoint': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'ETag': 'string', 'AnycastIpListId': 'string', 'Enabled': True|False, 'Status': 'string', 'IsDefault': True|False }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ConnectionGroups** *(list) --* The list of connection groups that you retrieved. * *(dict) --* A summary that contains details about your connection groups. * **Id** *(string) --* The ID of the connection group. * **Name** *(string) --* The name of the connection group. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the connection group. * **RoutingEndpoint** *(string) --* The routing endpoint (also known as the DNS name) that is assigned to the connection group, such as d111111abcdef8.cloudfront.net. * **CreatedTime** *(datetime) --* The date and time when the connection group was created. * **LastModifiedTime** *(datetime) --* The date and time when the connection group was updated. * **ETag** *(string) --* The current version of the connection group. * **AnycastIpListId** *(string) --* The ID of the Anycast static IP list. * **Enabled** *(boolean) --* Whether the connection group is enabled * **Status** *(string) --* The status of the connection group. * **IsDefault** *(boolean) --* Whether the connection group is the default connection group for the distribution tenants. * **NextToken** *(string) --* A token to resume pagination. CloudFront / Paginator / ListInvalidations ListInvalidations ***************** class 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' } ) Parameters: * **DistributionId** (*string*) -- **[REQUIRED]** The distribution's ID. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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 / Client / get_connection_group_by_routing_endpoint get_connection_group_by_routing_endpoint **************************************** CloudFront.Client.get_connection_group_by_routing_endpoint(**kwargs) Gets information about a connection group by using the endpoint that you specify. See also: AWS API Documentation **Request Syntax** response = client.get_connection_group_by_routing_endpoint( RoutingEndpoint='string' ) Parameters: **RoutingEndpoint** (*string*) -- **[REQUIRED]** The routing endpoint for the target connection group, such as d111111abcdef8.cloudfront.net. Return type: dict Returns: **Response Syntax** { 'ConnectionGroup': { 'Id': 'string', 'Name': 'string', 'Arn': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'Tags': { 'Items': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'Ipv6Enabled': True|False, 'RoutingEndpoint': 'string', 'AnycastIpListId': 'string', 'Status': 'string', 'Enabled': True|False, 'IsDefault': True|False }, 'ETag': 'string' } **Response Structure** * *(dict) --* * **ConnectionGroup** *(dict) --* The connection group for your distribution tenants. When you first create a distribution tenant and you don't specify a connection group, CloudFront will automatically create a default connection group for you. When you create a new distribution tenant and don't specify a connection group, the default one will be associated with your distribution tenant. * **Id** *(string) --* The ID of the connection group. * **Name** *(string) --* The name of the connection group. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the connection group. * **CreatedTime** *(datetime) --* The date and time when the connection group was created. * **LastModifiedTime** *(datetime) --* The date and time when the connection group was updated. * **Tags** *(dict) --* A complex type that contains zero or more "Tag" elements. * **Items** *(list) --* A complex type that contains "Tag" elements. * *(dict) --* A complex type that contains "Tag" key and "Tag" value. * **Key** *(string) --* 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 "_ - . : / = + @". * **Value** *(string) --* 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 "_ - . : / = + @". * **Ipv6Enabled** *(boolean) --* IPv6 is enabled for the connection group. * **RoutingEndpoint** *(string) --* The routing endpoint (also known as the DNS name) that is assigned to the connection group, such as d111111abcdef8.cloudfront.net. * **AnycastIpListId** *(string) --* The ID of the Anycast static IP list. * **Status** *(string) --* The status of the connection group. * **Enabled** *(boolean) --* Whether the connection group is enabled. * **IsDefault** *(boolean) --* Whether the connection group is the default connection group for the distribution tenants. * **ETag** *(string) --* The current version of the connection group. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" CloudFront / Client / list_distribution_tenants_by_customization list_distribution_tenants_by_customization ****************************************** CloudFront.Client.list_distribution_tenants_by_customization(**kwargs) Lists distribution tenants by the customization that you specify. You must specify either the "CertificateArn" parameter or "WebACLArn" parameter, but not both in the same request. See also: AWS API Documentation **Request Syntax** response = client.list_distribution_tenants_by_customization( WebACLArn='string', CertificateArn='string', Marker='string', MaxItems=123 ) Parameters: * **WebACLArn** (*string*) -- Filter by the ARN of the associated WAF web ACL. * **CertificateArn** (*string*) -- Filter by the ARN of the associated ACM certificate. * **Marker** (*string*) -- The marker for the next set of results. * **MaxItems** (*integer*) -- The maximum number of distribution tenants to return by the specified customization. Return type: dict Returns: **Response Syntax** { 'NextMarker': 'string', 'DistributionTenantList': [ { 'Id': 'string', 'DistributionId': 'string', 'Name': 'string', 'Arn': 'string', 'Domains': [ { 'Domain': 'string', 'Status': 'active'|'inactive' }, ], 'ConnectionGroupId': 'string', 'Customizations': { 'WebAcl': { 'Action': 'override'|'disable', 'Arn': 'string' }, 'Certificate': { 'Arn': 'string' }, 'GeoRestrictions': { 'RestrictionType': 'blacklist'|'whitelist'|'none', 'Locations': [ 'string', ] } }, 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'ETag': 'string', 'Enabled': True|False, 'Status': 'string' }, ] } **Response Structure** * *(dict) --* * **NextMarker** *(string) --* A token used for pagination of results returned in the response. You can use the token from the previous request to define where the current request should begin. * **DistributionTenantList** *(list) --* A list of distribution tenants with the specified customization. * *(dict) --* A summary of the information about a distribution tenant. * **Id** *(string) --* The ID of the distribution tenant. * **DistributionId** *(string) --* The identifier for the multi-tenant distribution. For example: "EDFDVBD632BHDS5". * **Name** *(string) --* The name of the distribution tenant. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the distribution tenant. * **Domains** *(list) --* The domains associated with the distribution tenant. * *(dict) --* The details about the domain result. * **Domain** *(string) --* The specified domain. * **Status** *(string) --* Whether the domain is active or inactive. * **ConnectionGroupId** *(string) --* The ID of the connection group ID for the distribution tenant. If you don't specify a connection group, CloudFront uses the default connection group. * **Customizations** *(dict) --* Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi- tenant distribution that was used to create the distribution tenant. * **WebAcl** *(dict) --* The WAF web ACL. * **Action** *(string) --* The action for the WAF web ACL customization. You can specify "override" to specify a separate WAF web ACL for the distribution tenant. If you specify "disable", the distribution tenant won't have WAF web ACL protections and won't inherit from the multi-tenant distribution. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the WAF web ACL. * **Certificate** *(dict) --* The Certificate Manager (ACM) certificate. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the ACM certificate. * **GeoRestrictions** *(dict) --* The geographic restrictions. * **RestrictionType** *(string) --* The method that you want to use to restrict distribution of your content by country: * "none": No geographic 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. * **Locations** *(list) --* The locations for geographic restrictions. * *(string) --* * **CreatedTime** *(datetime) --* The date and time when the distribution tenant was created. * **LastModifiedTime** *(datetime) --* The date and time when the distribution tenant was updated. * **ETag** *(string) --* The current version of the distribution tenant. * **Enabled** *(boolean) --* Indicates whether the distribution tenants are in an enabled state. If disabled, the distribution tenant won't service traffic. * **Status** *(string) --* The status of the distribution tenant. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / list_continuous_deployment_policies list_continuous_deployment_policies *********************************** CloudFront.Client.list_continuous_deployment_policies(**kwargs) Gets a list of the continuous deployment policies 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_continuous_deployment_policies( Marker='string', MaxItems='string' ) Parameters: * **Marker** (*string*) -- Use this field when paginating results to indicate where to begin in your list of continuous deployment policies. The response includes policies in the list that occur after the marker. To get the next page of the list, set this field's value to the value of "NextMarker" from the current page's response. * **MaxItems** (*string*) -- The maximum number of continuous deployment policies that you want returned in the response. Return type: dict Returns: **Response Syntax** { 'ContinuousDeploymentPolicyList': { 'NextMarker': 'string', 'MaxItems': 123, 'Quantity': 123, 'Items': [ { 'ContinuousDeploymentPolicy': { 'Id': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'ContinuousDeploymentPolicyConfig': { 'StagingDistributionDnsNames': { 'Quantity': 123, 'Items': [ 'string', ] }, 'Enabled': True|False, 'TrafficConfig': { 'SingleWeightConfig': { 'Weight': ..., 'SessionStickinessConfig': { 'IdleTTL': 123, 'MaximumTTL': 123 } }, 'SingleHeaderConfig': { 'Header': 'string', 'Value': 'string' }, 'Type': 'SingleWeight'|'SingleHeader' } } } }, ] } } **Response Structure** * *(dict) --* * **ContinuousDeploymentPolicyList** *(dict) --* A list of continuous deployment policies. * **NextMarker** *(string) --* Indicates the next page of continuous deployment policies. To get the next page of the list, use this value in the "Marker" field of your request. * **MaxItems** *(integer) --* The maximum number of continuous deployment policies that were specified in your request. * **Quantity** *(integer) --* The total number of continuous deployment policies in your Amazon Web Services account, regardless of the "MaxItems" value. * **Items** *(list) --* A list of continuous deployment policy items. * *(dict) --* A summary of the information about your continuous deployment policies. * **ContinuousDeploymentPolicy** *(dict) --* The continuous deployment policy. * **Id** *(string) --* The identifier of the continuous deployment policy. * **LastModifiedTime** *(datetime) --* The date and time the continuous deployment policy was last modified. * **ContinuousDeploymentPolicyConfig** *(dict) --* Contains the configuration for a continuous deployment policy. * **StagingDistributionDnsNames** *(dict) --* The CloudFront domain name of the staging distribution. For example: "d111111abcdef8.cloudfront.net". * **Quantity** *(integer) --* The number of CloudFront domain names in your staging distribution. * **Items** *(list) --* The CloudFront domain name of the staging distribution. * *(string) --* * **Enabled** *(boolean) --* A Boolean that indicates whether this continuous deployment policy is enabled (in effect). When this value is "true", this policy is enabled and in effect. When this value is "false", this policy is not enabled and has no effect. * **TrafficConfig** *(dict) --* Contains the parameters for routing production traffic from your primary to staging distributions. * **SingleWeightConfig** *(dict) --* Contains the percentage of traffic to send to the staging distribution. * **Weight** *(float) --* The percentage of traffic to send to a staging distribution, expressed as a decimal number between 0 and 0.15. For example, a value of 0.10 means 10% of traffic is sent to the staging distribution. * **SessionStickinessConfig** *(dict) --* Session stickiness provides the ability to define multiple requests from a single viewer as a single session. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution. Define the session duration using TTL values. * **IdleTTL** *(integer) --* The amount of time after which you want sessions to cease if no requests are received. Allowed values are 300–3600 seconds (5–60 minutes). The value must be less than or equal to "MaximumTTL". * **MaximumTTL** *(integer) --* The maximum amount of time to consider requests from the viewer as being part of the same session. Allowed values are 300–3600 seconds (5–60 minutes). The value must be greater than or equal to "IdleTTL". * **SingleHeaderConfig** *(dict) --* Determines which HTTP requests are sent to the staging distribution. * **Header** *(string) --* The request header name that you want CloudFront to send to your staging distribution. The header must contain the prefix "aws-cf-cd-". * **Value** *(string) --* The request header value. * **Type** *(string) --* The type of traffic configuration. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.NoSuchContinuousDeploymentPolicy" CloudFront / Client / create_key_group create_key_group **************** CloudFront.Client.create_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' } ) Parameters: **KeyGroupConfig** (*dict*) -- **[REQUIRED]** A key group configuration. * **Name** *(string) --* **[REQUIRED]** A name to identify the key group. * **Items** *(list) --* **[REQUIRED]** A list of the identifiers of the public keys in the key group. * *(string) --* * **Comment** *(string) --* A comment to describe the key group. The comment cannot be longer than 128 characters. Return type: dict Returns: **Response Syntax** { 'KeyGroup': { 'Id': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'KeyGroupConfig': { 'Name': 'string', 'Items': [ 'string', ], 'Comment': 'string' } }, 'Location': 'string', 'ETag': 'string' } **Response Structure** * *(dict) --* * **KeyGroup** *(dict) --* The key group that was just created. * **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. * *(string) --* * **Comment** *(string) --* A comment to describe the key group. The comment cannot be longer than 128 characters. * **Location** *(string) --* The URL of the key group. * **ETag** *(string) --* The identifier for this version of the key group. **Exceptions** * "CloudFront.Client.exceptions.TooManyPublicKeysInKeyGroup" * "CloudFront.Client.exceptions.TooManyKeyGroups" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.KeyGroupAlreadyExists" CloudFront / Client / update_continuous_deployment_policy update_continuous_deployment_policy *********************************** CloudFront.Client.update_continuous_deployment_policy(**kwargs) Updates a continuous deployment policy. You can update a continuous deployment policy to enable or disable it, to change the percentage of traffic that it sends to the staging distribution, or to change the staging distribution that it sends traffic to. When you update a continuous deployment policy configuration, all the fields are updated with the values that are provided in the request. You cannot update some fields independent of others. To update a continuous deployment policy configuration: * Use "GetContinuousDeploymentPolicyConfig" to get the current configuration. * Locally modify the fields in the continuous deployment policy configuration that you want to update. * Use "UpdateContinuousDeploymentPolicy", providing the entire continuous deployment policy configuration, including the fields that you modified and those that you didn't. See also: AWS API Documentation **Request Syntax** response = client.update_continuous_deployment_policy( ContinuousDeploymentPolicyConfig={ 'StagingDistributionDnsNames': { 'Quantity': 123, 'Items': [ 'string', ] }, 'Enabled': True|False, 'TrafficConfig': { 'SingleWeightConfig': { 'Weight': ..., 'SessionStickinessConfig': { 'IdleTTL': 123, 'MaximumTTL': 123 } }, 'SingleHeaderConfig': { 'Header': 'string', 'Value': 'string' }, 'Type': 'SingleWeight'|'SingleHeader' } }, Id='string', IfMatch='string' ) Parameters: * **ContinuousDeploymentPolicyConfig** (*dict*) -- **[REQUIRED]** The continuous deployment policy configuration. * **StagingDistributionDnsNames** *(dict) --* **[REQUIRED]** The CloudFront domain name of the staging distribution. For example: "d111111abcdef8.cloudfront.net". * **Quantity** *(integer) --* **[REQUIRED]** The number of CloudFront domain names in your staging distribution. * **Items** *(list) --* The CloudFront domain name of the staging distribution. * *(string) --* * **Enabled** *(boolean) --* **[REQUIRED]** A Boolean that indicates whether this continuous deployment policy is enabled (in effect). When this value is "true", this policy is enabled and in effect. When this value is "false", this policy is not enabled and has no effect. * **TrafficConfig** *(dict) --* Contains the parameters for routing production traffic from your primary to staging distributions. * **SingleWeightConfig** *(dict) --* Contains the percentage of traffic to send to the staging distribution. * **Weight** *(float) --* **[REQUIRED]** The percentage of traffic to send to a staging distribution, expressed as a decimal number between 0 and 0.15. For example, a value of 0.10 means 10% of traffic is sent to the staging distribution. * **SessionStickinessConfig** *(dict) --* Session stickiness provides the ability to define multiple requests from a single viewer as a single session. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution. Define the session duration using TTL values. * **IdleTTL** *(integer) --* **[REQUIRED]** The amount of time after which you want sessions to cease if no requests are received. Allowed values are 300–3600 seconds (5–60 minutes). The value must be less than or equal to "MaximumTTL". * **MaximumTTL** *(integer) --* **[REQUIRED]** The maximum amount of time to consider requests from the viewer as being part of the same session. Allowed values are 300–3600 seconds (5–60 minutes). The value must be greater than or equal to "IdleTTL". * **SingleHeaderConfig** *(dict) --* Determines which HTTP requests are sent to the staging distribution. * **Header** *(string) --* **[REQUIRED]** The request header name that you want CloudFront to send to your staging distribution. The header must contain the prefix "aws-cf-cd-". * **Value** *(string) --* **[REQUIRED]** The request header value. * **Type** *(string) --* **[REQUIRED]** The type of traffic configuration. * **Id** (*string*) -- **[REQUIRED]** The identifier of the continuous deployment policy that you are updating. * **IfMatch** (*string*) -- The current version ( "ETag" value) of the continuous deployment policy that you are updating. Return type: dict Returns: **Response Syntax** { 'ContinuousDeploymentPolicy': { 'Id': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'ContinuousDeploymentPolicyConfig': { 'StagingDistributionDnsNames': { 'Quantity': 123, 'Items': [ 'string', ] }, 'Enabled': True|False, 'TrafficConfig': { 'SingleWeightConfig': { 'Weight': ..., 'SessionStickinessConfig': { 'IdleTTL': 123, 'MaximumTTL': 123 } }, 'SingleHeaderConfig': { 'Header': 'string', 'Value': 'string' }, 'Type': 'SingleWeight'|'SingleHeader' } } }, 'ETag': 'string' } **Response Structure** * *(dict) --* * **ContinuousDeploymentPolicy** *(dict) --* A continuous deployment policy. * **Id** *(string) --* The identifier of the continuous deployment policy. * **LastModifiedTime** *(datetime) --* The date and time the continuous deployment policy was last modified. * **ContinuousDeploymentPolicyConfig** *(dict) --* Contains the configuration for a continuous deployment policy. * **StagingDistributionDnsNames** *(dict) --* The CloudFront domain name of the staging distribution. For example: "d111111abcdef8.cloudfront.net". * **Quantity** *(integer) --* The number of CloudFront domain names in your staging distribution. * **Items** *(list) --* The CloudFront domain name of the staging distribution. * *(string) --* * **Enabled** *(boolean) --* A Boolean that indicates whether this continuous deployment policy is enabled (in effect). When this value is "true", this policy is enabled and in effect. When this value is "false", this policy is not enabled and has no effect. * **TrafficConfig** *(dict) --* Contains the parameters for routing production traffic from your primary to staging distributions. * **SingleWeightConfig** *(dict) --* Contains the percentage of traffic to send to the staging distribution. * **Weight** *(float) --* The percentage of traffic to send to a staging distribution, expressed as a decimal number between 0 and 0.15. For example, a value of 0.10 means 10% of traffic is sent to the staging distribution. * **SessionStickinessConfig** *(dict) --* Session stickiness provides the ability to define multiple requests from a single viewer as a single session. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution. Define the session duration using TTL values. * **IdleTTL** *(integer) --* The amount of time after which you want sessions to cease if no requests are received. Allowed values are 300–3600 seconds (5–60 minutes). The value must be less than or equal to "MaximumTTL". * **MaximumTTL** *(integer) --* The maximum amount of time to consider requests from the viewer as being part of the same session. Allowed values are 300–3600 seconds (5–60 minutes). The value must be greater than or equal to "IdleTTL". * **SingleHeaderConfig** *(dict) --* Determines which HTTP requests are sent to the staging distribution. * **Header** *(string) --* The request header name that you want CloudFront to send to your staging distribution. The header must contain the prefix "aws-cf-cd-". * **Value** *(string) --* The request header value. * **Type** *(string) --* The type of traffic configuration. * **ETag** *(string) --* The version identifier for the current version of the continuous deployment policy. **Exceptions** * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.StagingDistributionInUse" * "CloudFront.Client.exceptions.InconsistentQuantities" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.NoSuchContinuousDeploymentPolicy" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / get_paginator get_paginator ************* CloudFront.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "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")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. CloudFront / Client / describe_key_value_store describe_key_value_store ************************ CloudFront.Client.describe_key_value_store(**kwargs) Specifies the key value store and its configuration. See also: AWS API Documentation **Request Syntax** response = client.describe_key_value_store( Name='string' ) Parameters: **Name** (*string*) -- **[REQUIRED]** The name of the key value store. Return type: dict Returns: **Response Syntax** { 'KeyValueStore': { 'Name': 'string', 'Id': 'string', 'Comment': 'string', 'ARN': 'string', 'Status': 'string', 'LastModifiedTime': datetime(2015, 1, 1) }, 'ETag': 'string' } **Response Structure** * *(dict) --* * **KeyValueStore** *(dict) --* The resulting key value store. * **Name** *(string) --* The name of the key value store. * **Id** *(string) --* The unique Id for the key value store. * **Comment** *(string) --* A comment for the key value store. * **ARN** *(string) --* The Amazon Resource Name (ARN) of the key value store. * **Status** *(string) --* The status of the key value store. * **LastModifiedTime** *(datetime) --* The last-modified time of the key value store. * **ETag** *(string) --* The "ETag" of the resulting key value store. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.UnsupportedOperation" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / update_cache_policy update_cache_policy ******************* CloudFront.Client.update_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: * Use "GetCachePolicyConfig" to get the current configuration. * Locally modify the fields in the cache policy configuration that you want to update. * Call "UpdateCachePolicy" by providing the entire cache policy configuration, including the fields that you modified and those that you didn't. Warning: If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the "Cache-Control: no-cache", "no-store", or "private" directives are present in the origin headers. 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' ) Parameters: * **CachePolicyConfig** (*dict*) -- **[REQUIRED]** A cache policy configuration. * **Comment** *(string) --* A comment to describe the cache policy. The comment cannot be longer than 128 characters. * **Name** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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 also included in requests that CloudFront sends to the origin. * **EnableAcceptEncodingGzip** *(boolean) --* **[REQUIRED]** 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: * Normalizes the value of the viewer's "Accept-Encoding" header * Includes the normalized header in the cache key * Includes the normalized header in the request to the origin, if a request is necessary For 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: * Normalizes the value of the viewer's "Accept-Encoding" header * Includes the normalized header in the cache key * Includes the normalized header in the request to the origin, if a request is necessary For 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) --* **[REQUIRED]** An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and in requests that CloudFront sends to the origin. * **HeaderBehavior** *(string) --* **[REQUIRED]** Determines whether any HTTP headers are included in the cache key and in requests that CloudFront sends to the origin. Valid values are: * "none" – No HTTP headers are included in the cache key or 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" – Only the HTTP headers that are listed in the "Headers" type are included in the cache key and in requests that CloudFront sends to the origin. * **Headers** *(dict) --* Contains a list of HTTP header names. * **Quantity** *(integer) --* **[REQUIRED]** The number of header names in the "Items" list. * **Items** *(list) --* A list of HTTP header names. * *(string) --* * **CookiesConfig** *(dict) --* **[REQUIRED]** An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin. * **CookieBehavior** *(string) --* **[REQUIRED]** Determines whether any cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are: * "none" – No cookies in viewer requests are included in the cache key or 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" – Only the cookies in viewer requests that are listed in the "CookieNames" type are included in the cache key and in requests that CloudFront sends to the origin. * "allExcept" – All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, **except** for those that are listed in the "CookieNames" type, which are not included. * "all" – All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. * **Cookies** *(dict) --* Contains a list of cookie names. * **Quantity** *(integer) --* **[REQUIRED]** The number of cookie names in the "Items" list. * **Items** *(list) --* A list of cookie names. * *(string) --* * **QueryStringsConfig** *(dict) --* **[REQUIRED]** 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 in requests that CloudFront sends to the origin. * **QueryStringBehavior** *(string) --* **[REQUIRED]** Determines whether any URL query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are: * "none" – No query strings in viewer requests are included in the cache key or 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" – Only the query strings in viewer requests that are listed in the "QueryStringNames" type are included in the cache key and in requests that CloudFront sends to the origin. * "allExcept" – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, **except** those that are listed in the "QueryStringNames" type, which are not included. * "all" – All query strings in viewer requests are included in the cache key and 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 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) --* **[REQUIRED]** The number of query string names in the "Items" list. * **Items** *(list) --* A list of query string names. * *(string) --* * **Id** (*string*) -- **[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". * **IfMatch** (*string*) -- The version of the cache policy that you are updating. The version is returned in the cache policy's "ETag" field in the response to "GetCachePolicyConfig". Return type: dict Returns: **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 also 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: * Normalizes the value of the viewer's "Accept- Encoding" header * Includes the normalized header in the cache key * Includes the normalized header in the request to the origin, if a request is necessary For 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: * Normalizes the value of the viewer's "Accept- Encoding" header * Includes the normalized header in the cache key * Includes the normalized header in the request to the origin, if a request is necessary For 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 in requests that CloudFront sends to the origin. * **HeaderBehavior** *(string) --* Determines whether any HTTP headers are included in the cache key and in requests that CloudFront sends to the origin. Valid values are: * "none" – No HTTP headers are included in the cache key or 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" – Only the HTTP headers that are listed in the "Headers" type are included in the cache key and 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. * *(string) --* * **CookiesConfig** *(dict) --* An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin. * **CookieBehavior** *(string) --* Determines whether any cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are: * "none" – No cookies in viewer requests are included in the cache key or 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" – Only the cookies in viewer requests that are listed in the "CookieNames" type are included in the cache key and in requests that CloudFront sends to the origin. * "allExcept" – All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, **except** for those that are listed in the "CookieNames" type, which are not included. * "all" – All cookies in viewer requests are included in the cache key and 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. * *(string) --* * **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 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 in requests that CloudFront sends to the origin. Valid values are: * "none" – No query strings in viewer requests are included in the cache key or 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" – Only the query strings in viewer requests that are listed in the "QueryStringNames" type are included in the cache key and in requests that CloudFront sends to the origin. * "allExcept" – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, **except** those that are listed in the "QueryStringNames" type, which are not included. * "all" – All query strings in viewer requests are included in the cache key and 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 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. * *(string) --* * **ETag** *(string) --* The current version of the cache policy. **Exceptions** * "CloudFront.Client.exceptions.NoSuchCachePolicy" * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.TooManyHeadersInCachePolicy" * "CloudFront.Client.exceptions.CachePolicyAlreadyExists" * "CloudFront.Client.exceptions.TooManyCookiesInCachePolicy" * "CloudFront.Client.exceptions.InconsistentQuantities" * "CloudFront.Client.exceptions.IllegalUpdate" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.TooManyQueryStringsInCachePolicy" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / list_distributions_by_response_headers_policy_id list_distributions_by_response_headers_policy_id ************************************************ CloudFront.Client.list_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' ) Parameters: * **Marker** (*string*) -- Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field's value to the value of "NextMarker" from the current page's response. * **MaxItems** (*string*) -- The maximum number of distribution IDs that you want to get in the response. * **ResponseHeadersPolicyId** (*string*) -- **[REQUIRED]** The ID of the response headers policy whose associated distribution IDs you want to list. Return type: dict Returns: **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. * *(string) --* **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.NoSuchResponseHeadersPolicy" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / list_distributions_by_connection_mode list_distributions_by_connection_mode ************************************* CloudFront.Client.list_distributions_by_connection_mode(**kwargs) Lists the distributions by the connection mode that you specify. See also: AWS API Documentation **Request Syntax** response = client.list_distributions_by_connection_mode( Marker='string', MaxItems=123, ConnectionMode='direct'|'tenant-only' ) Parameters: * **Marker** (*string*) -- The marker for the next set of distributions to retrieve. * **MaxItems** (*integer*) -- The maximum number of distributions to return. * **ConnectionMode** (*string*) -- **[REQUIRED]** This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only). Return type: dict Returns: **Response Syntax** { 'DistributionList': { 'Marker': 'string', 'NextMarker': 'string', 'MaxItems': 123, 'IsTruncated': True|False, 'Quantity': 123, 'Items': [ { 'Id': 'string', 'ARN': 'string', 'ETag': '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', 'OriginReadTimeout': 123 }, '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 }, 'VpcOriginConfig': { 'VpcOriginId': 'string', 'OriginReadTimeout': 123, 'OriginKeepaliveTimeout': 123 }, 'ConnectionAttempts': 123, 'ConnectionTimeout': 123, 'ResponseCompletionTimeout': 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' }, ] }, 'SelectionCriteria': 'default'|'media-quality-based' }, ] }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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'|'None', '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'|'TLSv1.3_2025', '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' }, ], 'Staging': True|False, 'ConnectionMode': 'direct'|'tenant-only', 'AnycastIpListId': 'string' }, ] } } **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:distri bution/EDFDVBD632BHDS5", where "123456789012" is your Amazon Web Services account ID. * **ETag** *(string) --* The current version of the distribution. * **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. * *(string) --* * **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: * Use "S3OriginConfig" to specify an Amazon S3 bucket that is not configured with static website hosting. * Use "VpcOriginConfig" to specify a VPC origin. * Use "CustomOriginConfig" to specify all other kinds of origins, including: * An Amazon S3 bucket that is configured with static website hosting * An Elastic Load Balancing load balancer * An Elemental MediaPackage endpoint * An Elemental MediaStore container * Any other HTTP server, running on an Amazon EC2 instance or any other kind of host For the current maximum number of origins that you can specify per distribution, see General Quotas on Web Distributions in the *Amazon CloudFront Developer Guide* (quotas were formerly referred to as limits). * **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 "OriginCustomHeader" element for each custom header that you want CloudFront to forward to the origin. If Quantity is "0", omit "Items". * *(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) --* Note: If you're using origin access control (OAC) instead of origin access identity, specify an empty "OriginAccessIdentity" element. For more information, see Restricting access to an Amazon Web Services in the *Amazon CloudFront Developer Guide*. 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" The "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*. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see Response timeout 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. * *(string) --* * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) in the *Amazon CloudFront Developer Guide*. * **VpcOriginConfig** *(dict) --* The VPC origin configuration. * **VpcOriginId** *(string) --* The VPC origin ID. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) 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*. * **ResponseCompletionTimeout** *(integer) --* The time (in seconds) that a request from CloudFront to the origin can stay open and wait for a response. If the complete response isn't received from the origin by this time, CloudFront ends the connection. The value for "ResponseCompletionTimeout" must be equal to or greater than the value for "OriginReadTimeout". If you don't set a value for "ResponseCompletionTimeout", CloudFront doesn't enforce a maximum value. For more information, see Response completion 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 secondary 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 specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the secondary origin under the failover conditions that you've chosen. Optionally, you can choose selection criteria for your origin group to specify how your origins are selected when your distribution routes viewer requests. * **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. * *(integer) --* * **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. * **SelectionCriteria** *(string) --* The selection criteria for the origin group. For more information, see Create an origin group in the *Amazon CloudFront Developer Guide*. * **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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **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. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control- Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. * **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. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(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. Your 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. Your 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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. * *(string) --* * **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. * *(string) --* * **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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **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 specify an empty individual "CacheBehavior" element, because this is invalid. For more information, see CacheBehaviors. 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. Warning: If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the "Cache-Control: no-cache", "no- store", or "private" directives are present in the origin headers. 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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **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. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access- Control-Request-Method, Access-Control- Request-Headers, and Origin headers for the responses to be cached correctly. * **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. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(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. Your 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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. * *(string) --* * **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. * *(string) --* * **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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **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: * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. * How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the *Amazon CloudFront Developer Guide*. * **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: * The value of "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/*". * The value of "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: * Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute "200", the response typically won't be intercepted. * If you don't care about distinguishing among different client errors or server errors, you can specify "400" or "500" as the "ResponseCode" for all 4xx or 5xx errors. * You might want to return a "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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) * "MinimumProtocolVersion" * "SSLSupportMethod" * **IAMCertificateId** *(string) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 ServicesSupport 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: * The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers. * The ciphers that CloudFront can use to encrypt the content that it returns to viewers. 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: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **CertificateSource** *(string) --* This field is deprecated. Use one of the following fields instead: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **Restrictions** *(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. * *(string) --* * **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 Amazon Web Services Regions outside of China. The status values returned are the following: * **APPROVED** indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED, that is, valid to use with the China Regions, a CNAME must have one ICP recordal number associated with it. * **SUSPENDED** indicates that the associated CNAME does not have a valid ICP recordal number. * **PENDING** indicates that CloudFront can't determine the ICP recordal status of the CNAME associated with the distribution because there was an error in trying to determine the status. You can try again to see if the error is resolved in which case CloudFront returns an APPROVED or SUSPENDED status. * **Staging** *(boolean) --* A Boolean that indicates whether this is a staging distribution. When this value is "true", this is a staging distribution. When this value is "false", this is not a staging distribution. * **ConnectionMode** *(string) --* This field specifies whether the connection mode is through a standard distribution (direct) or a multi- tenant distribution with distribution tenants (tenant- only). * **AnycastIpListId** *(string) --* ID of the Anycast static IP list that is associated with the distribution. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / delete_public_key delete_public_key ***************** CloudFront.Client.delete_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' ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The ID of the public key you want to remove from CloudFront. * **IfMatch** (*string*) -- The value of the "ETag" header that you received when retrieving the public key identity to delete. For example: "E2QWRUHAPOMQZL". Returns: None **Exceptions** * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.NoSuchPublicKey" * "CloudFront.Client.exceptions.PublicKeyInUse" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / create_distribution_with_tags create_distribution_with_tags ***************************** CloudFront.Client.create_distribution_with_tags(**kwargs) Create a new distribution with tags. This API operation requires the following IAM permissions: * CreateDistribution * TagResource 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', 'OriginReadTimeout': 123 }, '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 }, 'VpcOriginConfig': { 'VpcOriginId': 'string', 'OriginReadTimeout': 123, 'OriginKeepaliveTimeout': 123 }, 'ConnectionAttempts': 123, 'ConnectionTimeout': 123, 'ResponseCompletionTimeout': 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' }, ] }, 'SelectionCriteria': 'default'|'media-quality-based' }, ] }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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'|'None', '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'|'TLSv1.3_2025', '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, 'ContinuousDeploymentPolicyId': 'string', 'Staging': True|False, 'AnycastIpListId': 'string', 'TenantConfig': { 'ParameterDefinitions': [ { 'Name': 'string', 'Definition': { 'StringSchema': { 'Comment': 'string', 'DefaultValue': 'string', 'Required': True|False } } }, ] }, 'ConnectionMode': 'direct'|'tenant-only' }, 'Tags': { 'Items': [ { 'Key': 'string', 'Value': 'string' }, ] } } ) Parameters: **DistributionConfigWithTags** (*dict*) -- **[REQUIRED]** The distribution's configuration information. * **DistributionConfig** *(dict) --* **[REQUIRED]** A distribution configuration. * **CallerReference** *(string) --* **[REQUIRED]** 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution. * **Quantity** *(integer) --* **[REQUIRED]** 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. * *(string) --* * **DefaultRootObject** *(string) --* When a viewer requests the root URL for your distribution, the default root object is the object that you want CloudFront to request from your origin. For example, if your root URL is "https://www.example.com", you can specify CloudFront to return the "index.html" file as the default root object. You can specify a default root object so that viewers see a specific file or object, instead of another object in your distribution (for example, "https://www.example.com/product-description.html"). A default root object avoids exposing the contents of your distribution. You can specify the object name or a path to the object name (for example, "index.html" or "exampleFolderName/index.html"). Your string can't begin with a forward slash ( "/"). Only specify the object name or the path to the object. 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 Specify a default root object in the *Amazon CloudFront Developer Guide*. * **Origins** *(dict) --* **[REQUIRED]** A complex type that contains information about origins for this distribution. * **Quantity** *(integer) --* **[REQUIRED]** The number of origins for this distribution. * **Items** *(list) --* **[REQUIRED]** 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: * Use "S3OriginConfig" to specify an Amazon S3 bucket that is not configured with static website hosting. * Use "VpcOriginConfig" to specify a VPC origin. * Use "CustomOriginConfig" to specify all other kinds of origins, including: * An Amazon S3 bucket that is configured with static website hosting * An Elastic Load Balancing load balancer * An Elemental MediaPackage endpoint * An Elemental MediaStore container * Any other HTTP server, running on an Amazon EC2 instance or any other kind of host For the current maximum number of origins that you can specify per distribution, see General Quotas on Web Distributions in the *Amazon CloudFront Developer Guide* (quotas were formerly referred to as limits). * **Id** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of custom headers, if any, for this distribution. * **Items** *(list) --* **Optional**: A list that contains one "OriginCustomHeader" element for each custom header that you want CloudFront to forward to the origin. If Quantity is "0", omit "Items". * *(dict) --* A complex type that contains "HeaderName" and "HeaderValue" elements, if any, for this distribution. * **HeaderName** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** Note: If you're using origin access control (OAC) instead of origin access identity, specify an empty "OriginAccessIdentity" element. For more information, see Restricting access to an Amazon Web Services in the *Amazon CloudFront Developer Guide*. 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" The "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*. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see Response timeout 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) --* **[REQUIRED]** The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on. * **HTTPSPort** *(integer) --* **[REQUIRED]** The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on. * **OriginProtocolPolicy** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin. * **Items** *(list) --* **[REQUIRED]** A list that contains allowed SSL/TLS protocols for this distribution. * *(string) --* * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) in the *Amazon CloudFront Developer Guide*. * **VpcOriginConfig** *(dict) --* The VPC origin configuration. * **VpcOriginId** *(string) --* **[REQUIRED]** The VPC origin ID. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) 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*. * **ResponseCompletionTimeout** *(integer) --* The time (in seconds) that a request from CloudFront to the origin can stay open and wait for a response. If the complete response isn't received from the origin by this time, CloudFront ends the connection. The value for "ResponseCompletionTimeout" must be equal to or greater than the value for "OriginReadTimeout". If you don't set a value for "ResponseCompletionTimeout", CloudFront doesn't enforce a maximum value. For more information, see Response completion 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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 secondary 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 specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the secondary origin under the failover conditions that you've chosen. Optionally, you can choose selection criteria for your origin group to specify how your origins are selected when your distribution routes viewer requests. * **Id** *(string) --* **[REQUIRED]** The origin group's ID. * **FailoverCriteria** *(dict) --* **[REQUIRED]** A complex type that contains information about the failover criteria for an origin group. * **StatusCodes** *(dict) --* **[REQUIRED]** The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin. * **Quantity** *(integer) --* **[REQUIRED]** The number of status codes. * **Items** *(list) --* **[REQUIRED]** The items (status codes) for an origin group. * *(integer) --* * **Members** *(dict) --* **[REQUIRED]** A complex type that contains information about the origins in an origin group. * **Quantity** *(integer) --* **[REQUIRED]** The number of origins in an origin group. * **Items** *(list) --* **[REQUIRED]** Items (origins) in an origin group. * *(dict) --* An origin in an origin group. * **OriginId** *(string) --* **[REQUIRED]** The ID for an origin in an origin group. * **SelectionCriteria** *(string) --* The selection criteria for the origin group. For more information, see Create an origin group in the *Amazon CloudFront Developer Guide*. * **DefaultCacheBehavior** *(dict) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* **[REQUIRED]** This field is "true" if any of the Amazon Web Services accounts in the list are configured as trusted signers. If not, this field is "false". * **Quantity** *(integer) --* **[REQUIRED]** The number of Amazon Web Services accounts in the list. * **Items** *(list) --* A list of Amazon Web Services account identifiers. * *(string) --* * **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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of key groups in the list. * **Items** *(list) --* A list of key groups identifiers. * *(string) --* * **ViewerProtocolPolicy** *(string) --* **[REQUIRED]** 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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **Quantity** *(integer) --* **[REQUIRED]** 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) --* **[REQUIRED]** A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. * **Quantity** *(integer) --* **[REQUIRED]** 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) --* **[REQUIRED]** A complex type that contains the HTTP methods that you want CloudFront to cache responses to. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* **[REQUIRED]** The number of Lambda@Edge function associations for this cache behavior. * **Items** *(list) --* **Optional**: A complex type that contains "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(dict) --* A complex type that contains a Lambda@Edge function association. * **LambdaFunctionARN** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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. Your functions must be published to the "LIVE" stage to associate them with a cache behavior. * **Quantity** *(integer) --* **[REQUIRED]** The number of CloudFront functions in the list. * **Items** *(list) --* The CloudFront functions that are associated with a cache behavior in a CloudFront distribution. Your 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) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the function. * **EventType** *(string) --* **[REQUIRED]** 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* **[REQUIRED]** Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of cookie names in the "Items" list. * **Items** *(list) --* A list of cookie names. * *(string) --* * **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) --* **[REQUIRED]** The number of header names in the "Items" list. * **Items** *(list) --* A list of HTTP header names. * *(string) --* * **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) --* **[REQUIRED]** 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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **CacheBehaviors** *(dict) --* A complex type that contains zero or more "CacheBehavior" elements. * **Quantity** *(integer) --* **[REQUIRED]** 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 specify an empty individual "CacheBehavior" element, because this is invalid. For more information, see CacheBehaviors. 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. Warning: If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the "Cache- Control: no-cache", "no-store", or "private" directives are present in the origin headers. For more information about cache behaviors, see Cache Behavior Settings in the *Amazon CloudFront Developer Guide*. * **PathPattern** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* **[REQUIRED]** This field is "true" if any of the Amazon Web Services accounts in the list are configured as trusted signers. If not, this field is "false". * **Quantity** *(integer) --* **[REQUIRED]** The number of Amazon Web Services accounts in the list. * **Items** *(list) --* A list of Amazon Web Services account identifiers. * *(string) --* * **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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of key groups in the list. * **Items** *(list) --* A list of key groups identifiers. * *(string) --* * **ViewerProtocolPolicy** *(string) --* **[REQUIRED]** 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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **Quantity** *(integer) --* **[REQUIRED]** 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) --* **[REQUIRED]** A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control- Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. * **Quantity** *(integer) --* **[REQUIRED]** 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) --* **[REQUIRED]** A complex type that contains the HTTP methods that you want CloudFront to cache responses to. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* **[REQUIRED]** The number of Lambda@Edge function associations for this cache behavior. * **Items** *(list) --* **Optional**: A complex type that contains "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(dict) --* A complex type that contains a Lambda@Edge function association. * **LambdaFunctionARN** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of CloudFront functions in the list. * **Items** *(list) --* The CloudFront functions that are associated with a cache behavior in a CloudFront distribution. Your 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) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the function. * **EventType** *(string) --* **[REQUIRED]** 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* **[REQUIRED]** Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of cookie names in the "Items" list. * **Items** *(list) --* A list of cookie names. * *(string) --* * **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) --* **[REQUIRED]** The number of header names in the "Items" list. * **Items** *(list) --* A list of HTTP header names. * *(string) --* * **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) --* **[REQUIRED]** 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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **CustomErrorResponses** *(dict) --* A complex type that controls the following: * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. * How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the *Amazon CloudFront Developer Guide*. * **Quantity** *(integer) --* **[REQUIRED]** 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: * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. * How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the *Amazon CloudFront Developer Guide*. * **ErrorCode** *(integer) --* **[REQUIRED]** 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: * The value of "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/*". * The value of "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: * Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute "200", the response typically won't be intercepted. * If you don't care about distinguishing among different client errors or server errors, you can specify "400" or "500" as the "ResponseCode" for all 4xx or 5xx errors. * You might want to return a "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) --* **[REQUIRED]** A 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" and "prefix", 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, "amzn-s3-demo-bucket.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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* **[REQUIRED]** 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) * "MinimumProtocolVersion" * "SSLSupportMethod" * **IAMCertificateId** *(string) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 ServicesSupport 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: * The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers. * The ciphers that CloudFront can use to encrypt the content that it returns to viewers. 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: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **CertificateSource** *(string) --* This field is deprecated. Use one of the following fields instead: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **Restrictions** *(dict) --* A complex type that identifies ways in which you want to restrict distribution of your content. * **GeoRestriction** *(dict) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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. * *(string) --* * **WebACLId** *(string) --* Note: Multi-tenant distributions only support WAF V2 web ACLs. 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/we bacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111". To specify a web ACL created using WAF Classic, use the ACL ID, for example "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111". 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 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) --* Note: To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup. 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: * You enable IPv6 for the distribution * You're using alternate domain names in the URLs for your objects 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. * **ContinuousDeploymentPolicyId** *(string) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. The identifier of a continuous deployment policy. For more information, see "CreateContinuousDeploymentPolicy". * **Staging** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. A Boolean that indicates whether this is a staging distribution. When this value is "true", this is a staging distribution. When this value is "false", this is not a staging distribution. * **AnycastIpListId** *(string) --* Note: To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup. ID of the Anycast static IP list that is associated with the distribution. * **TenantConfig** *(dict) --* Note: This field only supports multi-tenant distributions. You can't specify this field for standard distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. A distribution tenant configuration. * **ParameterDefinitions** *(list) --* The parameters that you specify for a distribution tenant. * *(dict) --* A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution. * **Name** *(string) --* **[REQUIRED]** The name of the parameter. * **Definition** *(dict) --* **[REQUIRED]** The value that you assigned to the parameter. * **StringSchema** *(dict) --* An object that contains information about the string schema. * **Comment** *(string) --* A comment to describe the parameter. * **DefaultValue** *(string) --* The default value of the parameter. * **Required** *(boolean) --* **[REQUIRED]** Whether the defined parameter is required. * **ConnectionMode** *(string) --* This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only). * **Tags** *(dict) --* **[REQUIRED]** A complex type that contains zero or more "Tag" elements. * **Items** *(list) --* A complex type that contains "Tag" elements. * *(dict) --* A complex type that contains "Tag" key and "Tag" value. * **Key** *(string) --* **[REQUIRED]** 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 "_ - . : / = + @". * **Value** *(string) --* 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 "_ - . : / = + @". Return type: dict Returns: **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', 'OriginReadTimeout': 123 }, '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 }, 'VpcOriginConfig': { 'VpcOriginId': 'string', 'OriginReadTimeout': 123, 'OriginKeepaliveTimeout': 123 }, 'ConnectionAttempts': 123, 'ConnectionTimeout': 123, 'ResponseCompletionTimeout': 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' }, ] }, 'SelectionCriteria': 'default'|'media-quality-based' }, ] }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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'|'None', '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'|'TLSv1.3_2025', '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, 'ContinuousDeploymentPolicyId': 'string', 'Staging': True|False, 'AnycastIpListId': 'string', 'TenantConfig': { 'ParameterDefinitions': [ { 'Name': 'string', 'Definition': { 'StringSchema': { 'Comment': 'string', 'DefaultValue': 'string', 'Required': True|False } } }, ] }, 'ConnectionMode': 'direct'|'tenant-only' }, 'AliasICPRecordals': [ { 'CNAME': 'string', 'ICPRecordalStatus': 'APPROVED'|'SUSPENDED'|'PENDING' }, ] }, 'Location': 'string', 'ETag': 'string' } **Response Structure** * *(dict) --* The returned result of the corresponding request. * **Distribution** *(dict) --* The distribution's information. * **Id** *(string) --* The distribution's identifier. For example: "E1U5RQF7T870K0". * **ARN** *(string) --* The distribution's Amazon Resource Name (ARN). * **Status** *(string) --* The distribution's status. When the status is "Deployed", the distribution's information is fully propagated to all CloudFront edge locations. * **LastModifiedTime** *(datetime) --* The date and time when the distribution was last modified. * **InProgressInvalidationBatches** *(integer) --* The number of invalidation batches currently in progress. * **DomainName** *(string) --* The distribution's CloudFront domain name. For example: "d111111abcdef8.cloudfront.net". * **ActiveTrustedSigners** *(dict) --* Warning: We recommend using "TrustedKeyGroups" instead of "TrustedSigners". 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 are configured as trusted signers. 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. * *(string) --* * **ActiveTrustedKeyGroups** *(dict) --* 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. * *(string) --* * **DistributionConfig** *(dict) --* The distribution's configuration. * **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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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. * *(string) --* * **DefaultRootObject** *(string) --* When a viewer requests the root URL for your distribution, the default root object is the object that you want CloudFront to request from your origin. For example, if your root URL is "https://www.example.com", you can specify CloudFront to return the "index.html" file as the default root object. You can specify a default root object so that viewers see a specific file or object, instead of another object in your distribution (for example, "https://www.example.com /product-description.html"). A default root object avoids exposing the contents of your distribution. You can specify the object name or a path to the object name (for example, "index.html" or "exampleFolderName/index.html"). Your string can't begin with a forward slash ( "/"). Only specify the object name or the path to the object. 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 Specify 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: * Use "S3OriginConfig" to specify an Amazon S3 bucket that is not configured with static website hosting. * Use "VpcOriginConfig" to specify a VPC origin. * Use "CustomOriginConfig" to specify all other kinds of origins, including: * An Amazon S3 bucket that is configured with static website hosting * An Elastic Load Balancing load balancer * An Elemental MediaPackage endpoint * An Elemental MediaStore container * Any other HTTP server, running on an Amazon EC2 instance or any other kind of host For the current maximum number of origins that you can specify per distribution, see General Quotas on Web Distributions in the *Amazon CloudFront Developer Guide* (quotas were formerly referred to as limits). * **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 "OriginCustomHeader" element for each custom header that you want CloudFront to forward to the origin. If Quantity is "0", omit "Items". * *(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) --* Note: If you're using origin access control (OAC) instead of origin access identity, specify an empty "OriginAccessIdentity" element. For more information, see Restricting access to an Amazon Web Services in the *Amazon CloudFront Developer Guide*. 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" The "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*. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see Response timeout 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. * *(string) --* * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) in the *Amazon CloudFront Developer Guide*. * **VpcOriginConfig** *(dict) --* The VPC origin configuration. * **VpcOriginId** *(string) --* The VPC origin ID. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) 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*. * **ResponseCompletionTimeout** *(integer) --* The time (in seconds) that a request from CloudFront to the origin can stay open and wait for a response. If the complete response isn't received from the origin by this time, CloudFront ends the connection. The value for "ResponseCompletionTimeout" must be equal to or greater than the value for "OriginReadTimeout". If you don't set a value for "ResponseCompletionTimeout", CloudFront doesn't enforce a maximum value. For more information, see Response completion 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 secondary 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 specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the secondary origin under the failover conditions that you've chosen. Optionally, you can choose selection criteria for your origin group to specify how your origins are selected when your distribution routes viewer requests. * **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. * *(integer) --* * **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. * **SelectionCriteria** *(string) --* The selection criteria for the origin group. For more information, see Create an origin group in the *Amazon CloudFront Developer Guide*. * **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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **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. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control- Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. * **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. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(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. Your 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. Your 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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. * *(string) --* * **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. * *(string) --* * **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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **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 specify an empty individual "CacheBehavior" element, because this is invalid. For more information, see CacheBehaviors. 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. Warning: If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the "Cache-Control: no-cache", "no-store", or "private" directives are present in the origin headers. 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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **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. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control- Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. * **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. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(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. Your 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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. * *(string) --* * **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. * *(string) --* * **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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **CustomErrorResponses** *(dict) --* A complex type that controls the following: * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. * How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the *Amazon CloudFront Developer Guide*. * **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: * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. * How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the *Amazon CloudFront Developer Guide*. * **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: * The value of "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/*". * The value of "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: * Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute "200", the response typically won't be intercepted. * If you don't care about distinguishing among different client errors or server errors, you can specify "400" or "500" as the "ResponseCode" for all 4xx or 5xx errors. * You might want to return a "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) --* A 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" and "prefix", 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, "amzn-s3-demo-bucket.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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) * "MinimumProtocolVersion" * "SSLSupportMethod" * **IAMCertificateId** *(string) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 ServicesSupport 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: * The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers. * The ciphers that CloudFront can use to encrypt the content that it returns to viewers. 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: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **CertificateSource** *(string) --* This field is deprecated. Use one of the following fields instead: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **Restrictions** *(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. * *(string) --* * **WebACLId** *(string) --* Note: Multi-tenant distributions only support WAF V2 web ACLs. 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:123456789 012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef- EXAMPLE11111". To specify a web ACL created using WAF Classic, use the ACL ID, for example "a1b2c3d4-5678 -90ab-cdef-EXAMPLE11111". 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 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) --* Note: To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup. 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: * You enable IPv6 for the distribution * You're using alternate domain names in the URLs for your objects 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. * **ContinuousDeploymentPolicyId** *(string) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. The identifier of a continuous deployment policy. For more information, see "CreateContinuousDeploymentPolicy". * **Staging** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. A Boolean that indicates whether this is a staging distribution. When this value is "true", this is a staging distribution. When this value is "false", this is not a staging distribution. * **AnycastIpListId** *(string) --* Note: To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup. ID of the Anycast static IP list that is associated with the distribution. * **TenantConfig** *(dict) --* Note: This field only supports multi-tenant distributions. You can't specify this field for standard distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. A distribution tenant configuration. * **ParameterDefinitions** *(list) --* The parameters that you specify for a distribution tenant. * *(dict) --* A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution. * **Name** *(string) --* The name of the parameter. * **Definition** *(dict) --* The value that you assigned to the parameter. * **StringSchema** *(dict) --* An object that contains information about the string schema. * **Comment** *(string) --* A comment to describe the parameter. * **DefaultValue** *(string) --* The default value of the parameter. * **Required** *(boolean) --* Whether the defined parameter is required. * **ConnectionMode** *(string) --* This field specifies whether the connection mode is through a standard distribution (direct) or a multi- tenant distribution with distribution tenants (tenant- only). * **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 Amazon Web Services Regions outside of China. The status values returned are the following: * **APPROVED** indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED, that is, valid to use with the China Regions, a CNAME must have one ICP recordal number associated with it. * **SUSPENDED** indicates that the associated CNAME does not have a valid ICP recordal number. * **PENDING** indicates that CloudFront can't determine the ICP recordal status of the CNAME associated with the distribution because there was an error in trying to determine the status. You can try again to see if the error is resolved in which case CloudFront returns an APPROVED or SUSPENDED status. * **Location** *(string) --* The fully qualified URI of the new distribution resource just created. * **ETag** *(string) --* The current version of the distribution created. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToOr iginAccessControl" * "CloudFront.Client.exceptions.InvalidDefaultRootObject" * "CloudFront.Client.exceptions.InvalidDomainNameForOriginAccessCo ntrol" * "CloudFront.Client.exceptions.InvalidQueryStringParameters" * "CloudFront.Client.exceptions.TooManyTrustedSigners" * "CloudFront.Client.exceptions.TooManyCookieNamesInWhiteList" * "CloudFront.Client.exceptions.NoSuchFieldLevelEncryptionConfig" * "CloudFront.Client.exceptions.InvalidErrorCode" * "CloudFront.Client.exceptions.IllegalOriginAccessConfiguration" * "CloudFront.Client.exceptions.InvalidProtocolSettings" * "CloudFront.Client.exceptions.TooManyFunctionAssociations" * "CloudFront.Client.exceptions.TooManyOriginCustomHeaders" * "CloudFront.Client.exceptions.InvalidOrigin" * "CloudFront.Client.exceptions.InvalidForwardCookies" * "CloudFront.Client.exceptions.InvalidMinimumProtocolVersion" * "CloudFront.Client.exceptions.NoSuchCachePolicy" * "CloudFront.Client.exceptions.TooManyKeyGroupsAssociatedToDistri bution" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToCa chePolicy" * "CloudFront.Client.exceptions.InvalidRequiredProtocol" * "CloudFront.Client.exceptions.TooManyDistributionsWithFunctionAs sociations" * "CloudFront.Client.exceptions.TooManyOriginGroupsPerDistribution" * "CloudFront.Client.exceptions.TooManyDistributions" * "CloudFront.Client.exceptions.InvalidTTLOrder" * "CloudFront.Client.exceptions.IllegalFieldLevelEncryptionConfigA ssociationWithCacheBehavior" * "CloudFront.Client.exceptions.InvalidOriginKeepaliveTimeout" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.InvalidOriginReadTimeout" * "CloudFront.Client.exceptions.InvalidOriginAccessControl" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.InvalidHeadersForS3Origin" * "CloudFront.Client.exceptions.TrustedSignerDoesNotExist" * "CloudFront.Client.exceptions.InvalidWebACLId" * "CloudFront.Client.exceptions.TooManyDistributionsWithSingleFunc tionARN" * "CloudFront.Client.exceptions.InvalidRelativePath" * "CloudFront.Client.exceptions.TooManyLambdaFunctionAssociations" * "CloudFront.Client.exceptions.NoSuchOriginRequestPolicy" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToFi eldLevelEncryptionConfig" * "CloudFront.Client.exceptions.InconsistentQuantities" * "CloudFront.Client.exceptions.InvalidLocationCode" * "CloudFront.Client.exceptions.InvalidOriginAccessIdentity" * "CloudFront.Client.exceptions.InvalidTagging" * "CloudFront.Client.exceptions.TooManyDistributionCNAMEs" * "CloudFront.Client.exceptions.NoSuchContinuousDeploymentPolicy" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToOr iginRequestPolicy" * "CloudFront.Client.exceptions.TooManyQueryStringParameters" * "CloudFront.Client.exceptions.RealtimeLogConfigOwnerMismatch" * "CloudFront.Client.exceptions.ContinuousDeploymentPolicyInUse" * "CloudFront.Client.exceptions.MissingBody" * "CloudFront.Client.exceptions.TooManyHeadersInForwardedValues" * "CloudFront.Client.exceptions.InvalidLambdaFunctionAssociation" * "CloudFront.Client.exceptions.CNAMEAlreadyExists" * "CloudFront.Client.exceptions.TooManyCertificates" * "CloudFront.Client.exceptions.TrustedKeyGroupDoesNotExist" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToRe sponseHeadersPolicy" * "CloudFront.Client.exceptions.NoSuchResponseHeadersPolicy" * "CloudFront.Client.exceptions.NoSuchRealtimeLogConfig" * "CloudFront.Client.exceptions.InvalidResponseCode" * "CloudFront.Client.exceptions.InvalidGeoRestrictionParameter" * "CloudFront.Client.exceptions.TooManyOrigins" * "CloudFront.Client.exceptions.InvalidViewerCertificate" * "CloudFront.Client.exceptions.InvalidFunctionAssociation" * "CloudFront.Client.exceptions.TooManyDistributionsWithLambdaAsso ciations" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToKe yGroup" * "CloudFront.Client.exceptions.DistributionAlreadyExists" * "CloudFront.Client.exceptions.NoSuchOrigin" * "CloudFront.Client.exceptions.TooManyCacheBehaviors" CloudFront / Client / update_distribution_tenant update_distribution_tenant ************************** CloudFront.Client.update_distribution_tenant(**kwargs) Updates a distribution tenant. See also: AWS API Documentation **Request Syntax** response = client.update_distribution_tenant( Id='string', DistributionId='string', Domains=[ { 'Domain': 'string' }, ], Customizations={ 'WebAcl': { 'Action': 'override'|'disable', 'Arn': 'string' }, 'Certificate': { 'Arn': 'string' }, 'GeoRestrictions': { 'RestrictionType': 'blacklist'|'whitelist'|'none', 'Locations': [ 'string', ] } }, Parameters=[ { 'Name': 'string', 'Value': 'string' }, ], ConnectionGroupId='string', IfMatch='string', ManagedCertificateRequest={ 'ValidationTokenHost': 'cloudfront'|'self-hosted', 'PrimaryDomainName': 'string', 'CertificateTransparencyLoggingPreference': 'enabled'|'disabled' }, Enabled=True|False ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The ID of the distribution tenant. * **DistributionId** (*string*) -- The ID for the multi-tenant distribution. * **Domains** (*list*) -- The domains to update for the distribution tenant. A domain object can contain only a domain property. You must specify at least one domain. Each distribution tenant can have up to 5 domains. * *(dict) --* The domain for the specified distribution tenant. * **Domain** *(string) --* **[REQUIRED]** The domain name. * **Customizations** (*dict*) -- Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant. * **WebAcl** *(dict) --* The WAF web ACL. * **Action** *(string) --* **[REQUIRED]** The action for the WAF web ACL customization. You can specify "override" to specify a separate WAF web ACL for the distribution tenant. If you specify "disable", the distribution tenant won't have WAF web ACL protections and won't inherit from the multi-tenant distribution. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the WAF web ACL. * **Certificate** *(dict) --* The Certificate Manager (ACM) certificate. * **Arn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the ACM certificate. * **GeoRestrictions** *(dict) --* The geographic restrictions. * **RestrictionType** *(string) --* **[REQUIRED]** The method that you want to use to restrict distribution of your content by country: * "none": No geographic 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. * **Locations** *(list) --* The locations for geographic restrictions. * *(string) --* * **Parameters** (*list*) -- A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution. * *(dict) --* A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution. * **Name** *(string) --* **[REQUIRED]** The parameter name. * **Value** *(string) --* **[REQUIRED]** The parameter value. * **ConnectionGroupId** (*string*) -- The ID of the target connection group. * **IfMatch** (*string*) -- **[REQUIRED]** The value of the "ETag" header that you received when retrieving the distribution tenant to update. This value is returned in the response of the "GetDistributionTenant" API operation. * **ManagedCertificateRequest** (*dict*) -- An object that contains the CloudFront managed ACM certificate request. * **ValidationTokenHost** *(string) --* **[REQUIRED]** Specify how the HTTP validation token will be served when requesting the CloudFront managed ACM certificate. * For "cloudfront", CloudFront will automatically serve the validation token. Choose this mode if you can point the domain's DNS to CloudFront immediately. * For "self-hosted", you serve the validation token from your existing infrastructure. Choose this mode when you need to maintain current traffic flow while your certificate is being issued. You can place the validation token at the well-known path on your existing web server, wait for ACM to validate and issue the certificate, and then update your DNS to point to CloudFront. * **PrimaryDomainName** *(string) --* The primary domain name associated with the CloudFront managed ACM certificate. * **CertificateTransparencyLoggingPreference** *(string) --* You can opt out of certificate transparency logging by specifying the "disabled" option. Opt in by specifying "enabled". For more information, see Certificate Transparency Logging in the *Certificate Manager User Guide*. * **Enabled** (*boolean*) -- Indicates whether the distribution tenant should be updated to an enabled state. If you update the distribution tenant and it's not enabled, the distribution tenant won't serve traffic. Return type: dict Returns: **Response Syntax** { 'DistributionTenant': { 'Id': 'string', 'DistributionId': 'string', 'Name': 'string', 'Arn': 'string', 'Domains': [ { 'Domain': 'string', 'Status': 'active'|'inactive' }, ], 'Tags': { 'Items': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'Customizations': { 'WebAcl': { 'Action': 'override'|'disable', 'Arn': 'string' }, 'Certificate': { 'Arn': 'string' }, 'GeoRestrictions': { 'RestrictionType': 'blacklist'|'whitelist'|'none', 'Locations': [ 'string', ] } }, 'Parameters': [ { 'Name': 'string', 'Value': 'string' }, ], 'ConnectionGroupId': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'Enabled': True|False, 'Status': 'string' }, 'ETag': 'string' } **Response Structure** * *(dict) --* * **DistributionTenant** *(dict) --* The distribution tenant that you're updating. * **Id** *(string) --* The ID of the distribution tenant. * **DistributionId** *(string) --* The ID of the multi-tenant distribution. * **Name** *(string) --* The name of the distribution tenant. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the distribution tenant. * **Domains** *(list) --* The domains associated with the distribution tenant. * *(dict) --* The details about the domain result. * **Domain** *(string) --* The specified domain. * **Status** *(string) --* Whether the domain is active or inactive. * **Tags** *(dict) --* A complex type that contains zero or more "Tag" elements. * **Items** *(list) --* A complex type that contains "Tag" elements. * *(dict) --* A complex type that contains "Tag" key and "Tag" value. * **Key** *(string) --* 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 "_ - . : / = + @". * **Value** *(string) --* 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 "_ - . : / = + @". * **Customizations** *(dict) --* Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant. * **WebAcl** *(dict) --* The WAF web ACL. * **Action** *(string) --* The action for the WAF web ACL customization. You can specify "override" to specify a separate WAF web ACL for the distribution tenant. If you specify "disable", the distribution tenant won't have WAF web ACL protections and won't inherit from the multi-tenant distribution. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the WAF web ACL. * **Certificate** *(dict) --* The Certificate Manager (ACM) certificate. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the ACM certificate. * **GeoRestrictions** *(dict) --* The geographic restrictions. * **RestrictionType** *(string) --* The method that you want to use to restrict distribution of your content by country: * "none": No geographic 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. * **Locations** *(list) --* The locations for geographic restrictions. * *(string) --* * **Parameters** *(list) --* A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution. * *(dict) --* A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution. * **Name** *(string) --* The parameter name. * **Value** *(string) --* The parameter value. * **ConnectionGroupId** *(string) --* The ID of the connection group for the distribution tenant. If you don't specify a connection group, CloudFront uses the default connection group. * **CreatedTime** *(datetime) --* The date and time when the distribution tenant was created. * **LastModifiedTime** *(datetime) --* The date and time when the distribution tenant was updated. * **Enabled** *(boolean) --* Indicates whether the distribution tenant is in an enabled state. If disabled, the distribution tenant won't serve traffic. * **Status** *(string) --* The status of the distribution tenant. * **ETag** *(string) --* The current version of the distribution tenant. **Exceptions** * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.EntityAlreadyExists" * "CloudFront.Client.exceptions.CNAMEAlreadyExists" * "CloudFront.Client.exceptions.InvalidAssociation" * "CloudFront.Client.exceptions.EntityLimitExceeded" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / create_function create_function *************** CloudFront.Client.create_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'|'cloudfront-js-2.0', 'KeyValueStoreAssociations': { 'Quantity': 123, 'Items': [ { 'KeyValueStoreARN': 'string' }, ] } }, FunctionCode=b'bytes' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** A name to identify the function. * **FunctionConfig** (*dict*) -- **[REQUIRED]** Configuration information about the function, including an optional comment and the function's runtime. * **Comment** *(string) --* **[REQUIRED]** A comment to describe the function. * **Runtime** *(string) --* **[REQUIRED]** The function's runtime environment version. * **KeyValueStoreAssociations** *(dict) --* The configuration for the key value store associations. * **Quantity** *(integer) --* **[REQUIRED]** The quantity of key value store associations. * **Items** *(list) --* The items of the key value store association. * *(dict) --* The key value store association. * **KeyValueStoreARN** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the key value store association. * **FunctionCode** (*bytes*) -- **[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*. Return type: dict Returns: **Response Syntax** { 'FunctionSummary': { 'Name': 'string', 'Status': 'string', 'FunctionConfig': { 'Comment': 'string', 'Runtime': 'cloudfront-js-1.0'|'cloudfront-js-2.0', 'KeyValueStoreAssociations': { 'Quantity': 123, 'Items': [ { 'KeyValueStoreARN': 'string' }, ] } }, '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 version. * **KeyValueStoreAssociations** *(dict) --* The configuration for the key value store associations. * **Quantity** *(integer) --* The quantity of key value store associations. * **Items** *(list) --* The items of the key value store association. * *(dict) --* The key value store association. * **KeyValueStoreARN** *(string) --* The Amazon Resource Name (ARN) of the key value store association. * **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.FunctionAlreadyExists" * "CloudFront.Client.exceptions.UnsupportedOperation" * "CloudFront.Client.exceptions.FunctionSizeLimitExceeded" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.TooManyFunctions" CloudFront / Client / list_streaming_distributions list_streaming_distributions **************************** CloudFront.Client.list_streaming_distributions(**kwargs) List streaming distributions. See also: AWS API Documentation **Request Syntax** response = client.list_streaming_distributions( Marker='string', MaxItems='string' ) Parameters: * **Marker** (*string*) -- The value that you provided for the "Marker" request parameter. * **MaxItems** (*string*) -- The value that you provided for the "MaxItems" request parameter. Return type: dict Returns: **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'|'None', '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. * *(string) --* * **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 in the list are configured as trusted signers. 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. * *(string) --* * **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.InvalidArgument" CloudFront / Client / delete_response_headers_policy delete_response_headers_policy ****************************** CloudFront.Client.delete_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' ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The identifier for the response headers policy that you are deleting. To get the identifier, you can use "ListResponseHeadersPolicies". * **IfMatch** (*string*) -- 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". Returns: None **Exceptions** * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.ResponseHeadersPolicyInUse" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.IllegalDelete" * "CloudFront.Client.exceptions.NoSuchResponseHeadersPolicy" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / list_realtime_log_configs list_realtime_log_configs ************************* CloudFront.Client.list_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' ) Parameters: * **MaxItems** (*string*) -- The maximum number of real-time log configurations that you want in the response. * **Marker** (*string*) -- Use this field when paginating results to indicate where to begin in your list of real-time log configurations. The response includes real-time log configurations in the list that occur after the marker. To get the next page of the list, set this field's value to the value of "NextMarker" from the current page's response. Return type: dict Returns: **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're 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 in a real-time log configuration. * **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*. * *(string) --* * **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.AccessDenied" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.NoSuchRealtimeLogConfig" CloudFront / Client / list_distributions_by_vpc_origin_id list_distributions_by_vpc_origin_id *********************************** CloudFront.Client.list_distributions_by_vpc_origin_id(**kwargs) List CloudFront distributions by their VPC origin ID. See also: AWS API Documentation **Request Syntax** response = client.list_distributions_by_vpc_origin_id( Marker='string', MaxItems='string', VpcOriginId='string' ) Parameters: * **Marker** (*string*) -- The marker associated with the VPC origin distributions list. * **MaxItems** (*string*) -- The maximum number of items included in the list. * **VpcOriginId** (*string*) -- **[REQUIRED]** The VPC origin ID. Return type: dict Returns: **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. * *(string) --* **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.UnsupportedOperation" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / list_distribution_tenants list_distribution_tenants ************************* CloudFront.Client.list_distribution_tenants(**kwargs) Lists the distribution tenants in your Amazon Web Services account. See also: AWS API Documentation **Request Syntax** response = client.list_distribution_tenants( AssociationFilter={ 'DistributionId': 'string', 'ConnectionGroupId': 'string' }, Marker='string', MaxItems=123 ) Parameters: * **AssociationFilter** (*dict*) -- Filter by the associated distribution ID or connection group ID. * **DistributionId** *(string) --* The distribution ID to filter by. You can find distribution tenants associated with a specific distribution. * **ConnectionGroupId** *(string) --* The ID of the connection group to filter by. You can find distribution tenants associated with a specific connection group. * **Marker** (*string*) -- The marker for the next set of results. * **MaxItems** (*integer*) -- The maximum number of distribution tenants to return. Return type: dict Returns: **Response Syntax** { 'NextMarker': 'string', 'DistributionTenantList': [ { 'Id': 'string', 'DistributionId': 'string', 'Name': 'string', 'Arn': 'string', 'Domains': [ { 'Domain': 'string', 'Status': 'active'|'inactive' }, ], 'ConnectionGroupId': 'string', 'Customizations': { 'WebAcl': { 'Action': 'override'|'disable', 'Arn': 'string' }, 'Certificate': { 'Arn': 'string' }, 'GeoRestrictions': { 'RestrictionType': 'blacklist'|'whitelist'|'none', 'Locations': [ 'string', ] } }, 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'ETag': 'string', 'Enabled': True|False, 'Status': 'string' }, ] } **Response Structure** * *(dict) --* * **NextMarker** *(string) --* A token used for pagination of results returned in the response. You can use the token from the previous request to define where the current request should begin. * **DistributionTenantList** *(list) --* The list of distribution tenants that you retrieved. * *(dict) --* A summary of the information about a distribution tenant. * **Id** *(string) --* The ID of the distribution tenant. * **DistributionId** *(string) --* The identifier for the multi-tenant distribution. For example: "EDFDVBD632BHDS5". * **Name** *(string) --* The name of the distribution tenant. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the distribution tenant. * **Domains** *(list) --* The domains associated with the distribution tenant. * *(dict) --* The details about the domain result. * **Domain** *(string) --* The specified domain. * **Status** *(string) --* Whether the domain is active or inactive. * **ConnectionGroupId** *(string) --* The ID of the connection group ID for the distribution tenant. If you don't specify a connection group, CloudFront uses the default connection group. * **Customizations** *(dict) --* Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi- tenant distribution that was used to create the distribution tenant. * **WebAcl** *(dict) --* The WAF web ACL. * **Action** *(string) --* The action for the WAF web ACL customization. You can specify "override" to specify a separate WAF web ACL for the distribution tenant. If you specify "disable", the distribution tenant won't have WAF web ACL protections and won't inherit from the multi-tenant distribution. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the WAF web ACL. * **Certificate** *(dict) --* The Certificate Manager (ACM) certificate. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the ACM certificate. * **GeoRestrictions** *(dict) --* The geographic restrictions. * **RestrictionType** *(string) --* The method that you want to use to restrict distribution of your content by country: * "none": No geographic 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. * **Locations** *(list) --* The locations for geographic restrictions. * *(string) --* * **CreatedTime** *(datetime) --* The date and time when the distribution tenant was created. * **LastModifiedTime** *(datetime) --* The date and time when the distribution tenant was updated. * **ETag** *(string) --* The current version of the distribution tenant. * **Enabled** *(boolean) --* Indicates whether the distribution tenants are in an enabled state. If disabled, the distribution tenant won't service traffic. * **Status** *(string) --* The status of the distribution tenant. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / can_paginate can_paginate ************ CloudFront.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "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")". Returns: "True" if the operation can be paginated, "False" otherwise. CloudFront / Client / get_anycast_ip_list get_anycast_ip_list ******************* CloudFront.Client.get_anycast_ip_list(**kwargs) Gets an Anycast static IP list. See also: AWS API Documentation **Request Syntax** response = client.get_anycast_ip_list( Id='string' ) Parameters: **Id** (*string*) -- **[REQUIRED]** The ID of the Anycast static IP list. Return type: dict Returns: **Response Syntax** { 'AnycastIpList': { 'Id': 'string', 'Name': 'string', 'Status': 'string', 'Arn': 'string', 'AnycastIps': [ 'string', ], 'IpCount': 123, 'LastModifiedTime': datetime(2015, 1, 1) }, 'ETag': 'string' } **Response Structure** * *(dict) --* * **AnycastIpList** *(dict) --* The Anycast static IP list details. * **Id** *(string) --* The ID of the Anycast static IP list. * **Name** *(string) --* The name of the Anycast static IP list. * **Status** *(string) --* The status of the Anycast static IP list. Valid values: "Deployed", "Deploying", or "Failed". * **Arn** *(string) --* The Amazon Resource Name (ARN) of the Anycast static IP list. * **AnycastIps** *(list) --* The static IP addresses that are allocated to the Anycast static IP list. * *(string) --* * **IpCount** *(integer) --* The number of IP addresses in the Anycast static IP list. * **LastModifiedTime** *(datetime) --* The last time the Anycast static IP list was modified. * **ETag** *(string) --* The version identifier for the current version of the Anycast static IP list. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.UnsupportedOperation" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / list_domain_conflicts list_domain_conflicts ********************* CloudFront.Client.list_domain_conflicts(**kwargs) Note: We recommend that you use the "ListDomainConflicts" API operation to check for domain conflicts, as it supports both standard distributions and distribution tenants. ListConflictingAliases performs similar checks but only supports standard distributions. Lists existing domain associations that conflict with the domain that you specify. You can use this API operation to identify potential domain conflicts when moving domains between standard distributions and/or distribution tenants. Domain conflicts must be resolved first before they can be moved. 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 domains, specify the following: * The domain to search for * The ID of a standard distribution or distribution tenant in your account that has an attached TLS certificate, which covers the specified domain For more information, including how to set up the standard distribution or distribution tenant, and the certificate, see Moving an alternate domain name to a different standard distribution or distribution tenant 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_domain_conflicts( Domain='string', DomainControlValidationResource={ 'DistributionId': 'string', 'DistributionTenantId': 'string' }, MaxItems=123, Marker='string' ) Parameters: * **Domain** (*string*) -- **[REQUIRED]** The domain to check for conflicts. * **DomainControlValidationResource** (*dict*) -- **[REQUIRED]** The distribution resource identifier. This can be the standard distribution or distribution tenant that has a valid certificate, which covers the domain that you specify. * **DistributionId** *(string) --* The ID of the multi-tenant distribution. * **DistributionTenantId** *(string) --* The ID of the distribution tenant. * **MaxItems** (*integer*) -- The maximum number of domain conflicts to return. * **Marker** (*string*) -- The marker for the next set of domain conflicts. Return type: dict Returns: **Response Syntax** { 'DomainConflicts': [ { 'Domain': 'string', 'ResourceType': 'distribution'|'distribution-tenant', 'ResourceId': 'string', 'AccountId': 'string' }, ], 'NextMarker': 'string' } **Response Structure** * *(dict) --* * **DomainConflicts** *(list) --* Contains details about the domain conflicts. * *(dict) --* Contains information about the domain conflict. Use this information to determine the affected domain, the related resource, and the affected Amazon Web Services account. * **Domain** *(string) --* The domain used to find existing conflicts for domain configurations. * **ResourceType** *(string) --* The CloudFront resource type that has a domain conflict. * **ResourceId** *(string) --* The ID of the resource that has a domain conflict. * **AccountId** *(string) --* The ID of the Amazon Web Services account for the domain conflict. * **NextMarker** *(string) --* A token used for pagination of results returned in the response. You can use the token from the previous request to define where the current request should begin. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / update_public_key update_public_key ***************** CloudFront.Client.update_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' ) Parameters: * **PublicKeyConfig** (*dict*) -- **[REQUIRED]** A public key configuration. * **CallerReference** *(string) --* **[REQUIRED]** A string included in the request to help make sure that the request can't be replayed. * **Name** *(string) --* **[REQUIRED]** A name to help identify the public key. * **EncodedKey** *(string) --* **[REQUIRED]** 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. * **Id** (*string*) -- **[REQUIRED]** The identifier of the public key that you are updating. * **IfMatch** (*string*) -- The value of the "ETag" header that you received when retrieving the public key to update. For example: "E2QWRUHAPOMQZL". Return type: dict Returns: **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.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.NoSuchPublicKey" * "CloudFront.Client.exceptions.CannotChangeImmutablePublicKeyFiel ds" * "CloudFront.Client.exceptions.IllegalUpdate" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / delete_continuous_deployment_policy delete_continuous_deployment_policy *********************************** CloudFront.Client.delete_continuous_deployment_policy(**kwargs) Deletes a continuous deployment policy. You cannot delete a continuous deployment policy that's attached to a primary distribution. First update your distribution to remove the continuous deployment policy, then you can delete the policy. See also: AWS API Documentation **Request Syntax** response = client.delete_continuous_deployment_policy( Id='string', IfMatch='string' ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The identifier of the continuous deployment policy that you are deleting. * **IfMatch** (*string*) -- The current version ( "ETag" value) of the continuous deployment policy that you are deleting. Returns: None **Exceptions** * "CloudFront.Client.exceptions.ContinuousDeploymentPolicyInUse" * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.NoSuchContinuousDeploymentPolicy" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / create_origin_request_policy create_origin_request_policy **************************** CloudFront.Client.create_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: * The request body and the URL path (without the domain name) from the viewer request. * The headers that CloudFront automatically includes in every origin request, including "Host", "User-Agent", and "X-Amz-Cf- Id". * All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront. CloudFront sends a request when it can't find 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'|'allExcept', 'Headers': { 'Quantity': 123, 'Items': [ 'string', ] } }, 'CookiesConfig': { 'CookieBehavior': 'none'|'whitelist'|'all'|'allExcept', 'Cookies': { 'Quantity': 123, 'Items': [ 'string', ] } }, 'QueryStringsConfig': { 'QueryStringBehavior': 'none'|'whitelist'|'all'|'allExcept', 'QueryStrings': { 'Quantity': 123, 'Items': [ 'string', ] } } } ) Parameters: **OriginRequestPolicyConfig** (*dict*) -- **[REQUIRED]** An origin request policy configuration. * **Comment** *(string) --* A comment to describe the origin request policy. The comment cannot be longer than 128 characters. * **Name** *(string) --* **[REQUIRED]** A unique name to identify the origin request policy. * **HeadersConfig** *(dict) --* **[REQUIRED]** The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront. * **HeaderBehavior** *(string) --* **[REQUIRED]** Determines whether any HTTP headers are included in requests that CloudFront sends to the origin. Valid values are: * "none" – No HTTP headers in viewer requests are 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" – Only 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. * "allExcept" – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin, **except** for those listed in the "Headers" type, which are not included. * **Headers** *(dict) --* Contains a list of HTTP header names. * **Quantity** *(integer) --* **[REQUIRED]** The number of header names in the "Items" list. * **Items** *(list) --* A list of HTTP header names. * *(string) --* * **CookiesConfig** *(dict) --* **[REQUIRED]** The cookies from viewer requests to include in origin requests. * **CookieBehavior** *(string) --* **[REQUIRED]** Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are: * "none" – No cookies in viewer requests are 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" – Only 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. * "allExcept" – All cookies in viewer requests are included in requests that CloudFront sends to the origin, **except** for those listed in the "CookieNames" type, which are not included. * **Cookies** *(dict) --* Contains a list of cookie names. * **Quantity** *(integer) --* **[REQUIRED]** The number of cookie names in the "Items" list. * **Items** *(list) --* A list of cookie names. * *(string) --* * **QueryStringsConfig** *(dict) --* **[REQUIRED]** The URL query strings from viewer requests to include in origin requests. * **QueryStringBehavior** *(string) --* **[REQUIRED]** Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin. Valid values are: * "none" – No query strings in viewer requests are 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" – Only 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. * "allExcept" – All query strings in viewer requests are included in requests that CloudFront sends to the origin, **except** for those listed in the "QueryStringNames" type, which are not included. * **QueryStrings** *(dict) --* Contains the specific query strings in viewer requests that either **are** or **are not** included in requests that CloudFront sends to the origin. The behavior depends on whether the "QueryStringBehavior" field in the "OriginRequestPolicyQueryStringsConfig" 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) --* **[REQUIRED]** The number of query string names in the "Items" list. * **Items** *(list) --* A list of query string names. * *(string) --* Return type: dict Returns: **Response Syntax** { 'OriginRequestPolicy': { 'Id': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'OriginRequestPolicyConfig': { 'Comment': 'string', 'Name': 'string', 'HeadersConfig': { 'HeaderBehavior': 'none'|'whitelist'|'allViewer'|'allViewerAndWhitelistCloudFront'|'allExcept', 'Headers': { 'Quantity': 123, 'Items': [ 'string', ] } }, 'CookiesConfig': { 'CookieBehavior': 'none'|'whitelist'|'all'|'allExcept', 'Cookies': { 'Quantity': 123, 'Items': [ 'string', ] } }, 'QueryStringsConfig': { 'QueryStringBehavior': 'none'|'whitelist'|'all'|'allExcept', 'QueryStrings': { 'Quantity': 123, 'Items': [ 'string', ] } } } }, 'Location': '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" – No HTTP headers in viewer requests are 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" – Only 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. * "allExcept" – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin, **except** for those listed in the "Headers" type, which are not included. * **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. * *(string) --* * **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" – No cookies in viewer requests are 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" – Only 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. * "allExcept" – All cookies in viewer requests are included in requests that CloudFront sends to the origin, **except** for those listed in the "CookieNames" type, which are not included. * **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. * *(string) --* * **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" – No query strings in viewer requests are 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" – Only 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. * "allExcept" – All query strings in viewer requests are included in requests that CloudFront sends to the origin, **except** for those listed in the "QueryStringNames" type, which are not included. * **QueryStrings** *(dict) --* Contains the specific query strings in viewer requests that either **are** or **are not** included in requests that CloudFront sends to the origin. The behavior depends on whether the "QueryStringBehavior" field in the "OriginRequestPolicyQueryStringsConfig" 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. * *(string) --* * **Location** *(string) --* The fully qualified URI of the origin request policy just created. * **ETag** *(string) --* The current version of the origin request policy. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.TooManyHeadersInOriginRequestPolic y" * "CloudFront.Client.exceptions.TooManyCookiesInOriginRequestPolic y" * "CloudFront.Client.exceptions.InconsistentQuantities" * "CloudFront.Client.exceptions.OriginRequestPolicyAlreadyExists" * "CloudFront.Client.exceptions.TooManyQueryStringsInOriginRequest Policy" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.TooManyOriginRequestPolicies" CloudFront / Client / list_cloud_front_origin_access_identities list_cloud_front_origin_access_identities ***************************************** CloudFront.Client.list_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' ) Parameters: * **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). * **MaxItems** (*string*) -- The maximum number of origin access identities you want in the response body. Return type: dict Returns: **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.InvalidArgument" CloudFront / Client / get_invalidation_for_distribution_tenant get_invalidation_for_distribution_tenant **************************************** CloudFront.Client.get_invalidation_for_distribution_tenant(**kwargs) Gets information about a specific invalidation for a distribution tenant. See also: AWS API Documentation **Request Syntax** response = client.get_invalidation_for_distribution_tenant( DistributionTenantId='string', Id='string' ) Parameters: * **DistributionTenantId** (*string*) -- **[REQUIRED]** The ID of the distribution tenant. * **Id** (*string*) -- **[REQUIRED]** The ID of the invalidation to retrieve. Return type: dict Returns: **Response Syntax** { 'Invalidation': { 'Id': 'string', 'Status': 'string', 'CreateTime': datetime(2015, 1, 1), 'InvalidationBatch': { 'Paths': { 'Quantity': 123, 'Items': [ 'string', ] }, 'CallerReference': 'string' } } } **Response Structure** * *(dict) --* * **Invalidation** *(dict) --* An invalidation. * **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. * *(string) --* * **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.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.NoSuchInvalidation" CloudFront / Client / get_field_level_encryption_profile_config get_field_level_encryption_profile_config ***************************************** CloudFront.Client.get_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' ) Parameters: **Id** (*string*) -- **[REQUIRED]** Get the ID for the field-level encryption profile configuration information. Return type: dict Returns: **Response Syntax** { '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) --* * **FieldLevelEncryptionProfileConfig** *(dict) --* Return the field-level encryption profile configuration information. * **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. * *(string) --* * **ETag** *(string) --* The current version of the field-level encryption profile configuration result. For example: "E2QWRUHAPOMQZL". **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.NoSuchFieldLevelEncryptionProfile" CloudFront / Client / get_streaming_distribution_config get_streaming_distribution_config ********************************* CloudFront.Client.get_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' ) Parameters: **Id** (*string*) -- **[REQUIRED]** The streaming distribution's ID. Return type: dict Returns: **Response Syntax** { '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'|'None', 'Enabled': True|False }, 'ETag': 'string' } **Response Structure** * *(dict) --* The returned result of the corresponding request. * **StreamingDistributionConfig** *(dict) --* The streaming distribution's configuration information. * **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. * *(string) --* * **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, "amzn-s3-demo-bucket.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 in the list are configured as trusted signers. 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. * *(string) --* * **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.AccessDenied" * "CloudFront.Client.exceptions.NoSuchStreamingDistribution" CloudFront / Client / update_function update_function *************** CloudFront.Client.update_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'|'cloudfront-js-2.0', 'KeyValueStoreAssociations': { 'Quantity': 123, 'Items': [ { 'KeyValueStoreARN': 'string' }, ] } }, FunctionCode=b'bytes' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the function that you are updating. * **IfMatch** (*string*) -- **[REQUIRED]** The current version ( "ETag" value) of the function that you are updating, which you can get using "DescribeFunction". * **FunctionConfig** (*dict*) -- **[REQUIRED]** Configuration information about the function. * **Comment** *(string) --* **[REQUIRED]** A comment to describe the function. * **Runtime** *(string) --* **[REQUIRED]** The function's runtime environment version. * **KeyValueStoreAssociations** *(dict) --* The configuration for the key value store associations. * **Quantity** *(integer) --* **[REQUIRED]** The quantity of key value store associations. * **Items** *(list) --* The items of the key value store association. * *(dict) --* The key value store association. * **KeyValueStoreARN** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the key value store association. * **FunctionCode** (*bytes*) -- **[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*. Return type: dict Returns: **Response Syntax** { 'FunctionSummary': { 'Name': 'string', 'Status': 'string', 'FunctionConfig': { 'Comment': 'string', 'Runtime': 'cloudfront-js-1.0'|'cloudfront-js-2.0', 'KeyValueStoreAssociations': { 'Quantity': 123, 'Items': [ { 'KeyValueStoreARN': 'string' }, ] } }, '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 version. * **KeyValueStoreAssociations** *(dict) --* The configuration for the key value store associations. * **Quantity** *(integer) --* The quantity of key value store associations. * **Items** *(list) --* The items of the key value store association. * *(dict) --* The key value store association. * **KeyValueStoreARN** *(string) --* The Amazon Resource Name (ARN) of the key value store association. * **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.PreconditionFailed" * "CloudFront.Client.exceptions.UnsupportedOperation" * "CloudFront.Client.exceptions.FunctionSizeLimitExceeded" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.NoSuchFunctionExists" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / list_origin_request_policies list_origin_request_policies **************************** CloudFront.Client.list_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' ) Parameters: * **Type** (*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. * **Marker** (*string*) -- Use this field when paginating results to indicate where to begin in your list of origin request policies. The response includes origin request policies in the list that occur after the marker. To get the next page of the list, set this field's value to the value of "NextMarker" from the current page's response. * **MaxItems** (*string*) -- The maximum number of origin request policies that you want in the response. Return type: dict Returns: **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'|'allExcept', 'Headers': { 'Quantity': 123, 'Items': [ 'string', ] } }, 'CookiesConfig': { 'CookieBehavior': 'none'|'whitelist'|'all'|'allExcept', 'Cookies': { 'Quantity': 123, 'Items': [ 'string', ] } }, 'QueryStringsConfig': { 'QueryStringBehavior': 'none'|'whitelist'|'all'|'allExcept', '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" – No HTTP headers in viewer requests are 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" – Only 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. * "allExcept" – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin, **except** for those listed in the "Headers" type, which are not included. * **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. * *(string) --* * **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" – No cookies in viewer requests are 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" – Only 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. * "allExcept" – All cookies in viewer requests are included in requests that CloudFront sends to the origin, **except** for those listed in the "CookieNames" type, which are not included. * **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. * *(string) --* * **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" – No query strings in viewer requests are 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" – Only 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. * "allExcept" – All query strings in viewer requests are included in requests that CloudFront sends to the origin, **except** for those listed in the "QueryStringNames" type, which are not included. * **QueryStrings** *(dict) --* Contains the specific query strings in viewer requests that either **are** or **are not** included in requests that CloudFront sends to the origin. The behavior depends on whether the "QueryStringBehavior" field in the "OriginRequestPolicyQueryStringsConfig" 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. * *(string) --* **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.NoSuchOriginRequestPolicy" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / list_conflicting_aliases list_conflicting_aliases ************************ CloudFront.Client.list_conflicting_aliases(**kwargs) Note: The "ListConflictingAliases" API operation only supports standard distributions. To list domain conflicts for both standard distributions and distribution tenants, we recommend that you use the ListDomainConflicts API operation instead. Gets a list of aliases that conflict or overlap with the provided alias, and the associated CloudFront standard distribution and Amazon Web Services accounts for each conflicting alias. An alias is commonly known as a custom domain or vanity domain. It can also be called a CNAME or alternate domain name. In the returned list, the standard distribution and account IDs are partially hidden, which allows you to identify the standard distribution and accounts that you own, and 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, specify the alias to search and the ID of a standard distribution in your account that has an attached TLS certificate that includes the provided alias. For more information, including how to set up the standard distribution and certificate, see Moving an alternate domain name to a different standard distribution or distribution tenant 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 ) Parameters: * **DistributionId** (*string*) -- **[REQUIRED]** The ID of a standard distribution in your account that has an attached TLS certificate that includes the provided alias. * **Alias** (*string*) -- **[REQUIRED]** The alias (also called a CNAME) to search for conflicting aliases. * **Marker** (*string*) -- Use this field when paginating results to indicate where to begin in the list of conflicting aliases. The response includes conflicting aliases in the list that occur after the marker. To get the next page of the list, set this field's value to the value of "NextMarker" from the current page's response. * **MaxItems** (*integer*) -- The maximum number of conflicting aliases that you want in the response. Return type: dict Returns: **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 standard distribution and Amazon Web Services account ID that it's associated with. The standard distribution and account IDs are partially hidden, which allows you to identify the standard distributions and accounts that you own, and 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 standard distribution associated with the alias. * **AccountId** *(string) --* The (partially hidden) ID of the Amazon Web Services account that owns the standard distribution that's associated with the alias. **Exceptions** * "CloudFront.Client.exceptions.NoSuchDistribution" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / list_distributions list_distributions ****************** CloudFront.Client.list_distributions(**kwargs) List CloudFront distributions. See also: AWS API Documentation **Request Syntax** response = client.list_distributions( Marker='string', MaxItems='string' ) Parameters: * **Marker** (*string*) -- Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions 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 distribution on that page). * **MaxItems** (*string*) -- The maximum number of distributions you want in the response body. Return type: dict Returns: **Response Syntax** { 'DistributionList': { 'Marker': 'string', 'NextMarker': 'string', 'MaxItems': 123, 'IsTruncated': True|False, 'Quantity': 123, 'Items': [ { 'Id': 'string', 'ARN': 'string', 'ETag': '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', 'OriginReadTimeout': 123 }, '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 }, 'VpcOriginConfig': { 'VpcOriginId': 'string', 'OriginReadTimeout': 123, 'OriginKeepaliveTimeout': 123 }, 'ConnectionAttempts': 123, 'ConnectionTimeout': 123, 'ResponseCompletionTimeout': 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' }, ] }, 'SelectionCriteria': 'default'|'media-quality-based' }, ] }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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'|'None', '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'|'TLSv1.3_2025', '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' }, ], 'Staging': True|False, 'ConnectionMode': 'direct'|'tenant-only', 'AnycastIpListId': 'string' }, ] } } **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:distri bution/EDFDVBD632BHDS5", where "123456789012" is your Amazon Web Services account ID. * **ETag** *(string) --* The current version of the distribution. * **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. * *(string) --* * **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: * Use "S3OriginConfig" to specify an Amazon S3 bucket that is not configured with static website hosting. * Use "VpcOriginConfig" to specify a VPC origin. * Use "CustomOriginConfig" to specify all other kinds of origins, including: * An Amazon S3 bucket that is configured with static website hosting * An Elastic Load Balancing load balancer * An Elemental MediaPackage endpoint * An Elemental MediaStore container * Any other HTTP server, running on an Amazon EC2 instance or any other kind of host For the current maximum number of origins that you can specify per distribution, see General Quotas on Web Distributions in the *Amazon CloudFront Developer Guide* (quotas were formerly referred to as limits). * **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 "OriginCustomHeader" element for each custom header that you want CloudFront to forward to the origin. If Quantity is "0", omit "Items". * *(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) --* Note: If you're using origin access control (OAC) instead of origin access identity, specify an empty "OriginAccessIdentity" element. For more information, see Restricting access to an Amazon Web Services in the *Amazon CloudFront Developer Guide*. 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" The "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*. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see Response timeout 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. * *(string) --* * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) in the *Amazon CloudFront Developer Guide*. * **VpcOriginConfig** *(dict) --* The VPC origin configuration. * **VpcOriginId** *(string) --* The VPC origin ID. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) 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*. * **ResponseCompletionTimeout** *(integer) --* The time (in seconds) that a request from CloudFront to the origin can stay open and wait for a response. If the complete response isn't received from the origin by this time, CloudFront ends the connection. The value for "ResponseCompletionTimeout" must be equal to or greater than the value for "OriginReadTimeout". If you don't set a value for "ResponseCompletionTimeout", CloudFront doesn't enforce a maximum value. For more information, see Response completion 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 secondary 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 specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the secondary origin under the failover conditions that you've chosen. Optionally, you can choose selection criteria for your origin group to specify how your origins are selected when your distribution routes viewer requests. * **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. * *(integer) --* * **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. * **SelectionCriteria** *(string) --* The selection criteria for the origin group. For more information, see Create an origin group in the *Amazon CloudFront Developer Guide*. * **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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **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. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control- Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. * **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. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(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. Your 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. Your 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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. * *(string) --* * **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. * *(string) --* * **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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **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 specify an empty individual "CacheBehavior" element, because this is invalid. For more information, see CacheBehaviors. 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. Warning: If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the "Cache-Control: no-cache", "no- store", or "private" directives are present in the origin headers. 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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **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. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access- Control-Request-Method, Access-Control- Request-Headers, and Origin headers for the responses to be cached correctly. * **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. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(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. Your 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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. * *(string) --* * **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. * *(string) --* * **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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **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: * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. * How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the *Amazon CloudFront Developer Guide*. * **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: * The value of "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/*". * The value of "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: * Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute "200", the response typically won't be intercepted. * If you don't care about distinguishing among different client errors or server errors, you can specify "400" or "500" as the "ResponseCode" for all 4xx or 5xx errors. * You might want to return a "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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) * "MinimumProtocolVersion" * "SSLSupportMethod" * **IAMCertificateId** *(string) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 ServicesSupport 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: * The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers. * The ciphers that CloudFront can use to encrypt the content that it returns to viewers. 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: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **CertificateSource** *(string) --* This field is deprecated. Use one of the following fields instead: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **Restrictions** *(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. * *(string) --* * **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 Amazon Web Services Regions outside of China. The status values returned are the following: * **APPROVED** indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED, that is, valid to use with the China Regions, a CNAME must have one ICP recordal number associated with it. * **SUSPENDED** indicates that the associated CNAME does not have a valid ICP recordal number. * **PENDING** indicates that CloudFront can't determine the ICP recordal status of the CNAME associated with the distribution because there was an error in trying to determine the status. You can try again to see if the error is resolved in which case CloudFront returns an APPROVED or SUSPENDED status. * **Staging** *(boolean) --* A Boolean that indicates whether this is a staging distribution. When this value is "true", this is a staging distribution. When this value is "false", this is not a staging distribution. * **ConnectionMode** *(string) --* This field specifies whether the connection mode is through a standard distribution (direct) or a multi- tenant distribution with distribution tenants (tenant- only). * **AnycastIpListId** *(string) --* ID of the Anycast static IP list that is associated with the distribution. **Exceptions** * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / verify_dns_configuration verify_dns_configuration ************************ CloudFront.Client.verify_dns_configuration(**kwargs) Verify the DNS configuration for your domain names. This API operation checks whether your domain name points to the correct routing endpoint of the connection group, such as d111111abcdef8.cloudfront.net. You can use this API operation to troubleshoot and resolve DNS configuration issues. See also: AWS API Documentation **Request Syntax** response = client.verify_dns_configuration( Domain='string', Identifier='string' ) Parameters: * **Domain** (*string*) -- The domain name that you're verifying. * **Identifier** (*string*) -- **[REQUIRED]** The identifier of the distribution tenant. You can specify the ARN, ID, or name of the distribution tenant. Return type: dict Returns: **Response Syntax** { 'DnsConfigurationList': [ { 'Domain': 'string', 'Status': 'valid-configuration'|'invalid-configuration'|'unknown-configuration', 'Reason': 'string' }, ] } **Response Structure** * *(dict) --* * **DnsConfigurationList** *(list) --* The list of domain names, their statuses, and a description of each status. * *(dict) --* The DNS configuration for your domain names. * **Domain** *(string) --* The domain name that you're verifying. * **Status** *(string) --* The status of your domain name. * "valid-configuration": The domain name is correctly configured and points to the correct routing endpoint of the connection group. * "invalid-configuration": There is either a missing DNS record or the DNS record exists but it's using an incorrect routing endpoint. Update the DNS record to point to the correct routing endpoint. * "unknown-configuration": CloudFront can't validate your DNS configuration. This status can appear if CloudFront can't verify the DNS record, or the DNS lookup request failed or timed out. * **Reason** *(string) --* Explains the status of the DNS configuration. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / get_origin_access_control get_origin_access_control ************************* CloudFront.Client.get_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' ) Parameters: **Id** (*string*) -- **[REQUIRED]** The unique identifier of the origin access control. Return type: dict Returns: **Response Syntax** { 'OriginAccessControl': { 'Id': 'string', 'OriginAccessControlConfig': { 'Name': 'string', 'Description': 'string', 'SigningProtocol': 'sigv4', 'SigningBehavior': 'never'|'always'|'no-override', 'OriginAccessControlOriginType': 's3'|'mediastore'|'mediapackagev2'|'lambda' } }, 'ETag': 'string' } **Response Structure** * *(dict) --* * **OriginAccessControl** *(dict) --* Contains an origin access control, including its unique identifier. * **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. You can specify up to 64 characters. * **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 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. * **ETag** *(string) --* The version identifier for the current version of the origin access control. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.NoSuchOriginAccessControl" CloudFront / Client / describe_function describe_function ***************** CloudFront.Client.describe_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' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the function that you are getting information about. * **Stage** (*string*) -- The function's stage, either "DEVELOPMENT" or "LIVE". Return type: dict Returns: **Response Syntax** { 'FunctionSummary': { 'Name': 'string', 'Status': 'string', 'FunctionConfig': { 'Comment': 'string', 'Runtime': 'cloudfront-js-1.0'|'cloudfront-js-2.0', 'KeyValueStoreAssociations': { 'Quantity': 123, 'Items': [ { 'KeyValueStoreARN': 'string' }, ] } }, '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 version. * **KeyValueStoreAssociations** *(dict) --* The configuration for the key value store associations. * **Quantity** *(integer) --* The quantity of key value store associations. * **Items** *(list) --* The items of the key value store association. * *(dict) --* The key value store association. * **KeyValueStoreARN** *(string) --* The Amazon Resource Name (ARN) of the key value store association. * **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.UnsupportedOperation" * "CloudFront.Client.exceptions.NoSuchFunctionExists" CloudFront / Client / update_distribution update_distribution ******************* CloudFront.Client.update_distribution(**kwargs) Updates the configuration for a CloudFront distribution. The update process includes getting the current distribution configuration, updating it to make your changes, and then submitting an "UpdateDistribution" request to make the updates. **To update a web distribution using the CloudFront API** * Use "GetDistributionConfig" to get the current configuration, including the version identifier ( "ETag"). * Update the distribution configuration that was returned in the response. Note the following important requirements and restrictions: * You must copy the "ETag" field value from the response. (You'll use it for the "IfMatch" parameter in your request.) Then, remove the "ETag" field from the distribution configuration. * You can't change the value of "CallerReference". * Submit an "UpdateDistribution" request, providing the updated distribution configuration. The new configuration replaces the existing configuration. The values that you specify in an "UpdateDistribution" request are not merged into your existing configuration. Make sure to include all fields: the ones that you modified and also the ones that you didn't. 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', 'OriginReadTimeout': 123 }, '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 }, 'VpcOriginConfig': { 'VpcOriginId': 'string', 'OriginReadTimeout': 123, 'OriginKeepaliveTimeout': 123 }, 'ConnectionAttempts': 123, 'ConnectionTimeout': 123, 'ResponseCompletionTimeout': 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' }, ] }, 'SelectionCriteria': 'default'|'media-quality-based' }, ] }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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'|'None', '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'|'TLSv1.3_2025', '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, 'ContinuousDeploymentPolicyId': 'string', 'Staging': True|False, 'AnycastIpListId': 'string', 'TenantConfig': { 'ParameterDefinitions': [ { 'Name': 'string', 'Definition': { 'StringSchema': { 'Comment': 'string', 'DefaultValue': 'string', 'Required': True|False } } }, ] }, 'ConnectionMode': 'direct'|'tenant-only' }, Id='string', IfMatch='string' ) Parameters: * **DistributionConfig** (*dict*) -- **[REQUIRED]** The distribution's configuration information. * **CallerReference** *(string) --* **[REQUIRED]** 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution. * **Quantity** *(integer) --* **[REQUIRED]** 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. * *(string) --* * **DefaultRootObject** *(string) --* When a viewer requests the root URL for your distribution, the default root object is the object that you want CloudFront to request from your origin. For example, if your root URL is "https://www.example.com", you can specify CloudFront to return the "index.html" file as the default root object. You can specify a default root object so that viewers see a specific file or object, instead of another object in your distribution (for example, "https://www.example.com/product-description.html"). A default root object avoids exposing the contents of your distribution. You can specify the object name or a path to the object name (for example, "index.html" or "exampleFolderName/index.html"). Your string can't begin with a forward slash ( "/"). Only specify the object name or the path to the object. 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 Specify a default root object in the *Amazon CloudFront Developer Guide*. * **Origins** *(dict) --* **[REQUIRED]** A complex type that contains information about origins for this distribution. * **Quantity** *(integer) --* **[REQUIRED]** The number of origins for this distribution. * **Items** *(list) --* **[REQUIRED]** 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: * Use "S3OriginConfig" to specify an Amazon S3 bucket that is not configured with static website hosting. * Use "VpcOriginConfig" to specify a VPC origin. * Use "CustomOriginConfig" to specify all other kinds of origins, including: * An Amazon S3 bucket that is configured with static website hosting * An Elastic Load Balancing load balancer * An Elemental MediaPackage endpoint * An Elemental MediaStore container * Any other HTTP server, running on an Amazon EC2 instance or any other kind of host For the current maximum number of origins that you can specify per distribution, see General Quotas on Web Distributions in the *Amazon CloudFront Developer Guide* (quotas were formerly referred to as limits). * **Id** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of custom headers, if any, for this distribution. * **Items** *(list) --* **Optional**: A list that contains one "OriginCustomHeader" element for each custom header that you want CloudFront to forward to the origin. If Quantity is "0", omit "Items". * *(dict) --* A complex type that contains "HeaderName" and "HeaderValue" elements, if any, for this distribution. * **HeaderName** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** Note: If you're using origin access control (OAC) instead of origin access identity, specify an empty "OriginAccessIdentity" element. For more information, see Restricting access to an Amazon Web Services in the *Amazon CloudFront Developer Guide*. 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" The "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*. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see Response timeout 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) --* **[REQUIRED]** The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on. * **HTTPSPort** *(integer) --* **[REQUIRED]** The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on. * **OriginProtocolPolicy** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin. * **Items** *(list) --* **[REQUIRED]** A list that contains allowed SSL/TLS protocols for this distribution. * *(string) --* * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) in the *Amazon CloudFront Developer Guide*. * **VpcOriginConfig** *(dict) --* The VPC origin configuration. * **VpcOriginId** *(string) --* **[REQUIRED]** The VPC origin ID. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) 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*. * **ResponseCompletionTimeout** *(integer) --* The time (in seconds) that a request from CloudFront to the origin can stay open and wait for a response. If the complete response isn't received from the origin by this time, CloudFront ends the connection. The value for "ResponseCompletionTimeout" must be equal to or greater than the value for "OriginReadTimeout". If you don't set a value for "ResponseCompletionTimeout", CloudFront doesn't enforce a maximum value. For more information, see Response completion 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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 secondary 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 specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the secondary origin under the failover conditions that you've chosen. Optionally, you can choose selection criteria for your origin group to specify how your origins are selected when your distribution routes viewer requests. * **Id** *(string) --* **[REQUIRED]** The origin group's ID. * **FailoverCriteria** *(dict) --* **[REQUIRED]** A complex type that contains information about the failover criteria for an origin group. * **StatusCodes** *(dict) --* **[REQUIRED]** The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin. * **Quantity** *(integer) --* **[REQUIRED]** The number of status codes. * **Items** *(list) --* **[REQUIRED]** The items (status codes) for an origin group. * *(integer) --* * **Members** *(dict) --* **[REQUIRED]** A complex type that contains information about the origins in an origin group. * **Quantity** *(integer) --* **[REQUIRED]** The number of origins in an origin group. * **Items** *(list) --* **[REQUIRED]** Items (origins) in an origin group. * *(dict) --* An origin in an origin group. * **OriginId** *(string) --* **[REQUIRED]** The ID for an origin in an origin group. * **SelectionCriteria** *(string) --* The selection criteria for the origin group. For more information, see Create an origin group in the *Amazon CloudFront Developer Guide*. * **DefaultCacheBehavior** *(dict) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* **[REQUIRED]** This field is "true" if any of the Amazon Web Services accounts in the list are configured as trusted signers. If not, this field is "false". * **Quantity** *(integer) --* **[REQUIRED]** The number of Amazon Web Services accounts in the list. * **Items** *(list) --* A list of Amazon Web Services account identifiers. * *(string) --* * **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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of key groups in the list. * **Items** *(list) --* A list of key groups identifiers. * *(string) --* * **ViewerProtocolPolicy** *(string) --* **[REQUIRED]** 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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **Quantity** *(integer) --* **[REQUIRED]** 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) --* **[REQUIRED]** A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. * **Quantity** *(integer) --* **[REQUIRED]** 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) --* **[REQUIRED]** A complex type that contains the HTTP methods that you want CloudFront to cache responses to. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* **[REQUIRED]** The number of Lambda@Edge function associations for this cache behavior. * **Items** *(list) --* **Optional**: A complex type that contains "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(dict) --* A complex type that contains a Lambda@Edge function association. * **LambdaFunctionARN** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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. Your functions must be published to the "LIVE" stage to associate them with a cache behavior. * **Quantity** *(integer) --* **[REQUIRED]** The number of CloudFront functions in the list. * **Items** *(list) --* The CloudFront functions that are associated with a cache behavior in a CloudFront distribution. Your 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) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the function. * **EventType** *(string) --* **[REQUIRED]** 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* **[REQUIRED]** Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of cookie names in the "Items" list. * **Items** *(list) --* A list of cookie names. * *(string) --* * **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) --* **[REQUIRED]** The number of header names in the "Items" list. * **Items** *(list) --* A list of HTTP header names. * *(string) --* * **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) --* **[REQUIRED]** 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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **CacheBehaviors** *(dict) --* A complex type that contains zero or more "CacheBehavior" elements. * **Quantity** *(integer) --* **[REQUIRED]** 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 specify an empty individual "CacheBehavior" element, because this is invalid. For more information, see CacheBehaviors. 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. Warning: If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the "Cache- Control: no-cache", "no-store", or "private" directives are present in the origin headers. For more information about cache behaviors, see Cache Behavior Settings in the *Amazon CloudFront Developer Guide*. * **PathPattern** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* **[REQUIRED]** This field is "true" if any of the Amazon Web Services accounts in the list are configured as trusted signers. If not, this field is "false". * **Quantity** *(integer) --* **[REQUIRED]** The number of Amazon Web Services accounts in the list. * **Items** *(list) --* A list of Amazon Web Services account identifiers. * *(string) --* * **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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of key groups in the list. * **Items** *(list) --* A list of key groups identifiers. * *(string) --* * **ViewerProtocolPolicy** *(string) --* **[REQUIRED]** 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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **Quantity** *(integer) --* **[REQUIRED]** 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) --* **[REQUIRED]** A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control- Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. * **Quantity** *(integer) --* **[REQUIRED]** 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) --* **[REQUIRED]** A complex type that contains the HTTP methods that you want CloudFront to cache responses to. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* **[REQUIRED]** The number of Lambda@Edge function associations for this cache behavior. * **Items** *(list) --* **Optional**: A complex type that contains "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(dict) --* A complex type that contains a Lambda@Edge function association. * **LambdaFunctionARN** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of CloudFront functions in the list. * **Items** *(list) --* The CloudFront functions that are associated with a cache behavior in a CloudFront distribution. Your 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) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the function. * **EventType** *(string) --* **[REQUIRED]** 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* **[REQUIRED]** Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of cookie names in the "Items" list. * **Items** *(list) --* A list of cookie names. * *(string) --* * **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) --* **[REQUIRED]** The number of header names in the "Items" list. * **Items** *(list) --* A list of HTTP header names. * *(string) --* * **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) --* **[REQUIRED]** 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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **CustomErrorResponses** *(dict) --* A complex type that controls the following: * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. * How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the *Amazon CloudFront Developer Guide*. * **Quantity** *(integer) --* **[REQUIRED]** 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: * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. * How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the *Amazon CloudFront Developer Guide*. * **ErrorCode** *(integer) --* **[REQUIRED]** 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: * The value of "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/*". * The value of "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: * Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute "200", the response typically won't be intercepted. * If you don't care about distinguishing among different client errors or server errors, you can specify "400" or "500" as the "ResponseCode" for all 4xx or 5xx errors. * You might want to return a "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) --* **[REQUIRED]** A 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" and "prefix", 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, "amzn-s3-demo-bucket.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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* **[REQUIRED]** 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) * "MinimumProtocolVersion" * "SSLSupportMethod" * **IAMCertificateId** *(string) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 ServicesSupport 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: * The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers. * The ciphers that CloudFront can use to encrypt the content that it returns to viewers. 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: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **CertificateSource** *(string) --* This field is deprecated. Use one of the following fields instead: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **Restrictions** *(dict) --* A complex type that identifies ways in which you want to restrict distribution of your content. * **GeoRestriction** *(dict) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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. * *(string) --* * **WebACLId** *(string) --* Note: Multi-tenant distributions only support WAF V2 web ACLs. 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/we bacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111". To specify a web ACL created using WAF Classic, use the ACL ID, for example "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111". 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 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) --* Note: To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup. 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: * You enable IPv6 for the distribution * You're using alternate domain names in the URLs for your objects 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. * **ContinuousDeploymentPolicyId** *(string) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. The identifier of a continuous deployment policy. For more information, see "CreateContinuousDeploymentPolicy". * **Staging** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. A Boolean that indicates whether this is a staging distribution. When this value is "true", this is a staging distribution. When this value is "false", this is not a staging distribution. * **AnycastIpListId** *(string) --* Note: To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup. ID of the Anycast static IP list that is associated with the distribution. * **TenantConfig** *(dict) --* Note: This field only supports multi-tenant distributions. You can't specify this field for standard distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. A distribution tenant configuration. * **ParameterDefinitions** *(list) --* The parameters that you specify for a distribution tenant. * *(dict) --* A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution. * **Name** *(string) --* **[REQUIRED]** The name of the parameter. * **Definition** *(dict) --* **[REQUIRED]** The value that you assigned to the parameter. * **StringSchema** *(dict) --* An object that contains information about the string schema. * **Comment** *(string) --* A comment to describe the parameter. * **DefaultValue** *(string) --* The default value of the parameter. * **Required** *(boolean) --* **[REQUIRED]** Whether the defined parameter is required. * **ConnectionMode** *(string) --* This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only). * **Id** (*string*) -- **[REQUIRED]** The distribution's id. * **IfMatch** (*string*) -- The value of the "ETag" header that you received when retrieving the distribution's configuration. For example: "E2QWRUHAPOMQZL". Return type: dict Returns: **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', 'OriginReadTimeout': 123 }, '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 }, 'VpcOriginConfig': { 'VpcOriginId': 'string', 'OriginReadTimeout': 123, 'OriginKeepaliveTimeout': 123 }, 'ConnectionAttempts': 123, 'ConnectionTimeout': 123, 'ResponseCompletionTimeout': 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' }, ] }, 'SelectionCriteria': 'default'|'media-quality-based' }, ] }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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'|'None', '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'|'TLSv1.3_2025', '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, 'ContinuousDeploymentPolicyId': 'string', 'Staging': True|False, 'AnycastIpListId': 'string', 'TenantConfig': { 'ParameterDefinitions': [ { 'Name': 'string', 'Definition': { 'StringSchema': { 'Comment': 'string', 'DefaultValue': 'string', 'Required': True|False } } }, ] }, 'ConnectionMode': 'direct'|'tenant-only' }, '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 distribution's identifier. For example: "E1U5RQF7T870K0". * **ARN** *(string) --* The distribution's Amazon Resource Name (ARN). * **Status** *(string) --* The distribution's status. When the status is "Deployed", the distribution's information is fully propagated to all CloudFront edge locations. * **LastModifiedTime** *(datetime) --* The date and time when the distribution was last modified. * **InProgressInvalidationBatches** *(integer) --* The number of invalidation batches currently in progress. * **DomainName** *(string) --* The distribution's CloudFront domain name. For example: "d111111abcdef8.cloudfront.net". * **ActiveTrustedSigners** *(dict) --* Warning: We recommend using "TrustedKeyGroups" instead of "TrustedSigners". 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 are configured as trusted signers. 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. * *(string) --* * **ActiveTrustedKeyGroups** *(dict) --* 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. * *(string) --* * **DistributionConfig** *(dict) --* The distribution's configuration. * **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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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. * *(string) --* * **DefaultRootObject** *(string) --* When a viewer requests the root URL for your distribution, the default root object is the object that you want CloudFront to request from your origin. For example, if your root URL is "https://www.example.com", you can specify CloudFront to return the "index.html" file as the default root object. You can specify a default root object so that viewers see a specific file or object, instead of another object in your distribution (for example, "https://www.example.com /product-description.html"). A default root object avoids exposing the contents of your distribution. You can specify the object name or a path to the object name (for example, "index.html" or "exampleFolderName/index.html"). Your string can't begin with a forward slash ( "/"). Only specify the object name or the path to the object. 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 Specify 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: * Use "S3OriginConfig" to specify an Amazon S3 bucket that is not configured with static website hosting. * Use "VpcOriginConfig" to specify a VPC origin. * Use "CustomOriginConfig" to specify all other kinds of origins, including: * An Amazon S3 bucket that is configured with static website hosting * An Elastic Load Balancing load balancer * An Elemental MediaPackage endpoint * An Elemental MediaStore container * Any other HTTP server, running on an Amazon EC2 instance or any other kind of host For the current maximum number of origins that you can specify per distribution, see General Quotas on Web Distributions in the *Amazon CloudFront Developer Guide* (quotas were formerly referred to as limits). * **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 "OriginCustomHeader" element for each custom header that you want CloudFront to forward to the origin. If Quantity is "0", omit "Items". * *(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) --* Note: If you're using origin access control (OAC) instead of origin access identity, specify an empty "OriginAccessIdentity" element. For more information, see Restricting access to an Amazon Web Services in the *Amazon CloudFront Developer Guide*. 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" The "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*. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see Response timeout 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. * *(string) --* * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) in the *Amazon CloudFront Developer Guide*. * **VpcOriginConfig** *(dict) --* The VPC origin configuration. * **VpcOriginId** *(string) --* The VPC origin ID. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) 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*. * **ResponseCompletionTimeout** *(integer) --* The time (in seconds) that a request from CloudFront to the origin can stay open and wait for a response. If the complete response isn't received from the origin by this time, CloudFront ends the connection. The value for "ResponseCompletionTimeout" must be equal to or greater than the value for "OriginReadTimeout". If you don't set a value for "ResponseCompletionTimeout", CloudFront doesn't enforce a maximum value. For more information, see Response completion 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 secondary 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 specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the secondary origin under the failover conditions that you've chosen. Optionally, you can choose selection criteria for your origin group to specify how your origins are selected when your distribution routes viewer requests. * **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. * *(integer) --* * **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. * **SelectionCriteria** *(string) --* The selection criteria for the origin group. For more information, see Create an origin group in the *Amazon CloudFront Developer Guide*. * **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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **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. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control- Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. * **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. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(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. Your 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. Your 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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. * *(string) --* * **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. * *(string) --* * **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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **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 specify an empty individual "CacheBehavior" element, because this is invalid. For more information, see CacheBehaviors. 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. Warning: If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the "Cache-Control: no-cache", "no-store", or "private" directives are present in the origin headers. 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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **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. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control- Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. * **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. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(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. Your 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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. * *(string) --* * **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. * *(string) --* * **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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **CustomErrorResponses** *(dict) --* A complex type that controls the following: * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. * How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the *Amazon CloudFront Developer Guide*. * **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: * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. * How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the *Amazon CloudFront Developer Guide*. * **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: * The value of "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/*". * The value of "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: * Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute "200", the response typically won't be intercepted. * If you don't care about distinguishing among different client errors or server errors, you can specify "400" or "500" as the "ResponseCode" for all 4xx or 5xx errors. * You might want to return a "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) --* A 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" and "prefix", 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, "amzn-s3-demo-bucket.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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) * "MinimumProtocolVersion" * "SSLSupportMethod" * **IAMCertificateId** *(string) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 ServicesSupport 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: * The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers. * The ciphers that CloudFront can use to encrypt the content that it returns to viewers. 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: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **CertificateSource** *(string) --* This field is deprecated. Use one of the following fields instead: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **Restrictions** *(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. * *(string) --* * **WebACLId** *(string) --* Note: Multi-tenant distributions only support WAF V2 web ACLs. 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:123456789 012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef- EXAMPLE11111". To specify a web ACL created using WAF Classic, use the ACL ID, for example "a1b2c3d4-5678 -90ab-cdef-EXAMPLE11111". 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 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) --* Note: To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup. 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: * You enable IPv6 for the distribution * You're using alternate domain names in the URLs for your objects 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. * **ContinuousDeploymentPolicyId** *(string) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. The identifier of a continuous deployment policy. For more information, see "CreateContinuousDeploymentPolicy". * **Staging** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. A Boolean that indicates whether this is a staging distribution. When this value is "true", this is a staging distribution. When this value is "false", this is not a staging distribution. * **AnycastIpListId** *(string) --* Note: To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup. ID of the Anycast static IP list that is associated with the distribution. * **TenantConfig** *(dict) --* Note: This field only supports multi-tenant distributions. You can't specify this field for standard distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. A distribution tenant configuration. * **ParameterDefinitions** *(list) --* The parameters that you specify for a distribution tenant. * *(dict) --* A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution. * **Name** *(string) --* The name of the parameter. * **Definition** *(dict) --* The value that you assigned to the parameter. * **StringSchema** *(dict) --* An object that contains information about the string schema. * **Comment** *(string) --* A comment to describe the parameter. * **DefaultValue** *(string) --* The default value of the parameter. * **Required** *(boolean) --* Whether the defined parameter is required. * **ConnectionMode** *(string) --* This field specifies whether the connection mode is through a standard distribution (direct) or a multi- tenant distribution with distribution tenants (tenant- only). * **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 Amazon Web Services Regions outside of China. The status values returned are the following: * **APPROVED** indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED, that is, valid to use with the China Regions, a CNAME must have one ICP recordal number associated with it. * **SUSPENDED** indicates that the associated CNAME does not have a valid ICP recordal number. * **PENDING** indicates that CloudFront can't determine the ICP recordal status of the CNAME associated with the distribution because there was an error in trying to determine the status. You can try again to see if the error is resolved in which case CloudFront returns an APPROVED or SUSPENDED status. * **ETag** *(string) --* The current version of the configuration. For example: "E2QWRUHAPOMQZL". **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToOr iginAccessControl" * "CloudFront.Client.exceptions.InvalidDefaultRootObject" * "CloudFront.Client.exceptions.InvalidDomainNameForOriginAccessCo ntrol" * "CloudFront.Client.exceptions.InvalidQueryStringParameters" * "CloudFront.Client.exceptions.TooManyTrustedSigners" * "CloudFront.Client.exceptions.TooManyCookieNamesInWhiteList" * "CloudFront.Client.exceptions.NoSuchFieldLevelEncryptionConfig" * "CloudFront.Client.exceptions.InvalidErrorCode" * "CloudFront.Client.exceptions.IllegalOriginAccessConfiguration" * "CloudFront.Client.exceptions.TooManyFunctionAssociations" * "CloudFront.Client.exceptions.TooManyOriginCustomHeaders" * "CloudFront.Client.exceptions.InvalidForwardCookies" * "CloudFront.Client.exceptions.InvalidMinimumProtocolVersion" * "CloudFront.Client.exceptions.NoSuchCachePolicy" * "CloudFront.Client.exceptions.TooManyKeyGroupsAssociatedToDistri bution" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToCa chePolicy" * "CloudFront.Client.exceptions.InvalidRequiredProtocol" * "CloudFront.Client.exceptions.TooManyDistributionsWithFunctionAs sociations" * "CloudFront.Client.exceptions.TooManyOriginGroupsPerDistribution" * "CloudFront.Client.exceptions.InvalidTTLOrder" * "CloudFront.Client.exceptions.IllegalFieldLevelEncryptionConfigA ssociationWithCacheBehavior" * "CloudFront.Client.exceptions.InvalidOriginKeepaliveTimeout" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.InvalidOriginReadTimeout" * "CloudFront.Client.exceptions.IllegalUpdate" * "CloudFront.Client.exceptions.InvalidOriginAccessControl" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.StagingDistributionInUse" * "CloudFront.Client.exceptions.InvalidHeadersForS3Origin" * "CloudFront.Client.exceptions.TrustedSignerDoesNotExist" * "CloudFront.Client.exceptions.InvalidWebACLId" * "CloudFront.Client.exceptions.TooManyDistributionsWithSingleFunc tionARN" * "CloudFront.Client.exceptions.InvalidRelativePath" * "CloudFront.Client.exceptions.TooManyLambdaFunctionAssociations" * "CloudFront.Client.exceptions.NoSuchDistribution" * "CloudFront.Client.exceptions.NoSuchOriginRequestPolicy" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToFi eldLevelEncryptionConfig" * "CloudFront.Client.exceptions.InconsistentQuantities" * "CloudFront.Client.exceptions.InvalidLocationCode" * "CloudFront.Client.exceptions.InvalidOriginAccessIdentity" * "CloudFront.Client.exceptions.TooManyDistributionCNAMEs" * "CloudFront.Client.exceptions.NoSuchContinuousDeploymentPolicy" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToOr iginRequestPolicy" * "CloudFront.Client.exceptions.TooManyQueryStringParameters" * "CloudFront.Client.exceptions.RealtimeLogConfigOwnerMismatch" * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.ContinuousDeploymentPolicyInUse" * "CloudFront.Client.exceptions.MissingBody" * "CloudFront.Client.exceptions.TooManyHeadersInForwardedValues" * "CloudFront.Client.exceptions.InvalidLambdaFunctionAssociation" * "CloudFront.Client.exceptions.CNAMEAlreadyExists" * "CloudFront.Client.exceptions.TooManyCertificates" * "CloudFront.Client.exceptions.TrustedKeyGroupDoesNotExist" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToRe sponseHeadersPolicy" * "CloudFront.Client.exceptions.NoSuchResponseHeadersPolicy" * "CloudFront.Client.exceptions.NoSuchRealtimeLogConfig" * "CloudFront.Client.exceptions.InvalidResponseCode" * "CloudFront.Client.exceptions.InvalidGeoRestrictionParameter" * "CloudFront.Client.exceptions.TooManyOrigins" * "CloudFront.Client.exceptions.InvalidViewerCertificate" * "CloudFront.Client.exceptions.InvalidFunctionAssociation" * "CloudFront.Client.exceptions.TooManyDistributionsWithLambdaAsso ciations" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToKe yGroup" * "CloudFront.Client.exceptions.NoSuchOrigin" * "CloudFront.Client.exceptions.TooManyCacheBehaviors" CloudFront / Client / update_field_level_encryption_profile update_field_level_encryption_profile ************************************* CloudFront.Client.update_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' ) Parameters: * **FieldLevelEncryptionProfileConfig** (*dict*) -- **[REQUIRED]** Request to update a field-level encryption profile. * **Name** *(string) --* **[REQUIRED]** Profile name for the field-level encryption profile. * **CallerReference** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of field-level encryption field patterns. * **Items** *(list) --* An array of the field-level encryption field patterns. * *(string) --* * **Id** (*string*) -- **[REQUIRED]** The ID of the field-level encryption profile request. * **IfMatch** (*string*) -- The value of the "ETag" header that you received when retrieving the profile identity to update. For example: "E2QWRUHAPOMQZL". Return type: dict Returns: **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. * *(string) --* * **ETag** *(string) --* The result of the field-level encryption profile request. **Exceptions** * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.TooManyFieldLevelEncryptionFieldPa tterns" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.FieldLevelEncryptionProfileAlready Exists" * "CloudFront.Client.exceptions.NoSuchPublicKey" * "CloudFront.Client.exceptions.FieldLevelEncryptionProfileSizeExc eeded" * "CloudFront.Client.exceptions.InconsistentQuantities" * "CloudFront.Client.exceptions.NoSuchFieldLevelEncryptionProfile" * "CloudFront.Client.exceptions.TooManyFieldLevelEncryptionEncrypt ionEntities" * "CloudFront.Client.exceptions.IllegalUpdate" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / create_streaming_distribution_with_tags create_streaming_distribution_with_tags *************************************** CloudFront.Client.create_streaming_distribution_with_tags(**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_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'|'None', 'Enabled': True|False }, 'Tags': { 'Items': [ { 'Key': 'string', 'Value': 'string' }, ] } } ) Parameters: **StreamingDistributionConfigWithTags** (*dict*) -- **[REQUIRED]** The streaming distribution's configuration information. * **StreamingDistributionConfig** *(dict) --* **[REQUIRED]** A streaming distribution Configuration. * **CallerReference** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The DNS name of the Amazon S3 origin. * **OriginAccessIdentity** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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. * *(string) --* * **Comment** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The Amazon S3 bucket to store the access logs in, for example, "amzn-s3-demo-bucket.s3.amazonaws.com". * **Prefix** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** This field is "true" if any of the Amazon Web Services accounts in the list are configured as trusted signers. If not, this field is "false". * **Quantity** *(integer) --* **[REQUIRED]** The number of Amazon Web Services accounts in the list. * **Items** *(list) --* A list of Amazon Web Services account identifiers. * *(string) --* * **PriceClass** *(string) --* A complex type that contains information about price class for this streaming distribution. * **Enabled** *(boolean) --* **[REQUIRED]** Whether the streaming distribution is enabled to accept user requests for content. * **Tags** *(dict) --* **[REQUIRED]** A complex type that contains zero or more "Tag" elements. * **Items** *(list) --* A complex type that contains "Tag" elements. * *(dict) --* A complex type that contains "Tag" key and "Tag" value. * **Key** *(string) --* **[REQUIRED]** 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 "_ - . : / = + @". * **Value** *(string) --* 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 "_ - . : / = + @". Return type: dict Returns: **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'|'None', 'Enabled': True|False } }, 'Location': 'string', '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/E DFDVBD632BHDS5", 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 are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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, "amzn-s3-demo-bucket.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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * **Location** *(string) --* The fully qualified URI of the new streaming distribution resource just created. * **ETag** *(string) --* The current version of the distribution created. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.StreamingDistributionAlreadyExists" * "CloudFront.Client.exceptions.InconsistentQuantities" * "CloudFront.Client.exceptions.InvalidOriginAccessIdentity" * "CloudFront.Client.exceptions.InvalidTagging" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.TooManyTrustedSigners" * "CloudFront.Client.exceptions.InvalidOriginAccessControl" * "CloudFront.Client.exceptions.TooManyStreamingDistributions" * "CloudFront.Client.exceptions.MissingBody" * "CloudFront.Client.exceptions.TooManyStreamingDistributionCNAMEs" * "CloudFront.Client.exceptions.TrustedSignerDoesNotExist" * "CloudFront.Client.exceptions.CNAMEAlreadyExists" * "CloudFront.Client.exceptions.InvalidOrigin" CloudFront / Client / create_cloud_front_origin_access_identity create_cloud_front_origin_access_identity ***************************************** CloudFront.Client.create_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' } ) Parameters: **CloudFrontOriginAccessIdentityConfig** (*dict*) -- **[REQUIRED]** The current configuration information for the identity. * **CallerReference** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** A comment to describe the origin access identity. The comment cannot be longer than 128 characters. Return type: dict Returns: **Response Syntax** { 'CloudFrontOriginAccessIdentity': { 'Id': 'string', 'S3CanonicalUserId': 'string', 'CloudFrontOriginAccessIdentityConfig': { 'CallerReference': 'string', 'Comment': 'string' } }, 'Location': '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. * **Location** *(string) --* The fully qualified URI of the new origin access identity just created. * **ETag** *(string) --* The current version of the origin access identity created. **Exceptions** * "CloudFront.Client.exceptions.MissingBody" * "CloudFront.Client.exceptions.TooManyCloudFrontOriginAccessIdent ities" * "CloudFront.Client.exceptions.InconsistentQuantities" * "CloudFront.Client.exceptions.CloudFrontOriginAccessIdentityAlre adyExists" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / associate_distribution_tenant_web_acl associate_distribution_tenant_web_acl ************************************* CloudFront.Client.associate_distribution_tenant_web_acl(**kwargs) Associates the WAF web ACL with a distribution tenant. See also: AWS API Documentation **Request Syntax** response = client.associate_distribution_tenant_web_acl( Id='string', WebACLArn='string', IfMatch='string' ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The ID of the distribution tenant. * **WebACLArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the WAF web ACL to associate. * **IfMatch** (*string*) -- The current "ETag" of the distribution tenant. This value is returned in the response of the "GetDistributionTenant" API operation. Return type: dict Returns: **Response Syntax** { 'Id': 'string', 'WebACLArn': 'string', 'ETag': 'string' } **Response Structure** * *(dict) --* * **Id** *(string) --* The ID of the distribution tenant. * **WebACLArn** *(string) --* The ARN of the WAF web ACL that you associated with the distribution tenant. * **ETag** *(string) --* The current version of the distribution tenant. **Exceptions** * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / get_cache_policy get_cache_policy **************** CloudFront.Client.get_cache_policy(**kwargs) Gets a cache policy, including the following metadata: * The policy's identifier. * The date and time when the policy was last modified. 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' ) Parameters: **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". Return type: dict Returns: **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) --* 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 also 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: * Normalizes the value of the viewer's "Accept- Encoding" header * Includes the normalized header in the cache key * Includes the normalized header in the request to the origin, if a request is necessary For 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: * Normalizes the value of the viewer's "Accept- Encoding" header * Includes the normalized header in the cache key * Includes the normalized header in the request to the origin, if a request is necessary For 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 in requests that CloudFront sends to the origin. * **HeaderBehavior** *(string) --* Determines whether any HTTP headers are included in the cache key and in requests that CloudFront sends to the origin. Valid values are: * "none" – No HTTP headers are included in the cache key or 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" – Only the HTTP headers that are listed in the "Headers" type are included in the cache key and 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. * *(string) --* * **CookiesConfig** *(dict) --* An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin. * **CookieBehavior** *(string) --* Determines whether any cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are: * "none" – No cookies in viewer requests are included in the cache key or 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" – Only the cookies in viewer requests that are listed in the "CookieNames" type are included in the cache key and in requests that CloudFront sends to the origin. * "allExcept" – All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, **except** for those that are listed in the "CookieNames" type, which are not included. * "all" – All cookies in viewer requests are included in the cache key and 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. * *(string) --* * **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 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 in requests that CloudFront sends to the origin. Valid values are: * "none" – No query strings in viewer requests are included in the cache key or 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" – Only the query strings in viewer requests that are listed in the "QueryStringNames" type are included in the cache key and in requests that CloudFront sends to the origin. * "allExcept" – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, **except** those that are listed in the "QueryStringNames" type, which are not included. * "all" – All query strings in viewer requests are included in the cache key and 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 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. * *(string) --* * **ETag** *(string) --* The current version of the cache policy. **Exceptions** * "CloudFront.Client.exceptions.NoSuchCachePolicy" * "CloudFront.Client.exceptions.AccessDenied" CloudFront / Client / create_anycast_ip_list create_anycast_ip_list ********************** CloudFront.Client.create_anycast_ip_list(**kwargs) Creates an Anycast static IP list. See also: AWS API Documentation **Request Syntax** response = client.create_anycast_ip_list( Name='string', IpCount=123, Tags={ 'Items': [ { 'Key': 'string', 'Value': 'string' }, ] } ) Parameters: * **Name** (*string*) -- **[REQUIRED]** Name of the Anycast static IP list. * **IpCount** (*integer*) -- **[REQUIRED]** The number of static IP addresses that are allocated to the Anycast static IP list. Valid values: 21 or 3. * **Tags** (*dict*) -- A complex type that contains zero or more "Tag" elements. * **Items** *(list) --* A complex type that contains "Tag" elements. * *(dict) --* A complex type that contains "Tag" key and "Tag" value. * **Key** *(string) --* **[REQUIRED]** 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 "_ - . : / = + @". * **Value** *(string) --* 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 "_ - . : / = + @". Return type: dict Returns: **Response Syntax** { 'AnycastIpList': { 'Id': 'string', 'Name': 'string', 'Status': 'string', 'Arn': 'string', 'AnycastIps': [ 'string', ], 'IpCount': 123, 'LastModifiedTime': datetime(2015, 1, 1) }, 'ETag': 'string' } **Response Structure** * *(dict) --* * **AnycastIpList** *(dict) --* A response structure that includes the version identifier (ETag) and the created AnycastIpList structure. * **Id** *(string) --* The ID of the Anycast static IP list. * **Name** *(string) --* The name of the Anycast static IP list. * **Status** *(string) --* The status of the Anycast static IP list. Valid values: "Deployed", "Deploying", or "Failed". * **Arn** *(string) --* The Amazon Resource Name (ARN) of the Anycast static IP list. * **AnycastIps** *(list) --* The static IP addresses that are allocated to the Anycast static IP list. * *(string) --* * **IpCount** *(integer) --* The number of IP addresses in the Anycast static IP list. * **LastModifiedTime** *(datetime) --* The last time the Anycast static IP list was modified. * **ETag** *(string) --* The version identifier for the current version of the Anycast static IP list. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.UnsupportedOperation" * "CloudFront.Client.exceptions.EntityAlreadyExists" * "CloudFront.Client.exceptions.InvalidTagging" * "CloudFront.Client.exceptions.EntityLimitExceeded" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / list_connection_groups list_connection_groups ********************** CloudFront.Client.list_connection_groups(**kwargs) Lists the connection groups in your Amazon Web Services account. See also: AWS API Documentation **Request Syntax** response = client.list_connection_groups( AssociationFilter={ 'AnycastIpListId': 'string' }, Marker='string', MaxItems=123 ) Parameters: * **AssociationFilter** (*dict*) -- Filter by associated Anycast IP list ID. * **AnycastIpListId** *(string) --* The ID of the Anycast static IP list. * **Marker** (*string*) -- The marker for the next set of connection groups to retrieve. * **MaxItems** (*integer*) -- The maximum number of connection groups to return. Return type: dict Returns: **Response Syntax** { 'NextMarker': 'string', 'ConnectionGroups': [ { 'Id': 'string', 'Name': 'string', 'Arn': 'string', 'RoutingEndpoint': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'ETag': 'string', 'AnycastIpListId': 'string', 'Enabled': True|False, 'Status': 'string', 'IsDefault': True|False }, ] } **Response Structure** * *(dict) --* * **NextMarker** *(string) --* A token used for pagination of results returned in the response. You can use the token from the previous request to define where the current request should begin. * **ConnectionGroups** *(list) --* The list of connection groups that you retrieved. * *(dict) --* A summary that contains details about your connection groups. * **Id** *(string) --* The ID of the connection group. * **Name** *(string) --* The name of the connection group. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the connection group. * **RoutingEndpoint** *(string) --* The routing endpoint (also known as the DNS name) that is assigned to the connection group, such as d111111abcdef8.cloudfront.net. * **CreatedTime** *(datetime) --* The date and time when the connection group was created. * **LastModifiedTime** *(datetime) --* The date and time when the connection group was updated. * **ETag** *(string) --* The current version of the connection group. * **AnycastIpListId** *(string) --* The ID of the Anycast static IP list. * **Enabled** *(boolean) --* Whether the connection group is enabled * **Status** *(string) --* The status of the connection group. * **IsDefault** *(boolean) --* Whether the connection group is the default connection group for the distribution tenants. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / get_cloud_front_origin_access_identity get_cloud_front_origin_access_identity ************************************** CloudFront.Client.get_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' ) Parameters: **Id** (*string*) -- **[REQUIRED]** The identity's ID. Return type: dict Returns: **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 origin access identity's information. For example: "E2QWRUHAPOMQZL". **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.NoSuchCloudFrontOriginAccessIdenti ty" CloudFront / Client / get_continuous_deployment_policy_config get_continuous_deployment_policy_config *************************************** CloudFront.Client.get_continuous_deployment_policy_config(**kwargs) Gets configuration information about a continuous deployment policy. See also: AWS API Documentation **Request Syntax** response = client.get_continuous_deployment_policy_config( Id='string' ) Parameters: **Id** (*string*) -- **[REQUIRED]** The identifier of the continuous deployment policy whose configuration you are getting. Return type: dict Returns: **Response Syntax** { 'ContinuousDeploymentPolicyConfig': { 'StagingDistributionDnsNames': { 'Quantity': 123, 'Items': [ 'string', ] }, 'Enabled': True|False, 'TrafficConfig': { 'SingleWeightConfig': { 'Weight': ..., 'SessionStickinessConfig': { 'IdleTTL': 123, 'MaximumTTL': 123 } }, 'SingleHeaderConfig': { 'Header': 'string', 'Value': 'string' }, 'Type': 'SingleWeight'|'SingleHeader' } }, 'ETag': 'string' } **Response Structure** * *(dict) --* * **ContinuousDeploymentPolicyConfig** *(dict) --* Contains the configuration for a continuous deployment policy. * **StagingDistributionDnsNames** *(dict) --* The CloudFront domain name of the staging distribution. For example: "d111111abcdef8.cloudfront.net". * **Quantity** *(integer) --* The number of CloudFront domain names in your staging distribution. * **Items** *(list) --* The CloudFront domain name of the staging distribution. * *(string) --* * **Enabled** *(boolean) --* A Boolean that indicates whether this continuous deployment policy is enabled (in effect). When this value is "true", this policy is enabled and in effect. When this value is "false", this policy is not enabled and has no effect. * **TrafficConfig** *(dict) --* Contains the parameters for routing production traffic from your primary to staging distributions. * **SingleWeightConfig** *(dict) --* Contains the percentage of traffic to send to the staging distribution. * **Weight** *(float) --* The percentage of traffic to send to a staging distribution, expressed as a decimal number between 0 and 0.15. For example, a value of 0.10 means 10% of traffic is sent to the staging distribution. * **SessionStickinessConfig** *(dict) --* Session stickiness provides the ability to define multiple requests from a single viewer as a single session. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution. Define the session duration using TTL values. * **IdleTTL** *(integer) --* The amount of time after which you want sessions to cease if no requests are received. Allowed values are 300–3600 seconds (5–60 minutes). The value must be less than or equal to "MaximumTTL". * **MaximumTTL** *(integer) --* The maximum amount of time to consider requests from the viewer as being part of the same session. Allowed values are 300–3600 seconds (5–60 minutes). The value must be greater than or equal to "IdleTTL". * **SingleHeaderConfig** *(dict) --* Determines which HTTP requests are sent to the staging distribution. * **Header** *(string) --* The request header name that you want CloudFront to send to your staging distribution. The header must contain the prefix "aws-cf-cd-". * **Value** *(string) --* The request header value. * **Type** *(string) --* The type of traffic configuration. * **ETag** *(string) --* The version identifier for the current version of the continuous deployment policy. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.NoSuchContinuousDeploymentPolicy" CloudFront / Client / create_cache_policy create_cache_policy ******************* CloudFront.Client.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 values that CloudFront includes in the *cache key*. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer. * The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache. Warning: If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the "Cache-Control: no-cache", "no-store", or "private" directives are present in the origin headers. The headers, cookies, and query strings that are included in the cache key are also 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', ] } } } } ) Parameters: **CachePolicyConfig** (*dict*) -- **[REQUIRED]** A cache policy configuration. * **Comment** *(string) --* A comment to describe the cache policy. The comment cannot be longer than 128 characters. * **Name** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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 also included in requests that CloudFront sends to the origin. * **EnableAcceptEncodingGzip** *(boolean) --* **[REQUIRED]** 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: * Normalizes the value of the viewer's "Accept-Encoding" header * Includes the normalized header in the cache key * Includes the normalized header in the request to the origin, if a request is necessary For 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: * Normalizes the value of the viewer's "Accept-Encoding" header * Includes the normalized header in the cache key * Includes the normalized header in the request to the origin, if a request is necessary For 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) --* **[REQUIRED]** An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and in requests that CloudFront sends to the origin. * **HeaderBehavior** *(string) --* **[REQUIRED]** Determines whether any HTTP headers are included in the cache key and in requests that CloudFront sends to the origin. Valid values are: * "none" – No HTTP headers are included in the cache key or 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" – Only the HTTP headers that are listed in the "Headers" type are included in the cache key and in requests that CloudFront sends to the origin. * **Headers** *(dict) --* Contains a list of HTTP header names. * **Quantity** *(integer) --* **[REQUIRED]** The number of header names in the "Items" list. * **Items** *(list) --* A list of HTTP header names. * *(string) --* * **CookiesConfig** *(dict) --* **[REQUIRED]** An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin. * **CookieBehavior** *(string) --* **[REQUIRED]** Determines whether any cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are: * "none" – No cookies in viewer requests are included in the cache key or 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" – Only the cookies in viewer requests that are listed in the "CookieNames" type are included in the cache key and in requests that CloudFront sends to the origin. * "allExcept" – All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, **except** for those that are listed in the "CookieNames" type, which are not included. * "all" – All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. * **Cookies** *(dict) --* Contains a list of cookie names. * **Quantity** *(integer) --* **[REQUIRED]** The number of cookie names in the "Items" list. * **Items** *(list) --* A list of cookie names. * *(string) --* * **QueryStringsConfig** *(dict) --* **[REQUIRED]** 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 in requests that CloudFront sends to the origin. * **QueryStringBehavior** *(string) --* **[REQUIRED]** Determines whether any URL query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are: * "none" – No query strings in viewer requests are included in the cache key or 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" – Only the query strings in viewer requests that are listed in the "QueryStringNames" type are included in the cache key and in requests that CloudFront sends to the origin. * "allExcept" – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, **except** those that are listed in the "QueryStringNames" type, which are not included. * "all" – All query strings in viewer requests are included in the cache key and 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 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) --* **[REQUIRED]** The number of query string names in the "Items" list. * **Items** *(list) --* A list of query string names. * *(string) --* Return type: dict Returns: **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', ] } } } } }, 'Location': '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 also 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: * Normalizes the value of the viewer's "Accept- Encoding" header * Includes the normalized header in the cache key * Includes the normalized header in the request to the origin, if a request is necessary For 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: * Normalizes the value of the viewer's "Accept- Encoding" header * Includes the normalized header in the cache key * Includes the normalized header in the request to the origin, if a request is necessary For 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 in requests that CloudFront sends to the origin. * **HeaderBehavior** *(string) --* Determines whether any HTTP headers are included in the cache key and in requests that CloudFront sends to the origin. Valid values are: * "none" – No HTTP headers are included in the cache key or 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" – Only the HTTP headers that are listed in the "Headers" type are included in the cache key and 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. * *(string) --* * **CookiesConfig** *(dict) --* An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin. * **CookieBehavior** *(string) --* Determines whether any cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are: * "none" – No cookies in viewer requests are included in the cache key or 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" – Only the cookies in viewer requests that are listed in the "CookieNames" type are included in the cache key and in requests that CloudFront sends to the origin. * "allExcept" – All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, **except** for those that are listed in the "CookieNames" type, which are not included. * "all" – All cookies in viewer requests are included in the cache key and 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. * *(string) --* * **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 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 in requests that CloudFront sends to the origin. Valid values are: * "none" – No query strings in viewer requests are included in the cache key or 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" – Only the query strings in viewer requests that are listed in the "QueryStringNames" type are included in the cache key and in requests that CloudFront sends to the origin. * "allExcept" – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, **except** those that are listed in the "QueryStringNames" type, which are not included. * "all" – All query strings in viewer requests are included in the cache key and 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 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. * *(string) --* * **Location** *(string) --* The fully qualified URI of the cache policy just created. * **ETag** *(string) --* The current version of the cache policy. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.TooManyHeadersInCachePolicy" * "CloudFront.Client.exceptions.CachePolicyAlreadyExists" * "CloudFront.Client.exceptions.TooManyCookiesInCachePolicy" * "CloudFront.Client.exceptions.InconsistentQuantities" * "CloudFront.Client.exceptions.TooManyCachePolicies" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.TooManyQueryStringsInCachePolicy" CloudFront / Client / list_invalidations_for_distribution_tenant list_invalidations_for_distribution_tenant ****************************************** CloudFront.Client.list_invalidations_for_distribution_tenant(**kwargs) Lists the invalidations for a distribution tenant. See also: AWS API Documentation **Request Syntax** response = client.list_invalidations_for_distribution_tenant( Id='string', Marker='string', MaxItems=123 ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The ID of the distribution tenant. * **Marker** (*string*) -- Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set "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. * **MaxItems** (*integer*) -- The maximum number of invalidations to return for the distribution tenant. Return type: dict Returns: **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) --* * **InvalidationList** *(dict) --* The "InvalidationList" complex type describes the list of invalidation objects. For more information about invalidation, see Invalidating Objects (Web Distributions Only) in the *Amazon CloudFront Developer Guide*. * **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.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / create_streaming_distribution create_streaming_distribution ***************************** CloudFront.Client.create_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'|'None', 'Enabled': True|False } ) Parameters: **StreamingDistributionConfig** (*dict*) -- **[REQUIRED]** The streaming distribution's configuration information. * **CallerReference** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The DNS name of the Amazon S3 origin. * **OriginAccessIdentity** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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. * *(string) --* * **Comment** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The Amazon S3 bucket to store the access logs in, for example, "amzn-s3-demo-bucket.s3.amazonaws.com". * **Prefix** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** This field is "true" if any of the Amazon Web Services accounts in the list are configured as trusted signers. If not, this field is "false". * **Quantity** *(integer) --* **[REQUIRED]** The number of Amazon Web Services accounts in the list. * **Items** *(list) --* A list of Amazon Web Services account identifiers. * *(string) --* * **PriceClass** *(string) --* A complex type that contains information about price class for this streaming distribution. * **Enabled** *(boolean) --* **[REQUIRED]** Whether the streaming distribution is enabled to accept user requests for content. Return type: dict Returns: **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'|'None', 'Enabled': True|False } }, 'Location': 'string', '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/E DFDVBD632BHDS5", 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 are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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, "amzn-s3-demo-bucket.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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * **Location** *(string) --* The fully qualified URI of the new streaming distribution resource just created. * **ETag** *(string) --* The current version of the streaming distribution created. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.StreamingDistributionAlreadyExists" * "CloudFront.Client.exceptions.InconsistentQuantities" * "CloudFront.Client.exceptions.InvalidOriginAccessIdentity" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.TooManyTrustedSigners" * "CloudFront.Client.exceptions.InvalidOriginAccessControl" * "CloudFront.Client.exceptions.TooManyStreamingDistributions" * "CloudFront.Client.exceptions.MissingBody" * "CloudFront.Client.exceptions.TooManyStreamingDistributionCNAMEs" * "CloudFront.Client.exceptions.TrustedSignerDoesNotExist" * "CloudFront.Client.exceptions.CNAMEAlreadyExists" * "CloudFront.Client.exceptions.InvalidOrigin" CloudFront / Client / delete_vpc_origin delete_vpc_origin ***************** CloudFront.Client.delete_vpc_origin(**kwargs) Delete an Amazon CloudFront VPC origin. See also: AWS API Documentation **Request Syntax** response = client.delete_vpc_origin( Id='string', IfMatch='string' ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The VPC origin ID. * **IfMatch** (*string*) -- **[REQUIRED]** The version identifier of the VPC origin to delete. This is the "ETag" value returned in the response to GetVpcOrigin. Return type: dict Returns: **Response Syntax** { 'VpcOrigin': { 'Id': 'string', 'Arn': 'string', 'Status': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'VpcOriginEndpointConfig': { 'Name': 'string', 'Arn': 'string', 'HTTPPort': 123, 'HTTPSPort': 123, 'OriginProtocolPolicy': 'http-only'|'match-viewer'|'https-only', 'OriginSslProtocols': { 'Quantity': 123, 'Items': [ 'SSLv3'|'TLSv1'|'TLSv1.1'|'TLSv1.2', ] } } }, 'ETag': 'string' } **Response Structure** * *(dict) --* * **VpcOrigin** *(dict) --* The VPC origin. * **Id** *(string) --* The VPC origin ID. * **Arn** *(string) --* The VPC origin ARN. * **Status** *(string) --* The VPC origin status. * **CreatedTime** *(datetime) --* The VPC origin created time. * **LastModifiedTime** *(datetime) --* The VPC origin last modified time. * **VpcOriginEndpointConfig** *(dict) --* The VPC origin endpoint configuration. * **Name** *(string) --* The name of the CloudFront VPC origin endpoint configuration. * **Arn** *(string) --* The ARN of the CloudFront VPC origin endpoint configuration. * **HTTPPort** *(integer) --* The HTTP port for the CloudFront VPC origin endpoint configuration. The default value is "80". * **HTTPSPort** *(integer) --* The HTTPS port of the CloudFront VPC origin endpoint configuration. The default value is "443". * **OriginProtocolPolicy** *(string) --* The origin protocol policy for the CloudFront VPC origin endpoint configuration. * **OriginSslProtocols** *(dict) --* A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin. * **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. * *(string) --* * **ETag** *(string) --* The VPC origin ETag. **Exceptions** * "CloudFront.Client.exceptions.CannotDeleteEntityWhileInUse" * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.IllegalDelete" * "CloudFront.Client.exceptions.UnsupportedOperation" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / list_tags_for_resource list_tags_for_resource ********************** CloudFront.Client.list_tags_for_resource(**kwargs) List tags for a CloudFront resource. For more information, see Tagging a distribution in the *Amazon CloudFront Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( Resource='string' ) Parameters: **Resource** (*string*) -- **[REQUIRED]** An ARN of a CloudFront resource. Return type: dict Returns: **Response Syntax** { 'Tags': { 'Items': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* The returned result of the corresponding request. * **Tags** *(dict) --* A complex type that contains zero or more "Tag" elements. * **Items** *(list) --* A complex type that contains "Tag" elements. * *(dict) --* A complex type that contains "Tag" key and "Tag" value. * **Key** *(string) --* 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 "_ - . : / = + @". * **Value** *(string) --* 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.AccessDenied" * "CloudFront.Client.exceptions.InvalidTagging" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.NoSuchResource" CloudFront / Client / get_realtime_log_config get_realtime_log_config *********************** CloudFront.Client.get_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' ) Parameters: * **Name** (*string*) -- The name of the real-time log configuration to get. * **ARN** (*string*) -- The Amazon Resource Name (ARN) of the real-time log configuration to get. Return type: dict Returns: **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're 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 in a real-time log configuration. * **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*. * *(string) --* **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.NoSuchRealtimeLogConfig" CloudFront / Client / get_distribution_config get_distribution_config *********************** CloudFront.Client.get_distribution_config(**kwargs) Get the configuration information about a distribution. See also: AWS API Documentation **Request Syntax** response = client.get_distribution_config( Id='string' ) Parameters: **Id** (*string*) -- **[REQUIRED]** The distribution's ID. If the ID is empty, an empty distribution configuration is returned. Return type: dict Returns: **Response Syntax** { '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', 'OriginReadTimeout': 123 }, '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 }, 'VpcOriginConfig': { 'VpcOriginId': 'string', 'OriginReadTimeout': 123, 'OriginKeepaliveTimeout': 123 }, 'ConnectionAttempts': 123, 'ConnectionTimeout': 123, 'ResponseCompletionTimeout': 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' }, ] }, 'SelectionCriteria': 'default'|'media-quality-based' }, ] }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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'|'None', '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'|'TLSv1.3_2025', '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, 'ContinuousDeploymentPolicyId': 'string', 'Staging': True|False, 'AnycastIpListId': 'string', 'TenantConfig': { 'ParameterDefinitions': [ { 'Name': 'string', 'Definition': { 'StringSchema': { 'Comment': 'string', 'DefaultValue': 'string', 'Required': True|False } } }, ] }, 'ConnectionMode': 'direct'|'tenant-only' }, 'ETag': 'string' } **Response Structure** * *(dict) --* The returned result of the corresponding request. * **DistributionConfig** *(dict) --* The distribution's configuration information. * **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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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. * *(string) --* * **DefaultRootObject** *(string) --* When a viewer requests the root URL for your distribution, the default root object is the object that you want CloudFront to request from your origin. For example, if your root URL is "https://www.example.com", you can specify CloudFront to return the "index.html" file as the default root object. You can specify a default root object so that viewers see a specific file or object, instead of another object in your distribution (for example, "https://www.example.com/product-description.html"). A default root object avoids exposing the contents of your distribution. You can specify the object name or a path to the object name (for example, "index.html" or "exampleFolderName/index.html"). Your string can't begin with a forward slash ( "/"). Only specify the object name or the path to the object. 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 Specify 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: * Use "S3OriginConfig" to specify an Amazon S3 bucket that is not configured with static website hosting. * Use "VpcOriginConfig" to specify a VPC origin. * Use "CustomOriginConfig" to specify all other kinds of origins, including: * An Amazon S3 bucket that is configured with static website hosting * An Elastic Load Balancing load balancer * An Elemental MediaPackage endpoint * An Elemental MediaStore container * Any other HTTP server, running on an Amazon EC2 instance or any other kind of host For the current maximum number of origins that you can specify per distribution, see General Quotas on Web Distributions in the *Amazon CloudFront Developer Guide* (quotas were formerly referred to as limits). * **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 "OriginCustomHeader" element for each custom header that you want CloudFront to forward to the origin. If Quantity is "0", omit "Items". * *(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) --* Note: If you're using origin access control (OAC) instead of origin access identity, specify an empty "OriginAccessIdentity" element. For more information, see Restricting access to an Amazon Web Services in the *Amazon CloudFront Developer Guide*. 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" The "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*. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see Response timeout 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. * *(string) --* * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) in the *Amazon CloudFront Developer Guide*. * **VpcOriginConfig** *(dict) --* The VPC origin configuration. * **VpcOriginId** *(string) --* The VPC origin ID. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) 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*. * **ResponseCompletionTimeout** *(integer) --* The time (in seconds) that a request from CloudFront to the origin can stay open and wait for a response. If the complete response isn't received from the origin by this time, CloudFront ends the connection. The value for "ResponseCompletionTimeout" must be equal to or greater than the value for "OriginReadTimeout". If you don't set a value for "ResponseCompletionTimeout", CloudFront doesn't enforce a maximum value. For more information, see Response completion 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 secondary 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 specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the secondary origin under the failover conditions that you've chosen. Optionally, you can choose selection criteria for your origin group to specify how your origins are selected when your distribution routes viewer requests. * **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. * *(integer) --* * **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. * **SelectionCriteria** *(string) --* The selection criteria for the origin group. For more information, see Create an origin group in the *Amazon CloudFront Developer Guide*. * **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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **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. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control- Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. * **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. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(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. Your 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. Your 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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. * *(string) --* * **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. * *(string) --* * **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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **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 specify an empty individual "CacheBehavior" element, because this is invalid. For more information, see CacheBehaviors. 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. Warning: If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the "Cache-Control: no-cache", "no-store", or "private" directives are present in the origin headers. 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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **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. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control- Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. * **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. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(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. Your 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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. * *(string) --* * **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. * *(string) --* * **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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **CustomErrorResponses** *(dict) --* A complex type that controls the following: * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. * How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the *Amazon CloudFront Developer Guide*. * **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: * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. * How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the *Amazon CloudFront Developer Guide*. * **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: * The value of "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/*". * The value of "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: * Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute "200", the response typically won't be intercepted. * If you don't care about distinguishing among different client errors or server errors, you can specify "400" or "500" as the "ResponseCode" for all 4xx or 5xx errors. * You might want to return a "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) --* A 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" and "prefix", 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, "amzn-s3-demo-bucket.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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) * "MinimumProtocolVersion" * "SSLSupportMethod" * **IAMCertificateId** *(string) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 ServicesSupport 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: * The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers. * The ciphers that CloudFront can use to encrypt the content that it returns to viewers. 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: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **CertificateSource** *(string) --* This field is deprecated. Use one of the following fields instead: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **Restrictions** *(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. * *(string) --* * **WebACLId** *(string) --* Note: Multi-tenant distributions only support WAF V2 web ACLs. 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:gl obal/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef- EXAMPLE11111". To specify a web ACL created using WAF Classic, use the ACL ID, for example "a1b2c3d4-5678-90ab- cdef-EXAMPLE11111". 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 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) --* Note: To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup. 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: * You enable IPv6 for the distribution * You're using alternate domain names in the URLs for your objects 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. * **ContinuousDeploymentPolicyId** *(string) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. The identifier of a continuous deployment policy. For more information, see "CreateContinuousDeploymentPolicy". * **Staging** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. A Boolean that indicates whether this is a staging distribution. When this value is "true", this is a staging distribution. When this value is "false", this is not a staging distribution. * **AnycastIpListId** *(string) --* Note: To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup. ID of the Anycast static IP list that is associated with the distribution. * **TenantConfig** *(dict) --* Note: This field only supports multi-tenant distributions. You can't specify this field for standard distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. A distribution tenant configuration. * **ParameterDefinitions** *(list) --* The parameters that you specify for a distribution tenant. * *(dict) --* A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution. * **Name** *(string) --* The name of the parameter. * **Definition** *(dict) --* The value that you assigned to the parameter. * **StringSchema** *(dict) --* An object that contains information about the string schema. * **Comment** *(string) --* A comment to describe the parameter. * **DefaultValue** *(string) --* The default value of the parameter. * **Required** *(boolean) --* Whether the defined parameter is required. * **ConnectionMode** *(string) --* This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only). * **ETag** *(string) --* The current version of the configuration. For example: "E2QWRUHAPOMQZL". **Exceptions** * "CloudFront.Client.exceptions.NoSuchDistribution" * "CloudFront.Client.exceptions.AccessDenied" CloudFront / Client / list_distributions_by_cache_policy_id list_distributions_by_cache_policy_id ************************************* CloudFront.Client.list_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' ) Parameters: * **Marker** (*string*) -- Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field's value to the value of "NextMarker" from the current page's response. * **MaxItems** (*string*) -- The maximum number of distribution IDs that you want in the response. * **CachePolicyId** (*string*) -- **[REQUIRED]** The ID of the cache policy whose associated distribution IDs you want to list. Return type: dict Returns: **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. * *(string) --* **Exceptions** * "CloudFront.Client.exceptions.NoSuchCachePolicy" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / list_public_keys list_public_keys **************** CloudFront.Client.list_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' ) Parameters: * **Marker** (*string*) -- Use this when paginating results to indicate where to begin in your list of public keys. The results include public keys 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 public key on that page). * **MaxItems** (*string*) -- The maximum number of public keys you want in the response body. Return type: dict Returns: **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.InvalidArgument" CloudFront / Client / delete_monitoring_subscription delete_monitoring_subscription ****************************** CloudFront.Client.delete_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' ) Parameters: **DistributionId** (*string*) -- **[REQUIRED]** The ID of the distribution that you are disabling metrics for. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "CloudFront.Client.exceptions.NoSuchDistribution" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.UnsupportedOperation" * "CloudFront.Client.exceptions.NoSuchMonitoringSubscription" CloudFront / Client / disassociate_distribution_tenant_web_acl disassociate_distribution_tenant_web_acl **************************************** CloudFront.Client.disassociate_distribution_tenant_web_acl(**kwargs) Disassociates a distribution tenant from the WAF web ACL. See also: AWS API Documentation **Request Syntax** response = client.disassociate_distribution_tenant_web_acl( Id='string', IfMatch='string' ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The ID of the distribution tenant. * **IfMatch** (*string*) -- The current version of the distribution tenant that you're disassociating from the WAF web ACL. This is the "ETag" value returned in the response to the "GetDistributionTenant" API operation. Return type: dict Returns: **Response Syntax** { 'Id': 'string', 'ETag': 'string' } **Response Structure** * *(dict) --* * **Id** *(string) --* The ID of the distribution tenant. * **ETag** *(string) --* The current version of the distribution tenant. **Exceptions** * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / delete_origin_request_policy delete_origin_request_policy **************************** CloudFront.Client.delete_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' ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The unique identifier for the origin request policy that you are deleting. To get the identifier, you can use "ListOriginRequestPolicies". * **IfMatch** (*string*) -- The version of the origin request policy that you are deleting. The version is the origin request policy's "ETag" value, which you can get using "ListOriginRequestPolicies", "GetOriginRequestPolicy", or "GetOriginRequestPolicyConfig". Returns: None **Exceptions** * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.IllegalDelete" * "CloudFront.Client.exceptions.NoSuchOriginRequestPolicy" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" * "CloudFront.Client.exceptions.OriginRequestPolicyInUse" CloudFront / Client / untag_resource untag_resource ************** CloudFront.Client.untag_resource(**kwargs) Remove tags from a CloudFront resource. For more information, see Tagging a distribution in the *Amazon CloudFront Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( Resource='string', TagKeys={ 'Items': [ 'string', ] } ) Parameters: * **Resource** (*string*) -- **[REQUIRED]** An ARN of a CloudFront resource. * **TagKeys** (*dict*) -- **[REQUIRED]** A complex type that contains zero or more "Tag" key elements. * **Items** *(list) --* A complex type that contains "Tag" key elements. * *(string) --* 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 "_ - . : / = + @". Returns: None **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.InvalidTagging" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.NoSuchResource" CloudFront / Client / get_origin_request_policy_config get_origin_request_policy_config ******************************** CloudFront.Client.get_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' ) Parameters: **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". Return type: dict Returns: **Response Syntax** { 'OriginRequestPolicyConfig': { 'Comment': 'string', 'Name': 'string', 'HeadersConfig': { 'HeaderBehavior': 'none'|'whitelist'|'allViewer'|'allViewerAndWhitelistCloudFront'|'allExcept', 'Headers': { 'Quantity': 123, 'Items': [ 'string', ] } }, 'CookiesConfig': { 'CookieBehavior': 'none'|'whitelist'|'all'|'allExcept', 'Cookies': { 'Quantity': 123, 'Items': [ 'string', ] } }, 'QueryStringsConfig': { 'QueryStringBehavior': 'none'|'whitelist'|'all'|'allExcept', 'QueryStrings': { 'Quantity': 123, 'Items': [ 'string', ] } } }, 'ETag': 'string' } **Response Structure** * *(dict) --* * **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" – No HTTP headers in viewer requests are 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" – Only 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. * "allExcept" – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin, **except** for those listed in the "Headers" type, which are not included. * **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. * *(string) --* * **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" – No cookies in viewer requests are 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" – Only 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. * "allExcept" – All cookies in viewer requests are included in requests that CloudFront sends to the origin, **except** for those listed in the "CookieNames" type, which are not included. * **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. * *(string) --* * **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" – No query strings in viewer requests are 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" – Only 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. * "allExcept" – All query strings in viewer requests are included in requests that CloudFront sends to the origin, **except** for those listed in the "QueryStringNames" type, which are not included. * **QueryStrings** *(dict) --* Contains the specific query strings in viewer requests that either **are** or **are not** included in requests that CloudFront sends to the origin. The behavior depends on whether the "QueryStringBehavior" field in the "OriginRequestPolicyQueryStringsConfig" 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. * *(string) --* * **ETag** *(string) --* The current version of the origin request policy. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.NoSuchOriginRequestPolicy" CloudFront / Client / list_distributions_by_origin_request_policy_id list_distributions_by_origin_request_policy_id ********************************************** CloudFront.Client.list_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' ) Parameters: * **Marker** (*string*) -- Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field's value to the value of "NextMarker" from the current page's response. * **MaxItems** (*string*) -- The maximum number of distribution IDs that you want in the response. * **OriginRequestPolicyId** (*string*) -- **[REQUIRED]** The ID of the origin request policy whose associated distribution IDs you want to list. Return type: dict Returns: **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. * *(string) --* **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.NoSuchOriginRequestPolicy" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / list_anycast_ip_lists list_anycast_ip_lists ********************* CloudFront.Client.list_anycast_ip_lists(**kwargs) Lists your Anycast static IP lists. See also: AWS API Documentation **Request Syntax** response = client.list_anycast_ip_lists( Marker='string', MaxItems=123 ) Parameters: * **Marker** (*string*) -- Use this field when paginating results to indicate where to begin in your list. The response includes items in the list that occur after the marker. To get the next page of the list, set this field's value to the value of "NextMarker" from the current page's response. * **MaxItems** (*integer*) -- The maximum number of Anycast static IP lists that you want returned in the response. Return type: dict Returns: **Response Syntax** { 'AnycastIpLists': { 'Items': [ { 'Id': 'string', 'Name': 'string', 'Status': 'string', 'Arn': 'string', 'IpCount': 123, 'LastModifiedTime': datetime(2015, 1, 1) }, ], 'Marker': 'string', 'NextMarker': 'string', 'MaxItems': 123, 'IsTruncated': True|False, 'Quantity': 123 } } **Response Structure** * *(dict) --* * **AnycastIpLists** *(dict) --* Root level tag for the "AnycastIpLists" parameters. * **Items** *(list) --* Items in the Anycast static IP list collection. Each item is of the AnycastIpListSummary structure type. * *(dict) --* An abbreviated version of the AnycastIpList structure. Omits the allocated static IP addresses ( AnycastIpList$AnycastIps). * **Id** *(string) --* The ID of the Anycast static IP list. * **Name** *(string) --* The name of the Anycast static IP list. * **Status** *(string) --* The deployment status of the Anycast static IP list. Valid values: Deployed, Deploying, or Failed. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the Anycast static IP list. * **IpCount** *(integer) --* The number of IP addresses in the Anycast static IP list. * **LastModifiedTime** *(datetime) --* The last time the Anycast static IP list was modified. * **Marker** *(string) --* Use this field when paginating results to indicate where to begin in your list. The response includes items in the list that occur after the marker. To get the next page of the list, set this field's value to the value of "NextMarker" from the current page's response. * **NextMarker** *(string) --* Indicates the next page of the Anycast static IP list collection. To get the next page of the list, use this value in the "Marker" field of your request. * **MaxItems** *(integer) --* The maximum number of Anycast static IP list collections that you want returned in the response. * **IsTruncated** *(boolean) --* If there are more items in the list collection than are in this response, this value is "true". * **Quantity** *(integer) --* The quantity of Anycast static IP lists in the collection. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.UnsupportedOperation" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / get_field_level_encryption get_field_level_encryption ************************** CloudFront.Client.get_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' ) Parameters: **Id** (*string*) -- **[REQUIRED]** Request the ID for the field-level encryption configuration information. Return type: dict Returns: **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 field-level encryption configuration information. * **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 current version of the field level encryption configuration. For example: "E2QWRUHAPOMQZL". **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.NoSuchFieldLevelEncryptionConfig" CloudFront / Client / create_distribution_tenant create_distribution_tenant ************************** CloudFront.Client.create_distribution_tenant(**kwargs) Creates a distribution tenant. See also: AWS API Documentation **Request Syntax** response = client.create_distribution_tenant( DistributionId='string', Name='string', Domains=[ { 'Domain': 'string' }, ], Tags={ 'Items': [ { 'Key': 'string', 'Value': 'string' }, ] }, Customizations={ 'WebAcl': { 'Action': 'override'|'disable', 'Arn': 'string' }, 'Certificate': { 'Arn': 'string' }, 'GeoRestrictions': { 'RestrictionType': 'blacklist'|'whitelist'|'none', 'Locations': [ 'string', ] } }, Parameters=[ { 'Name': 'string', 'Value': 'string' }, ], ConnectionGroupId='string', ManagedCertificateRequest={ 'ValidationTokenHost': 'cloudfront'|'self-hosted', 'PrimaryDomainName': 'string', 'CertificateTransparencyLoggingPreference': 'enabled'|'disabled' }, Enabled=True|False ) Parameters: * **DistributionId** (*string*) -- **[REQUIRED]** The ID of the multi-tenant distribution to use for creating the distribution tenant. * **Name** (*string*) -- **[REQUIRED]** The name of the distribution tenant. Enter a friendly identifier that is unique within your Amazon Web Services account. This name can't be updated after you create the distribution tenant. * **Domains** (*list*) -- **[REQUIRED]** The domains associated with the distribution tenant. You must specify at least one domain in the request. * *(dict) --* The domain for the specified distribution tenant. * **Domain** *(string) --* **[REQUIRED]** The domain name. * **Tags** (*dict*) -- A complex type that contains zero or more "Tag" elements. * **Items** *(list) --* A complex type that contains "Tag" elements. * *(dict) --* A complex type that contains "Tag" key and "Tag" value. * **Key** *(string) --* **[REQUIRED]** 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 "_ - . : / = + @". * **Value** *(string) --* 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 "_ - . : / = + @". * **Customizations** (*dict*) -- Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant. * **WebAcl** *(dict) --* The WAF web ACL. * **Action** *(string) --* **[REQUIRED]** The action for the WAF web ACL customization. You can specify "override" to specify a separate WAF web ACL for the distribution tenant. If you specify "disable", the distribution tenant won't have WAF web ACL protections and won't inherit from the multi-tenant distribution. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the WAF web ACL. * **Certificate** *(dict) --* The Certificate Manager (ACM) certificate. * **Arn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the ACM certificate. * **GeoRestrictions** *(dict) --* The geographic restrictions. * **RestrictionType** *(string) --* **[REQUIRED]** The method that you want to use to restrict distribution of your content by country: * "none": No geographic 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. * **Locations** *(list) --* The locations for geographic restrictions. * *(string) --* * **Parameters** (*list*) -- A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution. * *(dict) --* A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution. * **Name** *(string) --* **[REQUIRED]** The parameter name. * **Value** *(string) --* **[REQUIRED]** The parameter value. * **ConnectionGroupId** (*string*) -- The ID of the connection group to associate with the distribution tenant. * **ManagedCertificateRequest** (*dict*) -- The configuration for the CloudFront managed ACM certificate request. * **ValidationTokenHost** *(string) --* **[REQUIRED]** Specify how the HTTP validation token will be served when requesting the CloudFront managed ACM certificate. * For "cloudfront", CloudFront will automatically serve the validation token. Choose this mode if you can point the domain's DNS to CloudFront immediately. * For "self-hosted", you serve the validation token from your existing infrastructure. Choose this mode when you need to maintain current traffic flow while your certificate is being issued. You can place the validation token at the well-known path on your existing web server, wait for ACM to validate and issue the certificate, and then update your DNS to point to CloudFront. * **PrimaryDomainName** *(string) --* The primary domain name associated with the CloudFront managed ACM certificate. * **CertificateTransparencyLoggingPreference** *(string) --* You can opt out of certificate transparency logging by specifying the "disabled" option. Opt in by specifying "enabled". For more information, see Certificate Transparency Logging in the *Certificate Manager User Guide*. * **Enabled** (*boolean*) -- Indicates whether the distribution tenant should be enabled when created. If the distribution tenant is disabled, the distribution tenant won't serve traffic. Return type: dict Returns: **Response Syntax** { 'DistributionTenant': { 'Id': 'string', 'DistributionId': 'string', 'Name': 'string', 'Arn': 'string', 'Domains': [ { 'Domain': 'string', 'Status': 'active'|'inactive' }, ], 'Tags': { 'Items': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'Customizations': { 'WebAcl': { 'Action': 'override'|'disable', 'Arn': 'string' }, 'Certificate': { 'Arn': 'string' }, 'GeoRestrictions': { 'RestrictionType': 'blacklist'|'whitelist'|'none', 'Locations': [ 'string', ] } }, 'Parameters': [ { 'Name': 'string', 'Value': 'string' }, ], 'ConnectionGroupId': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'Enabled': True|False, 'Status': 'string' }, 'ETag': 'string' } **Response Structure** * *(dict) --* * **DistributionTenant** *(dict) --* The distribution tenant that you created. * **Id** *(string) --* The ID of the distribution tenant. * **DistributionId** *(string) --* The ID of the multi-tenant distribution. * **Name** *(string) --* The name of the distribution tenant. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the distribution tenant. * **Domains** *(list) --* The domains associated with the distribution tenant. * *(dict) --* The details about the domain result. * **Domain** *(string) --* The specified domain. * **Status** *(string) --* Whether the domain is active or inactive. * **Tags** *(dict) --* A complex type that contains zero or more "Tag" elements. * **Items** *(list) --* A complex type that contains "Tag" elements. * *(dict) --* A complex type that contains "Tag" key and "Tag" value. * **Key** *(string) --* 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 "_ - . : / = + @". * **Value** *(string) --* 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 "_ - . : / = + @". * **Customizations** *(dict) --* Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant. * **WebAcl** *(dict) --* The WAF web ACL. * **Action** *(string) --* The action for the WAF web ACL customization. You can specify "override" to specify a separate WAF web ACL for the distribution tenant. If you specify "disable", the distribution tenant won't have WAF web ACL protections and won't inherit from the multi-tenant distribution. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the WAF web ACL. * **Certificate** *(dict) --* The Certificate Manager (ACM) certificate. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the ACM certificate. * **GeoRestrictions** *(dict) --* The geographic restrictions. * **RestrictionType** *(string) --* The method that you want to use to restrict distribution of your content by country: * "none": No geographic 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. * **Locations** *(list) --* The locations for geographic restrictions. * *(string) --* * **Parameters** *(list) --* A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution. * *(dict) --* A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution. * **Name** *(string) --* The parameter name. * **Value** *(string) --* The parameter value. * **ConnectionGroupId** *(string) --* The ID of the connection group for the distribution tenant. If you don't specify a connection group, CloudFront uses the default connection group. * **CreatedTime** *(datetime) --* The date and time when the distribution tenant was created. * **LastModifiedTime** *(datetime) --* The date and time when the distribution tenant was updated. * **Enabled** *(boolean) --* Indicates whether the distribution tenant is in an enabled state. If disabled, the distribution tenant won't serve traffic. * **Status** *(string) --* The status of the distribution tenant. * **ETag** *(string) --* The current version of the distribution tenant. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.EntityAlreadyExists" * "CloudFront.Client.exceptions.CNAMEAlreadyExists" * "CloudFront.Client.exceptions.InvalidTagging" * "CloudFront.Client.exceptions.InvalidAssociation" * "CloudFront.Client.exceptions.EntityLimitExceeded" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / update_vpc_origin update_vpc_origin ***************** CloudFront.Client.update_vpc_origin(**kwargs) Update an Amazon CloudFront VPC origin in your account. See also: AWS API Documentation **Request Syntax** response = client.update_vpc_origin( VpcOriginEndpointConfig={ 'Name': 'string', 'Arn': 'string', 'HTTPPort': 123, 'HTTPSPort': 123, 'OriginProtocolPolicy': 'http-only'|'match-viewer'|'https-only', 'OriginSslProtocols': { 'Quantity': 123, 'Items': [ 'SSLv3'|'TLSv1'|'TLSv1.1'|'TLSv1.2', ] } }, Id='string', IfMatch='string' ) Parameters: * **VpcOriginEndpointConfig** (*dict*) -- **[REQUIRED]** The VPC origin endpoint configuration. * **Name** *(string) --* **[REQUIRED]** The name of the CloudFront VPC origin endpoint configuration. * **Arn** *(string) --* **[REQUIRED]** The ARN of the CloudFront VPC origin endpoint configuration. * **HTTPPort** *(integer) --* **[REQUIRED]** The HTTP port for the CloudFront VPC origin endpoint configuration. The default value is "80". * **HTTPSPort** *(integer) --* **[REQUIRED]** The HTTPS port of the CloudFront VPC origin endpoint configuration. The default value is "443". * **OriginProtocolPolicy** *(string) --* **[REQUIRED]** The origin protocol policy for the CloudFront VPC origin endpoint configuration. * **OriginSslProtocols** *(dict) --* A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin. * **Quantity** *(integer) --* **[REQUIRED]** The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin. * **Items** *(list) --* **[REQUIRED]** A list that contains allowed SSL/TLS protocols for this distribution. * *(string) --* * **Id** (*string*) -- **[REQUIRED]** The VPC origin ID. * **IfMatch** (*string*) -- **[REQUIRED]** The VPC origin to update, if a match occurs. Return type: dict Returns: **Response Syntax** { 'VpcOrigin': { 'Id': 'string', 'Arn': 'string', 'Status': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'VpcOriginEndpointConfig': { 'Name': 'string', 'Arn': 'string', 'HTTPPort': 123, 'HTTPSPort': 123, 'OriginProtocolPolicy': 'http-only'|'match-viewer'|'https-only', 'OriginSslProtocols': { 'Quantity': 123, 'Items': [ 'SSLv3'|'TLSv1'|'TLSv1.1'|'TLSv1.2', ] } } }, 'ETag': 'string' } **Response Structure** * *(dict) --* * **VpcOrigin** *(dict) --* The VPC origin. * **Id** *(string) --* The VPC origin ID. * **Arn** *(string) --* The VPC origin ARN. * **Status** *(string) --* The VPC origin status. * **CreatedTime** *(datetime) --* The VPC origin created time. * **LastModifiedTime** *(datetime) --* The VPC origin last modified time. * **VpcOriginEndpointConfig** *(dict) --* The VPC origin endpoint configuration. * **Name** *(string) --* The name of the CloudFront VPC origin endpoint configuration. * **Arn** *(string) --* The ARN of the CloudFront VPC origin endpoint configuration. * **HTTPPort** *(integer) --* The HTTP port for the CloudFront VPC origin endpoint configuration. The default value is "80". * **HTTPSPort** *(integer) --* The HTTPS port of the CloudFront VPC origin endpoint configuration. The default value is "443". * **OriginProtocolPolicy** *(string) --* The origin protocol policy for the CloudFront VPC origin endpoint configuration. * **OriginSslProtocols** *(dict) --* A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin. * **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. * *(string) --* * **ETag** *(string) --* The VPC origin ETag. **Exceptions** * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.UnsupportedOperation" * "CloudFront.Client.exceptions.EntityAlreadyExists" * "CloudFront.Client.exceptions.InconsistentQuantities" * "CloudFront.Client.exceptions.CannotUpdateEntityWhileInUse" * "CloudFront.Client.exceptions.EntityLimitExceeded" * "CloudFront.Client.exceptions.IllegalUpdate" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / delete_anycast_ip_list delete_anycast_ip_list ********************** CloudFront.Client.delete_anycast_ip_list(**kwargs) Deletes an Anycast static IP list. See also: AWS API Documentation **Request Syntax** response = client.delete_anycast_ip_list( Id='string', IfMatch='string' ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The ID of the Anycast static IP list. * **IfMatch** (*string*) -- **[REQUIRED]** The current version ( "ETag" value) of the Anycast static IP list that you are deleting. Returns: None **Exceptions** * "CloudFront.Client.exceptions.CannotDeleteEntityWhileInUse" * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.IllegalDelete" * "CloudFront.Client.exceptions.UnsupportedOperation" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / update_origin_request_policy update_origin_request_policy **************************** CloudFront.Client.update_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: * Use "GetOriginRequestPolicyConfig" to get the current configuration. * Locally modify the fields in the origin request policy configuration that you want to update. * Call "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'|'allExcept', 'Headers': { 'Quantity': 123, 'Items': [ 'string', ] } }, 'CookiesConfig': { 'CookieBehavior': 'none'|'whitelist'|'all'|'allExcept', 'Cookies': { 'Quantity': 123, 'Items': [ 'string', ] } }, 'QueryStringsConfig': { 'QueryStringBehavior': 'none'|'whitelist'|'all'|'allExcept', 'QueryStrings': { 'Quantity': 123, 'Items': [ 'string', ] } } }, Id='string', IfMatch='string' ) Parameters: * **OriginRequestPolicyConfig** (*dict*) -- **[REQUIRED]** An origin request policy configuration. * **Comment** *(string) --* A comment to describe the origin request policy. The comment cannot be longer than 128 characters. * **Name** *(string) --* **[REQUIRED]** A unique name to identify the origin request policy. * **HeadersConfig** *(dict) --* **[REQUIRED]** The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront. * **HeaderBehavior** *(string) --* **[REQUIRED]** Determines whether any HTTP headers are included in requests that CloudFront sends to the origin. Valid values are: * "none" – No HTTP headers in viewer requests are 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" – Only 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. * "allExcept" – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin, **except** for those listed in the "Headers" type, which are not included. * **Headers** *(dict) --* Contains a list of HTTP header names. * **Quantity** *(integer) --* **[REQUIRED]** The number of header names in the "Items" list. * **Items** *(list) --* A list of HTTP header names. * *(string) --* * **CookiesConfig** *(dict) --* **[REQUIRED]** The cookies from viewer requests to include in origin requests. * **CookieBehavior** *(string) --* **[REQUIRED]** Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are: * "none" – No cookies in viewer requests are 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" – Only 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. * "allExcept" – All cookies in viewer requests are included in requests that CloudFront sends to the origin, **except** for those listed in the "CookieNames" type, which are not included. * **Cookies** *(dict) --* Contains a list of cookie names. * **Quantity** *(integer) --* **[REQUIRED]** The number of cookie names in the "Items" list. * **Items** *(list) --* A list of cookie names. * *(string) --* * **QueryStringsConfig** *(dict) --* **[REQUIRED]** The URL query strings from viewer requests to include in origin requests. * **QueryStringBehavior** *(string) --* **[REQUIRED]** Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin. Valid values are: * "none" – No query strings in viewer requests are 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" – Only 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. * "allExcept" – All query strings in viewer requests are included in requests that CloudFront sends to the origin, **except** for those listed in the "QueryStringNames" type, which are not included. * **QueryStrings** *(dict) --* Contains the specific query strings in viewer requests that either **are** or **are not** included in requests that CloudFront sends to the origin. The behavior depends on whether the "QueryStringBehavior" field in the "OriginRequestPolicyQueryStringsConfig" 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) --* **[REQUIRED]** The number of query string names in the "Items" list. * **Items** *(list) --* A list of query string names. * *(string) --* * **Id** (*string*) -- **[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". * **IfMatch** (*string*) -- The version of the origin request policy that you are updating. The version is returned in the origin request policy's "ETag" field in the response to "GetOriginRequestPolicyConfig". Return type: dict Returns: **Response Syntax** { 'OriginRequestPolicy': { 'Id': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'OriginRequestPolicyConfig': { 'Comment': 'string', 'Name': 'string', 'HeadersConfig': { 'HeaderBehavior': 'none'|'whitelist'|'allViewer'|'allViewerAndWhitelistCloudFront'|'allExcept', 'Headers': { 'Quantity': 123, 'Items': [ 'string', ] } }, 'CookiesConfig': { 'CookieBehavior': 'none'|'whitelist'|'all'|'allExcept', 'Cookies': { 'Quantity': 123, 'Items': [ 'string', ] } }, 'QueryStringsConfig': { 'QueryStringBehavior': 'none'|'whitelist'|'all'|'allExcept', '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" – No HTTP headers in viewer requests are 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" – Only 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. * "allExcept" – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin, **except** for those listed in the "Headers" type, which are not included. * **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. * *(string) --* * **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" – No cookies in viewer requests are 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" – Only 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. * "allExcept" – All cookies in viewer requests are included in requests that CloudFront sends to the origin, **except** for those listed in the "CookieNames" type, which are not included. * **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. * *(string) --* * **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" – No query strings in viewer requests are 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" – Only 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. * "allExcept" – All query strings in viewer requests are included in requests that CloudFront sends to the origin, **except** for those listed in the "QueryStringNames" type, which are not included. * **QueryStrings** *(dict) --* Contains the specific query strings in viewer requests that either **are** or **are not** included in requests that CloudFront sends to the origin. The behavior depends on whether the "QueryStringBehavior" field in the "OriginRequestPolicyQueryStringsConfig" 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. * *(string) --* * **ETag** *(string) --* The current version of the origin request policy. **Exceptions** * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.TooManyHeadersInOriginRequestPolic y" * "CloudFront.Client.exceptions.NoSuchOriginRequestPolicy" * "CloudFront.Client.exceptions.TooManyCookiesInOriginRequestPolic y" * "CloudFront.Client.exceptions.InconsistentQuantities" * "CloudFront.Client.exceptions.OriginRequestPolicyAlreadyExists" * "CloudFront.Client.exceptions.TooManyQueryStringsInOriginRequest Policy" * "CloudFront.Client.exceptions.IllegalUpdate" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / get_cloud_front_origin_access_identity_config get_cloud_front_origin_access_identity_config ********************************************* CloudFront.Client.get_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' ) Parameters: **Id** (*string*) -- **[REQUIRED]** The identity's ID. Return type: dict Returns: **Response Syntax** { 'CloudFrontOriginAccessIdentityConfig': { 'CallerReference': 'string', 'Comment': 'string' }, 'ETag': 'string' } **Response Structure** * *(dict) --* The returned result of the corresponding request. * **CloudFrontOriginAccessIdentityConfig** *(dict) --* The origin access identity's configuration information. * **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.AccessDenied" * "CloudFront.Client.exceptions.NoSuchCloudFrontOriginAccessIdenti ty" CloudFront / Client / get_waiter get_waiter ********** CloudFront.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" CloudFront / Client / list_distributions_by_key_group list_distributions_by_key_group ******************************* CloudFront.Client.list_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' ) Parameters: * **Marker** (*string*) -- Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field's value to the value of "NextMarker" from the current page's response. * **MaxItems** (*string*) -- The maximum number of distribution IDs that you want in the response. * **KeyGroupId** (*string*) -- **[REQUIRED]** The ID of the key group whose associated distribution IDs you are listing. Return type: dict Returns: **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. * *(string) --* **Exceptions** * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.NoSuchResource" CloudFront / Client / update_field_level_encryption_config update_field_level_encryption_config ************************************ CloudFront.Client.update_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' ) Parameters: * **FieldLevelEncryptionConfig** (*dict*) -- **[REQUIRED]** Request to update a field-level encryption configuration. * **CallerReference** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** Query argument for field-level encryption query argument-profile mapping. * **ProfileId** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The content type for a field-level encryption content type-profile mapping. * **Id** (*string*) -- **[REQUIRED]** The ID of the configuration you want to update. * **IfMatch** (*string*) -- The value of the "ETag" header that you received when retrieving the configuration identity to update. For example: "E2QWRUHAPOMQZL". Return type: dict Returns: **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.PreconditionFailed" * "CloudFront.Client.exceptions.QueryArgProfileEmpty" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.NoSuchFieldLevelEncryptionConfig" * "CloudFront.Client.exceptions.TooManyFieldLevelEncryptionContent TypeProfiles" * "CloudFront.Client.exceptions.TooManyFieldLevelEncryptionQueryAr gProfiles" * "CloudFront.Client.exceptions.InconsistentQuantities" * "CloudFront.Client.exceptions.NoSuchFieldLevelEncryptionProfile" * "CloudFront.Client.exceptions.IllegalUpdate" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / get_distribution get_distribution **************** CloudFront.Client.get_distribution(**kwargs) Get the information about a distribution. See also: AWS API Documentation **Request Syntax** response = client.get_distribution( Id='string' ) Parameters: **Id** (*string*) -- **[REQUIRED]** The distribution's ID. If the ID is empty, an empty distribution configuration is returned. Return type: dict Returns: **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', 'OriginReadTimeout': 123 }, '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 }, 'VpcOriginConfig': { 'VpcOriginId': 'string', 'OriginReadTimeout': 123, 'OriginKeepaliveTimeout': 123 }, 'ConnectionAttempts': 123, 'ConnectionTimeout': 123, 'ResponseCompletionTimeout': 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' }, ] }, 'SelectionCriteria': 'default'|'media-quality-based' }, ] }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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'|'None', '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'|'TLSv1.3_2025', '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, 'ContinuousDeploymentPolicyId': 'string', 'Staging': True|False, 'AnycastIpListId': 'string', 'TenantConfig': { 'ParameterDefinitions': [ { 'Name': 'string', 'Definition': { 'StringSchema': { 'Comment': 'string', 'DefaultValue': 'string', 'Required': True|False } } }, ] }, 'ConnectionMode': 'direct'|'tenant-only' }, '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 distribution's identifier. For example: "E1U5RQF7T870K0". * **ARN** *(string) --* The distribution's Amazon Resource Name (ARN). * **Status** *(string) --* The distribution's status. When the status is "Deployed", the distribution's information is fully propagated to all CloudFront edge locations. * **LastModifiedTime** *(datetime) --* The date and time when the distribution was last modified. * **InProgressInvalidationBatches** *(integer) --* The number of invalidation batches currently in progress. * **DomainName** *(string) --* The distribution's CloudFront domain name. For example: "d111111abcdef8.cloudfront.net". * **ActiveTrustedSigners** *(dict) --* Warning: We recommend using "TrustedKeyGroups" instead of "TrustedSigners". 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 are configured as trusted signers. 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. * *(string) --* * **ActiveTrustedKeyGroups** *(dict) --* 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. * *(string) --* * **DistributionConfig** *(dict) --* The distribution's configuration. * **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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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. * *(string) --* * **DefaultRootObject** *(string) --* When a viewer requests the root URL for your distribution, the default root object is the object that you want CloudFront to request from your origin. For example, if your root URL is "https://www.example.com", you can specify CloudFront to return the "index.html" file as the default root object. You can specify a default root object so that viewers see a specific file or object, instead of another object in your distribution (for example, "https://www.example.com /product-description.html"). A default root object avoids exposing the contents of your distribution. You can specify the object name or a path to the object name (for example, "index.html" or "exampleFolderName/index.html"). Your string can't begin with a forward slash ( "/"). Only specify the object name or the path to the object. 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 Specify 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: * Use "S3OriginConfig" to specify an Amazon S3 bucket that is not configured with static website hosting. * Use "VpcOriginConfig" to specify a VPC origin. * Use "CustomOriginConfig" to specify all other kinds of origins, including: * An Amazon S3 bucket that is configured with static website hosting * An Elastic Load Balancing load balancer * An Elemental MediaPackage endpoint * An Elemental MediaStore container * Any other HTTP server, running on an Amazon EC2 instance or any other kind of host For the current maximum number of origins that you can specify per distribution, see General Quotas on Web Distributions in the *Amazon CloudFront Developer Guide* (quotas were formerly referred to as limits). * **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 "OriginCustomHeader" element for each custom header that you want CloudFront to forward to the origin. If Quantity is "0", omit "Items". * *(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) --* Note: If you're using origin access control (OAC) instead of origin access identity, specify an empty "OriginAccessIdentity" element. For more information, see Restricting access to an Amazon Web Services in the *Amazon CloudFront Developer Guide*. 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" The "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*. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see Response timeout 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. * *(string) --* * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) in the *Amazon CloudFront Developer Guide*. * **VpcOriginConfig** *(dict) --* The VPC origin configuration. * **VpcOriginId** *(string) --* The VPC origin ID. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) 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*. * **ResponseCompletionTimeout** *(integer) --* The time (in seconds) that a request from CloudFront to the origin can stay open and wait for a response. If the complete response isn't received from the origin by this time, CloudFront ends the connection. The value for "ResponseCompletionTimeout" must be equal to or greater than the value for "OriginReadTimeout". If you don't set a value for "ResponseCompletionTimeout", CloudFront doesn't enforce a maximum value. For more information, see Response completion 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 secondary 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 specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the secondary origin under the failover conditions that you've chosen. Optionally, you can choose selection criteria for your origin group to specify how your origins are selected when your distribution routes viewer requests. * **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. * *(integer) --* * **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. * **SelectionCriteria** *(string) --* The selection criteria for the origin group. For more information, see Create an origin group in the *Amazon CloudFront Developer Guide*. * **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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **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. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control- Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. * **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. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(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. Your 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. Your 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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. * *(string) --* * **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. * *(string) --* * **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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **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 specify an empty individual "CacheBehavior" element, because this is invalid. For more information, see CacheBehaviors. 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. Warning: If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the "Cache-Control: no-cache", "no-store", or "private" directives are present in the origin headers. 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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **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. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control- Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. * **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. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(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. Your 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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. * *(string) --* * **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. * *(string) --* * **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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **CustomErrorResponses** *(dict) --* A complex type that controls the following: * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. * How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the *Amazon CloudFront Developer Guide*. * **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: * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. * How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the *Amazon CloudFront Developer Guide*. * **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: * The value of "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/*". * The value of "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: * Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute "200", the response typically won't be intercepted. * If you don't care about distinguishing among different client errors or server errors, you can specify "400" or "500" as the "ResponseCode" for all 4xx or 5xx errors. * You might want to return a "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) --* A 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" and "prefix", 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, "amzn-s3-demo-bucket.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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) * "MinimumProtocolVersion" * "SSLSupportMethod" * **IAMCertificateId** *(string) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 ServicesSupport 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: * The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers. * The ciphers that CloudFront can use to encrypt the content that it returns to viewers. 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: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **CertificateSource** *(string) --* This field is deprecated. Use one of the following fields instead: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **Restrictions** *(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. * *(string) --* * **WebACLId** *(string) --* Note: Multi-tenant distributions only support WAF V2 web ACLs. 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:123456789 012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef- EXAMPLE11111". To specify a web ACL created using WAF Classic, use the ACL ID, for example "a1b2c3d4-5678 -90ab-cdef-EXAMPLE11111". 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 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) --* Note: To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup. 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: * You enable IPv6 for the distribution * You're using alternate domain names in the URLs for your objects 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. * **ContinuousDeploymentPolicyId** *(string) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. The identifier of a continuous deployment policy. For more information, see "CreateContinuousDeploymentPolicy". * **Staging** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. A Boolean that indicates whether this is a staging distribution. When this value is "true", this is a staging distribution. When this value is "false", this is not a staging distribution. * **AnycastIpListId** *(string) --* Note: To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup. ID of the Anycast static IP list that is associated with the distribution. * **TenantConfig** *(dict) --* Note: This field only supports multi-tenant distributions. You can't specify this field for standard distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. A distribution tenant configuration. * **ParameterDefinitions** *(list) --* The parameters that you specify for a distribution tenant. * *(dict) --* A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution. * **Name** *(string) --* The name of the parameter. * **Definition** *(dict) --* The value that you assigned to the parameter. * **StringSchema** *(dict) --* An object that contains information about the string schema. * **Comment** *(string) --* A comment to describe the parameter. * **DefaultValue** *(string) --* The default value of the parameter. * **Required** *(boolean) --* Whether the defined parameter is required. * **ConnectionMode** *(string) --* This field specifies whether the connection mode is through a standard distribution (direct) or a multi- tenant distribution with distribution tenants (tenant- only). * **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 Amazon Web Services Regions outside of China. The status values returned are the following: * **APPROVED** indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED, that is, valid to use with the China Regions, a CNAME must have one ICP recordal number associated with it. * **SUSPENDED** indicates that the associated CNAME does not have a valid ICP recordal number. * **PENDING** indicates that CloudFront can't determine the ICP recordal status of the CNAME associated with the distribution because there was an error in trying to determine the status. You can try again to see if the error is resolved in which case CloudFront returns an APPROVED or SUSPENDED status. * **ETag** *(string) --* The current version of the distribution's information. For example: "E2QWRUHAPOMQZL". **Exceptions** * "CloudFront.Client.exceptions.NoSuchDistribution" * "CloudFront.Client.exceptions.AccessDenied" CloudFront / Client / delete_streaming_distribution delete_streaming_distribution ***************************** CloudFront.Client.delete_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**: * Disable the RTMP distribution. * Submit a "GET Streaming Distribution Config" request to get the current configuration and the "Etag" header for the distribution. * Update the XML document that was returned in the response to your "GET Streaming Distribution Config" request to change the value of "Enabled" to "false". * Submit a "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. * Review the response to the "PUT Streaming Distribution Config" request to confirm that the distribution was successfully disabled. * Submit a "GET Streaming Distribution Config" request to confirm that your changes have propagated. When propagation is complete, the value of "Status" is "Deployed". * Submit a "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. * Review the response to your "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' ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The distribution ID. * **IfMatch** (*string*) -- The value of the "ETag" header that you received when you disabled the streaming distribution. For example: "E2QWRUHAPOMQZL". Returns: None **Exceptions** * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.NoSuchStreamingDistribution" * "CloudFront.Client.exceptions.StreamingDistributionNotDisabled" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / delete_key_group delete_key_group **************** CloudFront.Client.delete_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' ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The identifier of the key group that you are deleting. To get the identifier, use "ListKeyGroups". * **IfMatch** (*string*) -- The version of the key group that you are deleting. The version is the key group's "ETag" value. To get the "ETag", use "GetKeyGroup" or "GetKeyGroupConfig". Returns: None **Exceptions** * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.ResourceInUse" * "CloudFront.Client.exceptions.NoSuchResource" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / associate_distribution_web_acl associate_distribution_web_acl ****************************** CloudFront.Client.associate_distribution_web_acl(**kwargs) Associates the WAF web ACL with a distribution. See also: AWS API Documentation **Request Syntax** response = client.associate_distribution_web_acl( Id='string', WebACLArn='string', IfMatch='string' ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The ID of the distribution. * **WebACLArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the WAF web ACL to associate. * **IfMatch** (*string*) -- The value of the "ETag" header that you received when retrieving the distribution that you're associating with the WAF web ACL. Return type: dict Returns: **Response Syntax** { 'Id': 'string', 'WebACLArn': 'string', 'ETag': 'string' } **Response Structure** * *(dict) --* * **Id** *(string) --* The ID of the distribution. * **WebACLArn** *(string) --* The ARN of the WAF web ACL that you associated with the distribution. * **ETag** *(string) --* The current version of the distribution. **Exceptions** * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / delete_realtime_log_config delete_realtime_log_config ************************** CloudFront.Client.delete_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' ) Parameters: * **Name** (*string*) -- The name of the real-time log configuration to delete. * **ARN** (*string*) -- The Amazon Resource Name (ARN) of the real-time log configuration to delete. Returns: None **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.NoSuchRealtimeLogConfig" * "CloudFront.Client.exceptions.RealtimeLogConfigInUse" CloudFront / Client / list_distributions_by_anycast_ip_list_id list_distributions_by_anycast_ip_list_id **************************************** CloudFront.Client.list_distributions_by_anycast_ip_list_id(**kwargs) Lists the distributions in your account that are associated with the specified "AnycastIpListId". See also: AWS API Documentation **Request Syntax** response = client.list_distributions_by_anycast_ip_list_id( Marker='string', MaxItems='string', AnycastIpListId='string' ) Parameters: * **Marker** (*string*) -- Use this field when paginating results to indicate where to begin in your list. The response includes items in the list that occur after the marker. To get the next page of the list, set this field's value to the value of "NextMarker" from the current page's response. * **MaxItems** (*string*) -- The maximum number of distributions that you want returned in the response. * **AnycastIpListId** (*string*) -- **[REQUIRED]** The ID of the Anycast static IP list. Return type: dict Returns: **Response Syntax** { 'DistributionList': { 'Marker': 'string', 'NextMarker': 'string', 'MaxItems': 123, 'IsTruncated': True|False, 'Quantity': 123, 'Items': [ { 'Id': 'string', 'ARN': 'string', 'ETag': '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', 'OriginReadTimeout': 123 }, '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 }, 'VpcOriginConfig': { 'VpcOriginId': 'string', 'OriginReadTimeout': 123, 'OriginKeepaliveTimeout': 123 }, 'ConnectionAttempts': 123, 'ConnectionTimeout': 123, 'ResponseCompletionTimeout': 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' }, ] }, 'SelectionCriteria': 'default'|'media-quality-based' }, ] }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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'|'None', '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'|'TLSv1.3_2025', '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' }, ], 'Staging': True|False, 'ConnectionMode': 'direct'|'tenant-only', 'AnycastIpListId': 'string' }, ] } } **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:distri bution/EDFDVBD632BHDS5", where "123456789012" is your Amazon Web Services account ID. * **ETag** *(string) --* The current version of the distribution. * **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. * *(string) --* * **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: * Use "S3OriginConfig" to specify an Amazon S3 bucket that is not configured with static website hosting. * Use "VpcOriginConfig" to specify a VPC origin. * Use "CustomOriginConfig" to specify all other kinds of origins, including: * An Amazon S3 bucket that is configured with static website hosting * An Elastic Load Balancing load balancer * An Elemental MediaPackage endpoint * An Elemental MediaStore container * Any other HTTP server, running on an Amazon EC2 instance or any other kind of host For the current maximum number of origins that you can specify per distribution, see General Quotas on Web Distributions in the *Amazon CloudFront Developer Guide* (quotas were formerly referred to as limits). * **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 "OriginCustomHeader" element for each custom header that you want CloudFront to forward to the origin. If Quantity is "0", omit "Items". * *(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) --* Note: If you're using origin access control (OAC) instead of origin access identity, specify an empty "OriginAccessIdentity" element. For more information, see Restricting access to an Amazon Web Services in the *Amazon CloudFront Developer Guide*. 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" The "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*. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see Response timeout 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. * *(string) --* * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) in the *Amazon CloudFront Developer Guide*. * **VpcOriginConfig** *(dict) --* The VPC origin configuration. * **VpcOriginId** *(string) --* The VPC origin ID. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) 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*. * **ResponseCompletionTimeout** *(integer) --* The time (in seconds) that a request from CloudFront to the origin can stay open and wait for a response. If the complete response isn't received from the origin by this time, CloudFront ends the connection. The value for "ResponseCompletionTimeout" must be equal to or greater than the value for "OriginReadTimeout". If you don't set a value for "ResponseCompletionTimeout", CloudFront doesn't enforce a maximum value. For more information, see Response completion 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 secondary 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 specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the secondary origin under the failover conditions that you've chosen. Optionally, you can choose selection criteria for your origin group to specify how your origins are selected when your distribution routes viewer requests. * **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. * *(integer) --* * **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. * **SelectionCriteria** *(string) --* The selection criteria for the origin group. For more information, see Create an origin group in the *Amazon CloudFront Developer Guide*. * **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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **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. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control- Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. * **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. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(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. Your 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. Your 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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. * *(string) --* * **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. * *(string) --* * **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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **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 specify an empty individual "CacheBehavior" element, because this is invalid. For more information, see CacheBehaviors. 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. Warning: If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the "Cache-Control: no-cache", "no- store", or "private" directives are present in the origin headers. 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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **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. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access- Control-Request-Method, Access-Control- Request-Headers, and Origin headers for the responses to be cached correctly. * **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. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(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. Your 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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. * *(string) --* * **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. * *(string) --* * **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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **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: * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. * How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the *Amazon CloudFront Developer Guide*. * **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: * The value of "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/*". * The value of "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: * Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute "200", the response typically won't be intercepted. * If you don't care about distinguishing among different client errors or server errors, you can specify "400" or "500" as the "ResponseCode" for all 4xx or 5xx errors. * You might want to return a "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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) * "MinimumProtocolVersion" * "SSLSupportMethod" * **IAMCertificateId** *(string) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 ServicesSupport 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: * The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers. * The ciphers that CloudFront can use to encrypt the content that it returns to viewers. 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: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **CertificateSource** *(string) --* This field is deprecated. Use one of the following fields instead: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **Restrictions** *(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. * *(string) --* * **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 Amazon Web Services Regions outside of China. The status values returned are the following: * **APPROVED** indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED, that is, valid to use with the China Regions, a CNAME must have one ICP recordal number associated with it. * **SUSPENDED** indicates that the associated CNAME does not have a valid ICP recordal number. * **PENDING** indicates that CloudFront can't determine the ICP recordal status of the CNAME associated with the distribution because there was an error in trying to determine the status. You can try again to see if the error is resolved in which case CloudFront returns an APPROVED or SUSPENDED status. * **Staging** *(boolean) --* A Boolean that indicates whether this is a staging distribution. When this value is "true", this is a staging distribution. When this value is "false", this is not a staging distribution. * **ConnectionMode** *(string) --* This field specifies whether the connection mode is through a standard distribution (direct) or a multi- tenant distribution with distribution tenants (tenant- only). * **AnycastIpListId** *(string) --* ID of the Anycast static IP list that is associated with the distribution. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.UnsupportedOperation" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / create_distribution create_distribution ******************* CloudFront.Client.create_distribution(**kwargs) Creates a CloudFront distribution. 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', 'OriginReadTimeout': 123 }, '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 }, 'VpcOriginConfig': { 'VpcOriginId': 'string', 'OriginReadTimeout': 123, 'OriginKeepaliveTimeout': 123 }, 'ConnectionAttempts': 123, 'ConnectionTimeout': 123, 'ResponseCompletionTimeout': 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' }, ] }, 'SelectionCriteria': 'default'|'media-quality-based' }, ] }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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'|'None', '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'|'TLSv1.3_2025', '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, 'ContinuousDeploymentPolicyId': 'string', 'Staging': True|False, 'AnycastIpListId': 'string', 'TenantConfig': { 'ParameterDefinitions': [ { 'Name': 'string', 'Definition': { 'StringSchema': { 'Comment': 'string', 'DefaultValue': 'string', 'Required': True|False } } }, ] }, 'ConnectionMode': 'direct'|'tenant-only' } ) Parameters: **DistributionConfig** (*dict*) -- **[REQUIRED]** The distribution's configuration information. * **CallerReference** *(string) --* **[REQUIRED]** 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution. * **Quantity** *(integer) --* **[REQUIRED]** 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. * *(string) --* * **DefaultRootObject** *(string) --* When a viewer requests the root URL for your distribution, the default root object is the object that you want CloudFront to request from your origin. For example, if your root URL is "https://www.example.com", you can specify CloudFront to return the "index.html" file as the default root object. You can specify a default root object so that viewers see a specific file or object, instead of another object in your distribution (for example, "https://www.example.com/product- description.html"). A default root object avoids exposing the contents of your distribution. You can specify the object name or a path to the object name (for example, "index.html" or "exampleFolderName/index.html"). Your string can't begin with a forward slash ( "/"). Only specify the object name or the path to the object. 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 Specify a default root object in the *Amazon CloudFront Developer Guide*. * **Origins** *(dict) --* **[REQUIRED]** A complex type that contains information about origins for this distribution. * **Quantity** *(integer) --* **[REQUIRED]** The number of origins for this distribution. * **Items** *(list) --* **[REQUIRED]** 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: * Use "S3OriginConfig" to specify an Amazon S3 bucket that is not configured with static website hosting. * Use "VpcOriginConfig" to specify a VPC origin. * Use "CustomOriginConfig" to specify all other kinds of origins, including: * An Amazon S3 bucket that is configured with static website hosting * An Elastic Load Balancing load balancer * An Elemental MediaPackage endpoint * An Elemental MediaStore container * Any other HTTP server, running on an Amazon EC2 instance or any other kind of host For the current maximum number of origins that you can specify per distribution, see General Quotas on Web Distributions in the *Amazon CloudFront Developer Guide* (quotas were formerly referred to as limits). * **Id** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of custom headers, if any, for this distribution. * **Items** *(list) --* **Optional**: A list that contains one "OriginCustomHeader" element for each custom header that you want CloudFront to forward to the origin. If Quantity is "0", omit "Items". * *(dict) --* A complex type that contains "HeaderName" and "HeaderValue" elements, if any, for this distribution. * **HeaderName** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** Note: If you're using origin access control (OAC) instead of origin access identity, specify an empty "OriginAccessIdentity" element. For more information, see Restricting access to an Amazon Web Services in the *Amazon CloudFront Developer Guide*. 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" The "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*. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see Response timeout 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) --* **[REQUIRED]** The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on. * **HTTPSPort** *(integer) --* **[REQUIRED]** The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on. * **OriginProtocolPolicy** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin. * **Items** *(list) --* **[REQUIRED]** A list that contains allowed SSL/TLS protocols for this distribution. * *(string) --* * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) in the *Amazon CloudFront Developer Guide*. * **VpcOriginConfig** *(dict) --* The VPC origin configuration. * **VpcOriginId** *(string) --* **[REQUIRED]** The VPC origin ID. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) 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*. * **ResponseCompletionTimeout** *(integer) --* The time (in seconds) that a request from CloudFront to the origin can stay open and wait for a response. If the complete response isn't received from the origin by this time, CloudFront ends the connection. The value for "ResponseCompletionTimeout" must be equal to or greater than the value for "OriginReadTimeout". If you don't set a value for "ResponseCompletionTimeout", CloudFront doesn't enforce a maximum value. For more information, see Response completion 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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 secondary 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 specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the secondary origin under the failover conditions that you've chosen. Optionally, you can choose selection criteria for your origin group to specify how your origins are selected when your distribution routes viewer requests. * **Id** *(string) --* **[REQUIRED]** The origin group's ID. * **FailoverCriteria** *(dict) --* **[REQUIRED]** A complex type that contains information about the failover criteria for an origin group. * **StatusCodes** *(dict) --* **[REQUIRED]** The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin. * **Quantity** *(integer) --* **[REQUIRED]** The number of status codes. * **Items** *(list) --* **[REQUIRED]** The items (status codes) for an origin group. * *(integer) --* * **Members** *(dict) --* **[REQUIRED]** A complex type that contains information about the origins in an origin group. * **Quantity** *(integer) --* **[REQUIRED]** The number of origins in an origin group. * **Items** *(list) --* **[REQUIRED]** Items (origins) in an origin group. * *(dict) --* An origin in an origin group. * **OriginId** *(string) --* **[REQUIRED]** The ID for an origin in an origin group. * **SelectionCriteria** *(string) --* The selection criteria for the origin group. For more information, see Create an origin group in the *Amazon CloudFront Developer Guide*. * **DefaultCacheBehavior** *(dict) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* **[REQUIRED]** This field is "true" if any of the Amazon Web Services accounts in the list are configured as trusted signers. If not, this field is "false". * **Quantity** *(integer) --* **[REQUIRED]** The number of Amazon Web Services accounts in the list. * **Items** *(list) --* A list of Amazon Web Services account identifiers. * *(string) --* * **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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of key groups in the list. * **Items** *(list) --* A list of key groups identifiers. * *(string) --* * **ViewerProtocolPolicy** *(string) --* **[REQUIRED]** 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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **Quantity** *(integer) --* **[REQUIRED]** 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) --* **[REQUIRED]** A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. * **Quantity** *(integer) --* **[REQUIRED]** 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) --* **[REQUIRED]** A complex type that contains the HTTP methods that you want CloudFront to cache responses to. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* **[REQUIRED]** The number of Lambda@Edge function associations for this cache behavior. * **Items** *(list) --* **Optional**: A complex type that contains "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(dict) --* A complex type that contains a Lambda@Edge function association. * **LambdaFunctionARN** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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. Your functions must be published to the "LIVE" stage to associate them with a cache behavior. * **Quantity** *(integer) --* **[REQUIRED]** The number of CloudFront functions in the list. * **Items** *(list) --* The CloudFront functions that are associated with a cache behavior in a CloudFront distribution. Your 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) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the function. * **EventType** *(string) --* **[REQUIRED]** 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* **[REQUIRED]** Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of cookie names in the "Items" list. * **Items** *(list) --* A list of cookie names. * *(string) --* * **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) --* **[REQUIRED]** The number of header names in the "Items" list. * **Items** *(list) --* A list of HTTP header names. * *(string) --* * **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) --* **[REQUIRED]** 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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **CacheBehaviors** *(dict) --* A complex type that contains zero or more "CacheBehavior" elements. * **Quantity** *(integer) --* **[REQUIRED]** 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 specify an empty individual "CacheBehavior" element, because this is invalid. For more information, see CacheBehaviors. 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. Warning: If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the "Cache-Control: no-cache", "no-store", or "private" directives are present in the origin headers. For more information about cache behaviors, see Cache Behavior Settings in the *Amazon CloudFront Developer Guide*. * **PathPattern** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* **[REQUIRED]** This field is "true" if any of the Amazon Web Services accounts in the list are configured as trusted signers. If not, this field is "false". * **Quantity** *(integer) --* **[REQUIRED]** The number of Amazon Web Services accounts in the list. * **Items** *(list) --* A list of Amazon Web Services account identifiers. * *(string) --* * **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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of key groups in the list. * **Items** *(list) --* A list of key groups identifiers. * *(string) --* * **ViewerProtocolPolicy** *(string) --* **[REQUIRED]** 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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **Quantity** *(integer) --* **[REQUIRED]** 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) --* **[REQUIRED]** A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control- Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. * **Quantity** *(integer) --* **[REQUIRED]** 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) --* **[REQUIRED]** A complex type that contains the HTTP methods that you want CloudFront to cache responses to. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* **[REQUIRED]** The number of Lambda@Edge function associations for this cache behavior. * **Items** *(list) --* **Optional**: A complex type that contains "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(dict) --* A complex type that contains a Lambda@Edge function association. * **LambdaFunctionARN** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of CloudFront functions in the list. * **Items** *(list) --* The CloudFront functions that are associated with a cache behavior in a CloudFront distribution. Your 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) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the function. * **EventType** *(string) --* **[REQUIRED]** 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* **[REQUIRED]** Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of cookie names in the "Items" list. * **Items** *(list) --* A list of cookie names. * *(string) --* * **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) --* **[REQUIRED]** The number of header names in the "Items" list. * **Items** *(list) --* A list of HTTP header names. * *(string) --* * **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) --* **[REQUIRED]** 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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **CustomErrorResponses** *(dict) --* A complex type that controls the following: * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. * How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the *Amazon CloudFront Developer Guide*. * **Quantity** *(integer) --* **[REQUIRED]** 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: * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. * How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the *Amazon CloudFront Developer Guide*. * **ErrorCode** *(integer) --* **[REQUIRED]** 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: * The value of "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/*". * The value of "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: * Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute "200", the response typically won't be intercepted. * If you don't care about distinguishing among different client errors or server errors, you can specify "400" or "500" as the "ResponseCode" for all 4xx or 5xx errors. * You might want to return a "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) --* **[REQUIRED]** A 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" and "prefix", 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, "amzn-s3-demo-bucket.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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* **[REQUIRED]** 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) * "MinimumProtocolVersion" * "SSLSupportMethod" * **IAMCertificateId** *(string) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 ServicesSupport 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: * The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers. * The ciphers that CloudFront can use to encrypt the content that it returns to viewers. 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: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **CertificateSource** *(string) --* This field is deprecated. Use one of the following fields instead: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **Restrictions** *(dict) --* A complex type that identifies ways in which you want to restrict distribution of your content. * **GeoRestriction** *(dict) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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. * *(string) --* * **WebACLId** *(string) --* Note: Multi-tenant distributions only support WAF V2 web ACLs. 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/a1b2c3d4-5678 -90ab-cdef-EXAMPLE11111". To specify a web ACL created using WAF Classic, use the ACL ID, for example "a1b2c3d4-5678-90ab- cdef-EXAMPLE11111". 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 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) --* Note: To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup. 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: * You enable IPv6 for the distribution * You're using alternate domain names in the URLs for your objects 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. * **ContinuousDeploymentPolicyId** *(string) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. The identifier of a continuous deployment policy. For more information, see "CreateContinuousDeploymentPolicy". * **Staging** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. A Boolean that indicates whether this is a staging distribution. When this value is "true", this is a staging distribution. When this value is "false", this is not a staging distribution. * **AnycastIpListId** *(string) --* Note: To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup. ID of the Anycast static IP list that is associated with the distribution. * **TenantConfig** *(dict) --* Note: This field only supports multi-tenant distributions. You can't specify this field for standard distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. A distribution tenant configuration. * **ParameterDefinitions** *(list) --* The parameters that you specify for a distribution tenant. * *(dict) --* A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution. * **Name** *(string) --* **[REQUIRED]** The name of the parameter. * **Definition** *(dict) --* **[REQUIRED]** The value that you assigned to the parameter. * **StringSchema** *(dict) --* An object that contains information about the string schema. * **Comment** *(string) --* A comment to describe the parameter. * **DefaultValue** *(string) --* The default value of the parameter. * **Required** *(boolean) --* **[REQUIRED]** Whether the defined parameter is required. * **ConnectionMode** *(string) --* This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only). Return type: dict Returns: **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', 'OriginReadTimeout': 123 }, '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 }, 'VpcOriginConfig': { 'VpcOriginId': 'string', 'OriginReadTimeout': 123, 'OriginKeepaliveTimeout': 123 }, 'ConnectionAttempts': 123, 'ConnectionTimeout': 123, 'ResponseCompletionTimeout': 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' }, ] }, 'SelectionCriteria': 'default'|'media-quality-based' }, ] }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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'|'None', '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'|'TLSv1.3_2025', '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, 'ContinuousDeploymentPolicyId': 'string', 'Staging': True|False, 'AnycastIpListId': 'string', 'TenantConfig': { 'ParameterDefinitions': [ { 'Name': 'string', 'Definition': { 'StringSchema': { 'Comment': 'string', 'DefaultValue': 'string', 'Required': True|False } } }, ] }, 'ConnectionMode': 'direct'|'tenant-only' }, 'AliasICPRecordals': [ { 'CNAME': 'string', 'ICPRecordalStatus': 'APPROVED'|'SUSPENDED'|'PENDING' }, ] }, 'Location': 'string', 'ETag': 'string' } **Response Structure** * *(dict) --* The returned result of the corresponding request. * **Distribution** *(dict) --* The distribution's information. * **Id** *(string) --* The distribution's identifier. For example: "E1U5RQF7T870K0". * **ARN** *(string) --* The distribution's Amazon Resource Name (ARN). * **Status** *(string) --* The distribution's status. When the status is "Deployed", the distribution's information is fully propagated to all CloudFront edge locations. * **LastModifiedTime** *(datetime) --* The date and time when the distribution was last modified. * **InProgressInvalidationBatches** *(integer) --* The number of invalidation batches currently in progress. * **DomainName** *(string) --* The distribution's CloudFront domain name. For example: "d111111abcdef8.cloudfront.net". * **ActiveTrustedSigners** *(dict) --* Warning: We recommend using "TrustedKeyGroups" instead of "TrustedSigners". 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 are configured as trusted signers. 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. * *(string) --* * **ActiveTrustedKeyGroups** *(dict) --* 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. * *(string) --* * **DistributionConfig** *(dict) --* The distribution's configuration. * **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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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. * *(string) --* * **DefaultRootObject** *(string) --* When a viewer requests the root URL for your distribution, the default root object is the object that you want CloudFront to request from your origin. For example, if your root URL is "https://www.example.com", you can specify CloudFront to return the "index.html" file as the default root object. You can specify a default root object so that viewers see a specific file or object, instead of another object in your distribution (for example, "https://www.example.com /product-description.html"). A default root object avoids exposing the contents of your distribution. You can specify the object name or a path to the object name (for example, "index.html" or "exampleFolderName/index.html"). Your string can't begin with a forward slash ( "/"). Only specify the object name or the path to the object. 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 Specify 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: * Use "S3OriginConfig" to specify an Amazon S3 bucket that is not configured with static website hosting. * Use "VpcOriginConfig" to specify a VPC origin. * Use "CustomOriginConfig" to specify all other kinds of origins, including: * An Amazon S3 bucket that is configured with static website hosting * An Elastic Load Balancing load balancer * An Elemental MediaPackage endpoint * An Elemental MediaStore container * Any other HTTP server, running on an Amazon EC2 instance or any other kind of host For the current maximum number of origins that you can specify per distribution, see General Quotas on Web Distributions in the *Amazon CloudFront Developer Guide* (quotas were formerly referred to as limits). * **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 "OriginCustomHeader" element for each custom header that you want CloudFront to forward to the origin. If Quantity is "0", omit "Items". * *(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) --* Note: If you're using origin access control (OAC) instead of origin access identity, specify an empty "OriginAccessIdentity" element. For more information, see Restricting access to an Amazon Web Services in the *Amazon CloudFront Developer Guide*. 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" The "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*. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see Response timeout 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. * *(string) --* * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) in the *Amazon CloudFront Developer Guide*. * **VpcOriginConfig** *(dict) --* The VPC origin configuration. * **VpcOriginId** *(string) --* The VPC origin ID. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) 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*. * **ResponseCompletionTimeout** *(integer) --* The time (in seconds) that a request from CloudFront to the origin can stay open and wait for a response. If the complete response isn't received from the origin by this time, CloudFront ends the connection. The value for "ResponseCompletionTimeout" must be equal to or greater than the value for "OriginReadTimeout". If you don't set a value for "ResponseCompletionTimeout", CloudFront doesn't enforce a maximum value. For more information, see Response completion 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 secondary 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 specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the secondary origin under the failover conditions that you've chosen. Optionally, you can choose selection criteria for your origin group to specify how your origins are selected when your distribution routes viewer requests. * **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. * *(integer) --* * **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. * **SelectionCriteria** *(string) --* The selection criteria for the origin group. For more information, see Create an origin group in the *Amazon CloudFront Developer Guide*. * **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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **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. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control- Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. * **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. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(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. Your 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. Your 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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. * *(string) --* * **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. * *(string) --* * **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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **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 specify an empty individual "CacheBehavior" element, because this is invalid. For more information, see CacheBehaviors. 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. Warning: If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the "Cache-Control: no-cache", "no-store", or "private" directives are present in the origin headers. 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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **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. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control- Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. * **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. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(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. Your 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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. * *(string) --* * **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. * *(string) --* * **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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **CustomErrorResponses** *(dict) --* A complex type that controls the following: * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. * How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the *Amazon CloudFront Developer Guide*. * **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: * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. * How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the *Amazon CloudFront Developer Guide*. * **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: * The value of "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/*". * The value of "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: * Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute "200", the response typically won't be intercepted. * If you don't care about distinguishing among different client errors or server errors, you can specify "400" or "500" as the "ResponseCode" for all 4xx or 5xx errors. * You might want to return a "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) --* A 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" and "prefix", 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, "amzn-s3-demo-bucket.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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) * "MinimumProtocolVersion" * "SSLSupportMethod" * **IAMCertificateId** *(string) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 ServicesSupport 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: * The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers. * The ciphers that CloudFront can use to encrypt the content that it returns to viewers. 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: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **CertificateSource** *(string) --* This field is deprecated. Use one of the following fields instead: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **Restrictions** *(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. * *(string) --* * **WebACLId** *(string) --* Note: Multi-tenant distributions only support WAF V2 web ACLs. 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:123456789 012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef- EXAMPLE11111". To specify a web ACL created using WAF Classic, use the ACL ID, for example "a1b2c3d4-5678 -90ab-cdef-EXAMPLE11111". 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 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) --* Note: To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup. 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: * You enable IPv6 for the distribution * You're using alternate domain names in the URLs for your objects 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. * **ContinuousDeploymentPolicyId** *(string) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. The identifier of a continuous deployment policy. For more information, see "CreateContinuousDeploymentPolicy". * **Staging** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. A Boolean that indicates whether this is a staging distribution. When this value is "true", this is a staging distribution. When this value is "false", this is not a staging distribution. * **AnycastIpListId** *(string) --* Note: To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup. ID of the Anycast static IP list that is associated with the distribution. * **TenantConfig** *(dict) --* Note: This field only supports multi-tenant distributions. You can't specify this field for standard distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. A distribution tenant configuration. * **ParameterDefinitions** *(list) --* The parameters that you specify for a distribution tenant. * *(dict) --* A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution. * **Name** *(string) --* The name of the parameter. * **Definition** *(dict) --* The value that you assigned to the parameter. * **StringSchema** *(dict) --* An object that contains information about the string schema. * **Comment** *(string) --* A comment to describe the parameter. * **DefaultValue** *(string) --* The default value of the parameter. * **Required** *(boolean) --* Whether the defined parameter is required. * **ConnectionMode** *(string) --* This field specifies whether the connection mode is through a standard distribution (direct) or a multi- tenant distribution with distribution tenants (tenant- only). * **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 Amazon Web Services Regions outside of China. The status values returned are the following: * **APPROVED** indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED, that is, valid to use with the China Regions, a CNAME must have one ICP recordal number associated with it. * **SUSPENDED** indicates that the associated CNAME does not have a valid ICP recordal number. * **PENDING** indicates that CloudFront can't determine the ICP recordal status of the CNAME associated with the distribution because there was an error in trying to determine the status. You can try again to see if the error is resolved in which case CloudFront returns an APPROVED or SUSPENDED status. * **Location** *(string) --* The fully qualified URI of the new distribution resource just created. * **ETag** *(string) --* The current version of the distribution created. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToOr iginAccessControl" * "CloudFront.Client.exceptions.InvalidDefaultRootObject" * "CloudFront.Client.exceptions.InvalidDomainNameForOriginAccessCo ntrol" * "CloudFront.Client.exceptions.InvalidQueryStringParameters" * "CloudFront.Client.exceptions.TooManyTrustedSigners" * "CloudFront.Client.exceptions.TooManyCookieNamesInWhiteList" * "CloudFront.Client.exceptions.NoSuchFieldLevelEncryptionConfig" * "CloudFront.Client.exceptions.InvalidErrorCode" * "CloudFront.Client.exceptions.IllegalOriginAccessConfiguration" * "CloudFront.Client.exceptions.InvalidProtocolSettings" * "CloudFront.Client.exceptions.TooManyFunctionAssociations" * "CloudFront.Client.exceptions.TooManyOriginCustomHeaders" * "CloudFront.Client.exceptions.InvalidOrigin" * "CloudFront.Client.exceptions.InvalidForwardCookies" * "CloudFront.Client.exceptions.InvalidMinimumProtocolVersion" * "CloudFront.Client.exceptions.NoSuchCachePolicy" * "CloudFront.Client.exceptions.TooManyKeyGroupsAssociatedToDistri bution" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToCa chePolicy" * "CloudFront.Client.exceptions.InvalidRequiredProtocol" * "CloudFront.Client.exceptions.TooManyDistributionsWithFunctionAs sociations" * "CloudFront.Client.exceptions.TooManyOriginGroupsPerDistribution" * "CloudFront.Client.exceptions.TooManyDistributions" * "CloudFront.Client.exceptions.InvalidTTLOrder" * "CloudFront.Client.exceptions.IllegalFieldLevelEncryptionConfigA ssociationWithCacheBehavior" * "CloudFront.Client.exceptions.InvalidOriginKeepaliveTimeout" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.InvalidOriginReadTimeout" * "CloudFront.Client.exceptions.InvalidOriginAccessControl" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.InvalidHeadersForS3Origin" * "CloudFront.Client.exceptions.TrustedSignerDoesNotExist" * "CloudFront.Client.exceptions.InvalidWebACLId" * "CloudFront.Client.exceptions.TooManyDistributionsWithSingleFunc tionARN" * "CloudFront.Client.exceptions.InvalidRelativePath" * "CloudFront.Client.exceptions.TooManyLambdaFunctionAssociations" * "CloudFront.Client.exceptions.NoSuchOriginRequestPolicy" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToFi eldLevelEncryptionConfig" * "CloudFront.Client.exceptions.InconsistentQuantities" * "CloudFront.Client.exceptions.InvalidLocationCode" * "CloudFront.Client.exceptions.InvalidOriginAccessIdentity" * "CloudFront.Client.exceptions.TooManyDistributionCNAMEs" * "CloudFront.Client.exceptions.NoSuchContinuousDeploymentPolicy" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToOr iginRequestPolicy" * "CloudFront.Client.exceptions.TooManyQueryStringParameters" * "CloudFront.Client.exceptions.RealtimeLogConfigOwnerMismatch" * "CloudFront.Client.exceptions.ContinuousDeploymentPolicyInUse" * "CloudFront.Client.exceptions.MissingBody" * "CloudFront.Client.exceptions.TooManyHeadersInForwardedValues" * "CloudFront.Client.exceptions.InvalidLambdaFunctionAssociation" * "CloudFront.Client.exceptions.CNAMEAlreadyExists" * "CloudFront.Client.exceptions.TooManyCertificates" * "CloudFront.Client.exceptions.TrustedKeyGroupDoesNotExist" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToRe sponseHeadersPolicy" * "CloudFront.Client.exceptions.NoSuchResponseHeadersPolicy" * "CloudFront.Client.exceptions.NoSuchRealtimeLogConfig" * "CloudFront.Client.exceptions.InvalidResponseCode" * "CloudFront.Client.exceptions.InvalidGeoRestrictionParameter" * "CloudFront.Client.exceptions.TooManyOrigins" * "CloudFront.Client.exceptions.InvalidViewerCertificate" * "CloudFront.Client.exceptions.InvalidFunctionAssociation" * "CloudFront.Client.exceptions.TooManyDistributionsWithLambdaAsso ciations" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToKe yGroup" * "CloudFront.Client.exceptions.EntityLimitExceeded" * "CloudFront.Client.exceptions.DistributionAlreadyExists" * "CloudFront.Client.exceptions.NoSuchOrigin" * "CloudFront.Client.exceptions.TooManyCacheBehaviors" CloudFront / Client / delete_cache_policy delete_cache_policy ******************* CloudFront.Client.delete_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' ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The unique identifier for the cache policy that you are deleting. To get the identifier, you can use "ListCachePolicies". * **IfMatch** (*string*) -- The version of the cache policy that you are deleting. The version is the cache policy's "ETag" value, which you can get using "ListCachePolicies", "GetCachePolicy", or "GetCachePolicyConfig". Returns: None **Exceptions** * "CloudFront.Client.exceptions.NoSuchCachePolicy" * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.IllegalDelete" * "CloudFront.Client.exceptions.CachePolicyInUse" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / get_response_headers_policy get_response_headers_policy *************************** CloudFront.Client.get_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' ) Parameters: **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". Return type: dict Returns: **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 }, ] }, 'RemoveHeadersConfig': { 'Quantity': 123, 'Items': [ { 'Header': 'string' }, ] } } }, 'ETag': 'string' } **Response Structure** * *(dict) --* * **ResponseHeadersPolicy** *(dict) --* Contains 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. * **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. * *(string) --* * **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. * *(string) --* * **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: * "GET" * "DELETE" * "HEAD" * "OPTIONS" * "PATCH" * "POST" * "PUT" * "ALL" "ALL" is a special value that includes all of the listed HTTP methods. * *(string) --* * **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. * *(string) --* * **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-referrer" * "no-referrer-when-downgrade" * "origin" * "origin-when-cross-origin" * "same-origin" * "strict-origin" * "strict-origin-when-cross-origin" * "unsafe-url" For 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 Security headers in the *Amazon CloudFront Developer Guide* and 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. * **RemoveHeadersConfig** *(dict) --* A configuration for a set of HTTP headers to remove from the HTTP response. * **Quantity** *(integer) --* The number of HTTP header names in the list. * **Items** *(list) --* The list of HTTP header names. * *(dict) --* The name of an HTTP header that CloudFront removes from HTTP responses to requests that match the cache behavior that this response headers policy is attached to. * **Header** *(string) --* The HTTP header name. * **ETag** *(string) --* The version identifier for the current version of the response headers policy. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.NoSuchResponseHeadersPolicy" CloudFront / Client / delete_function delete_function *************** CloudFront.Client.delete_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' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the function that you are deleting. * **IfMatch** (*string*) -- **[REQUIRED]** The current version ( "ETag" value) of the function that you are deleting, which you can get using "DescribeFunction". Returns: None **Exceptions** * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.UnsupportedOperation" * "CloudFront.Client.exceptions.FunctionInUse" * "CloudFront.Client.exceptions.NoSuchFunctionExists" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / create_response_headers_policy create_response_headers_policy ****************************** CloudFront.Client.create_response_headers_policy(**kwargs) Creates a response headers policy. A response headers policy contains information about a set of HTTP headers. To create a response headers policy, you provide some metadata about the policy and a set of configurations that specify the 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, the response headers policy affects the HTTP headers that CloudFront includes in HTTP responses to requests that match the cache behavior. CloudFront adds or removes response headers according to the configuration of the response headers policy. For more information, see Adding or removing HTTP headers in CloudFront responses in the *Amazon CloudFront Developer Guide*. 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 }, ] }, 'RemoveHeadersConfig': { 'Quantity': 123, 'Items': [ { 'Header': 'string' }, ] } } ) Parameters: **ResponseHeadersPolicyConfig** (*dict*) -- **[REQUIRED]** Contains metadata about the response headers policy, and a set of configurations that specify the HTTP headers. * **Comment** *(string) --* A comment to describe the response headers policy. The comment cannot be longer than 128 characters. * **Name** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of origins in the list. * **Items** *(list) --* **[REQUIRED]** The list of origins (domain names). You can specify "*" to allow all origins. * *(string) --* * **AccessControlAllowHeaders** *(dict) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of HTTP header names in the list. * **Items** *(list) --* **[REQUIRED]** The list of HTTP header names. You can specify "*" to allow all headers. * *(string) --* * **AccessControlAllowMethods** *(dict) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of HTTP methods in the list. * **Items** *(list) --* **[REQUIRED]** The list of HTTP methods. Valid values are: * "GET" * "DELETE" * "HEAD" * "OPTIONS" * "PATCH" * "POST" * "PUT" * "ALL" "ALL" is a special value that includes all of the listed HTTP methods. * *(string) --* * **AccessControlAllowCredentials** *(boolean) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of HTTP headers in the list. * **Items** *(list) --* The list of HTTP headers. You can specify "*" to expose all headers. * *(string) --* * **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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The value of the "Referrer-Policy" HTTP response header. Valid values are: * "no-referrer" * "no-referrer-when-downgrade" * "origin" * "origin-when-cross-origin" * "same-origin" * "strict-origin" * "strict-origin-when-cross-origin" * "unsafe-url" For 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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 Security headers in the *Amazon CloudFront Developer Guide* and Strict-Transport-Security in the MDN Web Docs. * **Override** *(boolean) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The HTTP response header name. * **Value** *(string) --* **[REQUIRED]** The value for the HTTP response header. * **Override** *(boolean) --* **[REQUIRED]** A Boolean that determines whether CloudFront overrides a response header with the same name received from the origin with the header specified here. * **RemoveHeadersConfig** *(dict) --* A configuration for a set of HTTP headers to remove from the HTTP response. * **Quantity** *(integer) --* **[REQUIRED]** The number of HTTP header names in the list. * **Items** *(list) --* The list of HTTP header names. * *(dict) --* The name of an HTTP header that CloudFront removes from HTTP responses to requests that match the cache behavior that this response headers policy is attached to. * **Header** *(string) --* **[REQUIRED]** The HTTP header name. Return type: dict Returns: **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 }, ] }, 'RemoveHeadersConfig': { 'Quantity': 123, 'Items': [ { 'Header': 'string' }, ] } } }, 'Location': 'string', 'ETag': 'string' } **Response Structure** * *(dict) --* * **ResponseHeadersPolicy** *(dict) --* Contains 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. * **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. * *(string) --* * **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. * *(string) --* * **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: * "GET" * "DELETE" * "HEAD" * "OPTIONS" * "PATCH" * "POST" * "PUT" * "ALL" "ALL" is a special value that includes all of the listed HTTP methods. * *(string) --* * **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. * *(string) --* * **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-referrer" * "no-referrer-when-downgrade" * "origin" * "origin-when-cross-origin" * "same-origin" * "strict-origin" * "strict-origin-when-cross-origin" * "unsafe-url" For 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 Security headers in the *Amazon CloudFront Developer Guide* and 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. * **RemoveHeadersConfig** *(dict) --* A configuration for a set of HTTP headers to remove from the HTTP response. * **Quantity** *(integer) --* The number of HTTP header names in the list. * **Items** *(list) --* The list of HTTP header names. * *(dict) --* The name of an HTTP header that CloudFront removes from HTTP responses to requests that match the cache behavior that this response headers policy is attached to. * **Header** *(string) --* The HTTP header name. * **Location** *(string) --* The URL of the response headers policy. * **ETag** *(string) --* The version identifier for the current version of the response headers policy. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.TooManyCustomHeadersInResponseHead ersPolicy" * "CloudFront.Client.exceptions.ResponseHeadersPolicyAlreadyExists" * "CloudFront.Client.exceptions.InconsistentQuantities" * "CloudFront.Client.exceptions.TooLongCSPInResponseHeadersPolicy" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.TooManyRemoveHeadersInResponseHead ersPolicy" * "CloudFront.Client.exceptions.TooManyResponseHeadersPolicies" CloudFront / Client / get_connection_group get_connection_group ******************** CloudFront.Client.get_connection_group(**kwargs) Gets information about a connection group. See also: AWS API Documentation **Request Syntax** response = client.get_connection_group( Identifier='string' ) Parameters: **Identifier** (*string*) -- **[REQUIRED]** The ID, name, or Amazon Resource Name (ARN) of the connection group. Return type: dict Returns: **Response Syntax** { 'ConnectionGroup': { 'Id': 'string', 'Name': 'string', 'Arn': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'Tags': { 'Items': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'Ipv6Enabled': True|False, 'RoutingEndpoint': 'string', 'AnycastIpListId': 'string', 'Status': 'string', 'Enabled': True|False, 'IsDefault': True|False }, 'ETag': 'string' } **Response Structure** * *(dict) --* * **ConnectionGroup** *(dict) --* The connection group that you retrieved. * **Id** *(string) --* The ID of the connection group. * **Name** *(string) --* The name of the connection group. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the connection group. * **CreatedTime** *(datetime) --* The date and time when the connection group was created. * **LastModifiedTime** *(datetime) --* The date and time when the connection group was updated. * **Tags** *(dict) --* A complex type that contains zero or more "Tag" elements. * **Items** *(list) --* A complex type that contains "Tag" elements. * *(dict) --* A complex type that contains "Tag" key and "Tag" value. * **Key** *(string) --* 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 "_ - . : / = + @". * **Value** *(string) --* 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 "_ - . : / = + @". * **Ipv6Enabled** *(boolean) --* IPv6 is enabled for the connection group. * **RoutingEndpoint** *(string) --* The routing endpoint (also known as the DNS name) that is assigned to the connection group, such as d111111abcdef8.cloudfront.net. * **AnycastIpListId** *(string) --* The ID of the Anycast static IP list. * **Status** *(string) --* The status of the connection group. * **Enabled** *(boolean) --* Whether the connection group is enabled. * **IsDefault** *(boolean) --* Whether the connection group is the default connection group for the distribution tenants. * **ETag** *(string) --* The current version of the connection group. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" CloudFront / Client / list_field_level_encryption_configs list_field_level_encryption_configs *********************************** CloudFront.Client.list_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' ) Parameters: * **Marker** (*string*) -- Use this when paginating results to indicate where to begin in your list of configurations. The results include configurations 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 configuration on that page). * **MaxItems** (*string*) -- The maximum number of field-level encryption configurations you want in the response body. Return type: dict Returns: **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.InvalidArgument" CloudFront / Client / list_key_value_stores list_key_value_stores ********************* CloudFront.Client.list_key_value_stores(**kwargs) Specifies the key value stores to list. See also: AWS API Documentation **Request Syntax** response = client.list_key_value_stores( Marker='string', MaxItems='string', Status='string' ) Parameters: * **Marker** (*string*) -- The marker associated with the key value stores list. * **MaxItems** (*string*) -- The maximum number of items in the key value stores list. * **Status** (*string*) -- The status of the request for the key value stores list. Return type: dict Returns: **Response Syntax** { 'KeyValueStoreList': { 'NextMarker': 'string', 'MaxItems': 123, 'Quantity': 123, 'Items': [ { 'Name': 'string', 'Id': 'string', 'Comment': 'string', 'ARN': 'string', 'Status': 'string', 'LastModifiedTime': datetime(2015, 1, 1) }, ] } } **Response Structure** * *(dict) --* * **KeyValueStoreList** *(dict) --* The resulting key value stores list. * **NextMarker** *(string) --* The next marker associated with the key value store list. * **MaxItems** *(integer) --* The maximum number of items in the key value store list. * **Quantity** *(integer) --* The quantity of the key value store list. * **Items** *(list) --* The items of the key value store list. * *(dict) --* The key value store. Use this to separate data from function code, allowing you to update data without having to publish a new version of a function. The key value store holds keys and their corresponding values. * **Name** *(string) --* The name of the key value store. * **Id** *(string) --* The unique Id for the key value store. * **Comment** *(string) --* A comment for the key value store. * **ARN** *(string) --* The Amazon Resource Name (ARN) of the key value store. * **Status** *(string) --* The status of the key value store. * **LastModifiedTime** *(datetime) --* The last-modified time of the key value store. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.UnsupportedOperation" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / list_distributions_by_realtime_log_config list_distributions_by_realtime_log_config ***************************************** CloudFront.Client.list_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' ) Parameters: * **Marker** (*string*) -- Use this field when paginating results to indicate where to begin in your list of distributions. The response includes distributions in the list that occur after the marker. To get the next page of the list, set this field's value to the value of "NextMarker" from the current page's response. * **MaxItems** (*string*) -- The maximum number of distributions that you want in the response. * **RealtimeLogConfigName** (*string*) -- The name of the real- time log configuration whose associated distributions you want to list. * **RealtimeLogConfigArn** (*string*) -- The Amazon Resource Name (ARN) of the real-time log configuration whose associated distributions you want to list. Return type: dict Returns: **Response Syntax** { 'DistributionList': { 'Marker': 'string', 'NextMarker': 'string', 'MaxItems': 123, 'IsTruncated': True|False, 'Quantity': 123, 'Items': [ { 'Id': 'string', 'ARN': 'string', 'ETag': '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', 'OriginReadTimeout': 123 }, '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 }, 'VpcOriginConfig': { 'VpcOriginId': 'string', 'OriginReadTimeout': 123, 'OriginKeepaliveTimeout': 123 }, 'ConnectionAttempts': 123, 'ConnectionTimeout': 123, 'ResponseCompletionTimeout': 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' }, ] }, 'SelectionCriteria': 'default'|'media-quality-based' }, ] }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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'|'None', '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'|'TLSv1.3_2025', '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' }, ], 'Staging': True|False, 'ConnectionMode': 'direct'|'tenant-only', 'AnycastIpListId': 'string' }, ] } } **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:distri bution/EDFDVBD632BHDS5", where "123456789012" is your Amazon Web Services account ID. * **ETag** *(string) --* The current version of the distribution. * **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. * *(string) --* * **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: * Use "S3OriginConfig" to specify an Amazon S3 bucket that is not configured with static website hosting. * Use "VpcOriginConfig" to specify a VPC origin. * Use "CustomOriginConfig" to specify all other kinds of origins, including: * An Amazon S3 bucket that is configured with static website hosting * An Elastic Load Balancing load balancer * An Elemental MediaPackage endpoint * An Elemental MediaStore container * Any other HTTP server, running on an Amazon EC2 instance or any other kind of host For the current maximum number of origins that you can specify per distribution, see General Quotas on Web Distributions in the *Amazon CloudFront Developer Guide* (quotas were formerly referred to as limits). * **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 "OriginCustomHeader" element for each custom header that you want CloudFront to forward to the origin. If Quantity is "0", omit "Items". * *(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) --* Note: If you're using origin access control (OAC) instead of origin access identity, specify an empty "OriginAccessIdentity" element. For more information, see Restricting access to an Amazon Web Services in the *Amazon CloudFront Developer Guide*. 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" The "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*. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see Response timeout 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. * *(string) --* * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) in the *Amazon CloudFront Developer Guide*. * **VpcOriginConfig** *(dict) --* The VPC origin configuration. * **VpcOriginId** *(string) --* The VPC origin ID. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) 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*. * **ResponseCompletionTimeout** *(integer) --* The time (in seconds) that a request from CloudFront to the origin can stay open and wait for a response. If the complete response isn't received from the origin by this time, CloudFront ends the connection. The value for "ResponseCompletionTimeout" must be equal to or greater than the value for "OriginReadTimeout". If you don't set a value for "ResponseCompletionTimeout", CloudFront doesn't enforce a maximum value. For more information, see Response completion 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 secondary 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 specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the secondary origin under the failover conditions that you've chosen. Optionally, you can choose selection criteria for your origin group to specify how your origins are selected when your distribution routes viewer requests. * **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. * *(integer) --* * **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. * **SelectionCriteria** *(string) --* The selection criteria for the origin group. For more information, see Create an origin group in the *Amazon CloudFront Developer Guide*. * **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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **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. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control- Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. * **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. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(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. Your 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. Your 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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. * *(string) --* * **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. * *(string) --* * **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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **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 specify an empty individual "CacheBehavior" element, because this is invalid. For more information, see CacheBehaviors. 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. Warning: If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the "Cache-Control: no-cache", "no- store", or "private" directives are present in the origin headers. 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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **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. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access- Control-Request-Method, Access-Control- Request-Headers, and Origin headers for the responses to be cached correctly. * **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. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(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. Your 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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. * *(string) --* * **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. * *(string) --* * **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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **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: * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. * How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the *Amazon CloudFront Developer Guide*. * **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: * The value of "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/*". * The value of "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: * Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute "200", the response typically won't be intercepted. * If you don't care about distinguishing among different client errors or server errors, you can specify "400" or "500" as the "ResponseCode" for all 4xx or 5xx errors. * You might want to return a "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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) * "MinimumProtocolVersion" * "SSLSupportMethod" * **IAMCertificateId** *(string) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 ServicesSupport 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: * The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers. * The ciphers that CloudFront can use to encrypt the content that it returns to viewers. 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: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **CertificateSource** *(string) --* This field is deprecated. Use one of the following fields instead: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **Restrictions** *(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. * *(string) --* * **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 Amazon Web Services Regions outside of China. The status values returned are the following: * **APPROVED** indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED, that is, valid to use with the China Regions, a CNAME must have one ICP recordal number associated with it. * **SUSPENDED** indicates that the associated CNAME does not have a valid ICP recordal number. * **PENDING** indicates that CloudFront can't determine the ICP recordal status of the CNAME associated with the distribution because there was an error in trying to determine the status. You can try again to see if the error is resolved in which case CloudFront returns an APPROVED or SUSPENDED status. * **Staging** *(boolean) --* A Boolean that indicates whether this is a staging distribution. When this value is "true", this is a staging distribution. When this value is "false", this is not a staging distribution. * **ConnectionMode** *(string) --* This field specifies whether the connection mode is through a standard distribution (direct) or a multi- tenant distribution with distribution tenants (tenant- only). * **AnycastIpListId** *(string) --* ID of the Anycast static IP list that is associated with the distribution. **Exceptions** * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / delete_distribution_tenant delete_distribution_tenant ************************** CloudFront.Client.delete_distribution_tenant(**kwargs) Deletes a distribution tenant. If you use this API operation to delete a distribution tenant that is currently enabled, the request will fail. To delete a distribution tenant, you must first disable the distribution tenant by using the "UpdateDistributionTenant" API operation. See also: AWS API Documentation **Request Syntax** response = client.delete_distribution_tenant( Id='string', IfMatch='string' ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The ID of the distribution tenant to delete. * **IfMatch** (*string*) -- **[REQUIRED]** The value of the "ETag" header that you received when retrieving the distribution tenant. This value is returned in the response of the "GetDistributionTenant" API operation. Returns: None **Exceptions** * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.ResourceNotDisabled" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / get_continuous_deployment_policy get_continuous_deployment_policy ******************************** CloudFront.Client.get_continuous_deployment_policy(**kwargs) Gets a continuous deployment policy, including metadata (the policy's identifier and the date and time when the policy was last modified). See also: AWS API Documentation **Request Syntax** response = client.get_continuous_deployment_policy( Id='string' ) Parameters: **Id** (*string*) -- **[REQUIRED]** The identifier of the continuous deployment policy that you are getting. Return type: dict Returns: **Response Syntax** { 'ContinuousDeploymentPolicy': { 'Id': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'ContinuousDeploymentPolicyConfig': { 'StagingDistributionDnsNames': { 'Quantity': 123, 'Items': [ 'string', ] }, 'Enabled': True|False, 'TrafficConfig': { 'SingleWeightConfig': { 'Weight': ..., 'SessionStickinessConfig': { 'IdleTTL': 123, 'MaximumTTL': 123 } }, 'SingleHeaderConfig': { 'Header': 'string', 'Value': 'string' }, 'Type': 'SingleWeight'|'SingleHeader' } } }, 'ETag': 'string' } **Response Structure** * *(dict) --* * **ContinuousDeploymentPolicy** *(dict) --* A continuous deployment policy. * **Id** *(string) --* The identifier of the continuous deployment policy. * **LastModifiedTime** *(datetime) --* The date and time the continuous deployment policy was last modified. * **ContinuousDeploymentPolicyConfig** *(dict) --* Contains the configuration for a continuous deployment policy. * **StagingDistributionDnsNames** *(dict) --* The CloudFront domain name of the staging distribution. For example: "d111111abcdef8.cloudfront.net". * **Quantity** *(integer) --* The number of CloudFront domain names in your staging distribution. * **Items** *(list) --* The CloudFront domain name of the staging distribution. * *(string) --* * **Enabled** *(boolean) --* A Boolean that indicates whether this continuous deployment policy is enabled (in effect). When this value is "true", this policy is enabled and in effect. When this value is "false", this policy is not enabled and has no effect. * **TrafficConfig** *(dict) --* Contains the parameters for routing production traffic from your primary to staging distributions. * **SingleWeightConfig** *(dict) --* Contains the percentage of traffic to send to the staging distribution. * **Weight** *(float) --* The percentage of traffic to send to a staging distribution, expressed as a decimal number between 0 and 0.15. For example, a value of 0.10 means 10% of traffic is sent to the staging distribution. * **SessionStickinessConfig** *(dict) --* Session stickiness provides the ability to define multiple requests from a single viewer as a single session. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution. Define the session duration using TTL values. * **IdleTTL** *(integer) --* The amount of time after which you want sessions to cease if no requests are received. Allowed values are 300–3600 seconds (5–60 minutes). The value must be less than or equal to "MaximumTTL". * **MaximumTTL** *(integer) --* The maximum amount of time to consider requests from the viewer as being part of the same session. Allowed values are 300–3600 seconds (5–60 minutes). The value must be greater than or equal to "IdleTTL". * **SingleHeaderConfig** *(dict) --* Determines which HTTP requests are sent to the staging distribution. * **Header** *(string) --* The request header name that you want CloudFront to send to your staging distribution. The header must contain the prefix "aws-cf-cd-". * **Value** *(string) --* The request header value. * **Type** *(string) --* The type of traffic configuration. * **ETag** *(string) --* The version identifier for the current version of the continuous deployment policy. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.NoSuchContinuousDeploymentPolicy" CloudFront / Client / get_field_level_encryption_profile get_field_level_encryption_profile ********************************** CloudFront.Client.get_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' ) Parameters: **Id** (*string*) -- **[REQUIRED]** Get the ID for the field-level encryption profile information. Return type: dict Returns: **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 field-level encryption profile information. * **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. * *(string) --* * **ETag** *(string) --* The current version of the field level encryption profile. For example: "E2QWRUHAPOMQZL". **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.NoSuchFieldLevelEncryptionProfile" CloudFront / Client / associate_alias associate_alias *************** CloudFront.Client.associate_alias(**kwargs) Note: The "AssociateAlias" API operation only supports standard distributions. To move domains between distribution tenants and/or standard distributions, we recommend that you use the UpdateDomainAssociation API operation instead. Associates an alias with a CloudFront standard distribution. An alias is commonly known as a custom domain or vanity domain. It can also be called a CNAME or alternate domain name. With this operation, you can move an alias that's already used for a standard distribution to a different standard distribution. This prevents the downtime that could occur if you first remove the alias from one standard distribution and then separately add the alias to another standard distribution. To use this operation, specify the alias and the ID of the target standard distribution. For more information, including how to set up the target standard distribution, prerequisites that you must complete, and other restrictions, see Moving an alternate domain name to a different standard distribution or distribution tenant in the *Amazon CloudFront Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.associate_alias( TargetDistributionId='string', Alias='string' ) Parameters: * **TargetDistributionId** (*string*) -- **[REQUIRED]** The ID of the standard distribution that you're associating the alias with. * **Alias** (*string*) -- **[REQUIRED]** The alias (also known as a CNAME) to add to the target standard distribution. Returns: None **Exceptions** * "CloudFront.Client.exceptions.NoSuchDistribution" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.IllegalUpdate" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.TooManyDistributionCNAMEs" CloudFront / Client / create_realtime_log_config create_realtime_log_config ************************** CloudFront.Client.create_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 ) Parameters: * **EndPoints** (*list*) -- **[REQUIRED]** Contains information about the Amazon Kinesis data stream where you are sending real-time log data. * *(dict) --* Contains information about the Amazon Kinesis data stream where you're sending real-time log data in a real-time log configuration. * **StreamType** *(string) --* **[REQUIRED]** 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 in a real-time log configuration. * **RoleARN** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data. * **Fields** (*list*) -- **[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*. * *(string) --* * **Name** (*string*) -- **[REQUIRED]** A unique name to identify this real-time log configuration. * **SamplingRate** (*integer*) -- **[REQUIRED]** The sampling rate for this real-time log configuration. You can specify a whole number between 1 and 100 (inclusive) to determine the percentage of viewer requests that are represented in the real-time log data. Return type: dict Returns: **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're 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 in a real-time log configuration. * **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*. * *(string) --* **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.RealtimeLogConfigAlreadyExists" * "CloudFront.Client.exceptions.TooManyRealtimeLogConfigs" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / delete_origin_access_control delete_origin_access_control **************************** CloudFront.Client.delete_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' ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The unique identifier of the origin access control that you are deleting. * **IfMatch** (*string*) -- The current version ( "ETag" value) of the origin access control that you are deleting. Returns: None **Exceptions** * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.OriginAccessControlInUse" * "CloudFront.Client.exceptions.NoSuchOriginAccessControl" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / delete_connection_group delete_connection_group *********************** CloudFront.Client.delete_connection_group(**kwargs) Deletes a connection group. See also: AWS API Documentation **Request Syntax** response = client.delete_connection_group( Id='string', IfMatch='string' ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The ID of the connection group to delete. * **IfMatch** (*string*) -- **[REQUIRED]** The value of the "ETag" header that you received when retrieving the connection group to delete. Returns: None **Exceptions** * "CloudFront.Client.exceptions.CannotDeleteEntityWhileInUse" * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.ResourceNotDisabled" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / create_invalidation_for_distribution_tenant create_invalidation_for_distribution_tenant ******************************************* CloudFront.Client.create_invalidation_for_distribution_tenant(**kwargs) Creates an invalidation for a distribution tenant. For more information, see Invalidating files in the *Amazon CloudFront Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_invalidation_for_distribution_tenant( Id='string', InvalidationBatch={ 'Paths': { 'Quantity': 123, 'Items': [ 'string', ] }, 'CallerReference': 'string' } ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The ID of the distribution tenant. * **InvalidationBatch** (*dict*) -- **[REQUIRED]** An invalidation batch. * **Paths** *(dict) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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. * *(string) --* * **CallerReference** *(string) --* **[REQUIRED]** 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. Return type: dict Returns: **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) --* * **Location** *(string) --* The location for the invalidation. * **Invalidation** *(dict) --* An invalidation. * **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. * *(string) --* * **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.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.TooManyInvalidationsInProgress" * "CloudFront.Client.exceptions.MissingBody" * "CloudFront.Client.exceptions.InconsistentQuantities" * "CloudFront.Client.exceptions.BatchTooLarge" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / get_response_headers_policy_config get_response_headers_policy_config ********************************** CloudFront.Client.get_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' ) Parameters: **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". Return type: dict Returns: **Response Syntax** { '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 }, ] }, 'RemoveHeadersConfig': { 'Quantity': 123, 'Items': [ { 'Header': 'string' }, ] } }, 'ETag': 'string' } **Response Structure** * *(dict) --* * **ResponseHeadersPolicyConfig** *(dict) --* Contains a response headers 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. * *(string) --* * **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. * *(string) --* * **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: * "GET" * "DELETE" * "HEAD" * "OPTIONS" * "PATCH" * "POST" * "PUT" * "ALL" "ALL" is a special value that includes all of the listed HTTP methods. * *(string) --* * **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. * *(string) --* * **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-referrer" * "no-referrer-when-downgrade" * "origin" * "origin-when-cross-origin" * "same-origin" * "strict-origin" * "strict-origin-when-cross-origin" * "unsafe-url" For 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 Security headers in the *Amazon CloudFront Developer Guide* and 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. * **RemoveHeadersConfig** *(dict) --* A configuration for a set of HTTP headers to remove from the HTTP response. * **Quantity** *(integer) --* The number of HTTP header names in the list. * **Items** *(list) --* The list of HTTP header names. * *(dict) --* The name of an HTTP header that CloudFront removes from HTTP responses to requests that match the cache behavior that this response headers policy is attached to. * **Header** *(string) --* The HTTP header name. * **ETag** *(string) --* The version identifier for the current version of the response headers policy. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.NoSuchResponseHeadersPolicy" CloudFront / Client / test_function test_function ************* CloudFront.Client.test_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' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the function that you are testing. * **IfMatch** (*string*) -- **[REQUIRED]** The current version ( "ETag" value) of the function that you are testing, which you can get using "DescribeFunction". * **Stage** (*string*) -- The stage of the function that you are testing, either "DEVELOPMENT" or "LIVE". * **EventObject** (*bytes*) -- **[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*. Return type: dict Returns: **Response Syntax** { 'TestResult': { 'FunctionSummary': { 'Name': 'string', 'Status': 'string', 'FunctionConfig': { 'Comment': 'string', 'Runtime': 'cloudfront-js-1.0'|'cloudfront-js-2.0', 'KeyValueStoreAssociations': { 'Quantity': 123, 'Items': [ { 'KeyValueStoreARN': 'string' }, ] } }, '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 version. * **KeyValueStoreAssociations** *(dict) --* The configuration for the key value store associations. * **Quantity** *(integer) --* The quantity of key value store associations. * **Items** *(list) --* The items of the key value store association. * *(dict) --* The key value store association. * **KeyValueStoreARN** *(string) --* The Amazon Resource Name (ARN) of the key value store association. * **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. * *(string) --* * **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.TestFunctionFailed" * "CloudFront.Client.exceptions.UnsupportedOperation" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.NoSuchFunctionExists" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / get_distribution_tenant get_distribution_tenant *********************** CloudFront.Client.get_distribution_tenant(**kwargs) Gets information about a distribution tenant. See also: AWS API Documentation **Request Syntax** response = client.get_distribution_tenant( Identifier='string' ) Parameters: **Identifier** (*string*) -- **[REQUIRED]** The identifier of the distribution tenant. You can specify the ARN, ID, or name of the distribution tenant. Return type: dict Returns: **Response Syntax** { 'DistributionTenant': { 'Id': 'string', 'DistributionId': 'string', 'Name': 'string', 'Arn': 'string', 'Domains': [ { 'Domain': 'string', 'Status': 'active'|'inactive' }, ], 'Tags': { 'Items': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'Customizations': { 'WebAcl': { 'Action': 'override'|'disable', 'Arn': 'string' }, 'Certificate': { 'Arn': 'string' }, 'GeoRestrictions': { 'RestrictionType': 'blacklist'|'whitelist'|'none', 'Locations': [ 'string', ] } }, 'Parameters': [ { 'Name': 'string', 'Value': 'string' }, ], 'ConnectionGroupId': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'Enabled': True|False, 'Status': 'string' }, 'ETag': 'string' } **Response Structure** * *(dict) --* * **DistributionTenant** *(dict) --* The distribution tenant that you retrieved. * **Id** *(string) --* The ID of the distribution tenant. * **DistributionId** *(string) --* The ID of the multi-tenant distribution. * **Name** *(string) --* The name of the distribution tenant. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the distribution tenant. * **Domains** *(list) --* The domains associated with the distribution tenant. * *(dict) --* The details about the domain result. * **Domain** *(string) --* The specified domain. * **Status** *(string) --* Whether the domain is active or inactive. * **Tags** *(dict) --* A complex type that contains zero or more "Tag" elements. * **Items** *(list) --* A complex type that contains "Tag" elements. * *(dict) --* A complex type that contains "Tag" key and "Tag" value. * **Key** *(string) --* 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 "_ - . : / = + @". * **Value** *(string) --* 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 "_ - . : / = + @". * **Customizations** *(dict) --* Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant. * **WebAcl** *(dict) --* The WAF web ACL. * **Action** *(string) --* The action for the WAF web ACL customization. You can specify "override" to specify a separate WAF web ACL for the distribution tenant. If you specify "disable", the distribution tenant won't have WAF web ACL protections and won't inherit from the multi-tenant distribution. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the WAF web ACL. * **Certificate** *(dict) --* The Certificate Manager (ACM) certificate. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the ACM certificate. * **GeoRestrictions** *(dict) --* The geographic restrictions. * **RestrictionType** *(string) --* The method that you want to use to restrict distribution of your content by country: * "none": No geographic 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. * **Locations** *(list) --* The locations for geographic restrictions. * *(string) --* * **Parameters** *(list) --* A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution. * *(dict) --* A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution. * **Name** *(string) --* The parameter name. * **Value** *(string) --* The parameter value. * **ConnectionGroupId** *(string) --* The ID of the connection group for the distribution tenant. If you don't specify a connection group, CloudFront uses the default connection group. * **CreatedTime** *(datetime) --* The date and time when the distribution tenant was created. * **LastModifiedTime** *(datetime) --* The date and time when the distribution tenant was updated. * **Enabled** *(boolean) --* Indicates whether the distribution tenant is in an enabled state. If disabled, the distribution tenant won't serve traffic. * **Status** *(string) --* The status of the distribution tenant. * **ETag** *(string) --* The current version of the distribution tenant. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" CloudFront / Client / update_streaming_distribution update_streaming_distribution ***************************** CloudFront.Client.update_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'|'None', 'Enabled': True|False }, Id='string', IfMatch='string' ) Parameters: * **StreamingDistributionConfig** (*dict*) -- **[REQUIRED]** The streaming distribution's configuration information. * **CallerReference** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The DNS name of the Amazon S3 origin. * **OriginAccessIdentity** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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. * *(string) --* * **Comment** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The Amazon S3 bucket to store the access logs in, for example, "amzn-s3-demo-bucket.s3.amazonaws.com". * **Prefix** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** This field is "true" if any of the Amazon Web Services accounts in the list are configured as trusted signers. If not, this field is "false". * **Quantity** *(integer) --* **[REQUIRED]** The number of Amazon Web Services accounts in the list. * **Items** *(list) --* A list of Amazon Web Services account identifiers. * *(string) --* * **PriceClass** *(string) --* A complex type that contains information about price class for this streaming distribution. * **Enabled** *(boolean) --* **[REQUIRED]** Whether the streaming distribution is enabled to accept user requests for content. * **Id** (*string*) -- **[REQUIRED]** The streaming distribution's id. * **IfMatch** (*string*) -- The value of the "ETag" header that you received when retrieving the streaming distribution's configuration. For example: "E2QWRUHAPOMQZL". Return type: dict Returns: **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'|'None', '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/E DFDVBD632BHDS5", 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 are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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, "amzn-s3-demo-bucket.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 in the list are configured as trusted signers. 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. * *(string) --* * **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.AccessDenied" * "CloudFront.Client.exceptions.InconsistentQuantities" * "CloudFront.Client.exceptions.InvalidOriginAccessIdentity" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.IllegalUpdate" * "CloudFront.Client.exceptions.TooManyTrustedSigners" * "CloudFront.Client.exceptions.InvalidOriginAccessControl" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.MissingBody" * "CloudFront.Client.exceptions.TooManyStreamingDistributionCNAMEs" * "CloudFront.Client.exceptions.TrustedSignerDoesNotExist" * "CloudFront.Client.exceptions.CNAMEAlreadyExists" * "CloudFront.Client.exceptions.NoSuchStreamingDistribution" CloudFront / Client / create_vpc_origin create_vpc_origin ***************** CloudFront.Client.create_vpc_origin(**kwargs) Create an Amazon CloudFront VPC origin. See also: AWS API Documentation **Request Syntax** response = client.create_vpc_origin( VpcOriginEndpointConfig={ 'Name': 'string', 'Arn': 'string', 'HTTPPort': 123, 'HTTPSPort': 123, 'OriginProtocolPolicy': 'http-only'|'match-viewer'|'https-only', 'OriginSslProtocols': { 'Quantity': 123, 'Items': [ 'SSLv3'|'TLSv1'|'TLSv1.1'|'TLSv1.2', ] } }, Tags={ 'Items': [ { 'Key': 'string', 'Value': 'string' }, ] } ) Parameters: * **VpcOriginEndpointConfig** (*dict*) -- **[REQUIRED]** The VPC origin endpoint configuration. * **Name** *(string) --* **[REQUIRED]** The name of the CloudFront VPC origin endpoint configuration. * **Arn** *(string) --* **[REQUIRED]** The ARN of the CloudFront VPC origin endpoint configuration. * **HTTPPort** *(integer) --* **[REQUIRED]** The HTTP port for the CloudFront VPC origin endpoint configuration. The default value is "80". * **HTTPSPort** *(integer) --* **[REQUIRED]** The HTTPS port of the CloudFront VPC origin endpoint configuration. The default value is "443". * **OriginProtocolPolicy** *(string) --* **[REQUIRED]** The origin protocol policy for the CloudFront VPC origin endpoint configuration. * **OriginSslProtocols** *(dict) --* A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin. * **Quantity** *(integer) --* **[REQUIRED]** The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin. * **Items** *(list) --* **[REQUIRED]** A list that contains allowed SSL/TLS protocols for this distribution. * *(string) --* * **Tags** (*dict*) -- A complex type that contains zero or more "Tag" elements. * **Items** *(list) --* A complex type that contains "Tag" elements. * *(dict) --* A complex type that contains "Tag" key and "Tag" value. * **Key** *(string) --* **[REQUIRED]** 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 "_ - . : / = + @". * **Value** *(string) --* 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 "_ - . : / = + @". Return type: dict Returns: **Response Syntax** { 'VpcOrigin': { 'Id': 'string', 'Arn': 'string', 'Status': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'VpcOriginEndpointConfig': { 'Name': 'string', 'Arn': 'string', 'HTTPPort': 123, 'HTTPSPort': 123, 'OriginProtocolPolicy': 'http-only'|'match-viewer'|'https-only', 'OriginSslProtocols': { 'Quantity': 123, 'Items': [ 'SSLv3'|'TLSv1'|'TLSv1.1'|'TLSv1.2', ] } } }, 'Location': 'string', 'ETag': 'string' } **Response Structure** * *(dict) --* * **VpcOrigin** *(dict) --* The VPC origin. * **Id** *(string) --* The VPC origin ID. * **Arn** *(string) --* The VPC origin ARN. * **Status** *(string) --* The VPC origin status. * **CreatedTime** *(datetime) --* The VPC origin created time. * **LastModifiedTime** *(datetime) --* The VPC origin last modified time. * **VpcOriginEndpointConfig** *(dict) --* The VPC origin endpoint configuration. * **Name** *(string) --* The name of the CloudFront VPC origin endpoint configuration. * **Arn** *(string) --* The ARN of the CloudFront VPC origin endpoint configuration. * **HTTPPort** *(integer) --* The HTTP port for the CloudFront VPC origin endpoint configuration. The default value is "80". * **HTTPSPort** *(integer) --* The HTTPS port of the CloudFront VPC origin endpoint configuration. The default value is "443". * **OriginProtocolPolicy** *(string) --* The origin protocol policy for the CloudFront VPC origin endpoint configuration. * **OriginSslProtocols** *(dict) --* A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin. * **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. * *(string) --* * **Location** *(string) --* The VPC origin location. * **ETag** *(string) --* The VPC origin ETag. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.UnsupportedOperation" * "CloudFront.Client.exceptions.EntityAlreadyExists" * "CloudFront.Client.exceptions.InconsistentQuantities" * "CloudFront.Client.exceptions.InvalidTagging" * "CloudFront.Client.exceptions.EntityLimitExceeded" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / update_origin_access_control update_origin_access_control **************************** CloudFront.Client.update_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'|'mediastore'|'mediapackagev2'|'lambda' }, Id='string', IfMatch='string' ) Parameters: * **OriginAccessControlConfig** (*dict*) -- **[REQUIRED]** An origin access control. * **Name** *(string) --* **[REQUIRED]** A name to identify the origin access control. You can specify up to 64 characters. * **Description** *(string) --* A description of the origin access control. * **SigningProtocol** *(string) --* **[REQUIRED]** The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is "sigv4". * **SigningBehavior** *(string) --* **[REQUIRED]** 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 for all cache behaviors that use origins associated with this origin access control. * **OriginAccessControlOriginType** *(string) --* **[REQUIRED]** The type of origin that this origin access control is for. * **Id** (*string*) -- **[REQUIRED]** The unique identifier of the origin access control that you are updating. * **IfMatch** (*string*) -- The current version ( "ETag" value) of the origin access control that you are updating. Return type: dict Returns: **Response Syntax** { 'OriginAccessControl': { 'Id': 'string', 'OriginAccessControlConfig': { 'Name': 'string', 'Description': 'string', 'SigningProtocol': 'sigv4', 'SigningBehavior': 'never'|'always'|'no-override', 'OriginAccessControlOriginType': 's3'|'mediastore'|'mediapackagev2'|'lambda' } }, '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. You can specify up to 64 characters. * **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 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. * **ETag** *(string) --* The new version of the origin access control after it has been updated. **Exceptions** * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.OriginAccessControlAlreadyExists" * "CloudFront.Client.exceptions.NoSuchOriginAccessControl" * "CloudFront.Client.exceptions.IllegalUpdate" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / create_field_level_encryption_profile create_field_level_encryption_profile ************************************* CloudFront.Client.create_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', ] } }, ] } } ) Parameters: **FieldLevelEncryptionProfileConfig** (*dict*) -- **[REQUIRED]** The request to create a field-level encryption profile. * **Name** *(string) --* **[REQUIRED]** Profile name for the field-level encryption profile. * **CallerReference** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of field-level encryption field patterns. * **Items** *(list) --* An array of the field-level encryption field patterns. * *(string) --* Return type: dict Returns: **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', ] } }, ] } } }, 'Location': 'string', 'ETag': 'string' } **Response Structure** * *(dict) --* * **FieldLevelEncryptionProfile** *(dict) --* Returned when you create a new field-level encryption 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. * *(string) --* * **Location** *(string) --* The fully qualified URI of the new profile resource just created. * **ETag** *(string) --* The current version of the field level encryption profile. For example: "E2QWRUHAPOMQZL". **Exceptions** * "CloudFront.Client.exceptions.TooManyFieldLevelEncryptionFieldPa tterns" * "CloudFront.Client.exceptions.FieldLevelEncryptionProfileAlready Exists" * "CloudFront.Client.exceptions.NoSuchPublicKey" * "CloudFront.Client.exceptions.FieldLevelEncryptionProfileSizeExc eeded" * "CloudFront.Client.exceptions.InconsistentQuantities" * "CloudFront.Client.exceptions.TooManyFieldLevelEncryptionProfile s" * "CloudFront.Client.exceptions.TooManyFieldLevelEncryptionEncrypt ionEntities" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / delete_distribution delete_distribution ******************* CloudFront.Client.delete_distribution(**kwargs) Delete a distribution. See also: AWS API Documentation **Request Syntax** response = client.delete_distribution( Id='string', IfMatch='string' ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The distribution ID. * **IfMatch** (*string*) -- The value of the "ETag" header that you received when you disabled the distribution. For example: "E2QWRUHAPOMQZL". Returns: None **Exceptions** * "CloudFront.Client.exceptions.ResourceInUse" * "CloudFront.Client.exceptions.NoSuchDistribution" * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.DistributionNotDisabled" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / disassociate_distribution_web_acl disassociate_distribution_web_acl ********************************* CloudFront.Client.disassociate_distribution_web_acl(**kwargs) Disassociates a distribution from the WAF web ACL. See also: AWS API Documentation **Request Syntax** response = client.disassociate_distribution_web_acl( Id='string', IfMatch='string' ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The ID of the distribution. * **IfMatch** (*string*) -- The value of the "ETag" header that you received when retrieving the distribution that you're disassociating from the WAF web ACL. Return type: dict Returns: **Response Syntax** { 'Id': 'string', 'ETag': 'string' } **Response Structure** * *(dict) --* * **Id** *(string) --* The ID of the distribution. * **ETag** *(string) --* The current version of the distribution. **Exceptions** * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / list_key_groups list_key_groups *************** CloudFront.Client.list_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' ) Parameters: * **Marker** (*string*) -- Use this field when paginating results to indicate where to begin in your list of key groups. The response includes key groups in the list that occur after the marker. To get the next page of the list, set this field's value to the value of "NextMarker" from the current page's response. * **MaxItems** (*string*) -- The maximum number of key groups that you want in the response. Return type: dict Returns: **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. * *(string) --* * **Comment** *(string) --* A comment to describe the key group. The comment cannot be longer than 128 characters. **Exceptions** * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / delete_field_level_encryption_config delete_field_level_encryption_config ************************************ CloudFront.Client.delete_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' ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The ID of the configuration you want to delete from CloudFront. * **IfMatch** (*string*) -- The value of the "ETag" header that you received when retrieving the configuration identity to delete. For example: "E2QWRUHAPOMQZL". Returns: None **Exceptions** * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.FieldLevelEncryptionConfigInUse" * "CloudFront.Client.exceptions.NoSuchFieldLevelEncryptionConfig" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / update_key_value_store update_key_value_store ********************** CloudFront.Client.update_key_value_store(**kwargs) Specifies the key value store to update. See also: AWS API Documentation **Request Syntax** response = client.update_key_value_store( Name='string', Comment='string', IfMatch='string' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the key value store to update. * **Comment** (*string*) -- **[REQUIRED]** The comment of the key value store to update. * **IfMatch** (*string*) -- **[REQUIRED]** The key value store to update, if a match occurs. Return type: dict Returns: **Response Syntax** { 'KeyValueStore': { 'Name': 'string', 'Id': 'string', 'Comment': 'string', 'ARN': 'string', 'Status': 'string', 'LastModifiedTime': datetime(2015, 1, 1) }, 'ETag': 'string' } **Response Structure** * *(dict) --* * **KeyValueStore** *(dict) --* The resulting key value store to update. * **Name** *(string) --* The name of the key value store. * **Id** *(string) --* The unique Id for the key value store. * **Comment** *(string) --* A comment for the key value store. * **ARN** *(string) --* The Amazon Resource Name (ARN) of the key value store. * **Status** *(string) --* The status of the key value store. * **LastModifiedTime** *(datetime) --* The last-modified time of the key value store. * **ETag** *(string) --* The "ETag" of the resulting key value store. **Exceptions** * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.UnsupportedOperation" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / close close ***** CloudFront.Client.close() Closes underlying endpoint connections. CloudFront / Client / delete_field_level_encryption_profile delete_field_level_encryption_profile ************************************* CloudFront.Client.delete_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' ) Parameters: * **Id** (*string*) -- **[REQUIRED]** Request the ID of the profile you want to delete from CloudFront. * **IfMatch** (*string*) -- The value of the "ETag" header that you received when retrieving the profile to delete. For example: "E2QWRUHAPOMQZL". Returns: None **Exceptions** * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.NoSuchFieldLevelEncryptionProfile" * "CloudFront.Client.exceptions.FieldLevelEncryptionProfileInUse" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / create_field_level_encryption_config create_field_level_encryption_config ************************************ CloudFront.Client.create_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' }, ] } } } ) Parameters: **FieldLevelEncryptionConfig** (*dict*) -- **[REQUIRED]** The request to create a new field-level encryption configuration. * **CallerReference** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** Query argument for field-level encryption query argument-profile mapping. * **ProfileId** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The content type for a field-level encryption content type-profile mapping. Return type: dict Returns: **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' }, ] } } } }, 'Location': 'string', 'ETag': 'string' } **Response Structure** * *(dict) --* * **FieldLevelEncryption** *(dict) --* Returned when you create a new field-level encryption 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. * **Location** *(string) --* The fully qualified URI of the new configuration resource just created. * **ETag** *(string) --* The current version of the field level encryption configuration. For example: "E2QWRUHAPOMQZL". **Exceptions** * "CloudFront.Client.exceptions.QueryArgProfileEmpty" * "CloudFront.Client.exceptions.TooManyFieldLevelEncryptionContent TypeProfiles" * "CloudFront.Client.exceptions.TooManyFieldLevelEncryptionQueryAr gProfiles" * "CloudFront.Client.exceptions.FieldLevelEncryptionConfigAlreadyE xists" * "CloudFront.Client.exceptions.InconsistentQuantities" * "CloudFront.Client.exceptions.TooManyFieldLevelEncryptionConfigs" * "CloudFront.Client.exceptions.NoSuchFieldLevelEncryptionProfile" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / get_public_key get_public_key ************** CloudFront.Client.get_public_key(**kwargs) Gets a public key. See also: AWS API Documentation **Request Syntax** response = client.get_public_key( Id='string' ) Parameters: **Id** (*string*) -- **[REQUIRED]** The identifier of the public key you are getting. Return type: dict Returns: **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 for this version of the public key. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.NoSuchPublicKey" CloudFront / Client / list_origin_access_controls list_origin_access_controls *************************** CloudFront.Client.list_origin_access_controls(**kwargs) Gets the list of CloudFront origin access controls (OACs) 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. Note: If you're not using origin access controls for your Amazon Web Services account, the "ListOriginAccessControls" operation doesn't return the "Items" element in the response. See also: AWS API Documentation **Request Syntax** response = client.list_origin_access_controls( Marker='string', MaxItems='string' ) Parameters: * **Marker** (*string*) -- Use this field when paginating results to indicate where to begin in your list of origin access controls. The response includes the items in the list that occur after the marker. To get the next page of the list, set this field's value to the value of "NextMarker" from the current page's response. * **MaxItems** (*string*) -- The maximum number of origin access controls that you want in the response. Return type: dict Returns: **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'|'mediastore'|'mediapackagev2'|'lambda' }, ] } } **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. **Exceptions** * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / get_monitoring_subscription get_monitoring_subscription *************************** CloudFront.Client.get_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' ) Parameters: **DistributionId** (*string*) -- **[REQUIRED]** The ID of the distribution that you are getting metrics information for. Return type: dict Returns: **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.NoSuchDistribution" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.UnsupportedOperation" * "CloudFront.Client.exceptions.NoSuchMonitoringSubscription" CloudFront / Client / list_invalidations list_invalidations ****************** CloudFront.Client.list_invalidations(**kwargs) Lists invalidation batches. See also: AWS API Documentation **Request Syntax** response = client.list_invalidations( DistributionId='string', Marker='string', MaxItems='string' ) Parameters: * **DistributionId** (*string*) -- **[REQUIRED]** The distribution's ID. * **Marker** (*string*) -- Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set "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. * **MaxItems** (*string*) -- The maximum number of invalidation batches that you want in the response body. Return type: dict Returns: **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.NoSuchDistribution" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / create_monitoring_subscription create_monitoring_subscription ****************************** CloudFront.Client.create_monitoring_subscription(**kwargs) Enables or disables additional Amazon 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' } } ) Parameters: * **DistributionId** (*string*) -- **[REQUIRED]** The ID of the distribution that you are enabling metrics for. * **MonitoringSubscription** (*dict*) -- **[REQUIRED]** 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) --* **[REQUIRED]** A flag that indicates whether additional CloudWatch metrics are enabled for a given CloudFront distribution. Return type: dict Returns: **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.NoSuchDistribution" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.MonitoringSubscriptionAlreadyExist s" * "CloudFront.Client.exceptions.UnsupportedOperation" CloudFront / Client / update_cloud_front_origin_access_identity update_cloud_front_origin_access_identity ***************************************** CloudFront.Client.update_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' ) Parameters: * **CloudFrontOriginAccessIdentityConfig** (*dict*) -- **[REQUIRED]** The identity's configuration information. * **CallerReference** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** A comment to describe the origin access identity. The comment cannot be longer than 128 characters. * **Id** (*string*) -- **[REQUIRED]** The identity's id. * **IfMatch** (*string*) -- The value of the "ETag" header that you received when retrieving the identity's configuration. For example: "E2QWRUHAPOMQZL". Return type: dict Returns: **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.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.MissingBody" * "CloudFront.Client.exceptions.InconsistentQuantities" * "CloudFront.Client.exceptions.IllegalUpdate" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" * "CloudFront.Client.exceptions.NoSuchCloudFrontOriginAccessIdenti ty" CloudFront / Client / get_cache_policy_config get_cache_policy_config *********************** CloudFront.Client.get_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' ) Parameters: **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". Return type: dict Returns: **Response Syntax** { '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) --* * **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 also 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: * Normalizes the value of the viewer's "Accept-Encoding" header * Includes the normalized header in the cache key * Includes the normalized header in the request to the origin, if a request is necessary For 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: * Normalizes the value of the viewer's "Accept-Encoding" header * Includes the normalized header in the cache key * Includes the normalized header in the request to the origin, if a request is necessary For 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 in requests that CloudFront sends to the origin. * **HeaderBehavior** *(string) --* Determines whether any HTTP headers are included in the cache key and in requests that CloudFront sends to the origin. Valid values are: * "none" – No HTTP headers are included in the cache key or 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" – Only the HTTP headers that are listed in the "Headers" type are included in the cache key and 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. * *(string) --* * **CookiesConfig** *(dict) --* An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin. * **CookieBehavior** *(string) --* Determines whether any cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are: * "none" – No cookies in viewer requests are included in the cache key or 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" – Only the cookies in viewer requests that are listed in the "CookieNames" type are included in the cache key and in requests that CloudFront sends to the origin. * "allExcept" – All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, **except** for those that are listed in the "CookieNames" type, which are not included. * "all" – All cookies in viewer requests are included in the cache key and 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. * *(string) --* * **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 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 in requests that CloudFront sends to the origin. Valid values are: * "none" – No query strings in viewer requests are included in the cache key or 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" – Only the query strings in viewer requests that are listed in the "QueryStringNames" type are included in the cache key and in requests that CloudFront sends to the origin. * "allExcept" – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, **except** those that are listed in the "QueryStringNames" type, which are not included. * "all" – All query strings in viewer requests are included in the cache key and 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 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. * *(string) --* * **ETag** *(string) --* The current version of the cache policy. **Exceptions** * "CloudFront.Client.exceptions.NoSuchCachePolicy" * "CloudFront.Client.exceptions.AccessDenied" CloudFront / Client / get_managed_certificate_details get_managed_certificate_details ******************************* CloudFront.Client.get_managed_certificate_details(**kwargs) Gets details about the CloudFront managed ACM certificate. See also: AWS API Documentation **Request Syntax** response = client.get_managed_certificate_details( Identifier='string' ) Parameters: **Identifier** (*string*) -- **[REQUIRED]** The identifier of the distribution tenant. You can specify the ARN, ID, or name of the distribution tenant. Return type: dict Returns: **Response Syntax** { 'ManagedCertificateDetails': { 'CertificateArn': 'string', 'CertificateStatus': 'pending-validation'|'issued'|'inactive'|'expired'|'validation-timed-out'|'revoked'|'failed', 'ValidationTokenHost': 'cloudfront'|'self-hosted', 'ValidationTokenDetails': [ { 'Domain': 'string', 'RedirectTo': 'string', 'RedirectFrom': 'string' }, ] } } **Response Structure** * *(dict) --* * **ManagedCertificateDetails** *(dict) --* Contains details about the CloudFront managed ACM certificate. * **CertificateArn** *(string) --* The ARN of the CloudFront managed ACM certificate. * **CertificateStatus** *(string) --* The status of the CloudFront managed ACM certificate. Note: Your distribution tenant will be updated with the latest certificate status. When calling the UpdateDistributionTenant operation, use the latest value for the "ETag". * **ValidationTokenHost** *(string) --* Contains details about the validation token host of the specified CloudFront managed ACM certificate. * For "cloudfront", CloudFront will automatically serve the validation token. Choose this mode if you can point the domain's DNS to CloudFront immediately. * For "self-hosted", you serve the validation token from your existing infrastructure. Choose this mode when you need to maintain current traffic flow while your certificate is being issued. You can place the validation token at the well-known path on your existing web server, wait for ACM to validate and issue the certificate, and then update your DNS to point to CloudFront. Note: This setting only affects the initial certificate request. Once the DNS points to CloudFront, all future certificate renewals are automatically handled through CloudFront. * **ValidationTokenDetails** *(list) --* Contains details about the validation token of the specified CloudFront managed ACM certificate. * *(dict) --* Contains details about the validation token. * **Domain** *(string) --* The domain name. * **RedirectTo** *(string) --* The domain to redirect to. * **RedirectFrom** *(string) --* The domain to redirect from. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" CloudFront / Client / list_cache_policies list_cache_policies ******************* CloudFront.Client.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' ) Parameters: * **Type** (*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. * **Marker** (*string*) -- Use this field when paginating results to indicate where to begin in your list of cache policies. The response includes cache policies in the list that occur after the marker. To get the next page of the list, set this field's value to the value of "NextMarker" from the current page's response. * **MaxItems** (*string*) -- The maximum number of cache policies that you want in the response. Return type: dict Returns: **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 also 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: * Normalizes the value of the viewer's "Accept- Encoding" header * Includes the normalized header in the cache key * Includes the normalized header in the request to the origin, if a request is necessary For 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: * Normalizes the value of the viewer's "Accept- Encoding" header * Includes the normalized header in the cache key * Includes the normalized header in the request to the origin, if a request is necessary For 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 in requests that CloudFront sends to the origin. * **HeaderBehavior** *(string) --* Determines whether any HTTP headers are included in the cache key and in requests that CloudFront sends to the origin. Valid values are: * "none" – No HTTP headers are included in the cache key or 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" – Only the HTTP headers that are listed in the "Headers" type are included in the cache key and 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. * *(string) --* * **CookiesConfig** *(dict) --* An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin. * **CookieBehavior** *(string) --* Determines whether any cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are: * "none" – No cookies in viewer requests are included in the cache key or 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" – Only the cookies in viewer requests that are listed in the "CookieNames" type are included in the cache key and in requests that CloudFront sends to the origin. * "allExcept" – All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, **except** for those that are listed in the "CookieNames" type, which are not included. * "all" – All cookies in viewer requests are included in the cache key and 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. * *(string) --* * **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 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 in requests that CloudFront sends to the origin. Valid values are: * "none" – No query strings in viewer requests are included in the cache key or 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" – Only the query strings in viewer requests that are listed in the "QueryStringNames" type are included in the cache key and in requests that CloudFront sends to the origin. * "allExcept" – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, **except** those that are listed in the "QueryStringNames" type, which are not included. * "all" – All query strings in viewer requests are included in the cache key and 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 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. * *(string) --* **Exceptions** * "CloudFront.Client.exceptions.NoSuchCachePolicy" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / get_origin_access_control_config get_origin_access_control_config ******************************** CloudFront.Client.get_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' ) Parameters: **Id** (*string*) -- **[REQUIRED]** The unique identifier of the origin access control. Return type: dict Returns: **Response Syntax** { 'OriginAccessControlConfig': { 'Name': 'string', 'Description': 'string', 'SigningProtocol': 'sigv4', 'SigningBehavior': 'never'|'always'|'no-override', 'OriginAccessControlOriginType': 's3'|'mediastore'|'mediapackagev2'|'lambda' }, 'ETag': 'string' } **Response Structure** * *(dict) --* * **OriginAccessControlConfig** *(dict) --* Contains an origin access control configuration. * **Name** *(string) --* A name to identify the origin access control. You can specify up to 64 characters. * **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 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. * **ETag** *(string) --* The version identifier for the current version of the origin access control. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.NoSuchOriginAccessControl" CloudFront / Client / get_field_level_encryption_config get_field_level_encryption_config ********************************* CloudFront.Client.get_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' ) Parameters: **Id** (*string*) -- **[REQUIRED]** Request the ID for the field-level encryption configuration information. Return type: dict Returns: **Response Syntax** { '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) --* * **FieldLevelEncryptionConfig** *(dict) --* Return the field-level encryption configuration information. * **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 current version of the field level encryption configuration. For example: "E2QWRUHAPOMQZL". **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.NoSuchFieldLevelEncryptionConfig" CloudFront / Client / update_response_headers_policy update_response_headers_policy ****************************** CloudFront.Client.update_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: * Use "GetResponseHeadersPolicyConfig" to get the current policy's configuration. * Modify the fields in the response headers policy configuration that you want to update. * Call "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 }, ] }, 'RemoveHeadersConfig': { 'Quantity': 123, 'Items': [ { 'Header': 'string' }, ] } }, Id='string', IfMatch='string' ) Parameters: * **ResponseHeadersPolicyConfig** (*dict*) -- **[REQUIRED]** A response headers policy configuration. * **Comment** *(string) --* A comment to describe the response headers policy. The comment cannot be longer than 128 characters. * **Name** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of origins in the list. * **Items** *(list) --* **[REQUIRED]** The list of origins (domain names). You can specify "*" to allow all origins. * *(string) --* * **AccessControlAllowHeaders** *(dict) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of HTTP header names in the list. * **Items** *(list) --* **[REQUIRED]** The list of HTTP header names. You can specify "*" to allow all headers. * *(string) --* * **AccessControlAllowMethods** *(dict) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of HTTP methods in the list. * **Items** *(list) --* **[REQUIRED]** The list of HTTP methods. Valid values are: * "GET" * "DELETE" * "HEAD" * "OPTIONS" * "PATCH" * "POST" * "PUT" * "ALL" "ALL" is a special value that includes all of the listed HTTP methods. * *(string) --* * **AccessControlAllowCredentials** *(boolean) --* **[REQUIRED]** 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) --* **[REQUIRED]** The number of HTTP headers in the list. * **Items** *(list) --* The list of HTTP headers. You can specify "*" to expose all headers. * *(string) --* * **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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The value of the "Referrer-Policy" HTTP response header. Valid values are: * "no-referrer" * "no-referrer-when-downgrade" * "origin" * "origin-when-cross-origin" * "same-origin" * "strict-origin" * "strict-origin-when-cross-origin" * "unsafe-url" For 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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 Security headers in the *Amazon CloudFront Developer Guide* and Strict-Transport-Security in the MDN Web Docs. * **Override** *(boolean) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** The HTTP response header name. * **Value** *(string) --* **[REQUIRED]** The value for the HTTP response header. * **Override** *(boolean) --* **[REQUIRED]** A Boolean that determines whether CloudFront overrides a response header with the same name received from the origin with the header specified here. * **RemoveHeadersConfig** *(dict) --* A configuration for a set of HTTP headers to remove from the HTTP response. * **Quantity** *(integer) --* **[REQUIRED]** The number of HTTP header names in the list. * **Items** *(list) --* The list of HTTP header names. * *(dict) --* The name of an HTTP header that CloudFront removes from HTTP responses to requests that match the cache behavior that this response headers policy is attached to. * **Header** *(string) --* **[REQUIRED]** The HTTP header name. * **Id** (*string*) -- **[REQUIRED]** The identifier for the response headers policy that you are updating. * **IfMatch** (*string*) -- 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". Return type: dict Returns: **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 }, ] }, 'RemoveHeadersConfig': { 'Quantity': 123, 'Items': [ { 'Header': 'string' }, ] } } }, '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. * **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. * *(string) --* * **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. * *(string) --* * **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: * "GET" * "DELETE" * "HEAD" * "OPTIONS" * "PATCH" * "POST" * "PUT" * "ALL" "ALL" is a special value that includes all of the listed HTTP methods. * *(string) --* * **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. * *(string) --* * **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-referrer" * "no-referrer-when-downgrade" * "origin" * "origin-when-cross-origin" * "same-origin" * "strict-origin" * "strict-origin-when-cross-origin" * "unsafe-url" For 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 Security headers in the *Amazon CloudFront Developer Guide* and 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. * **RemoveHeadersConfig** *(dict) --* A configuration for a set of HTTP headers to remove from the HTTP response. * **Quantity** *(integer) --* The number of HTTP header names in the list. * **Items** *(list) --* The list of HTTP header names. * *(dict) --* The name of an HTTP header that CloudFront removes from HTTP responses to requests that match the cache behavior that this response headers policy is attached to. * **Header** *(string) --* The HTTP header name. * **ETag** *(string) --* The current version of the response headers policy. **Exceptions** * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.TooManyCustomHeadersInResponseHead ersPolicy" * "CloudFront.Client.exceptions.ResponseHeadersPolicyAlreadyExists" * "CloudFront.Client.exceptions.InconsistentQuantities" * "CloudFront.Client.exceptions.NoSuchResponseHeadersPolicy" * "CloudFront.Client.exceptions.TooLongCSPInResponseHeadersPolicy" * "CloudFront.Client.exceptions.IllegalUpdate" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.TooManyRemoveHeadersInResponseHead ersPolicy" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / list_vpc_origins list_vpc_origins **************** CloudFront.Client.list_vpc_origins(**kwargs) List the CloudFront VPC origins in your account. See also: AWS API Documentation **Request Syntax** response = client.list_vpc_origins( Marker='string', MaxItems='string' ) Parameters: * **Marker** (*string*) -- The marker associated with the VPC origins list. * **MaxItems** (*string*) -- The maximum number of items included in the list. Return type: dict Returns: **Response Syntax** { 'VpcOriginList': { 'Marker': 'string', 'NextMarker': 'string', 'MaxItems': 123, 'IsTruncated': True|False, 'Quantity': 123, 'Items': [ { 'Id': 'string', 'Name': 'string', 'Status': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'Arn': 'string', 'OriginEndpointArn': 'string' }, ] } } **Response Structure** * *(dict) --* * **VpcOriginList** *(dict) --* List of VPC origins. * **Marker** *(string) --* The marker associated with the VPC origins list. * **NextMarker** *(string) --* The next marker associated with the VPC origins list. * **MaxItems** *(integer) --* The maximum number of items included in the list. * **IsTruncated** *(boolean) --* A flag that indicates whether more VPC origins 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 VPC origins in the list. * **Quantity** *(integer) --* The number of VPC origins in the list. * **Items** *(list) --* The items of the VPC origins list. * *(dict) --* A summary of the CloudFront VPC origin. * **Id** *(string) --* The VPC origin summary ID. * **Name** *(string) --* The VPC origin summary name. * **Status** *(string) --* The VPC origin summary status. * **CreatedTime** *(datetime) --* The VPC origin summary created time. * **LastModifiedTime** *(datetime) --* The VPC origin summary last modified time. * **Arn** *(string) --* The VPC origin summary ARN. * **OriginEndpointArn** *(string) --* The VPC origin summary origin endpoint ARN. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.UnsupportedOperation" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / update_distribution_with_staging_config update_distribution_with_staging_config *************************************** CloudFront.Client.update_distribution_with_staging_config(**kwargs) Copies the staging distribution's configuration to its corresponding primary distribution. The primary distribution retains its "Aliases" (also known as alternate domain names or CNAMEs) and "ContinuousDeploymentPolicyId" value, but otherwise its configuration is overwritten to match the staging distribution. You can use this operation in a continuous deployment workflow after you have tested configuration changes on the staging distribution. After using a continuous deployment policy to move a portion of your domain name's traffic to the staging distribution and verifying that it works as intended, you can use this operation to copy the staging distribution's configuration to the primary distribution. This action will disable the continuous deployment policy and move your domain's traffic back to the primary distribution. This API operation requires the following IAM permissions: * GetDistribution * UpdateDistribution See also: AWS API Documentation **Request Syntax** response = client.update_distribution_with_staging_config( Id='string', StagingDistributionId='string', IfMatch='string' ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The identifier of the primary distribution to which you are copying a staging distribution's configuration. * **StagingDistributionId** (*string*) -- The identifier of the staging distribution whose configuration you are copying to the primary distribution. * **IfMatch** (*string*) -- The current versions ( "ETag" values) of both primary and staging distributions. Provide these in the following format: ", " Return type: dict Returns: **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', 'OriginReadTimeout': 123 }, '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 }, 'VpcOriginConfig': { 'VpcOriginId': 'string', 'OriginReadTimeout': 123, 'OriginKeepaliveTimeout': 123 }, 'ConnectionAttempts': 123, 'ConnectionTimeout': 123, 'ResponseCompletionTimeout': 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' }, ] }, 'SelectionCriteria': 'default'|'media-quality-based' }, ] }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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'|'None', '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'|'TLSv1.3_2025', '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, 'ContinuousDeploymentPolicyId': 'string', 'Staging': True|False, 'AnycastIpListId': 'string', 'TenantConfig': { 'ParameterDefinitions': [ { 'Name': 'string', 'Definition': { 'StringSchema': { 'Comment': 'string', 'DefaultValue': 'string', 'Required': True|False } } }, ] }, 'ConnectionMode': 'direct'|'tenant-only' }, 'AliasICPRecordals': [ { 'CNAME': 'string', 'ICPRecordalStatus': 'APPROVED'|'SUSPENDED'|'PENDING' }, ] }, 'ETag': 'string' } **Response Structure** * *(dict) --* * **Distribution** *(dict) --* A distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery. * **Id** *(string) --* The distribution's identifier. For example: "E1U5RQF7T870K0". * **ARN** *(string) --* The distribution's Amazon Resource Name (ARN). * **Status** *(string) --* The distribution's status. When the status is "Deployed", the distribution's information is fully propagated to all CloudFront edge locations. * **LastModifiedTime** *(datetime) --* The date and time when the distribution was last modified. * **InProgressInvalidationBatches** *(integer) --* The number of invalidation batches currently in progress. * **DomainName** *(string) --* The distribution's CloudFront domain name. For example: "d111111abcdef8.cloudfront.net". * **ActiveTrustedSigners** *(dict) --* Warning: We recommend using "TrustedKeyGroups" instead of "TrustedSigners". 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 are configured as trusted signers. 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. * *(string) --* * **ActiveTrustedKeyGroups** *(dict) --* 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. * *(string) --* * **DistributionConfig** *(dict) --* The distribution's configuration. * **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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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. * *(string) --* * **DefaultRootObject** *(string) --* When a viewer requests the root URL for your distribution, the default root object is the object that you want CloudFront to request from your origin. For example, if your root URL is "https://www.example.com", you can specify CloudFront to return the "index.html" file as the default root object. You can specify a default root object so that viewers see a specific file or object, instead of another object in your distribution (for example, "https://www.example.com /product-description.html"). A default root object avoids exposing the contents of your distribution. You can specify the object name or a path to the object name (for example, "index.html" or "exampleFolderName/index.html"). Your string can't begin with a forward slash ( "/"). Only specify the object name or the path to the object. 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 Specify 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: * Use "S3OriginConfig" to specify an Amazon S3 bucket that is not configured with static website hosting. * Use "VpcOriginConfig" to specify a VPC origin. * Use "CustomOriginConfig" to specify all other kinds of origins, including: * An Amazon S3 bucket that is configured with static website hosting * An Elastic Load Balancing load balancer * An Elemental MediaPackage endpoint * An Elemental MediaStore container * Any other HTTP server, running on an Amazon EC2 instance or any other kind of host For the current maximum number of origins that you can specify per distribution, see General Quotas on Web Distributions in the *Amazon CloudFront Developer Guide* (quotas were formerly referred to as limits). * **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 "OriginCustomHeader" element for each custom header that you want CloudFront to forward to the origin. If Quantity is "0", omit "Items". * *(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) --* Note: If you're using origin access control (OAC) instead of origin access identity, specify an empty "OriginAccessIdentity" element. For more information, see Restricting access to an Amazon Web Services in the *Amazon CloudFront Developer Guide*. 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" The "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*. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see Response timeout 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. * *(string) --* * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) in the *Amazon CloudFront Developer Guide*. * **VpcOriginConfig** *(dict) --* The VPC origin configuration. * **VpcOriginId** *(string) --* The VPC origin ID. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) 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*. * **ResponseCompletionTimeout** *(integer) --* The time (in seconds) that a request from CloudFront to the origin can stay open and wait for a response. If the complete response isn't received from the origin by this time, CloudFront ends the connection. The value for "ResponseCompletionTimeout" must be equal to or greater than the value for "OriginReadTimeout". If you don't set a value for "ResponseCompletionTimeout", CloudFront doesn't enforce a maximum value. For more information, see Response completion 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 secondary 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 specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the secondary origin under the failover conditions that you've chosen. Optionally, you can choose selection criteria for your origin group to specify how your origins are selected when your distribution routes viewer requests. * **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. * *(integer) --* * **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. * **SelectionCriteria** *(string) --* The selection criteria for the origin group. For more information, see Create an origin group in the *Amazon CloudFront Developer Guide*. * **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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **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. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control- Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. * **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. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(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. Your 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. Your 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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. * *(string) --* * **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. * *(string) --* * **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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **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 specify an empty individual "CacheBehavior" element, because this is invalid. For more information, see CacheBehaviors. 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. Warning: If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the "Cache-Control: no-cache", "no-store", or "private" directives are present in the origin headers. 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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **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. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control- Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. * **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. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(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. Your 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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. * *(string) --* * **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. * *(string) --* * **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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **CustomErrorResponses** *(dict) --* A complex type that controls the following: * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. * How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the *Amazon CloudFront Developer Guide*. * **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: * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. * How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the *Amazon CloudFront Developer Guide*. * **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: * The value of "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/*". * The value of "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: * Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute "200", the response typically won't be intercepted. * If you don't care about distinguishing among different client errors or server errors, you can specify "400" or "500" as the "ResponseCode" for all 4xx or 5xx errors. * You might want to return a "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) --* A 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" and "prefix", 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, "amzn-s3-demo-bucket.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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) * "MinimumProtocolVersion" * "SSLSupportMethod" * **IAMCertificateId** *(string) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 ServicesSupport 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: * The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers. * The ciphers that CloudFront can use to encrypt the content that it returns to viewers. 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: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **CertificateSource** *(string) --* This field is deprecated. Use one of the following fields instead: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **Restrictions** *(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. * *(string) --* * **WebACLId** *(string) --* Note: Multi-tenant distributions only support WAF V2 web ACLs. 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:123456789 012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef- EXAMPLE11111". To specify a web ACL created using WAF Classic, use the ACL ID, for example "a1b2c3d4-5678 -90ab-cdef-EXAMPLE11111". 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 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) --* Note: To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup. 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: * You enable IPv6 for the distribution * You're using alternate domain names in the URLs for your objects 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. * **ContinuousDeploymentPolicyId** *(string) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. The identifier of a continuous deployment policy. For more information, see "CreateContinuousDeploymentPolicy". * **Staging** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. A Boolean that indicates whether this is a staging distribution. When this value is "true", this is a staging distribution. When this value is "false", this is not a staging distribution. * **AnycastIpListId** *(string) --* Note: To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup. ID of the Anycast static IP list that is associated with the distribution. * **TenantConfig** *(dict) --* Note: This field only supports multi-tenant distributions. You can't specify this field for standard distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. A distribution tenant configuration. * **ParameterDefinitions** *(list) --* The parameters that you specify for a distribution tenant. * *(dict) --* A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution. * **Name** *(string) --* The name of the parameter. * **Definition** *(dict) --* The value that you assigned to the parameter. * **StringSchema** *(dict) --* An object that contains information about the string schema. * **Comment** *(string) --* A comment to describe the parameter. * **DefaultValue** *(string) --* The default value of the parameter. * **Required** *(boolean) --* Whether the defined parameter is required. * **ConnectionMode** *(string) --* This field specifies whether the connection mode is through a standard distribution (direct) or a multi- tenant distribution with distribution tenants (tenant- only). * **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 Amazon Web Services Regions outside of China. The status values returned are the following: * **APPROVED** indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED, that is, valid to use with the China Regions, a CNAME must have one ICP recordal number associated with it. * **SUSPENDED** indicates that the associated CNAME does not have a valid ICP recordal number. * **PENDING** indicates that CloudFront can't determine the ICP recordal status of the CNAME associated with the distribution because there was an error in trying to determine the status. You can try again to see if the error is resolved in which case CloudFront returns an APPROVED or SUSPENDED status. * **ETag** *(string) --* The current version of the primary distribution (after it's updated). **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToOr iginAccessControl" * "CloudFront.Client.exceptions.InvalidDefaultRootObject" * "CloudFront.Client.exceptions.InvalidQueryStringParameters" * "CloudFront.Client.exceptions.TooManyTrustedSigners" * "CloudFront.Client.exceptions.TooManyCookieNamesInWhiteList" * "CloudFront.Client.exceptions.NoSuchFieldLevelEncryptionConfig" * "CloudFront.Client.exceptions.InvalidErrorCode" * "CloudFront.Client.exceptions.TooManyFunctionAssociations" * "CloudFront.Client.exceptions.TooManyOriginCustomHeaders" * "CloudFront.Client.exceptions.InvalidForwardCookies" * "CloudFront.Client.exceptions.InvalidMinimumProtocolVersion" * "CloudFront.Client.exceptions.NoSuchCachePolicy" * "CloudFront.Client.exceptions.TooManyKeyGroupsAssociatedToDistri bution" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToCa chePolicy" * "CloudFront.Client.exceptions.InvalidRequiredProtocol" * "CloudFront.Client.exceptions.TooManyDistributionsWithFunctionAs sociations" * "CloudFront.Client.exceptions.TooManyOriginGroupsPerDistribution" * "CloudFront.Client.exceptions.InvalidTTLOrder" * "CloudFront.Client.exceptions.IllegalFieldLevelEncryptionConfigA ssociationWithCacheBehavior" * "CloudFront.Client.exceptions.InvalidOriginKeepaliveTimeout" * "CloudFront.Client.exceptions.IllegalUpdate" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.InvalidOriginReadTimeout" * "CloudFront.Client.exceptions.InvalidOriginAccessControl" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.InvalidHeadersForS3Origin" * "CloudFront.Client.exceptions.TrustedSignerDoesNotExist" * "CloudFront.Client.exceptions.InvalidWebACLId" * "CloudFront.Client.exceptions.TooManyDistributionsWithSingleFunc tionARN" * "CloudFront.Client.exceptions.InvalidRelativePath" * "CloudFront.Client.exceptions.TooManyLambdaFunctionAssociations" * "CloudFront.Client.exceptions.NoSuchDistribution" * "CloudFront.Client.exceptions.NoSuchOriginRequestPolicy" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToFi eldLevelEncryptionConfig" * "CloudFront.Client.exceptions.InconsistentQuantities" * "CloudFront.Client.exceptions.InvalidLocationCode" * "CloudFront.Client.exceptions.InvalidOriginAccessIdentity" * "CloudFront.Client.exceptions.TooManyDistributionCNAMEs" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToOr iginRequestPolicy" * "CloudFront.Client.exceptions.TooManyQueryStringParameters" * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.RealtimeLogConfigOwnerMismatch" * "CloudFront.Client.exceptions.MissingBody" * "CloudFront.Client.exceptions.TooManyHeadersInForwardedValues" * "CloudFront.Client.exceptions.InvalidLambdaFunctionAssociation" * "CloudFront.Client.exceptions.CNAMEAlreadyExists" * "CloudFront.Client.exceptions.TooManyCertificates" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToRe sponseHeadersPolicy" * "CloudFront.Client.exceptions.TrustedKeyGroupDoesNotExist" * "CloudFront.Client.exceptions.NoSuchResponseHeadersPolicy" * "CloudFront.Client.exceptions.InvalidResponseCode" * "CloudFront.Client.exceptions.NoSuchRealtimeLogConfig" * "CloudFront.Client.exceptions.InvalidGeoRestrictionParameter" * "CloudFront.Client.exceptions.InvalidViewerCertificate" * "CloudFront.Client.exceptions.TooManyOrigins" * "CloudFront.Client.exceptions.InvalidFunctionAssociation" * "CloudFront.Client.exceptions.TooManyDistributionsWithLambdaAsso ciations" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToKe yGroup" * "CloudFront.Client.exceptions.NoSuchOrigin" * "CloudFront.Client.exceptions.TooManyCacheBehaviors" CloudFront / Client / list_response_headers_policies list_response_headers_policies ****************************** CloudFront.Client.list_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' ) Parameters: * **Type** (*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. * **Marker** (*string*) -- Use this field when paginating results to indicate where to begin in your list of response headers policies. The response includes response headers policies in the list that occur after the marker. To get the next page of the list, set this field's value to the value of "NextMarker" from the current page's response. * **MaxItems** (*string*) -- The maximum number of response headers policies that you want to get in the response. Return type: dict Returns: **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 }, ] }, 'RemoveHeadersConfig': { 'Quantity': 123, 'Items': [ { 'Header': 'string' }, ] } } } }, ] } } **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. * **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. * *(string) --* * **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. * *(string) --* * **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: * "GET" * "DELETE" * "HEAD" * "OPTIONS" * "PATCH" * "POST" * "PUT" * "ALL" "ALL" is a special value that includes all of the listed HTTP methods. * *(string) --* * **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. * *(string) --* * **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-referrer" * "no-referrer-when-downgrade" * "origin" * "origin-when-cross-origin" * "same-origin" * "strict-origin" * "strict-origin-when-cross-origin" * "unsafe-url" For 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 Security headers in the *Amazon CloudFront Developer Guide* and 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. * **RemoveHeadersConfig** *(dict) --* A configuration for a set of HTTP headers to remove from the HTTP response. * **Quantity** *(integer) --* The number of HTTP header names in the list. * **Items** *(list) --* The list of HTTP header names. * *(dict) --* The name of an HTTP header that CloudFront removes from HTTP responses to requests that match the cache behavior that this response headers policy is attached to. * **Header** *(string) --* The HTTP header name. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.NoSuchResponseHeadersPolicy" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / get_key_group get_key_group ************* CloudFront.Client.get_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' ) Parameters: **Id** (*string*) -- **[REQUIRED]** The identifier of the key group that you are getting. To get the identifier, use "ListKeyGroups". Return type: dict Returns: **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. * **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. * *(string) --* * **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.NoSuchResource" CloudFront / Client / copy_distribution copy_distribution ***************** CloudFront.Client.copy_distribution(**kwargs) Creates a staging distribution using the configuration of the provided primary distribution. A staging distribution is a copy of an existing distribution (called the primary distribution) that you can use in a continuous deployment workflow. After you create a staging distribution, you can use "UpdateDistribution" to modify the staging distribution's configuration. Then you can use "CreateContinuousDeploymentPolicy" to incrementally move traffic to the staging distribution. This API operation requires the following IAM permissions: * GetDistribution * CreateDistribution * CopyDistribution See also: AWS API Documentation **Request Syntax** response = client.copy_distribution( PrimaryDistributionId='string', Staging=True|False, IfMatch='string', CallerReference='string', Enabled=True|False ) Parameters: * **PrimaryDistributionId** (*string*) -- **[REQUIRED]** The identifier of the primary distribution whose configuration you are copying. To get a distribution ID, use "ListDistributions". * **Staging** (*boolean*) -- The type of distribution that your primary distribution will be copied to. The only valid value is "True", indicating that you are copying to a staging distribution. * **IfMatch** (*string*) -- The version identifier of the primary distribution whose configuration you are copying. This is the "ETag" value returned in the response to "GetDistribution" and "GetDistributionConfig". * **CallerReference** (*string*) -- **[REQUIRED]** A value that uniquely identifies a request to create a resource. This helps to prevent CloudFront from creating a duplicate resource if you accidentally resubmit an identical request. * **Enabled** (*boolean*) -- A Boolean flag to specify the state of the staging distribution when it's created. When you set this value to "True", the staging distribution is enabled. When you set this value to "False", the staging distribution is disabled. If you omit this field, the default value is "True". Return type: dict Returns: **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', 'OriginReadTimeout': 123 }, '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 }, 'VpcOriginConfig': { 'VpcOriginId': 'string', 'OriginReadTimeout': 123, 'OriginKeepaliveTimeout': 123 }, 'ConnectionAttempts': 123, 'ConnectionTimeout': 123, 'ResponseCompletionTimeout': 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' }, ] }, 'SelectionCriteria': 'default'|'media-quality-based' }, ] }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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'|'None', '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'|'TLSv1.3_2025', '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, 'ContinuousDeploymentPolicyId': 'string', 'Staging': True|False, 'AnycastIpListId': 'string', 'TenantConfig': { 'ParameterDefinitions': [ { 'Name': 'string', 'Definition': { 'StringSchema': { 'Comment': 'string', 'DefaultValue': 'string', 'Required': True|False } } }, ] }, 'ConnectionMode': 'direct'|'tenant-only' }, 'AliasICPRecordals': [ { 'CNAME': 'string', 'ICPRecordalStatus': 'APPROVED'|'SUSPENDED'|'PENDING' }, ] }, 'Location': 'string', 'ETag': 'string' } **Response Structure** * *(dict) --* * **Distribution** *(dict) --* A distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery. * **Id** *(string) --* The distribution's identifier. For example: "E1U5RQF7T870K0". * **ARN** *(string) --* The distribution's Amazon Resource Name (ARN). * **Status** *(string) --* The distribution's status. When the status is "Deployed", the distribution's information is fully propagated to all CloudFront edge locations. * **LastModifiedTime** *(datetime) --* The date and time when the distribution was last modified. * **InProgressInvalidationBatches** *(integer) --* The number of invalidation batches currently in progress. * **DomainName** *(string) --* The distribution's CloudFront domain name. For example: "d111111abcdef8.cloudfront.net". * **ActiveTrustedSigners** *(dict) --* Warning: We recommend using "TrustedKeyGroups" instead of "TrustedSigners". 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 are configured as trusted signers. 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. * *(string) --* * **ActiveTrustedKeyGroups** *(dict) --* 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. * *(string) --* * **DistributionConfig** *(dict) --* The distribution's configuration. * **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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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. * *(string) --* * **DefaultRootObject** *(string) --* When a viewer requests the root URL for your distribution, the default root object is the object that you want CloudFront to request from your origin. For example, if your root URL is "https://www.example.com", you can specify CloudFront to return the "index.html" file as the default root object. You can specify a default root object so that viewers see a specific file or object, instead of another object in your distribution (for example, "https://www.example.com /product-description.html"). A default root object avoids exposing the contents of your distribution. You can specify the object name or a path to the object name (for example, "index.html" or "exampleFolderName/index.html"). Your string can't begin with a forward slash ( "/"). Only specify the object name or the path to the object. 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 Specify 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: * Use "S3OriginConfig" to specify an Amazon S3 bucket that is not configured with static website hosting. * Use "VpcOriginConfig" to specify a VPC origin. * Use "CustomOriginConfig" to specify all other kinds of origins, including: * An Amazon S3 bucket that is configured with static website hosting * An Elastic Load Balancing load balancer * An Elemental MediaPackage endpoint * An Elemental MediaStore container * Any other HTTP server, running on an Amazon EC2 instance or any other kind of host For the current maximum number of origins that you can specify per distribution, see General Quotas on Web Distributions in the *Amazon CloudFront Developer Guide* (quotas were formerly referred to as limits). * **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 "OriginCustomHeader" element for each custom header that you want CloudFront to forward to the origin. If Quantity is "0", omit "Items". * *(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) --* Note: If you're using origin access control (OAC) instead of origin access identity, specify an empty "OriginAccessIdentity" element. For more information, see Restricting access to an Amazon Web Services in the *Amazon CloudFront Developer Guide*. 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" The "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*. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see Response timeout 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. * *(string) --* * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) in the *Amazon CloudFront Developer Guide*. * **VpcOriginConfig** *(dict) --* The VPC origin configuration. * **VpcOriginId** *(string) --* The VPC origin ID. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) 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*. * **ResponseCompletionTimeout** *(integer) --* The time (in seconds) that a request from CloudFront to the origin can stay open and wait for a response. If the complete response isn't received from the origin by this time, CloudFront ends the connection. The value for "ResponseCompletionTimeout" must be equal to or greater than the value for "OriginReadTimeout". If you don't set a value for "ResponseCompletionTimeout", CloudFront doesn't enforce a maximum value. For more information, see Response completion 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 secondary 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 specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the secondary origin under the failover conditions that you've chosen. Optionally, you can choose selection criteria for your origin group to specify how your origins are selected when your distribution routes viewer requests. * **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. * *(integer) --* * **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. * **SelectionCriteria** *(string) --* The selection criteria for the origin group. For more information, see Create an origin group in the *Amazon CloudFront Developer Guide*. * **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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **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. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control- Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. * **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. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(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. Your 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. Your 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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. * *(string) --* * **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. * *(string) --* * **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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **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 specify an empty individual "CacheBehavior" element, because this is invalid. For more information, see CacheBehaviors. 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. Warning: If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the "Cache-Control: no-cache", "no-store", or "private" directives are present in the origin headers. 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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **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. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control- Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. * **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. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(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. Your 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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. * *(string) --* * **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. * *(string) --* * **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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **CustomErrorResponses** *(dict) --* A complex type that controls the following: * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. * How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the *Amazon CloudFront Developer Guide*. * **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: * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. * How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the *Amazon CloudFront Developer Guide*. * **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: * The value of "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/*". * The value of "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: * Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute "200", the response typically won't be intercepted. * If you don't care about distinguishing among different client errors or server errors, you can specify "400" or "500" as the "ResponseCode" for all 4xx or 5xx errors. * You might want to return a "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) --* A 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" and "prefix", 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, "amzn-s3-demo-bucket.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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) * "MinimumProtocolVersion" * "SSLSupportMethod" * **IAMCertificateId** *(string) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 ServicesSupport 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: * The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers. * The ciphers that CloudFront can use to encrypt the content that it returns to viewers. 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: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **CertificateSource** *(string) --* This field is deprecated. Use one of the following fields instead: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **Restrictions** *(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. * *(string) --* * **WebACLId** *(string) --* Note: Multi-tenant distributions only support WAF V2 web ACLs. 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:123456789 012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef- EXAMPLE11111". To specify a web ACL created using WAF Classic, use the ACL ID, for example "a1b2c3d4-5678 -90ab-cdef-EXAMPLE11111". 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 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) --* Note: To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup. 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: * You enable IPv6 for the distribution * You're using alternate domain names in the URLs for your objects 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. * **ContinuousDeploymentPolicyId** *(string) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. The identifier of a continuous deployment policy. For more information, see "CreateContinuousDeploymentPolicy". * **Staging** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. A Boolean that indicates whether this is a staging distribution. When this value is "true", this is a staging distribution. When this value is "false", this is not a staging distribution. * **AnycastIpListId** *(string) --* Note: To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup. ID of the Anycast static IP list that is associated with the distribution. * **TenantConfig** *(dict) --* Note: This field only supports multi-tenant distributions. You can't specify this field for standard distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. A distribution tenant configuration. * **ParameterDefinitions** *(list) --* The parameters that you specify for a distribution tenant. * *(dict) --* A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution. * **Name** *(string) --* The name of the parameter. * **Definition** *(dict) --* The value that you assigned to the parameter. * **StringSchema** *(dict) --* An object that contains information about the string schema. * **Comment** *(string) --* A comment to describe the parameter. * **DefaultValue** *(string) --* The default value of the parameter. * **Required** *(boolean) --* Whether the defined parameter is required. * **ConnectionMode** *(string) --* This field specifies whether the connection mode is through a standard distribution (direct) or a multi- tenant distribution with distribution tenants (tenant- only). * **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 Amazon Web Services Regions outside of China. The status values returned are the following: * **APPROVED** indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED, that is, valid to use with the China Regions, a CNAME must have one ICP recordal number associated with it. * **SUSPENDED** indicates that the associated CNAME does not have a valid ICP recordal number. * **PENDING** indicates that CloudFront can't determine the ICP recordal status of the CNAME associated with the distribution because there was an error in trying to determine the status. You can try again to see if the error is resolved in which case CloudFront returns an APPROVED or SUSPENDED status. * **Location** *(string) --* The URL of the staging distribution. * **ETag** *(string) --* The version identifier for the current version of the staging distribution. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToOr iginAccessControl" * "CloudFront.Client.exceptions.InvalidDefaultRootObject" * "CloudFront.Client.exceptions.InvalidQueryStringParameters" * "CloudFront.Client.exceptions.TooManyTrustedSigners" * "CloudFront.Client.exceptions.TooManyCookieNamesInWhiteList" * "CloudFront.Client.exceptions.NoSuchFieldLevelEncryptionConfig" * "CloudFront.Client.exceptions.InvalidErrorCode" * "CloudFront.Client.exceptions.InvalidProtocolSettings" * "CloudFront.Client.exceptions.TooManyFunctionAssociations" * "CloudFront.Client.exceptions.TooManyOriginCustomHeaders" * "CloudFront.Client.exceptions.InvalidOrigin" * "CloudFront.Client.exceptions.InvalidForwardCookies" * "CloudFront.Client.exceptions.InvalidMinimumProtocolVersion" * "CloudFront.Client.exceptions.NoSuchCachePolicy" * "CloudFront.Client.exceptions.TooManyKeyGroupsAssociatedToDistri bution" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToCa chePolicy" * "CloudFront.Client.exceptions.InvalidRequiredProtocol" * "CloudFront.Client.exceptions.TooManyDistributionsWithFunctionAs sociations" * "CloudFront.Client.exceptions.TooManyOriginGroupsPerDistribution" * "CloudFront.Client.exceptions.TooManyDistributions" * "CloudFront.Client.exceptions.InvalidTTLOrder" * "CloudFront.Client.exceptions.IllegalFieldLevelEncryptionConfigA ssociationWithCacheBehavior" * "CloudFront.Client.exceptions.InvalidOriginKeepaliveTimeout" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.InvalidOriginReadTimeout" * "CloudFront.Client.exceptions.InvalidOriginAccessControl" * "CloudFront.Client.exceptions.InvalidHeadersForS3Origin" * "CloudFront.Client.exceptions.TrustedSignerDoesNotExist" * "CloudFront.Client.exceptions.InvalidWebACLId" * "CloudFront.Client.exceptions.TooManyDistributionsWithSingleFunc tionARN" * "CloudFront.Client.exceptions.InvalidRelativePath" * "CloudFront.Client.exceptions.TooManyLambdaFunctionAssociations" * "CloudFront.Client.exceptions.NoSuchDistribution" * "CloudFront.Client.exceptions.NoSuchOriginRequestPolicy" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToFi eldLevelEncryptionConfig" * "CloudFront.Client.exceptions.InconsistentQuantities" * "CloudFront.Client.exceptions.InvalidLocationCode" * "CloudFront.Client.exceptions.InvalidOriginAccessIdentity" * "CloudFront.Client.exceptions.TooManyDistributionCNAMEs" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToOr iginRequestPolicy" * "CloudFront.Client.exceptions.TooManyQueryStringParameters" * "CloudFront.Client.exceptions.RealtimeLogConfigOwnerMismatch" * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.MissingBody" * "CloudFront.Client.exceptions.TooManyHeadersInForwardedValues" * "CloudFront.Client.exceptions.InvalidLambdaFunctionAssociation" * "CloudFront.Client.exceptions.CNAMEAlreadyExists" * "CloudFront.Client.exceptions.TooManyCertificates" * "CloudFront.Client.exceptions.TrustedKeyGroupDoesNotExist" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToRe sponseHeadersPolicy" * "CloudFront.Client.exceptions.NoSuchResponseHeadersPolicy" * "CloudFront.Client.exceptions.NoSuchRealtimeLogConfig" * "CloudFront.Client.exceptions.InvalidResponseCode" * "CloudFront.Client.exceptions.InvalidGeoRestrictionParameter" * "CloudFront.Client.exceptions.TooManyOrigins" * "CloudFront.Client.exceptions.InvalidViewerCertificate" * "CloudFront.Client.exceptions.InvalidFunctionAssociation" * "CloudFront.Client.exceptions.TooManyDistributionsWithLambdaAsso ciations" * "CloudFront.Client.exceptions.TooManyDistributionsAssociatedToKe yGroup" * "CloudFront.Client.exceptions.DistributionAlreadyExists" * "CloudFront.Client.exceptions.NoSuchOrigin" * "CloudFront.Client.exceptions.TooManyCacheBehaviors" CloudFront / Client / delete_key_value_store delete_key_value_store ********************** CloudFront.Client.delete_key_value_store(**kwargs) Specifies the key value store to delete. See also: AWS API Documentation **Request Syntax** response = client.delete_key_value_store( Name='string', IfMatch='string' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the key value store. * **IfMatch** (*string*) -- **[REQUIRED]** The key value store to delete, if a match occurs. Returns: None **Exceptions** * "CloudFront.Client.exceptions.CannotDeleteEntityWhileInUse" * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.UnsupportedOperation" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / list_functions list_functions ************** CloudFront.Client.list_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' ) Parameters: * **Marker** (*string*) -- Use this field when paginating results to indicate where to begin in your list of functions. The response includes functions in the list that occur after the marker. To get the next page of the list, set this field's value to the value of "NextMarker" from the current page's response. * **MaxItems** (*string*) -- The maximum number of functions that you want in the response. * **Stage** (*string*) -- An optional filter to return only the functions that are in the specified stage, either "DEVELOPMENT" or "LIVE". Return type: dict Returns: **Response Syntax** { 'FunctionList': { 'NextMarker': 'string', 'MaxItems': 123, 'Quantity': 123, 'Items': [ { 'Name': 'string', 'Status': 'string', 'FunctionConfig': { 'Comment': 'string', 'Runtime': 'cloudfront-js-1.0'|'cloudfront-js-2.0', 'KeyValueStoreAssociations': { 'Quantity': 123, 'Items': [ { 'KeyValueStoreARN': 'string' }, ] } }, '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 version. * **KeyValueStoreAssociations** *(dict) --* The configuration for the key value store associations. * **Quantity** *(integer) --* The quantity of key value store associations. * **Items** *(list) --* The items of the key value store association. * *(dict) --* The key value store association. * **KeyValueStoreARN** *(string) --* The Amazon Resource Name (ARN) of the key value store association. * **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.UnsupportedOperation" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / list_distributions_by_web_acl_id list_distributions_by_web_acl_id ******************************** CloudFront.Client.list_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' ) Parameters: * **Marker** (*string*) -- Use "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".) * **MaxItems** (*string*) -- The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100. * **WebACLId** (*string*) -- **[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. For WAFV2, this is the ARN of the web ACL, such as "arn:aws:wafv2:us- east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678 -90ab-cdef-EXAMPLE11111". For WAF Classic, this is the ID of the web ACL, such as "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111". Return type: dict Returns: **Response Syntax** { 'DistributionList': { 'Marker': 'string', 'NextMarker': 'string', 'MaxItems': 123, 'IsTruncated': True|False, 'Quantity': 123, 'Items': [ { 'Id': 'string', 'ARN': 'string', 'ETag': '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', 'OriginReadTimeout': 123 }, '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 }, 'VpcOriginConfig': { 'VpcOriginId': 'string', 'OriginReadTimeout': 123, 'OriginKeepaliveTimeout': 123 }, 'ConnectionAttempts': 123, 'ConnectionTimeout': 123, 'ResponseCompletionTimeout': 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' }, ] }, 'SelectionCriteria': 'default'|'media-quality-based' }, ] }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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', 'GrpcConfig': { 'Enabled': True|False }, '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'|'None', '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'|'TLSv1.3_2025', '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' }, ], 'Staging': True|False, 'ConnectionMode': 'direct'|'tenant-only', 'AnycastIpListId': 'string' }, ] } } **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:distri bution/EDFDVBD632BHDS5", where "123456789012" is your Amazon Web Services account ID. * **ETag** *(string) --* The current version of the distribution. * **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. * *(string) --* * **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: * Use "S3OriginConfig" to specify an Amazon S3 bucket that is not configured with static website hosting. * Use "VpcOriginConfig" to specify a VPC origin. * Use "CustomOriginConfig" to specify all other kinds of origins, including: * An Amazon S3 bucket that is configured with static website hosting * An Elastic Load Balancing load balancer * An Elemental MediaPackage endpoint * An Elemental MediaStore container * Any other HTTP server, running on an Amazon EC2 instance or any other kind of host For the current maximum number of origins that you can specify per distribution, see General Quotas on Web Distributions in the *Amazon CloudFront Developer Guide* (quotas were formerly referred to as limits). * **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 "OriginCustomHeader" element for each custom header that you want CloudFront to forward to the origin. If Quantity is "0", omit "Items". * *(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) --* Note: If you're using origin access control (OAC) instead of origin access identity, specify an empty "OriginAccessIdentity" element. For more information, see Restricting access to an Amazon Web Services in the *Amazon CloudFront Developer Guide*. 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" The "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*. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see Response timeout 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. * *(string) --* * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) in the *Amazon CloudFront Developer Guide*. * **VpcOriginConfig** *(dict) --* The VPC origin configuration. * **VpcOriginId** *(string) --* The VPC origin ID. * **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 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see 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 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see Keep-alive timeout (custom origins only) 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*. * **ResponseCompletionTimeout** *(integer) --* The time (in seconds) that a request from CloudFront to the origin can stay open and wait for a response. If the complete response isn't received from the origin by this time, CloudFront ends the connection. The value for "ResponseCompletionTimeout" must be equal to or greater than the value for "OriginReadTimeout". If you don't set a value for "ResponseCompletionTimeout", CloudFront doesn't enforce a maximum value. For more information, see Response completion 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 secondary 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 specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the secondary origin under the failover conditions that you've chosen. Optionally, you can choose selection criteria for your origin group to specify how your origins are selected when your distribution routes viewer requests. * **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. * *(integer) --* * **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. * **SelectionCriteria** *(string) --* The selection criteria for the origin group. For more information, see Create an origin group in the *Amazon CloudFront Developer Guide*. * **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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **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. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control- Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. * **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. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(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. Your 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. Your 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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. * *(string) --* * **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. * *(string) --* * **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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **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 specify an empty individual "CacheBehavior" element, because this is invalid. For more information, see CacheBehaviors. 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. Warning: If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the "Cache-Control: no-cache", "no- store", or "private" directives are present in the origin headers. 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". Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 in the list are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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: * CloudFront forwards only "GET" and "HEAD" requests. * CloudFront forwards only "GET", "HEAD", and "OPTIONS" requests. * CloudFront forwards "GET, HEAD, OPTIONS, PUT, PATCH, POST", and "DELETE" requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. * **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. * *(string) --* * **CachedMethods** *(dict) --* A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: * CloudFront caches responses to "GET" and "HEAD" requests. * CloudFront caches responses to "GET", "HEAD", and "OPTIONS" requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access- Control-Request-Method, Access-Control- Request-Headers, and Origin headers for the responses to be cached correctly. * **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. Valid values for "CachedMethods" include "GET", "HEAD", and "OPTIONS", depending on which caching option you choose. For more information, see the preceding section. * *(string) --* * **SmoothStreaming** *(boolean) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 "LambdaFunctionAssociation" items for this cache behavior. If "Quantity" is "0", you can omit "Items". * *(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. Your 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. * **GrpcConfig** *(dict) --* The gRPC configuration for your cache behavior. * **Enabled** *(boolean) --* Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. * **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. * *(string) --* * **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. * *(string) --* * **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". * *(string) --* * **MinTTL** *(integer) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront 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*. * **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: * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. * How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the *Amazon CloudFront Developer Guide*. * **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: * The value of "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/*". * The value of "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: * Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute "200", the response typically won't be intercepted. * If you don't care about distinguishing among different client errors or server errors, you can specify "400" or "500" as the "ResponseCode" for all 4xx or 5xx errors. * You might want to return a "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) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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) * "MinimumProtocolVersion" * "SSLSupportMethod" * **IAMCertificateId** *(string) --* Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the *Amazon CloudFront Developer Guide*. 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 ServicesSupport 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: * The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers. * The ciphers that CloudFront can use to encrypt the content that it returns to viewers. 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: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **CertificateSource** *(string) --* This field is deprecated. Use one of the following fields instead: * "ACMCertificateArn" * "IAMCertificateId" * "CloudFrontDefaultCertificate" * **Restrictions** *(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. * *(string) --* * **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 Amazon Web Services Regions outside of China. The status values returned are the following: * **APPROVED** indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED, that is, valid to use with the China Regions, a CNAME must have one ICP recordal number associated with it. * **SUSPENDED** indicates that the associated CNAME does not have a valid ICP recordal number. * **PENDING** indicates that CloudFront can't determine the ICP recordal status of the CNAME associated with the distribution because there was an error in trying to determine the status. You can try again to see if the error is resolved in which case CloudFront returns an APPROVED or SUSPENDED status. * **Staging** *(boolean) --* A Boolean that indicates whether this is a staging distribution. When this value is "true", this is a staging distribution. When this value is "false", this is not a staging distribution. * **ConnectionMode** *(string) --* This field specifies whether the connection mode is through a standard distribution (direct) or a multi- tenant distribution with distribution tenants (tenant- only). * **AnycastIpListId** *(string) --* ID of the Anycast static IP list that is associated with the distribution. **Exceptions** * "CloudFront.Client.exceptions.InvalidWebACLId" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / list_field_level_encryption_profiles list_field_level_encryption_profiles ************************************ CloudFront.Client.list_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' ) Parameters: * **Marker** (*string*) -- Use this when paginating results to indicate where to begin in your list of profiles. The results include profiles 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 profile on that page). * **MaxItems** (*string*) -- The maximum number of field-level encryption profiles you want in the response body. Return type: dict Returns: **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 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. * *(string) --* * **Comment** *(string) --* An optional comment for the field-level encryption profile summary. The comment cannot be longer than 128 characters. **Exceptions** * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / tag_resource tag_resource ************ CloudFront.Client.tag_resource(**kwargs) Add tags to a CloudFront resource. For more information, see Tagging a distribution in the *Amazon CloudFront Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( Resource='string', Tags={ 'Items': [ { 'Key': 'string', 'Value': 'string' }, ] } ) Parameters: * **Resource** (*string*) -- **[REQUIRED]** An ARN of a CloudFront resource. * **Tags** (*dict*) -- **[REQUIRED]** A complex type that contains zero or more "Tag" elements. * **Items** *(list) --* A complex type that contains "Tag" elements. * *(dict) --* A complex type that contains "Tag" key and "Tag" value. * **Key** *(string) --* **[REQUIRED]** 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 "_ - . : / = + @". * **Value** *(string) --* 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 "_ - . : / = + @". Returns: None **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.InvalidTagging" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.NoSuchResource" CloudFront / Client / update_realtime_log_config update_realtime_log_config ************************** CloudFront.Client.update_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: * Call "GetRealtimeLogConfig" to get the current real-time log configuration. * Locally modify the parameters in the real-time log configuration that you want to update. * Call this API ( "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 ) Parameters: * **EndPoints** (*list*) -- Contains information about the Amazon Kinesis data stream where you are sending real-time log data. * *(dict) --* Contains information about the Amazon Kinesis data stream where you're sending real-time log data in a real-time log configuration. * **StreamType** *(string) --* **[REQUIRED]** 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 in a real-time log configuration. * **RoleARN** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data. * **Fields** (*list*) -- 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*. * *(string) --* * **Name** (*string*) -- The name for this real-time log configuration. * **ARN** (*string*) -- The Amazon Resource Name (ARN) for 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. You must provide an integer between 1 and 100, inclusive. Return type: dict Returns: **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're 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 in a real-time log configuration. * **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*. * *(string) --* **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.NoSuchRealtimeLogConfig" CloudFront / Client / create_origin_access_control create_origin_access_control **************************** CloudFront.Client.create_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. This makes it possible to block public access to the origin, allowing viewers (users) to access the origin's content only through CloudFront. For more information about using a CloudFront origin access control, see Restricting access to an Amazon Web Services 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'|'mediastore'|'mediapackagev2'|'lambda' } ) Parameters: **OriginAccessControlConfig** (*dict*) -- **[REQUIRED]** Contains the origin access control. * **Name** *(string) --* **[REQUIRED]** A name to identify the origin access control. You can specify up to 64 characters. * **Description** *(string) --* A description of the origin access control. * **SigningProtocol** *(string) --* **[REQUIRED]** The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is "sigv4". * **SigningBehavior** *(string) --* **[REQUIRED]** 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 for all cache behaviors that use origins associated with this origin access control. * **OriginAccessControlOriginType** *(string) --* **[REQUIRED]** The type of origin that this origin access control is for. Return type: dict Returns: **Response Syntax** { 'OriginAccessControl': { 'Id': 'string', 'OriginAccessControlConfig': { 'Name': 'string', 'Description': 'string', 'SigningProtocol': 'sigv4', 'SigningBehavior': 'never'|'always'|'no-override', 'OriginAccessControlOriginType': 's3'|'mediastore'|'mediapackagev2'|'lambda' } }, 'Location': 'string', 'ETag': 'string' } **Response Structure** * *(dict) --* * **OriginAccessControl** *(dict) --* Contains an origin access control. * **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. You can specify up to 64 characters. * **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 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. * **Location** *(string) --* The URL of the origin access control. * **ETag** *(string) --* The version identifier for the current version of the origin access control. **Exceptions** * "CloudFront.Client.exceptions.OriginAccessControlAlreadyExists" * "CloudFront.Client.exceptions.TooManyOriginAccessControls" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / delete_cloud_front_origin_access_identity delete_cloud_front_origin_access_identity ***************************************** CloudFront.Client.delete_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' ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The origin access identity's ID. * **IfMatch** (*string*) -- The value of the "ETag" header you received from a previous "GET" or "PUT" request. For example: "E2QWRUHAPOMQZL". Returns: None **Exceptions** * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.CloudFrontOriginAccessIdentityInUs e" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" * "CloudFront.Client.exceptions.NoSuchCloudFrontOriginAccessIdenti ty" CloudFront / Client / get_streaming_distribution get_streaming_distribution ************************** CloudFront.Client.get_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' ) Parameters: **Id** (*string*) -- **[REQUIRED]** The streaming distribution's ID. Return type: dict Returns: **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'|'None', '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/E DFDVBD632BHDS5", 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 are configured as trusted signers. 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. * *(string) --* * **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. * *(string) --* * **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, "amzn-s3-demo-bucket.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 in the list are configured as trusted signers. 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. * *(string) --* * **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 streaming distribution's information. For example: "E2QWRUHAPOMQZL". **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.NoSuchStreamingDistribution" CloudFront / Client / update_key_group update_key_group **************** CloudFront.Client.update_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: * Get the current key group with "GetKeyGroup" or "GetKeyGroupConfig". * Locally modify the fields in the key group that you want to update. For example, add or remove public key IDs. * Call "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' ) Parameters: * **KeyGroupConfig** (*dict*) -- **[REQUIRED]** The key group configuration. * **Name** *(string) --* **[REQUIRED]** A name to identify the key group. * **Items** *(list) --* **[REQUIRED]** A list of the identifiers of the public keys in the key group. * *(string) --* * **Comment** *(string) --* A comment to describe the key group. The comment cannot be longer than 128 characters. * **Id** (*string*) -- **[REQUIRED]** The identifier of the key group that you are updating. * **IfMatch** (*string*) -- The version of the key group that you are updating. The version is the key group's "ETag" value. Return type: dict Returns: **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. * *(string) --* * **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.PreconditionFailed" * "CloudFront.Client.exceptions.TooManyPublicKeysInKeyGroup" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.NoSuchResource" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" * "CloudFront.Client.exceptions.KeyGroupAlreadyExists" CloudFront / Client / create_public_key create_public_key ***************** CloudFront.Client.create_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' } ) Parameters: **PublicKeyConfig** (*dict*) -- **[REQUIRED]** A CloudFront public key configuration. * **CallerReference** *(string) --* **[REQUIRED]** A string included in the request to help make sure that the request can't be replayed. * **Name** *(string) --* **[REQUIRED]** A name to help identify the public key. * **EncodedKey** *(string) --* **[REQUIRED]** 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. Return type: dict Returns: **Response Syntax** { 'PublicKey': { 'Id': 'string', 'CreatedTime': datetime(2015, 1, 1), 'PublicKeyConfig': { 'CallerReference': 'string', 'Name': 'string', 'EncodedKey': 'string', 'Comment': 'string' } }, 'Location': '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. * **Location** *(string) --* The URL of the public key. * **ETag** *(string) --* The identifier for this version of the public key. **Exceptions** * "CloudFront.Client.exceptions.TooManyPublicKeys" * "CloudFront.Client.exceptions.PublicKeyAlreadyExists" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / publish_function publish_function **************** CloudFront.Client.publish_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' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the function that you are publishing. * **IfMatch** (*string*) -- **[REQUIRED]** The current version ( "ETag" value) of the function that you are publishing, which you can get using "DescribeFunction". Return type: dict Returns: **Response Syntax** { 'FunctionSummary': { 'Name': 'string', 'Status': 'string', 'FunctionConfig': { 'Comment': 'string', 'Runtime': 'cloudfront-js-1.0'|'cloudfront-js-2.0', 'KeyValueStoreAssociations': { 'Quantity': 123, 'Items': [ { 'KeyValueStoreARN': 'string' }, ] } }, '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 version. * **KeyValueStoreAssociations** *(dict) --* The configuration for the key value store associations. * **Quantity** *(integer) --* The quantity of key value store associations. * **Items** *(list) --* The items of the key value store association. * *(dict) --* The key value store association. * **KeyValueStoreARN** *(string) --* The Amazon Resource Name (ARN) of the key value store association. * **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.PreconditionFailed" * "CloudFront.Client.exceptions.UnsupportedOperation" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.NoSuchFunctionExists" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / get_key_group_config get_key_group_config ******************** CloudFront.Client.get_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' ) Parameters: **Id** (*string*) -- **[REQUIRED]** The identifier of the key group whose configuration you are getting. To get the identifier, use "ListKeyGroups". Return type: dict Returns: **Response Syntax** { 'KeyGroupConfig': { 'Name': 'string', 'Items': [ 'string', ], 'Comment': 'string' }, 'ETag': 'string' } **Response Structure** * *(dict) --* * **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. * *(string) --* * **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.NoSuchResource" CloudFront / Client / get_distribution_tenant_by_domain get_distribution_tenant_by_domain ********************************* CloudFront.Client.get_distribution_tenant_by_domain(**kwargs) Gets information about a distribution tenant by the associated domain. See also: AWS API Documentation **Request Syntax** response = client.get_distribution_tenant_by_domain( Domain='string' ) Parameters: **Domain** (*string*) -- **[REQUIRED]** A domain name associated with the target distribution tenant. Return type: dict Returns: **Response Syntax** { 'DistributionTenant': { 'Id': 'string', 'DistributionId': 'string', 'Name': 'string', 'Arn': 'string', 'Domains': [ { 'Domain': 'string', 'Status': 'active'|'inactive' }, ], 'Tags': { 'Items': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'Customizations': { 'WebAcl': { 'Action': 'override'|'disable', 'Arn': 'string' }, 'Certificate': { 'Arn': 'string' }, 'GeoRestrictions': { 'RestrictionType': 'blacklist'|'whitelist'|'none', 'Locations': [ 'string', ] } }, 'Parameters': [ { 'Name': 'string', 'Value': 'string' }, ], 'ConnectionGroupId': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'Enabled': True|False, 'Status': 'string' }, 'ETag': 'string' } **Response Structure** * *(dict) --* * **DistributionTenant** *(dict) --* The distribution tenant. * **Id** *(string) --* The ID of the distribution tenant. * **DistributionId** *(string) --* The ID of the multi-tenant distribution. * **Name** *(string) --* The name of the distribution tenant. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the distribution tenant. * **Domains** *(list) --* The domains associated with the distribution tenant. * *(dict) --* The details about the domain result. * **Domain** *(string) --* The specified domain. * **Status** *(string) --* Whether the domain is active or inactive. * **Tags** *(dict) --* A complex type that contains zero or more "Tag" elements. * **Items** *(list) --* A complex type that contains "Tag" elements. * *(dict) --* A complex type that contains "Tag" key and "Tag" value. * **Key** *(string) --* 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 "_ - . : / = + @". * **Value** *(string) --* 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 "_ - . : / = + @". * **Customizations** *(dict) --* Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant. * **WebAcl** *(dict) --* The WAF web ACL. * **Action** *(string) --* The action for the WAF web ACL customization. You can specify "override" to specify a separate WAF web ACL for the distribution tenant. If you specify "disable", the distribution tenant won't have WAF web ACL protections and won't inherit from the multi-tenant distribution. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the WAF web ACL. * **Certificate** *(dict) --* The Certificate Manager (ACM) certificate. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the ACM certificate. * **GeoRestrictions** *(dict) --* The geographic restrictions. * **RestrictionType** *(string) --* The method that you want to use to restrict distribution of your content by country: * "none": No geographic 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. * **Locations** *(list) --* The locations for geographic restrictions. * *(string) --* * **Parameters** *(list) --* A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution. * *(dict) --* A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution. * **Name** *(string) --* The parameter name. * **Value** *(string) --* The parameter value. * **ConnectionGroupId** *(string) --* The ID of the connection group for the distribution tenant. If you don't specify a connection group, CloudFront uses the default connection group. * **CreatedTime** *(datetime) --* The date and time when the distribution tenant was created. * **LastModifiedTime** *(datetime) --* The date and time when the distribution tenant was updated. * **Enabled** *(boolean) --* Indicates whether the distribution tenant is in an enabled state. If disabled, the distribution tenant won't serve traffic. * **Status** *(string) --* The status of the distribution tenant. * **ETag** *(string) --* The current version of the distribution tenant. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" CloudFront / Client / get_function get_function ************ CloudFront.Client.get_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' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the function whose code you are getting. * **Stage** (*string*) -- The function's stage, either "DEVELOPMENT" or "LIVE". Return type: dict Returns: **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.UnsupportedOperation" * "CloudFront.Client.exceptions.NoSuchFunctionExists" CloudFront / Client / update_domain_association update_domain_association ************************* CloudFront.Client.update_domain_association(**kwargs) Note: We recommend that you use the "UpdateDomainAssociation" API operation to move a domain association, as it supports both standard distributions and distribution tenants. AssociateAlias performs similar checks but only supports standard distributions. Moves a domain from its current standard distribution or distribution tenant to another one. You must first disable the source distribution (standard distribution or distribution tenant) and then separately call this operation to move the domain to another target distribution (standard distribution or distribution tenant). To use this operation, specify the domain and the ID of the target resource (standard distribution or distribution tenant). For more information, including how to set up the target resource, prerequisites that you must complete, and other restrictions, see Moving an alternate domain name to a different standard distribution or distribution tenant in the *Amazon CloudFront Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.update_domain_association( Domain='string', TargetResource={ 'DistributionId': 'string', 'DistributionTenantId': 'string' }, IfMatch='string' ) Parameters: * **Domain** (*string*) -- **[REQUIRED]** The domain to update. * **TargetResource** (*dict*) -- **[REQUIRED]** The target standard distribution or distribution tenant resource for the domain. You can specify either "DistributionId" or "DistributionTenantId", but not both. * **DistributionId** *(string) --* The ID of the multi-tenant distribution. * **DistributionTenantId** *(string) --* The ID of the distribution tenant. * **IfMatch** (*string*) -- The value of the "ETag" identifier for the standard distribution or distribution tenant that will be associated with the domain. Return type: dict Returns: **Response Syntax** { 'Domain': 'string', 'ResourceId': 'string', 'ETag': 'string' } **Response Structure** * *(dict) --* * **Domain** *(string) --* The domain that you're moving. * **ResourceId** *(string) --* The intended destination for the domain. * **ETag** *(string) --* The current version of the target standard distribution or distribution tenant that was associated with the domain. **Exceptions** * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.IllegalUpdate" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / get_origin_request_policy get_origin_request_policy ************************* CloudFront.Client.get_origin_request_policy(**kwargs) Gets an origin request policy, including the following metadata: * The policy's identifier. * The date and time when the policy was last modified. 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' ) Parameters: **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". Return type: dict Returns: **Response Syntax** { 'OriginRequestPolicy': { 'Id': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'OriginRequestPolicyConfig': { 'Comment': 'string', 'Name': 'string', 'HeadersConfig': { 'HeaderBehavior': 'none'|'whitelist'|'allViewer'|'allViewerAndWhitelistCloudFront'|'allExcept', 'Headers': { 'Quantity': 123, 'Items': [ 'string', ] } }, 'CookiesConfig': { 'CookieBehavior': 'none'|'whitelist'|'all'|'allExcept', 'Cookies': { 'Quantity': 123, 'Items': [ 'string', ] } }, 'QueryStringsConfig': { 'QueryStringBehavior': 'none'|'whitelist'|'all'|'allExcept', 'QueryStrings': { 'Quantity': 123, 'Items': [ 'string', ] } } } }, 'ETag': 'string' } **Response Structure** * *(dict) --* * **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" – No HTTP headers in viewer requests are 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" – Only 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. * "allExcept" – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin, **except** for those listed in the "Headers" type, which are not included. * **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. * *(string) --* * **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" – No cookies in viewer requests are 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" – Only 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. * "allExcept" – All cookies in viewer requests are included in requests that CloudFront sends to the origin, **except** for those listed in the "CookieNames" type, which are not included. * **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. * *(string) --* * **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" – No query strings in viewer requests are 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" – Only 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. * "allExcept" – All query strings in viewer requests are included in requests that CloudFront sends to the origin, **except** for those listed in the "QueryStringNames" type, which are not included. * **QueryStrings** *(dict) --* Contains the specific query strings in viewer requests that either **are** or **are not** included in requests that CloudFront sends to the origin. The behavior depends on whether the "QueryStringBehavior" field in the "OriginRequestPolicyQueryStringsConfig" 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. * *(string) --* * **ETag** *(string) --* The current version of the origin request policy. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.NoSuchOriginRequestPolicy" CloudFront / Client / update_connection_group update_connection_group *********************** CloudFront.Client.update_connection_group(**kwargs) Updates a connection group. See also: AWS API Documentation **Request Syntax** response = client.update_connection_group( Id='string', Ipv6Enabled=True|False, IfMatch='string', AnycastIpListId='string', Enabled=True|False ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The ID of the connection group. * **Ipv6Enabled** (*boolean*) -- Enable IPv6 for the connection group. For more information, see Enable IPv6 in the *Amazon CloudFront Developer Guide*. * **IfMatch** (*string*) -- **[REQUIRED]** The value of the "ETag" header that you received when retrieving the connection group that you're updating. * **AnycastIpListId** (*string*) -- The ID of the Anycast static IP list. * **Enabled** (*boolean*) -- Whether the connection group is enabled. Return type: dict Returns: **Response Syntax** { 'ConnectionGroup': { 'Id': 'string', 'Name': 'string', 'Arn': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'Tags': { 'Items': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'Ipv6Enabled': True|False, 'RoutingEndpoint': 'string', 'AnycastIpListId': 'string', 'Status': 'string', 'Enabled': True|False, 'IsDefault': True|False }, 'ETag': 'string' } **Response Structure** * *(dict) --* * **ConnectionGroup** *(dict) --* The connection group that you updated. * **Id** *(string) --* The ID of the connection group. * **Name** *(string) --* The name of the connection group. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the connection group. * **CreatedTime** *(datetime) --* The date and time when the connection group was created. * **LastModifiedTime** *(datetime) --* The date and time when the connection group was updated. * **Tags** *(dict) --* A complex type that contains zero or more "Tag" elements. * **Items** *(list) --* A complex type that contains "Tag" elements. * *(dict) --* A complex type that contains "Tag" key and "Tag" value. * **Key** *(string) --* 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 "_ - . : / = + @". * **Value** *(string) --* 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 "_ - . : / = + @". * **Ipv6Enabled** *(boolean) --* IPv6 is enabled for the connection group. * **RoutingEndpoint** *(string) --* The routing endpoint (also known as the DNS name) that is assigned to the connection group, such as d111111abcdef8.cloudfront.net. * **AnycastIpListId** *(string) --* The ID of the Anycast static IP list. * **Status** *(string) --* The status of the connection group. * **Enabled** *(boolean) --* Whether the connection group is enabled. * **IsDefault** *(boolean) --* Whether the connection group is the default connection group for the distribution tenants. * **ETag** *(string) --* The current version of the connection group. **Exceptions** * "CloudFront.Client.exceptions.PreconditionFailed" * "CloudFront.Client.exceptions.ResourceInUse" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.EntityAlreadyExists" * "CloudFront.Client.exceptions.EntityLimitExceeded" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.InvalidIfMatchVersion" CloudFront / Client / create_key_value_store create_key_value_store ********************** CloudFront.Client.create_key_value_store(**kwargs) Specifies the key value store resource to add to your account. In your account, the key value store names must be unique. You can also import key value store data in JSON format from an S3 bucket by providing a valid "ImportSource" that you own. See also: AWS API Documentation **Request Syntax** response = client.create_key_value_store( Name='string', Comment='string', ImportSource={ 'SourceType': 'S3', 'SourceARN': 'string' } ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the key value store. The minimum length is 1 character and the maximum length is 64 characters. * **Comment** (*string*) -- The comment of the key value store. * **ImportSource** (*dict*) -- The S3 bucket that provides the source for the import. The source must be in a valid JSON format. * **SourceType** *(string) --* **[REQUIRED]** The source type of the import source for the key value store. * **SourceARN** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the import source for the key value store. Return type: dict Returns: **Response Syntax** { 'KeyValueStore': { 'Name': 'string', 'Id': 'string', 'Comment': 'string', 'ARN': 'string', 'Status': 'string', 'LastModifiedTime': datetime(2015, 1, 1) }, 'ETag': 'string', 'Location': 'string' } **Response Structure** * *(dict) --* * **KeyValueStore** *(dict) --* The resulting key value store. * **Name** *(string) --* The name of the key value store. * **Id** *(string) --* The unique Id for the key value store. * **Comment** *(string) --* A comment for the key value store. * **ARN** *(string) --* The Amazon Resource Name (ARN) of the key value store. * **Status** *(string) --* The status of the key value store. * **LastModifiedTime** *(datetime) --* The last-modified time of the key value store. * **ETag** *(string) --* The "ETag" in the resulting key value store. * **Location** *(string) --* The location of the resulting key value store. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.UnsupportedOperation" * "CloudFront.Client.exceptions.EntityAlreadyExists" * "CloudFront.Client.exceptions.EntityLimitExceeded" * "CloudFront.Client.exceptions.InvalidArgument" * "CloudFront.Client.exceptions.EntitySizeLimitExceeded" CloudFront / Client / create_connection_group create_connection_group *********************** CloudFront.Client.create_connection_group(**kwargs) Creates a connection group. See also: AWS API Documentation **Request Syntax** response = client.create_connection_group( Name='string', Ipv6Enabled=True|False, Tags={ 'Items': [ { 'Key': 'string', 'Value': 'string' }, ] }, AnycastIpListId='string', Enabled=True|False ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the connection group. Enter a friendly identifier that is unique within your Amazon Web Services account. This name can't be updated after you create the connection group. * **Ipv6Enabled** (*boolean*) -- Enable IPv6 for the connection group. The default is "true". For more information, see Enable IPv6 in the *Amazon CloudFront Developer Guide*. * **Tags** (*dict*) -- A complex type that contains zero or more "Tag" elements. * **Items** *(list) --* A complex type that contains "Tag" elements. * *(dict) --* A complex type that contains "Tag" key and "Tag" value. * **Key** *(string) --* **[REQUIRED]** 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 "_ - . : / = + @". * **Value** *(string) --* 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 "_ - . : / = + @". * **AnycastIpListId** (*string*) -- The ID of the Anycast static IP list. * **Enabled** (*boolean*) -- Enable the connection group. Return type: dict Returns: **Response Syntax** { 'ConnectionGroup': { 'Id': 'string', 'Name': 'string', 'Arn': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'Tags': { 'Items': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'Ipv6Enabled': True|False, 'RoutingEndpoint': 'string', 'AnycastIpListId': 'string', 'Status': 'string', 'Enabled': True|False, 'IsDefault': True|False }, 'ETag': 'string' } **Response Structure** * *(dict) --* * **ConnectionGroup** *(dict) --* The connection group that you created. * **Id** *(string) --* The ID of the connection group. * **Name** *(string) --* The name of the connection group. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the connection group. * **CreatedTime** *(datetime) --* The date and time when the connection group was created. * **LastModifiedTime** *(datetime) --* The date and time when the connection group was updated. * **Tags** *(dict) --* A complex type that contains zero or more "Tag" elements. * **Items** *(list) --* A complex type that contains "Tag" elements. * *(dict) --* A complex type that contains "Tag" key and "Tag" value. * **Key** *(string) --* 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 "_ - . : / = + @". * **Value** *(string) --* 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 "_ - . : / = + @". * **Ipv6Enabled** *(boolean) --* IPv6 is enabled for the connection group. * **RoutingEndpoint** *(string) --* The routing endpoint (also known as the DNS name) that is assigned to the connection group, such as d111111abcdef8.cloudfront.net. * **AnycastIpListId** *(string) --* The ID of the Anycast static IP list. * **Status** *(string) --* The status of the connection group. * **Enabled** *(boolean) --* Whether the connection group is enabled. * **IsDefault** *(boolean) --* Whether the connection group is the default connection group for the distribution tenants. * **ETag** *(string) --* The current version of the connection group. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.EntityAlreadyExists" * "CloudFront.Client.exceptions.InvalidTagging" * "CloudFront.Client.exceptions.EntityLimitExceeded" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / create_invalidation create_invalidation ******************* CloudFront.Client.create_invalidation(**kwargs) Create a new invalidation. For more information, see Invalidating files in the *Amazon CloudFront Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_invalidation( DistributionId='string', InvalidationBatch={ 'Paths': { 'Quantity': 123, 'Items': [ 'string', ] }, 'CallerReference': 'string' } ) Parameters: * **DistributionId** (*string*) -- **[REQUIRED]** The distribution's id. * **InvalidationBatch** (*dict*) -- **[REQUIRED]** The batch information for the invalidation. * **Paths** *(dict) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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. * *(string) --* * **CallerReference** *(string) --* **[REQUIRED]** 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. Return type: dict Returns: **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. * *(string) --* * **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.NoSuchDistribution" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.TooManyInvalidationsInProgress" * "CloudFront.Client.exceptions.MissingBody" * "CloudFront.Client.exceptions.InconsistentQuantities" * "CloudFront.Client.exceptions.BatchTooLarge" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / get_public_key_config get_public_key_config ********************* CloudFront.Client.get_public_key_config(**kwargs) Gets a public key configuration. See also: AWS API Documentation **Request Syntax** response = client.get_public_key_config( Id='string' ) Parameters: **Id** (*string*) -- **[REQUIRED]** The identifier of the public key whose configuration you are getting. Return type: dict Returns: **Response Syntax** { 'PublicKeyConfig': { 'CallerReference': 'string', 'Name': 'string', 'EncodedKey': 'string', 'Comment': 'string' }, 'ETag': 'string' } **Response Structure** * *(dict) --* * **PublicKeyConfig** *(dict) --* A public key configuration. * **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 for this version of the public key configuration. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.NoSuchPublicKey" CloudFront / Client / create_continuous_deployment_policy create_continuous_deployment_policy *********************************** CloudFront.Client.create_continuous_deployment_policy(**kwargs) Creates a continuous deployment policy that distributes traffic for a custom domain name to two different CloudFront distributions. To use a continuous deployment policy, first use "CopyDistribution" to create a staging distribution, then use "UpdateDistribution" to modify the staging distribution's configuration. After you create and update a staging distribution, you can use a continuous deployment policy to incrementally move traffic to the staging distribution. This workflow enables you to test changes to a distribution's configuration before moving all of your domain's production traffic to the new configuration. See also: AWS API Documentation **Request Syntax** response = client.create_continuous_deployment_policy( ContinuousDeploymentPolicyConfig={ 'StagingDistributionDnsNames': { 'Quantity': 123, 'Items': [ 'string', ] }, 'Enabled': True|False, 'TrafficConfig': { 'SingleWeightConfig': { 'Weight': ..., 'SessionStickinessConfig': { 'IdleTTL': 123, 'MaximumTTL': 123 } }, 'SingleHeaderConfig': { 'Header': 'string', 'Value': 'string' }, 'Type': 'SingleWeight'|'SingleHeader' } } ) Parameters: **ContinuousDeploymentPolicyConfig** (*dict*) -- **[REQUIRED]** Contains the configuration for a continuous deployment policy. * **StagingDistributionDnsNames** *(dict) --* **[REQUIRED]** The CloudFront domain name of the staging distribution. For example: "d111111abcdef8.cloudfront.net". * **Quantity** *(integer) --* **[REQUIRED]** The number of CloudFront domain names in your staging distribution. * **Items** *(list) --* The CloudFront domain name of the staging distribution. * *(string) --* * **Enabled** *(boolean) --* **[REQUIRED]** A Boolean that indicates whether this continuous deployment policy is enabled (in effect). When this value is "true", this policy is enabled and in effect. When this value is "false", this policy is not enabled and has no effect. * **TrafficConfig** *(dict) --* Contains the parameters for routing production traffic from your primary to staging distributions. * **SingleWeightConfig** *(dict) --* Contains the percentage of traffic to send to the staging distribution. * **Weight** *(float) --* **[REQUIRED]** The percentage of traffic to send to a staging distribution, expressed as a decimal number between 0 and 0.15. For example, a value of 0.10 means 10% of traffic is sent to the staging distribution. * **SessionStickinessConfig** *(dict) --* Session stickiness provides the ability to define multiple requests from a single viewer as a single session. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution. Define the session duration using TTL values. * **IdleTTL** *(integer) --* **[REQUIRED]** The amount of time after which you want sessions to cease if no requests are received. Allowed values are 300–3600 seconds (5–60 minutes). The value must be less than or equal to "MaximumTTL". * **MaximumTTL** *(integer) --* **[REQUIRED]** The maximum amount of time to consider requests from the viewer as being part of the same session. Allowed values are 300–3600 seconds (5–60 minutes). The value must be greater than or equal to "IdleTTL". * **SingleHeaderConfig** *(dict) --* Determines which HTTP requests are sent to the staging distribution. * **Header** *(string) --* **[REQUIRED]** The request header name that you want CloudFront to send to your staging distribution. The header must contain the prefix "aws-cf-cd-". * **Value** *(string) --* **[REQUIRED]** The request header value. * **Type** *(string) --* **[REQUIRED]** The type of traffic configuration. Return type: dict Returns: **Response Syntax** { 'ContinuousDeploymentPolicy': { 'Id': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'ContinuousDeploymentPolicyConfig': { 'StagingDistributionDnsNames': { 'Quantity': 123, 'Items': [ 'string', ] }, 'Enabled': True|False, 'TrafficConfig': { 'SingleWeightConfig': { 'Weight': ..., 'SessionStickinessConfig': { 'IdleTTL': 123, 'MaximumTTL': 123 } }, 'SingleHeaderConfig': { 'Header': 'string', 'Value': 'string' }, 'Type': 'SingleWeight'|'SingleHeader' } } }, 'Location': 'string', 'ETag': 'string' } **Response Structure** * *(dict) --* * **ContinuousDeploymentPolicy** *(dict) --* A continuous deployment policy. * **Id** *(string) --* The identifier of the continuous deployment policy. * **LastModifiedTime** *(datetime) --* The date and time the continuous deployment policy was last modified. * **ContinuousDeploymentPolicyConfig** *(dict) --* Contains the configuration for a continuous deployment policy. * **StagingDistributionDnsNames** *(dict) --* The CloudFront domain name of the staging distribution. For example: "d111111abcdef8.cloudfront.net". * **Quantity** *(integer) --* The number of CloudFront domain names in your staging distribution. * **Items** *(list) --* The CloudFront domain name of the staging distribution. * *(string) --* * **Enabled** *(boolean) --* A Boolean that indicates whether this continuous deployment policy is enabled (in effect). When this value is "true", this policy is enabled and in effect. When this value is "false", this policy is not enabled and has no effect. * **TrafficConfig** *(dict) --* Contains the parameters for routing production traffic from your primary to staging distributions. * **SingleWeightConfig** *(dict) --* Contains the percentage of traffic to send to the staging distribution. * **Weight** *(float) --* The percentage of traffic to send to a staging distribution, expressed as a decimal number between 0 and 0.15. For example, a value of 0.10 means 10% of traffic is sent to the staging distribution. * **SessionStickinessConfig** *(dict) --* Session stickiness provides the ability to define multiple requests from a single viewer as a single session. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution. Define the session duration using TTL values. * **IdleTTL** *(integer) --* The amount of time after which you want sessions to cease if no requests are received. Allowed values are 300–3600 seconds (5–60 minutes). The value must be less than or equal to "MaximumTTL". * **MaximumTTL** *(integer) --* The maximum amount of time to consider requests from the viewer as being part of the same session. Allowed values are 300–3600 seconds (5–60 minutes). The value must be greater than or equal to "IdleTTL". * **SingleHeaderConfig** *(dict) --* Determines which HTTP requests are sent to the staging distribution. * **Header** *(string) --* The request header name that you want CloudFront to send to your staging distribution. The header must contain the prefix "aws-cf-cd-". * **Value** *(string) --* The request header value. * **Type** *(string) --* The type of traffic configuration. * **Location** *(string) --* The location of the continuous deployment policy. * **ETag** *(string) --* The version identifier for the current version of the continuous deployment policy. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.TooManyContinuousDeploymentPolicie s" * "CloudFront.Client.exceptions.StagingDistributionInUse" * "CloudFront.Client.exceptions.InconsistentQuantities" * "CloudFront.Client.exceptions.ContinuousDeploymentPolicyAlreadyE xists" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / get_vpc_origin get_vpc_origin ************** CloudFront.Client.get_vpc_origin(**kwargs) Get the details of an Amazon CloudFront VPC origin. See also: AWS API Documentation **Request Syntax** response = client.get_vpc_origin( Id='string' ) Parameters: **Id** (*string*) -- **[REQUIRED]** The VPC origin ID. Return type: dict Returns: **Response Syntax** { 'VpcOrigin': { 'Id': 'string', 'Arn': 'string', 'Status': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'VpcOriginEndpointConfig': { 'Name': 'string', 'Arn': 'string', 'HTTPPort': 123, 'HTTPSPort': 123, 'OriginProtocolPolicy': 'http-only'|'match-viewer'|'https-only', 'OriginSslProtocols': { 'Quantity': 123, 'Items': [ 'SSLv3'|'TLSv1'|'TLSv1.1'|'TLSv1.2', ] } } }, 'ETag': 'string' } **Response Structure** * *(dict) --* * **VpcOrigin** *(dict) --* The VPC origin. * **Id** *(string) --* The VPC origin ID. * **Arn** *(string) --* The VPC origin ARN. * **Status** *(string) --* The VPC origin status. * **CreatedTime** *(datetime) --* The VPC origin created time. * **LastModifiedTime** *(datetime) --* The VPC origin last modified time. * **VpcOriginEndpointConfig** *(dict) --* The VPC origin endpoint configuration. * **Name** *(string) --* The name of the CloudFront VPC origin endpoint configuration. * **Arn** *(string) --* The ARN of the CloudFront VPC origin endpoint configuration. * **HTTPPort** *(integer) --* The HTTP port for the CloudFront VPC origin endpoint configuration. The default value is "80". * **HTTPSPort** *(integer) --* The HTTPS port of the CloudFront VPC origin endpoint configuration. The default value is "443". * **OriginProtocolPolicy** *(string) --* The origin protocol policy for the CloudFront VPC origin endpoint configuration. * **OriginSslProtocols** *(dict) --* A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin. * **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. * *(string) --* * **ETag** *(string) --* The VPC origin ETag. **Exceptions** * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.EntityNotFound" * "CloudFront.Client.exceptions.UnsupportedOperation" * "CloudFront.Client.exceptions.InvalidArgument" CloudFront / Client / get_invalidation get_invalidation **************** CloudFront.Client.get_invalidation(**kwargs) Get the information about an invalidation. See also: AWS API Documentation **Request Syntax** response = client.get_invalidation( DistributionId='string', Id='string' ) Parameters: * **DistributionId** (*string*) -- **[REQUIRED]** The distribution's ID. * **Id** (*string*) -- **[REQUIRED]** The identifier for the invalidation request, for example, "IDFDVBD632BHDS5". Return type: dict Returns: **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. * *(string) --* * **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.NoSuchDistribution" * "CloudFront.Client.exceptions.AccessDenied" * "CloudFront.Client.exceptions.NoSuchInvalidation"