Class: AWS.CloudFront

Inherits:
AWS.Service show all
Identifier:
cloudfront
API Version:
2020-05-31
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using CloudFront

var cloudfront = new AWS.CloudFront();
cloudfront.createCachePolicy(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the CloudFront object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var cloudfront = new AWS.CloudFront({apiVersion: '2020-05-31'});

You can also set the API version globally in AWS.config.apiVersions using the cloudfront service identifier:

AWS.config.apiVersions = {
  cloudfront: '2020-05-31',
  // other service API versions
};

var cloudfront = new AWS.CloudFront();

Version:

  • 2020-05-31

Defined Under Namespace

Classes: Signer

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

distributionDeployed, invalidationCompleted, streamingDistributionDeployed

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, defineService

Constructor Details

new AWS.CloudFront(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a CloudFront object

var cloudfront = new AWS.CloudFront({apiVersion: '2020-05-31'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.CloudFront.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.CloudFront.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.CloudFront.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

createCachePolicy(params = {}, callback) ⇒ AWS.Request

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.

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

For more information about cache policies, see Controlling the cache key in the Amazon CloudFront Developer Guide.

Service Reference:

Examples:

Calling the createCachePolicy operation

var params = {
  CachePolicyConfig: { /* required */
    MinTTL: 'NUMBER_VALUE', /* required */
    Name: 'STRING_VALUE', /* required */
    Comment: 'STRING_VALUE',
    DefaultTTL: 'NUMBER_VALUE',
    MaxTTL: 'NUMBER_VALUE',
    ParametersInCacheKeyAndForwardedToOrigin: {
      CookiesConfig: { /* required */
        CookieBehavior: none | whitelist | allExcept | all, /* required */
        Cookies: {
          Quantity: 'NUMBER_VALUE', /* required */
          Items: [
            'STRING_VALUE',
            /* more items */
          ]
        }
      },
      EnableAcceptEncodingGzip: true || false, /* required */
      HeadersConfig: { /* required */
        HeaderBehavior: none | whitelist, /* required */
        Headers: {
          Quantity: 'NUMBER_VALUE', /* required */
          Items: [
            'STRING_VALUE',
            /* more items */
          ]
        }
      },
      QueryStringsConfig: { /* required */
        QueryStringBehavior: none | whitelist | allExcept | all, /* required */
        QueryStrings: {
          Quantity: 'NUMBER_VALUE', /* required */
          Items: [
            'STRING_VALUE',
            /* more items */
          ]
        }
      },
      EnableAcceptEncodingBrotli: true || false
    }
  }
};
cloudfront.createCachePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CachePolicyConfig — (map)

      A cache policy configuration.

      • Comment — (String)

        A comment to describe the cache policy.

      • Name — required — (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 — required — (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 — (map)

        The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are automatically included in requests that CloudFront sends to the origin.

        • EnableAcceptEncodingGzip — required — (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 — required — (map)

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

          • HeaderBehavior — required — (String)

            Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:

            • none – HTTP headers are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none, any headers that are listed in an OriginRequestPolicy are included in origin requests.

            • whitelist – The HTTP headers that are listed in the Headers type are included in the cache key and are automatically included in requests that CloudFront sends to the origin.

            Possible values include:
            • "none"
            • "whitelist"
          • Headers — (map)

            Contains a list of HTTP header names.

            • Quantity — required — (Integer)

              The number of header names in the Items list.

            • Items — (Array<String>)

              A list of HTTP header names.

        • CookiesConfig — required — (map)

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

          • CookieBehavior — required — (String)

            Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:

            • none – Cookies in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none, any cookies that are listed in an OriginRequestPolicy are included in origin requests.

            • whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.

            • allExcept – All cookies in viewer requests that are not listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.

            • all – All cookies in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.

            Possible values include:
            • "none"
            • "whitelist"
            • "allExcept"
            • "all"
          • Cookies — (map)

            Contains a list of cookie names.

            • Quantity — required — (Integer)

              The number of cookie names in the Items list.

            • Items — (Array<String>)

              A list of cookie names.

        • QueryStringsConfig — required — (map)

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

          • QueryStringBehavior — required — (String)

            Determines whether any URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:

            • none – Query strings in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none, any query strings that are listed in an OriginRequestPolicy are included in origin requests.

            • whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.

            • allExcept – All query strings in viewer requests that are not listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.

            • all – All query strings in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.

            Possible values include:
            • "none"
            • "whitelist"
            • "allExcept"
            • "all"
          • QueryStrings — (map)

            Contains the specific query strings in viewer requests that either are or are not included in the cache key and automatically included in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the CachePolicyQueryStringsConfig type is set to whitelist (the listed query strings are included) or allExcept (the listed query strings are not included, but all other query strings are).

            • Quantity — required — (Integer)

              The number of query string names in the Items list.

            • Items — (Array<String>)

              A list of query string names.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CachePolicy — (map)

        A cache policy.

        • Id — required — (String)

          The unique identifier for the cache policy.

        • LastModifiedTime — required — (Date)

          The date and time when the cache policy was last modified.

        • CachePolicyConfig — required — (map)

          The cache policy configuration.

          • Comment — (String)

            A comment to describe the cache policy.

          • Name — required — (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 — required — (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 — (map)

            The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are automatically included in requests that CloudFront sends to the origin.

            • EnableAcceptEncodingGzip — required — (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 — required — (map)

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

              • HeaderBehavior — required — (String)

                Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:

                • none – HTTP headers are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none, any headers that are listed in an OriginRequestPolicy are included in origin requests.

                • whitelist – The HTTP headers that are listed in the Headers type are included in the cache key and are automatically included in requests that CloudFront sends to the origin.

                Possible values include:
                • "none"
                • "whitelist"
              • Headers — (map)

                Contains a list of HTTP header names.

                • Quantity — required — (Integer)

                  The number of header names in the Items list.

                • Items — (Array<String>)

                  A list of HTTP header names.

            • CookiesConfig — required — (map)

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

              • CookieBehavior — required — (String)

                Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:

                • none – Cookies in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none, any cookies that are listed in an OriginRequestPolicy are included in origin requests.

                • whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.

                • allExcept – All cookies in viewer requests that are not listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.

                • all – All cookies in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.

                Possible values include:
                • "none"
                • "whitelist"
                • "allExcept"
                • "all"
              • Cookies — (map)

                Contains a list of cookie names.

                • Quantity — required — (Integer)

                  The number of cookie names in the Items list.

                • Items — (Array<String>)

                  A list of cookie names.

            • QueryStringsConfig — required — (map)

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

              • QueryStringBehavior — required — (String)

                Determines whether any URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:

                • none – Query strings in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none, any query strings that are listed in an OriginRequestPolicy are included in origin requests.

                • whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.

                • allExcept – All query strings in viewer requests that are not listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.

                • all – All query strings in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.

                Possible values include:
                • "none"
                • "whitelist"
                • "allExcept"
                • "all"
              • QueryStrings — (map)

                Contains the specific query strings in viewer requests that either are or are not included in the cache key and automatically included in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the CachePolicyQueryStringsConfig type is set to whitelist (the listed query strings are included) or allExcept (the listed query strings are not included, but all other query strings are).

                • Quantity — required — (Integer)

                  The number of query string names in the Items list.

                • Items — (Array<String>)

                  A list of query string names.

      • Location — (String)

        The fully qualified URI of the cache policy just created.

      • ETag — (String)

        The current version of the cache policy.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createCloudFrontOriginAccessIdentity(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createCloudFrontOriginAccessIdentity operation

var params = {
  CloudFrontOriginAccessIdentityConfig: { /* required */
    CallerReference: 'STRING_VALUE', /* required */
    Comment: 'STRING_VALUE' /* required */
  }
};
cloudfront.createCloudFrontOriginAccessIdentity(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CloudFrontOriginAccessIdentityConfig — (map)

      The current configuration information for the identity.

      • CallerReference — required — (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 — required — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CloudFrontOriginAccessIdentity — (map)

        The origin access identity's information.

        • Id — required — (String)

          The ID for the origin access identity, for example, E74FTE3AJFJ256A.

        • S3CanonicalUserId — required — (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 — (map)

          The current configuration information for the identity.

          • CallerReference — required — (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 — required — (String)

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

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createDistribution(params = {}, callback) ⇒ AWS.Request

Creates a new web distribution. You create a CloudFront distribution to tell CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery. Send a POST request to the /CloudFront API version/distribution/distribution ID resource.

When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using UpdateDistribution, follow the steps included in the documentation to get the current configuration and then make your updates. This helps to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.

Service Reference:

Examples:

Calling the createDistribution operation

var params = {
  DistributionConfig: { /* required */
    CallerReference: 'STRING_VALUE', /* required */
    Comment: 'STRING_VALUE', /* required */
    DefaultCacheBehavior: { /* required */
      TargetOriginId: 'STRING_VALUE', /* required */
      ViewerProtocolPolicy: allow-all | https-only | redirect-to-https, /* required */
      AllowedMethods: {
        Items: [ /* required */
          GET | HEAD | POST | PUT | PATCH | OPTIONS | DELETE,
          /* more items */
        ],
        Quantity: 'NUMBER_VALUE', /* required */
        CachedMethods: {
          Items: [ /* required */
            GET | HEAD | POST | PUT | PATCH | OPTIONS | DELETE,
            /* more items */
          ],
          Quantity: 'NUMBER_VALUE' /* required */
        }
      },
      CachePolicyId: 'STRING_VALUE',
      Compress: true || false,
      DefaultTTL: 'NUMBER_VALUE',
      FieldLevelEncryptionId: 'STRING_VALUE',
      ForwardedValues: {
        Cookies: { /* required */
          Forward: none | whitelist | all, /* required */
          WhitelistedNames: {
            Quantity: 'NUMBER_VALUE', /* required */
            Items: [
              'STRING_VALUE',
              /* more items */
            ]
          }
        },
        QueryString: true || false, /* required */
        Headers: {
          Quantity: 'NUMBER_VALUE', /* required */
          Items: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        QueryStringCacheKeys: {
          Quantity: 'NUMBER_VALUE', /* required */
          Items: [
            'STRING_VALUE',
            /* more items */
          ]
        }
      },
      LambdaFunctionAssociations: {
        Quantity: 'NUMBER_VALUE', /* required */
        Items: [
          {
            EventType: viewer-request | viewer-response | origin-request | origin-response, /* required */
            LambdaFunctionARN: 'STRING_VALUE', /* required */
            IncludeBody: true || false
          },
          /* more items */
        ]
      },
      MaxTTL: 'NUMBER_VALUE',
      MinTTL: 'NUMBER_VALUE',
      OriginRequestPolicyId: 'STRING_VALUE',
      RealtimeLogConfigArn: 'STRING_VALUE',
      SmoothStreaming: true || false,
      TrustedKeyGroups: {
        Enabled: true || false, /* required */
        Quantity: 'NUMBER_VALUE', /* required */
        Items: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      TrustedSigners: {
        Enabled: true || false, /* required */
        Quantity: 'NUMBER_VALUE', /* required */
        Items: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    Enabled: true || false, /* required */
    Origins: { /* required */
      Items: [ /* required */
        {
          DomainName: 'STRING_VALUE', /* required */
          Id: 'STRING_VALUE', /* required */
          ConnectionAttempts: 'NUMBER_VALUE',
          ConnectionTimeout: 'NUMBER_VALUE',
          CustomHeaders: {
            Quantity: 'NUMBER_VALUE', /* required */
            Items: [
              {
                HeaderName: 'STRING_VALUE', /* required */
                HeaderValue: 'STRING_VALUE' /* required */
              },
              /* more items */
            ]
          },
          CustomOriginConfig: {
            HTTPPort: 'NUMBER_VALUE', /* required */
            HTTPSPort: 'NUMBER_VALUE', /* required */
            OriginProtocolPolicy: http-only | match-viewer | https-only, /* required */
            OriginKeepaliveTimeout: 'NUMBER_VALUE',
            OriginReadTimeout: 'NUMBER_VALUE',
            OriginSslProtocols: {
              Items: [ /* required */
                SSLv3 | TLSv1 | TLSv1.1 | TLSv1.2,
                /* more items */
              ],
              Quantity: 'NUMBER_VALUE' /* required */
            }
          },
          OriginPath: 'STRING_VALUE',
          OriginShield: {
            Enabled: true || false, /* required */
            OriginShieldRegion: 'STRING_VALUE'
          },
          S3OriginConfig: {
            OriginAccessIdentity: 'STRING_VALUE' /* required */
          }
        },
        /* more items */
      ],
      Quantity: 'NUMBER_VALUE' /* required */
    },
    Aliases: {
      Quantity: 'NUMBER_VALUE', /* required */
      Items: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    CacheBehaviors: {
      Quantity: 'NUMBER_VALUE', /* required */
      Items: [
        {
          PathPattern: 'STRING_VALUE', /* required */
          TargetOriginId: 'STRING_VALUE', /* required */
          ViewerProtocolPolicy: allow-all | https-only | redirect-to-https, /* required */
          AllowedMethods: {
            Items: [ /* required */
              GET | HEAD | POST | PUT | PATCH | OPTIONS | DELETE,
              /* more items */
            ],
            Quantity: 'NUMBER_VALUE', /* required */
            CachedMethods: {
              Items: [ /* required */
                GET | HEAD | POST | PUT | PATCH | OPTIONS | DELETE,
                /* more items */
              ],
              Quantity: 'NUMBER_VALUE' /* required */
            }
          },
          CachePolicyId: 'STRING_VALUE',
          Compress: true || false,
          DefaultTTL: 'NUMBER_VALUE',
          FieldLevelEncryptionId: 'STRING_VALUE',
          ForwardedValues: {
            Cookies: { /* required */
              Forward: none | whitelist | all, /* required */
              WhitelistedNames: {
                Quantity: 'NUMBER_VALUE', /* required */
                Items: [
                  'STRING_VALUE',
                  /* more items */
                ]
              }
            },
            QueryString: true || false, /* required */
            Headers: {
              Quantity: 'NUMBER_VALUE', /* required */
              Items: [
                'STRING_VALUE',
                /* more items */
              ]
            },
            QueryStringCacheKeys: {
              Quantity: 'NUMBER_VALUE', /* required */
              Items: [
                'STRING_VALUE',
                /* more items */
              ]
            }
          },
          LambdaFunctionAssociations: {
            Quantity: 'NUMBER_VALUE', /* required */
            Items: [
              {
                EventType: viewer-request | viewer-response | origin-request | origin-response, /* required */
                LambdaFunctionARN: 'STRING_VALUE', /* required */
                IncludeBody: true || false
              },
              /* more items */
            ]
          },
          MaxTTL: 'NUMBER_VALUE',
          MinTTL: 'NUMBER_VALUE',
          OriginRequestPolicyId: 'STRING_VALUE',
          RealtimeLogConfigArn: 'STRING_VALUE',
          SmoothStreaming: true || false,
          TrustedKeyGroups: {
            Enabled: true || false, /* required */
            Quantity: 'NUMBER_VALUE', /* required */
            Items: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          TrustedSigners: {
            Enabled: true || false, /* required */
            Quantity: 'NUMBER_VALUE', /* required */
            Items: [
              'STRING_VALUE',
              /* more items */
            ]
          }
        },
        /* more items */
      ]
    },
    CustomErrorResponses: {
      Quantity: 'NUMBER_VALUE', /* required */
      Items: [
        {
          ErrorCode: 'NUMBER_VALUE', /* required */
          ErrorCachingMinTTL: 'NUMBER_VALUE',
          ResponseCode: 'STRING_VALUE',
          ResponsePagePath: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    DefaultRootObject: 'STRING_VALUE',
    HttpVersion: http1.1 | http2,
    IsIPV6Enabled: true || false,
    Logging: {
      Bucket: 'STRING_VALUE', /* required */
      Enabled: true || false, /* required */
      IncludeCookies: true || false, /* required */
      Prefix: 'STRING_VALUE' /* required */
    },
    OriginGroups: {
      Quantity: 'NUMBER_VALUE', /* required */
      Items: [
        {
          FailoverCriteria: { /* required */
            StatusCodes: { /* required */
              Items: [ /* required */
                'NUMBER_VALUE',
                /* more items */
              ],
              Quantity: 'NUMBER_VALUE' /* required */
            }
          },
          Id: 'STRING_VALUE', /* required */
          Members: { /* required */
            Items: [ /* required */
              {
                OriginId: 'STRING_VALUE' /* required */
              },
              /* more items */
            ],
            Quantity: 'NUMBER_VALUE' /* required */
          }
        },
        /* more items */
      ]
    },
    PriceClass: PriceClass_100 | PriceClass_200 | PriceClass_All,
    Restrictions: {
      GeoRestriction: { /* required */
        Quantity: 'NUMBER_VALUE', /* required */
        RestrictionType: blacklist | whitelist | none, /* required */
        Items: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    ViewerCertificate: {
      ACMCertificateArn: 'STRING_VALUE',
      Certificate: 'STRING_VALUE',
      CertificateSource: cloudfront | iam | acm,
      CloudFrontDefaultCertificate: true || false,
      IAMCertificateId: 'STRING_VALUE',
      MinimumProtocolVersion: SSLv3 | TLSv1 | TLSv1_2016 | TLSv1.1_2016 | TLSv1.2_2018 | TLSv1.2_2019,
      SSLSupportMethod: sni-only | vip | static-ip
    },
    WebACLId: 'STRING_VALUE'
  }
};
cloudfront.createDistribution(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DistributionConfig — (map)

      The distribution's configuration information.

      • CallerReference — required — (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 — (map)

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

        • Quantity — required — (Integer)

          The number of CNAME aliases, if any, that you want to associate with this distribution.

        • Items — (Array<String>)

          A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.

      • DefaultRootObject — (String)

        The object that you want CloudFront to request from your origin (for example, index.html) when a viewer requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/product-description.html). Specifying a default root object avoids exposing the contents of your distribution.

        Specify only the object name, for example, index.html. Don't add a / before the object name.

        If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element.

        To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element.

        To replace the default root object, update the distribution configuration and specify the new object.

        For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide.

      • Origins — required — (map)

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

        • Quantity — required — (Integer)

          The number of origins for this distribution.

        • Items — required — (Array<map>)

          A list of origins.

          • Id — required — (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 — required — (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 — (map)

            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 — required — (Integer)

              The number of custom headers, if any, for this distribution.

            • Items — (Array<map>)

              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.

              • HeaderName — required — (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 — required — (String)

                The value for the header that you specified in the HeaderName field.

          • S3OriginConfig — (map)

            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 — required — (String)

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

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

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

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

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

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

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

          • CustomOriginConfig — (map)

            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 — required — (Integer)

              The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.

            • HTTPSPort — required — (Integer)

              The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.

            • OriginProtocolPolicy — required — (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.

              Possible values include:
              • "http-only"
              • "match-viewer"
              • "https-only"
            • OriginSslProtocols — (map)

              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 — required — (Integer)

                The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.

              • Items — required — (Array<String>)

                A list that contains allowed SSL/TLS protocols for this distribution.

            • OriginReadTimeout — (Integer)

              Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 30 seconds.

              For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide.

            • OriginKeepaliveTimeout — (Integer)

              Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 5 seconds.

              For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide.

          • ConnectionAttempts — (Integer)

            The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don’t specify otherwise) is 3.

            For a custom origin (including an Amazon S3 bucket that’s configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout.

            For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide.

          • ConnectionTimeout — (Integer)

            The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don’t specify otherwise) is 10 seconds.

            For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide.

          • OriginShield — (map)

            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 — required — (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 AWS Region for Origin Shield.

              Specify the AWS 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 AWS Region for Origin Shield. For the list of AWS Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the AWS Region for Origin Shield in the Amazon CloudFront Developer Guide.

      • OriginGroups — (map)

        A complex type that contains information about origin groups for this distribution.

        • Quantity — required — (Integer)

          The number of origin groups.

        • Items — (Array<map>)

          The items (origin groups) in a distribution.

          • Id — required — (String)

            The origin group's ID.

          • FailoverCriteria — required — (map)

            A complex type that contains information about the failover criteria for an origin group.

            • StatusCodes — required — (map)

              The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.

              • Quantity — required — (Integer)

                The number of status codes.

              • Items — required — (Array<Integer>)

                The items (status codes) for an origin group.

          • Members — required — (map)

            A complex type that contains information about the origins in an origin group.

            • Quantity — required — (Integer)

              The number of origins in an origin group.

            • Items — required — (Array<map>)

              Items (origins) in an origin group.

              • OriginId — required — (String)

                The ID for an origin in an origin group.

      • DefaultCacheBehavior — required — (map)

        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 — required — (String)

          The value of ID for the origin that you want CloudFront to route requests to when they use the default cache behavior.

        • TrustedSigners — (map)

          We recommend using TrustedKeyGroups instead of TrustedSigners.

          A list of AWS 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 AWS 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 — required — (Boolean)

            This field is true if any of the AWS accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.

          • Quantity — required — (Integer)

            The number of AWS accounts in the list.

          • Items — (Array<String>)

            A list of AWS account identifiers.

        • TrustedKeyGroups — (map)

          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 — required — (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 — required — (Integer)

            The number of key groups in the list.

          • Items — (Array<String>)

            A list of key groups identifiers.

        • ViewerProtocolPolicy — required — (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.
          Possible values include:
          • "allow-all"
          • "https-only"
          • "redirect-to-https"
        • AllowedMethods — (map)

          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 — required — (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 — required — (Array<String>)

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

          • CachedMethods — (map)

            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 — required — (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 — required — (Array<String>)

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

        • SmoothStreaming — (Boolean)

          Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

        • Compress — (Boolean)

          Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

        • LambdaFunctionAssociations — (map)

          A complex type that contains zero or more Lambda function associations for a cache behavior.

          • Quantity — required — (Integer)

            The number of Lambda function associations for this cache behavior.

          • Items — (Array<map>)

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

            • LambdaFunctionARN — required — (String)

              The ARN of the Lambda function. You must specify the ARN of a function version; you can't specify a Lambda alias or $LATEST.

            • EventType — required — (String)

              Specifies the event type that triggers a Lambda 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.

              Possible values include:
              • "viewer-request"
              • "viewer-response"
              • "origin-request"
              • "origin-response"
            • IncludeBody — (Boolean)

              A flag that allows a Lambda 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.

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

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

        • ForwardedValues — (map)

          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 complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.

          • QueryString — required — (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 — required — (map)

            This field 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 — required — (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.

              Possible values include:
              • "none"
              • "whitelist"
              • "all"
            • WhitelistedNames — (map)

              This field 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 AWS General Reference.

              • Quantity — required — (Integer)

                The number of cookie names in the Items list.

              • Items — (Array<String>)

                A list of cookie names.

          • Headers — (map)

            This field 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 — required — (Integer)

              The number of header names in the Items list.

            • Items — (Array<String>)

              A list of HTTP header names.

          • QueryStringCacheKeys — (map)

            This field 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 — required — (Integer)

              The number of whitelisted query string parameters for a cache behavior.

            • Items — (Array<String>)

              A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items.

        • MinTTL — (Integer)

          This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

          The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

          You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

        • DefaultTTL — (Integer)

          This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

          The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

        • MaxTTL — (Integer)

          This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

          The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

      • CacheBehaviors — (map)

        A complex type that contains zero or more CacheBehavior elements.

        • Quantity — required — (Integer)

          The number of cache behaviors for this distribution.

        • Items — (Array<map>)

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

          • PathPattern — required — (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 — required — (String)

            The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.

          • TrustedSigners — (map)

            We recommend using TrustedKeyGroups instead of TrustedSigners.

            A list of AWS 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 AWS 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 — required — (Boolean)

              This field is true if any of the AWS accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.

            • Quantity — required — (Integer)

              The number of AWS accounts in the list.

            • Items — (Array<String>)

              A list of AWS account identifiers.

          • TrustedKeyGroups — (map)

            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 — required — (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 — required — (Integer)

              The number of key groups in the list.

            • Items — (Array<String>)

              A list of key groups identifiers.

          • ViewerProtocolPolicy — required — (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.
            Possible values include:
            • "allow-all"
            • "https-only"
            • "redirect-to-https"
          • AllowedMethods — (map)

            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 — required — (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 — required — (Array<String>)

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

            • CachedMethods — (map)

              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 — required — (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 — required — (Array<String>)

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

          • SmoothStreaming — (Boolean)

            Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

          • Compress — (Boolean)

            Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

          • LambdaFunctionAssociations — (map)

            A complex type that contains zero or more Lambda function associations for a cache behavior.

            • Quantity — required — (Integer)

              The number of Lambda function associations for this cache behavior.

            • Items — (Array<map>)

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

              • LambdaFunctionARN — required — (String)

                The ARN of the Lambda function. You must specify the ARN of a function version; you can't specify a Lambda alias or $LATEST.

              • EventType — required — (String)

                Specifies the event type that triggers a Lambda 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.

                Possible values include:
                • "viewer-request"
                • "viewer-response"
                • "origin-request"
                • "origin-response"
              • IncludeBody — (Boolean)

                A flag that allows a Lambda 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.

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

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

          • ForwardedValues — (map)

            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 complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.

            • QueryString — required — (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 — required — (map)

              This field 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 — required — (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.

                Possible values include:
                • "none"
                • "whitelist"
                • "all"
              • WhitelistedNames — (map)

                This field 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 AWS General Reference.

                • Quantity — required — (Integer)

                  The number of cookie names in the Items list.

                • Items — (Array<String>)

                  A list of cookie names.

            • Headers — (map)

              This field 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 — required — (Integer)

                The number of header names in the Items list.

              • Items — (Array<String>)

                A list of HTTP header names.

            • QueryStringCacheKeys — (map)

              This field 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 — required — (Integer)

                The number of whitelisted query string parameters for a cache behavior.

              • Items — (Array<String>)

                A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items.

          • MinTTL — (Integer)

            This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

            The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

            You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

          • DefaultTTL — (Integer)

            This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

            The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

          • MaxTTL — (Integer)

            This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

            The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

      • CustomErrorResponses — (map)

        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 — required — (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 — (Array<map>)

          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.

          • ErrorCode — required — (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 — required — (String)

        Any comments you want to include about the distribution.

        If you don't want to specify a comment, include an empty Comment element.

        To delete an existing comment, update the distribution configuration and include an empty Comment element.

        To add or change a comment, update the distribution configuration and specify the new comment.

      • Logging — (map)

        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 — required — (Boolean)

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

        • IncludeCookies — required — (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 — required — (String)

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

        • Prefix — required — (String)

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

      • PriceClass — (String)

        The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations.

        If you specify a price class other than PriceClass_All, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.

        For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing.

        Possible values include:
        • "PriceClass_100"
        • "PriceClass_200"
        • "PriceClass_All"
      • Enabled — required — (Boolean)

        From this field, you can enable or disable the selected distribution.

      • ViewerCertificate — (map)

        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)

          If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in AWS Identity and Access Management (AWS IAM), provide the ID of the IAM certificate.

          If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVerison and SSLSupportMethod.

        • ACMCertificateArn — (String)

          If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in AWS 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 MinimumProtocolVerison 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 AWS Support Center.

          If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net, don’t set a value for this field.

          Possible values include:
          • "sni-only"
          • "vip"
          • "static-ip"
        • 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.

          Possible values include:
          • "SSLv3"
          • "TLSv1"
          • "TLSv1_2016"
          • "TLSv1.1_2016"
          • "TLSv1.2_2018"
          • "TLSv1.2_2019"
        • 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

          Possible values include:
          • "cloudfront"
          • "iam"
          • "acm"
      • Restrictions — (map)

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

        • GeoRestriction — required — (map)

          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 — required — (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.

            Possible values include:
            • "blacklist"
            • "whitelist"
            • "none"
          • Quantity — required — (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 — (Array<String>)

            A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist).

            The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country.

            CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.

      • WebACLId — (String)

        A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a.

        AWS 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 AWS WAF, see the AWS WAF Developer Guide.

      • HttpVersion — (String)

        (Optional) 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 automatically use an earlier HTTP version.

        For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).

        In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for "http/2 optimization."

        Possible values include:
        • "http1.1"
        • "http2"
      • IsIPV6Enabled — (Boolean)

        If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true. If you specify false, CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.

        In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide.

        If you're using an Amazon Route 53 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 Amazon Route 53 Developer Guide.

        If you created a CNAME resource record set, either with Amazon Route 53 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Distribution — (map)

        The distribution's information.

        • Id — required — (String)

          The identifier for the distribution. For example: EDFDVBD632BHDS5.

        • ARN — required — (String)

          The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

        • Status — required — (String)

          This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated to all CloudFront edge locations.

        • LastModifiedTime — required — (Date)

          The date and time the distribution was last modified.

        • InProgressInvalidationBatches — required — (Integer)

          The number of invalidation batches currently in progress.

        • DomainName — required — (String)

          The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.

        • ActiveTrustedSigners — (map)

          We recommend using TrustedKeyGroups instead of TrustedSigners.

          CloudFront automatically adds this field to the response if you’ve configured a cache behavior in this distribution to serve private content using trusted signers. This field contains a list of AWS 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 — required — (Boolean)

            This field is true if any of the AWS accounts in the list have active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.

          • Quantity — required — (Integer)

            The number of AWS accounts in the list.

          • Items — (Array<map>)

            A list of AWS 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.

            • AwsAccountNumber — (String)

              An AWS account number that contains active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If the AWS account that owns the key pairs is the same account that owns the CloudFront distribution, the value of this field is self.

            • KeyPairIds — (map)

              A list of CloudFront key pair identifiers.

              • Quantity — required — (Integer)

                The number of key pair identifiers in the list.

              • Items — (Array<String>)

                A list of CloudFront key pair identifiers.

        • ActiveTrustedKeyGroups — (map)

          CloudFront automatically adds this field to the response if you’ve configured a cache behavior in this distribution to serve private content using key groups. This field contains a list of key groups and the public keys in each key group that CloudFront can use to verify the signatures of signed URLs or signed cookies.

          • Enabled — required — (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 — required — (Integer)

            The number of key groups in the list.

          • Items — (Array<map>)

            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.

            • KeyGroupId — (String)

              The identifier of the key group that contains the public keys.

            • KeyPairIds — (map)

              A list of CloudFront key pair identifiers.

              • Quantity — required — (Integer)

                The number of key pair identifiers in the list.

              • Items — (Array<String>)

                A list of CloudFront key pair identifiers.

        • DistributionConfig — required — (map)

          The current configuration information for the distribution. Send a GET request to the /CloudFront API version/distribution ID/config resource.

          • CallerReference — required — (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 — (map)

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

            • Quantity — required — (Integer)

              The number of CNAME aliases, if any, that you want to associate with this distribution.

            • Items — (Array<String>)

              A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.

          • DefaultRootObject — (String)

            The object that you want CloudFront to request from your origin (for example, index.html) when a viewer requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/product-description.html). Specifying a default root object avoids exposing the contents of your distribution.

            Specify only the object name, for example, index.html. Don't add a / before the object name.

            If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element.

            To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element.

            To replace the default root object, update the distribution configuration and specify the new object.

            For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide.

          • Origins — required — (map)

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

            • Quantity — required — (Integer)

              The number of origins for this distribution.

            • Items — required — (Array<map>)

              A list of origins.

              • Id — required — (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 — required — (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 — (map)

                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 — required — (Integer)

                  The number of custom headers, if any, for this distribution.

                • Items — (Array<map>)

                  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.

                  • HeaderName — required — (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 — required — (String)

                    The value for the header that you specified in the HeaderName field.

              • S3OriginConfig — (map)

                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 — required — (String)

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

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

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

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

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

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

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

              • CustomOriginConfig — (map)

                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 — required — (Integer)

                  The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.

                • HTTPSPort — required — (Integer)

                  The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.

                • OriginProtocolPolicy — required — (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.

                  Possible values include:
                  • "http-only"
                  • "match-viewer"
                  • "https-only"
                • OriginSslProtocols — (map)

                  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 — required — (Integer)

                    The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.

                  • Items — required — (Array<String>)

                    A list that contains allowed SSL/TLS protocols for this distribution.

                • OriginReadTimeout — (Integer)

                  Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 30 seconds.

                  For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide.

                • OriginKeepaliveTimeout — (Integer)

                  Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 5 seconds.

                  For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide.

              • ConnectionAttempts — (Integer)

                The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don’t specify otherwise) is 3.

                For a custom origin (including an Amazon S3 bucket that’s configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout.

                For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide.

              • ConnectionTimeout — (Integer)

                The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don’t specify otherwise) is 10 seconds.

                For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide.

              • OriginShield — (map)

                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 — required — (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 AWS Region for Origin Shield.

                  Specify the AWS 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 AWS Region for Origin Shield. For the list of AWS Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the AWS Region for Origin Shield in the Amazon CloudFront Developer Guide.

          • OriginGroups — (map)

            A complex type that contains information about origin groups for this distribution.

            • Quantity — required — (Integer)

              The number of origin groups.

            • Items — (Array<map>)

              The items (origin groups) in a distribution.

              • Id — required — (String)

                The origin group's ID.

              • FailoverCriteria — required — (map)

                A complex type that contains information about the failover criteria for an origin group.

                • StatusCodes — required — (map)

                  The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.

                  • Quantity — required — (Integer)

                    The number of status codes.

                  • Items — required — (Array<Integer>)

                    The items (status codes) for an origin group.

              • Members — required — (map)

                A complex type that contains information about the origins in an origin group.

                • Quantity — required — (Integer)

                  The number of origins in an origin group.

                • Items — required — (Array<map>)

                  Items (origins) in an origin group.

                  • OriginId — required — (String)

                    The ID for an origin in an origin group.

          • DefaultCacheBehavior — required — (map)

            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 — required — (String)

              The value of ID for the origin that you want CloudFront to route requests to when they use the default cache behavior.

            • TrustedSigners — (map)

              We recommend using TrustedKeyGroups instead of TrustedSigners.

              A list of AWS 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 AWS 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 — required — (Boolean)

                This field is true if any of the AWS accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.

              • Quantity — required — (Integer)

                The number of AWS accounts in the list.

              • Items — (Array<String>)

                A list of AWS account identifiers.

            • TrustedKeyGroups — (map)

              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 — required — (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 — required — (Integer)

                The number of key groups in the list.

              • Items — (Array<String>)

                A list of key groups identifiers.

            • ViewerProtocolPolicy — required — (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.
              Possible values include:
              • "allow-all"
              • "https-only"
              • "redirect-to-https"
            • AllowedMethods — (map)

              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 — required — (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 — required — (Array<String>)

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

              • CachedMethods — (map)

                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 — required — (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 — required — (Array<String>)

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

            • SmoothStreaming — (Boolean)

              Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

            • Compress — (Boolean)

              Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

            • LambdaFunctionAssociations — (map)

              A complex type that contains zero or more Lambda function associations for a cache behavior.

              • Quantity — required — (Integer)

                The number of Lambda function associations for this cache behavior.

              • Items — (Array<map>)

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

                • LambdaFunctionARN — required — (String)

                  The ARN of the Lambda function. You must specify the ARN of a function version; you can't specify a Lambda alias or $LATEST.

                • EventType — required — (String)

                  Specifies the event type that triggers a Lambda 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.

                  Possible values include:
                  • "viewer-request"
                  • "viewer-response"
                  • "origin-request"
                  • "origin-response"
                • IncludeBody — (Boolean)

                  A flag that allows a Lambda 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.

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

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

            • ForwardedValues — (map)

              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 complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.

              • QueryString — required — (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 — required — (map)

                This field 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 — required — (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.

                  Possible values include:
                  • "none"
                  • "whitelist"
                  • "all"
                • WhitelistedNames — (map)

                  This field 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 AWS General Reference.

                  • Quantity — required — (Integer)

                    The number of cookie names in the Items list.

                  • Items — (Array<String>)

                    A list of cookie names.

              • Headers — (map)

                This field 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 — required — (Integer)

                  The number of header names in the Items list.

                • Items — (Array<String>)

                  A list of HTTP header names.

              • QueryStringCacheKeys — (map)

                This field 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 — required — (Integer)

                  The number of whitelisted query string parameters for a cache behavior.

                • Items — (Array<String>)

                  A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items.

            • MinTTL — (Integer)

              This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

              The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

              You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

            • DefaultTTL — (Integer)

              This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

              The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

            • MaxTTL — (Integer)

              This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

              The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

          • CacheBehaviors — (map)

            A complex type that contains zero or more CacheBehavior elements.

            • Quantity — required — (Integer)

              The number of cache behaviors for this distribution.

            • Items — (Array<map>)

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

              • PathPattern — required — (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 — required — (String)

                The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.

              • TrustedSigners — (map)

                We recommend using TrustedKeyGroups instead of TrustedSigners.

                A list of AWS 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 AWS 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 — required — (Boolean)

                  This field is true if any of the AWS accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.

                • Quantity — required — (Integer)

                  The number of AWS accounts in the list.

                • Items — (Array<String>)

                  A list of AWS account identifiers.

              • TrustedKeyGroups — (map)

                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 — required — (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 — required — (Integer)

                  The number of key groups in the list.

                • Items — (Array<String>)

                  A list of key groups identifiers.

              • ViewerProtocolPolicy — required — (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.
                Possible values include:
                • "allow-all"
                • "https-only"
                • "redirect-to-https"
              • AllowedMethods — (map)

                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 — required — (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 — required — (Array<String>)

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

                • CachedMethods — (map)

                  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 — required — (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 — required — (Array<String>)

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

              • SmoothStreaming — (Boolean)

                Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

              • Compress — (Boolean)

                Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

              • LambdaFunctionAssociations — (map)

                A complex type that contains zero or more Lambda function associations for a cache behavior.

                • Quantity — required — (Integer)

                  The number of Lambda function associations for this cache behavior.

                • Items — (Array<map>)

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

                  • LambdaFunctionARN — required — (String)

                    The ARN of the Lambda function. You must specify the ARN of a function version; you can't specify a Lambda alias or $LATEST.

                  • EventType — required — (String)

                    Specifies the event type that triggers a Lambda 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.

                    Possible values include:
                    • "viewer-request"
                    • "viewer-response"
                    • "origin-request"
                    • "origin-response"
                  • IncludeBody — (Boolean)

                    A flag that allows a Lambda 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.

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

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

              • ForwardedValues — (map)

                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 complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.

                • QueryString — required — (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 — required — (map)

                  This field 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 — required — (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.

                    Possible values include:
                    • "none"
                    • "whitelist"
                    • "all"
                  • WhitelistedNames — (map)

                    This field 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 AWS General Reference.

                    • Quantity — required — (Integer)

                      The number of cookie names in the Items list.

                    • Items — (Array<String>)

                      A list of cookie names.

                • Headers — (map)

                  This field 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 — required — (Integer)

                    The number of header names in the Items list.

                  • Items — (Array<String>)

                    A list of HTTP header names.

                • QueryStringCacheKeys — (map)

                  This field 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 — required — (Integer)

                    The number of whitelisted query string parameters for a cache behavior.

                  • Items — (Array<String>)

                    A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items.

              • MinTTL — (Integer)

                This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

                The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

                You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

              • DefaultTTL — (Integer)

                This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

                The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

              • MaxTTL — (Integer)

                This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

                The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

          • CustomErrorResponses — (map)

            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 — required — (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 — (Array<map>)

              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.

              • ErrorCode — required — (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 — required — (String)

            Any comments you want to include about the distribution.

            If you don't want to specify a comment, include an empty Comment element.

            To delete an existing comment, update the distribution configuration and include an empty Comment element.

            To add or change a comment, update the distribution configuration and specify the new comment.

          • Logging — (map)

            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 — required — (Boolean)

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

            • IncludeCookies — required — (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 — required — (String)

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

            • Prefix — required — (String)

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

          • PriceClass — (String)

            The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations.

            If you specify a price class other than PriceClass_All, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.

            For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing.

            Possible values include:
            • "PriceClass_100"
            • "PriceClass_200"
            • "PriceClass_All"
          • Enabled — required — (Boolean)

            From this field, you can enable or disable the selected distribution.

          • ViewerCertificate — (map)

            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)

              If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in AWS Identity and Access Management (AWS IAM), provide the ID of the IAM certificate.

              If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVerison and SSLSupportMethod.

            • ACMCertificateArn — (String)

              If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in AWS 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 MinimumProtocolVerison 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 AWS Support Center.

              If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net, don’t set a value for this field.

              Possible values include:
              • "sni-only"
              • "vip"
              • "static-ip"
            • 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.

              Possible values include:
              • "SSLv3"
              • "TLSv1"
              • "TLSv1_2016"
              • "TLSv1.1_2016"
              • "TLSv1.2_2018"
              • "TLSv1.2_2019"
            • 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

              Possible values include:
              • "cloudfront"
              • "iam"
              • "acm"
          • Restrictions — (map)

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

            • GeoRestriction — required — (map)

              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 — required — (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.

                Possible values include:
                • "blacklist"
                • "whitelist"
                • "none"
              • Quantity — required — (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 — (Array<String>)

                A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist).

                The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country.

                CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.

          • WebACLId — (String)

            A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a.

            AWS 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 AWS WAF, see the AWS WAF Developer Guide.

          • HttpVersion — (String)

            (Optional) 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 automatically use an earlier HTTP version.

            For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).

            In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for "http/2 optimization."

            Possible values include:
            • "http1.1"
            • "http2"
          • IsIPV6Enabled — (Boolean)

            If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true. If you specify false, CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.

            In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide.

            If you're using an Amazon Route 53 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 Amazon Route 53 Developer Guide.

            If you created a CNAME resource record set, either with Amazon Route 53 or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.

        • AliasICPRecordals — (Array<map>)

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

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

          • CNAME — (String)

            A domain name associated with a distribution.

          • ICPRecordalStatus — (String)

            The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in regions outside of China.

            The status values returned are the following:

            • 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 China region, 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.

            Possible values include:
            • "APPROVED"
            • "SUSPENDED"
            • "PENDING"
      • Location — (String)

        The fully qualified URI of the new distribution resource just created.

      • ETag — (String)

        The current version of the distribution created.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createDistributionWithTags(params = {}, callback) ⇒ AWS.Request

Create a new distribution with tags.

Service Reference:

Examples:

Calling the createDistributionWithTags operation

var params = {
  DistributionConfigWithTags: { /* required */
    DistributionConfig: { /* required */
      CallerReference: 'STRING_VALUE', /* required */
      Comment: 'STRING_VALUE', /* required */
      DefaultCacheBehavior: { /* required */
        TargetOriginId: 'STRING_VALUE', /* required */
        ViewerProtocolPolicy: allow-all | https-only | redirect-to-https, /* required */
        AllowedMethods: {
          Items: [ /* required */
            GET | HEAD | POST | PUT | PATCH | OPTIONS | DELETE,
            /* more items */
          ],
          Quantity: 'NUMBER_VALUE', /* required */
          CachedMethods: {
            Items: [ /* required */
              GET | HEAD | POST | PUT | PATCH | OPTIONS | DELETE,
              /* more items */
            ],
            Quantity: 'NUMBER_VALUE' /* required */
          }
        },
        CachePolicyId: 'STRING_VALUE',
        Compress: true || false,
        DefaultTTL: 'NUMBER_VALUE',
        FieldLevelEncryptionId: 'STRING_VALUE',
        ForwardedValues: {
          Cookies: { /* required */
            Forward: none | whitelist | all, /* required */
            WhitelistedNames: {
              Quantity: 'NUMBER_VALUE', /* required */
              Items: [
                'STRING_VALUE',
                /* more items */
              ]
            }
          },
          QueryString: true || false, /* required */
          Headers: {
            Quantity: 'NUMBER_VALUE', /* required */
            Items: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          QueryStringCacheKeys: {
            Quantity: 'NUMBER_VALUE', /* required */
            Items: [
              'STRING_VALUE',
              /* more items */
            ]
          }
        },
        LambdaFunctionAssociations: {
          Quantity: 'NUMBER_VALUE', /* required */
          Items: [
            {
              EventType: viewer-request | viewer-response | origin-request | origin-response, /* required */
              LambdaFunctionARN: 'STRING_VALUE', /* required */
              IncludeBody: true || false
            },
            /* more items */
          ]
        },
        MaxTTL: 'NUMBER_VALUE',
        MinTTL: 'NUMBER_VALUE',
        OriginRequestPolicyId: 'STRING_VALUE',
        RealtimeLogConfigArn: 'STRING_VALUE',
        SmoothStreaming: true || false,
        TrustedKeyGroups: {
          Enabled: true || false, /* required */
          Quantity: 'NUMBER_VALUE', /* required */
          Items: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        TrustedSigners: {
          Enabled: true || false, /* required */
          Quantity: 'NUMBER_VALUE', /* required */
          Items: [
            'STRING_VALUE',
            /* more items */
          ]
        }
      },
      Enabled: true || false, /* required */
      Origins: { /* required */
        Items: [ /* required */
          {
            DomainName: 'STRING_VALUE', /* required */
            Id: 'STRING_VALUE', /* required */
            ConnectionAttempts: 'NUMBER_VALUE',
            ConnectionTimeout: 'NUMBER_VALUE',
            CustomHeaders: {
              Quantity: 'NUMBER_VALUE', /* required */
              Items: [
                {
                  HeaderName: 'STRING_VALUE', /* required */
                  HeaderValue: 'STRING_VALUE' /* required */
                },
                /* more items */
              ]
            },
            CustomOriginConfig: {
              HTTPPort: 'NUMBER_VALUE', /* required */
              HTTPSPort: 'NUMBER_VALUE', /* required */
              OriginProtocolPolicy: http-only | match-viewer | https-only, /* required */
              OriginKeepaliveTimeout: 'NUMBER_VALUE',
              OriginReadTimeout: 'NUMBER_VALUE',
              OriginSslProtocols: {
                Items: [ /* required */
                  SSLv3 | TLSv1 | TLSv1.1 | TLSv1.2,
                  /* more items */
                ],
                Quantity: 'NUMBER_VALUE' /* required */
              }
            },
            OriginPath: 'STRING_VALUE',
            OriginShield: {
              Enabled: true || false, /* required */
              OriginShieldRegion: 'STRING_VALUE'
            },
            S3OriginConfig: {
              OriginAccessIdentity: 'STRING_VALUE' /* required */
            }
          },
          /* more items */
        ],
        Quantity: 'NUMBER_VALUE' /* required */
      },
      Aliases: {
        Quantity: 'NUMBER_VALUE', /* required */
        Items: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      CacheBehaviors: {
        Quantity: 'NUMBER_VALUE', /* required */
        Items: [
          {
            PathPattern: 'STRING_VALUE', /* required */
            TargetOriginId: 'STRING_VALUE', /* required */
            ViewerProtocolPolicy: allow-all | https-only | redirect-to-https, /* required */
            AllowedMethods: {
              Items: [ /* required */
                GET | HEAD | POST | PUT | PATCH | OPTIONS | DELETE,
                /* more items */
              ],
              Quantity: 'NUMBER_VALUE', /* required */
              CachedMethods: {
                Items: [ /* required */
                  GET | HEAD | POST | PUT | PATCH | OPTIONS | DELETE,
                  /* more items */
                ],
                Quantity: 'NUMBER_VALUE' /* required */
              }
            },
            CachePolicyId: 'STRING_VALUE',
            Compress: true || false,
            DefaultTTL: 'NUMBER_VALUE',
            FieldLevelEncryptionId: 'STRING_VALUE',
            ForwardedValues: {
              Cookies: { /* required */
                Forward: none | whitelist | all, /* required */
                WhitelistedNames: {
                  Quantity: 'NUMBER_VALUE', /* required */
                  Items: [
                    'STRING_VALUE',
                    /* more items */
                  ]
                }
              },
              QueryString: true || false, /* required */
              Headers: {
                Quantity: 'NUMBER_VALUE', /* required */
                Items: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              QueryStringCacheKeys: {
                Quantity: 'NUMBER_VALUE', /* required */
                Items: [
                  'STRING_VALUE',
                  /* more items */
                ]
              }
            },
            LambdaFunctionAssociations: {
              Quantity: 'NUMBER_VALUE', /* required */
              Items: [
                {
                  EventType: viewer-request | viewer-response | origin-request | origin-response, /* required */
                  LambdaFunctionARN: 'STRING_VALUE', /* required */
                  IncludeBody: true || false
                },
                /* more items */
              ]
            },
            MaxTTL: 'NUMBER_VALUE',
            MinTTL: 'NUMBER_VALUE',
            OriginRequestPolicyId: 'STRING_VALUE',
            RealtimeLogConfigArn: 'STRING_VALUE',
            SmoothStreaming: true || false,
            TrustedKeyGroups: {
              Enabled: true || false, /* required */
              Quantity: 'NUMBER_VALUE', /* required */
              Items: [
                'STRING_VALUE',
                /* more items */
              ]
            },
            TrustedSigners: {
              Enabled: true || false, /* required */
              Quantity: 'NUMBER_VALUE', /* required */
              Items: [
                'STRING_VALUE',
                /* more items */
              ]
            }
          },
          /* more items */
        ]
      },
      CustomErrorResponses: {
        Quantity: 'NUMBER_VALUE', /* required */
        Items: [
          {
            ErrorCode: 'NUMBER_VALUE', /* required */
            ErrorCachingMinTTL: 'NUMBER_VALUE',
            ResponseCode: 'STRING_VALUE',
            ResponsePagePath: 'STRING_VALUE'
          },
          /* more items */
        ]
      },
      DefaultRootObject: 'STRING_VALUE',
      HttpVersion: http1.1 | http2,
      IsIPV6Enabled: true || false,
      Logging: {
        Bucket: 'STRING_VALUE', /* required */
        Enabled: true || false, /* required */
        IncludeCookies: true || false, /* required */
        Prefix: 'STRING_VALUE' /* required */
      },
      OriginGroups: {
        Quantity: 'NUMBER_VALUE', /* required */
        Items: [
          {
            FailoverCriteria: { /* required */
              StatusCodes: { /* required */
                Items: [ /* required */
                  'NUMBER_VALUE',
                  /* more items */
                ],
                Quantity: 'NUMBER_VALUE' /* required */
              }
            },
            Id: 'STRING_VALUE', /* required */
            Members: { /* required */
              Items: [ /* required */
                {
                  OriginId: 'STRING_VALUE' /* required */
                },
                /* more items */
              ],
              Quantity: 'NUMBER_VALUE' /* required */
            }
          },
          /* more items */
        ]
      },
      PriceClass: PriceClass_100 | PriceClass_200 | PriceClass_All,
      Restrictions: {
        GeoRestriction: { /* required */
          Quantity: 'NUMBER_VALUE', /* required */
          RestrictionType: blacklist | whitelist | none, /* required */
          Items: [
            'STRING_VALUE',
            /* more items */
          ]
        }
      },
      ViewerCertificate: {
        ACMCertificateArn: 'STRING_VALUE',
        Certificate: 'STRING_VALUE',
        CertificateSource: cloudfront | iam | acm,
        CloudFrontDefaultCertificate: true || false,
        IAMCertificateId: 'STRING_VALUE',
        MinimumProtocolVersion: SSLv3 | TLSv1 | TLSv1_2016 | TLSv1.1_2016 | TLSv1.2_2018 | TLSv1.2_2019,
        SSLSupportMethod: sni-only | vip | static-ip
      },
      WebACLId: 'STRING_VALUE'
    },
    Tags: { /* required */
      Items: [
        {
          Key: 'STRING_VALUE', /* required */
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    }
  }
};
cloudfront.createDistributionWithTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DistributionConfigWithTags — (map)

      The distribution's configuration information.

      • DistributionConfig — required — (map)

        A distribution configuration.

        • CallerReference — required — (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 — (map)

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

          • Quantity — required — (Integer)

            The number of CNAME aliases, if any, that you want to associate with this distribution.

          • Items — (Array<String>)

            A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.

        • DefaultRootObject — (String)

          The object that you want CloudFront to request from your origin (for example, index.html) when a viewer requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/product-description.html). Specifying a default root object avoids exposing the contents of your distribution.

          Specify only the object name, for example, index.html. Don't add a / before the object name.

          If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element.

          To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element.

          To replace the default root object, update the distribution configuration and specify the new object.

          For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide.

        • Origins — required — (map)

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

          • Quantity — required — (Integer)

            The number of origins for this distribution.

          • Items — required — (Array<map>)

            A list of origins.

            • Id — required — (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 — required — (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 — (map)

              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 — required — (Integer)

                The number of custom headers, if any, for this distribution.

              • Items — (Array<map>)

                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.

                • HeaderName — required — (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 — required — (String)

                  The value for the header that you specified in the HeaderName field.

            • S3OriginConfig — (map)

              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 — required — (String)

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

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

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

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

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

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

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

            • CustomOriginConfig — (map)

              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 — required — (Integer)

                The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.

              • HTTPSPort — required — (Integer)

                The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.

              • OriginProtocolPolicy — required — (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.

                Possible values include:
                • "http-only"
                • "match-viewer"
                • "https-only"
              • OriginSslProtocols — (map)

                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 — required — (Integer)

                  The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.

                • Items — required — (Array<String>)

                  A list that contains allowed SSL/TLS protocols for this distribution.

              • OriginReadTimeout — (Integer)

                Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 30 seconds.

                For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide.

              • OriginKeepaliveTimeout — (Integer)

                Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 5 seconds.

                For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide.

            • ConnectionAttempts — (Integer)

              The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don’t specify otherwise) is 3.

              For a custom origin (including an Amazon S3 bucket that’s configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout.

              For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide.

            • ConnectionTimeout — (Integer)

              The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don’t specify otherwise) is 10 seconds.

              For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide.

            • OriginShield — (map)

              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 — required — (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 AWS Region for Origin Shield.

                Specify the AWS 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 AWS Region for Origin Shield. For the list of AWS Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the AWS Region for Origin Shield in the Amazon CloudFront Developer Guide.

        • OriginGroups — (map)

          A complex type that contains information about origin groups for this distribution.

          • Quantity — required — (Integer)

            The number of origin groups.

          • Items — (Array<map>)

            The items (origin groups) in a distribution.

            • Id — required — (String)

              The origin group's ID.

            • FailoverCriteria — required — (map)

              A complex type that contains information about the failover criteria for an origin group.

              • StatusCodes — required — (map)

                The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.

                • Quantity — required — (Integer)

                  The number of status codes.

                • Items — required — (Array<Integer>)

                  The items (status codes) for an origin group.

            • Members — required — (map)

              A complex type that contains information about the origins in an origin group.

              • Quantity — required — (Integer)

                The number of origins in an origin group.

              • Items — required — (Array<map>)

                Items (origins) in an origin group.

                • OriginId — required — (String)

                  The ID for an origin in an origin group.

        • DefaultCacheBehavior — required — (map)

          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 — required — (String)

            The value of ID for the origin that you want CloudFront to route requests to when they use the default cache behavior.

          • TrustedSigners — (map)

            We recommend using TrustedKeyGroups instead of TrustedSigners.

            A list of AWS 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 AWS 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 — required — (Boolean)

              This field is true if any of the AWS accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.

            • Quantity — required — (Integer)

              The number of AWS accounts in the list.

            • Items — (Array<String>)

              A list of AWS account identifiers.

          • TrustedKeyGroups — (map)

            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 — required — (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 — required — (Integer)

              The number of key groups in the list.

            • Items — (Array<String>)

              A list of key groups identifiers.

          • ViewerProtocolPolicy — required — (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.
            Possible values include:
            • "allow-all"
            • "https-only"
            • "redirect-to-https"
          • AllowedMethods — (map)

            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 — required — (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 — required — (Array<String>)

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

            • CachedMethods — (map)

              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 — required — (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 — required — (Array<String>)

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

          • SmoothStreaming — (Boolean)

            Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

          • Compress — (Boolean)

            Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

          • LambdaFunctionAssociations — (map)

            A complex type that contains zero or more Lambda function associations for a cache behavior.

            • Quantity — required — (Integer)

              The number of Lambda function associations for this cache behavior.

            • Items — (Array<map>)

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

              • LambdaFunctionARN — required — (String)

                The ARN of the Lambda function. You must specify the ARN of a function version; you can't specify a Lambda alias or $LATEST.

              • EventType — required — (String)

                Specifies the event type that triggers a Lambda 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.

                Possible values include:
                • "viewer-request"
                • "viewer-response"
                • "origin-request"
                • "origin-response"
              • IncludeBody — (Boolean)

                A flag that allows a Lambda 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.

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

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

          • ForwardedValues — (map)

            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 complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.

            • QueryString — required — (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 — required — (map)

              This field 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 — required — (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.

                Possible values include:
                • "none"
                • "whitelist"
                • "all"
              • WhitelistedNames — (map)

                This field 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 AWS General Reference.

                • Quantity — required — (Integer)

                  The number of cookie names in the Items list.

                • Items — (Array<String>)

                  A list of cookie names.

            • Headers — (map)

              This field 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 — required — (Integer)

                The number of header names in the Items list.

              • Items — (Array<String>)

                A list of HTTP header names.

            • QueryStringCacheKeys — (map)

              This field 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 — required — (Integer)

                The number of whitelisted query string parameters for a cache behavior.

              • Items — (Array<String>)

                A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items.

          • MinTTL — (Integer)

            This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

            The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

            You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

          • DefaultTTL — (Integer)

            This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

            The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

          • MaxTTL — (Integer)

            This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

            The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

        • CacheBehaviors — (map)

          A complex type that contains zero or more CacheBehavior elements.

          • Quantity — required — (Integer)

            The number of cache behaviors for this distribution.

          • Items — (Array<map>)

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

            • PathPattern — required — (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 — required — (String)

              The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.

            • TrustedSigners — (map)

              We recommend using TrustedKeyGroups instead of TrustedSigners.

              A list of AWS 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 AWS 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 — required — (Boolean)

                This field is true if any of the AWS accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.

              • Quantity — required — (Integer)

                The number of AWS accounts in the list.

              • Items — (Array<String>)

                A list of AWS account identifiers.

            • TrustedKeyGroups — (map)

              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 — required — (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 — required — (Integer)

                The number of key groups in the list.

              • Items — (Array<String>)

                A list of key groups identifiers.

            • ViewerProtocolPolicy — required — (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.
              Possible values include:
              • "allow-all"
              • "https-only"
              • "redirect-to-https"
            • AllowedMethods — (map)

              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 — required — (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 — required — (Array<String>)

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

              • CachedMethods — (map)

                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 — required — (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 — required — (Array<String>)

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

            • SmoothStreaming — (Boolean)

              Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

            • Compress — (Boolean)

              Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

            • LambdaFunctionAssociations — (map)

              A complex type that contains zero or more Lambda function associations for a cache behavior.

              • Quantity — required — (Integer)

                The number of Lambda function associations for this cache behavior.

              • Items — (Array<map>)

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

                • LambdaFunctionARN — required — (String)

                  The ARN of the Lambda function. You must specify the ARN of a function version; you can't specify a Lambda alias or $LATEST.

                • EventType — required — (String)

                  Specifies the event type that triggers a Lambda 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.

                  Possible values include:
                  • "viewer-request"
                  • "viewer-response"
                  • "origin-request"
                  • "origin-response"
                • IncludeBody — (Boolean)

                  A flag that allows a Lambda 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.

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

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

            • ForwardedValues — (map)

              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 complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.

              • QueryString — required — (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 — required — (map)

                This field 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 — required — (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.

                  Possible values include:
                  • "none"
                  • "whitelist"
                  • "all"
                • WhitelistedNames — (map)

                  This field 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 AWS General Reference.

                  • Quantity — required — (Integer)

                    The number of cookie names in the Items list.

                  • Items — (Array<String>)

                    A list of cookie names.

              • Headers — (map)

                This field 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 — required — (Integer)

                  The number of header names in the Items list.

                • Items — (Array<String>)

                  A list of HTTP header names.

              • QueryStringCacheKeys — (map)

                This field 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 — required — (Integer)

                  The number of whitelisted query string parameters for a cache behavior.

                • Items — (Array<String>)

                  A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items.

            • MinTTL — (Integer)

              This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

              The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

              You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

            • DefaultTTL — (Integer)

              This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

              The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

            • MaxTTL — (Integer)

              This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

              The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

        • CustomErrorResponses — (map)

          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 — required — (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 — (Array<map>)

            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.

            • ErrorCode — required — (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 — required — (String)

          Any comments you want to include about the distribution.

          If you don't want to specify a comment, include an empty Comment element.

          To delete an existing comment, update the distribution configuration and include an empty Comment element.

          To add or change a comment, update the distribution configuration and specify the new comment.

        • Logging — (map)

          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 — required — (Boolean)

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

          • IncludeCookies — required — (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 — required — (String)

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

          • Prefix — required — (String)

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

        • PriceClass — (String)

          The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations.

          If you specify a price class other than PriceClass_All, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.

          For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing.

          Possible values include:
          • "PriceClass_100"
          • "PriceClass_200"
          • "PriceClass_All"
        • Enabled — required — (Boolean)

          From this field, you can enable or disable the selected distribution.

        • ViewerCertificate — (map)

          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)

            If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in AWS Identity and Access Management (AWS IAM), provide the ID of the IAM certificate.

            If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVerison and SSLSupportMethod.

          • ACMCertificateArn — (String)

            If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in AWS 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 MinimumProtocolVerison 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 AWS Support Center.

            If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net, don’t set a value for this field.

            Possible values include:
            • "sni-only"
            • "vip"
            • "static-ip"
          • 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.

            Possible values include:
            • "SSLv3"
            • "TLSv1"
            • "TLSv1_2016"
            • "TLSv1.1_2016"
            • "TLSv1.2_2018"
            • "TLSv1.2_2019"
          • 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

            Possible values include:
            • "cloudfront"
            • "iam"
            • "acm"
        • Restrictions — (map)

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

          • GeoRestriction — required — (map)

            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 — required — (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.

              Possible values include:
              • "blacklist"
              • "whitelist"
              • "none"
            • Quantity — required — (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 — (Array<String>)

              A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist).

              The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country.

              CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.

        • WebACLId — (String)

          A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a.

          AWS 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 AWS WAF, see the AWS WAF Developer Guide.

        • HttpVersion — (String)

          (Optional) 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 automatically use an earlier HTTP version.

          For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).

          In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for "http/2 optimization."

          Possible values include:
          • "http1.1"
          • "http2"
        • IsIPV6Enabled — (Boolean)

          If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true. If you specify false, CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.

          In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide.

          If you're using an Amazon Route 53 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 Amazon Route 53 Developer Guide.

          If you created a CNAME resource record set, either with Amazon Route 53 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.

      • Tags — required — (map)

        A complex type that contains zero or more Tag elements.

        • Items — (Array<map>)

          A complex type that contains Tag elements.

          • Key — required — (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 _ - . : / = + @.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Distribution — (map)

        The distribution's information.

        • Id — required — (String)

          The identifier for the distribution. For example: EDFDVBD632BHDS5.

        • ARN — required — (String)

          The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

        • Status — required — (String)

          This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated to all CloudFront edge locations.

        • LastModifiedTime — required — (Date)

          The date and time the distribution was last modified.

        • InProgressInvalidationBatches — required — (Integer)

          The number of invalidation batches currently in progress.

        • DomainName — required — (String)

          The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.

        • ActiveTrustedSigners — (map)

          We recommend using TrustedKeyGroups instead of TrustedSigners.

          CloudFront automatically adds this field to the response if you’ve configured a cache behavior in this distribution to serve private content using trusted signers. This field contains a list of AWS 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 — required — (Boolean)

            This field is true if any of the AWS accounts in the list have active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.

          • Quantity — required — (Integer)

            The number of AWS accounts in the list.

          • Items — (Array<map>)

            A list of AWS 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.

            • AwsAccountNumber — (String)

              An AWS account number that contains active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If the AWS account that owns the key pairs is the same account that owns the CloudFront distribution, the value of this field is self.

            • KeyPairIds — (map)

              A list of CloudFront key pair identifiers.

              • Quantity — required — (Integer)

                The number of key pair identifiers in the list.

              • Items — (Array<String>)

                A list of CloudFront key pair identifiers.

        • ActiveTrustedKeyGroups — (map)

          CloudFront automatically adds this field to the response if you’ve configured a cache behavior in this distribution to serve private content using key groups. This field contains a list of key groups and the public keys in each key group that CloudFront can use to verify the signatures of signed URLs or signed cookies.

          • Enabled — required — (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 — required — (Integer)

            The number of key groups in the list.

          • Items — (Array<map>)

            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.

            • KeyGroupId — (String)

              The identifier of the key group that contains the public keys.

            • KeyPairIds — (map)

              A list of CloudFront key pair identifiers.

              • Quantity — required — (Integer)

                The number of key pair identifiers in the list.

              • Items — (Array<String>)

                A list of CloudFront key pair identifiers.

        • DistributionConfig — required — (map)

          The current configuration information for the distribution. Send a GET request to the /CloudFront API version/distribution ID/config resource.

          • CallerReference — required — (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 — (map)

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

            • Quantity — required — (Integer)

              The number of CNAME aliases, if any, that you want to associate with this distribution.

            • Items — (Array<String>)

              A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.

          • DefaultRootObject — (String)

            The object that you want CloudFront to request from your origin (for example, index.html) when a viewer requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/product-description.html). Specifying a default root object avoids exposing the contents of your distribution.

            Specify only the object name, for example, index.html. Don't add a / before the object name.

            If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element.

            To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element.

            To replace the default root object, update the distribution configuration and specify the new object.

            For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide.

          • Origins — required — (map)

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

            • Quantity — required — (Integer)

              The number of origins for this distribution.

            • Items — required — (Array<map>)

              A list of origins.

              • Id — required — (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 — required — (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 — (map)

                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 — required — (Integer)

                  The number of custom headers, if any, for this distribution.

                • Items — (Array<map>)

                  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.

                  • HeaderName — required — (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 — required — (String)

                    The value for the header that you specified in the HeaderName field.

              • S3OriginConfig — (map)

                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 — required — (String)

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

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

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

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

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

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

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

              • CustomOriginConfig — (map)

                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 — required — (Integer)

                  The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.

                • HTTPSPort — required — (Integer)

                  The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.

                • OriginProtocolPolicy — required — (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.

                  Possible values include:
                  • "http-only"
                  • "match-viewer"
                  • "https-only"
                • OriginSslProtocols — (map)

                  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 — required — (Integer)

                    The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.

                  • Items — required — (Array<String>)

                    A list that contains allowed SSL/TLS protocols for this distribution.

                • OriginReadTimeout — (Integer)

                  Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 30 seconds.

                  For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide.

                • OriginKeepaliveTimeout — (Integer)

                  Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 5 seconds.

                  For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide.

              • ConnectionAttempts — (Integer)

                The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don’t specify otherwise) is 3.

                For a custom origin (including an Amazon S3 bucket that’s configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout.

                For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide.

              • ConnectionTimeout — (Integer)

                The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don’t specify otherwise) is 10 seconds.

                For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide.

              • OriginShield — (map)

                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 — required — (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 AWS Region for Origin Shield.

                  Specify the AWS 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 AWS Region for Origin Shield. For the list of AWS Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the AWS Region for Origin Shield in the Amazon CloudFront Developer Guide.

          • OriginGroups — (map)

            A complex type that contains information about origin groups for this distribution.

            • Quantity — required — (Integer)

              The number of origin groups.

            • Items — (Array<map>)

              The items (origin groups) in a distribution.

              • Id — required — (String)

                The origin group's ID.

              • FailoverCriteria — required — (map)

                A complex type that contains information about the failover criteria for an origin group.

                • StatusCodes — required — (map)

                  The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.

                  • Quantity — required — (Integer)

                    The number of status codes.

                  • Items — required — (Array<Integer>)

                    The items (status codes) for an origin group.

              • Members — required — (map)

                A complex type that contains information about the origins in an origin group.

                • Quantity — required — (Integer)

                  The number of origins in an origin group.

                • Items — required — (Array<map>)

                  Items (origins) in an origin group.

                  • OriginId — required — (String)

                    The ID for an origin in an origin group.

          • DefaultCacheBehavior — required — (map)

            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 — required — (String)

              The value of ID for the origin that you want CloudFront to route requests to when they use the default cache behavior.

            • TrustedSigners — (map)

              We recommend using TrustedKeyGroups instead of TrustedSigners.

              A list of AWS 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 AWS 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 — required — (Boolean)

                This field is true if any of the AWS accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.

              • Quantity — required — (Integer)

                The number of AWS accounts in the list.

              • Items — (Array<String>)

                A list of AWS account identifiers.

            • TrustedKeyGroups — (map)

              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 — required — (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 — required — (Integer)

                The number of key groups in the list.

              • Items — (Array<String>)

                A list of key groups identifiers.

            • ViewerProtocolPolicy — required — (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.
              Possible values include:
              • "allow-all"
              • "https-only"
              • "redirect-to-https"
            • AllowedMethods — (map)

              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 — required — (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 — required — (Array<String>)

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

              • CachedMethods — (map)

                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 — required — (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 — required — (Array<String>)

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

            • SmoothStreaming — (Boolean)

              Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

            • Compress — (Boolean)

              Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

            • LambdaFunctionAssociations — (map)

              A complex type that contains zero or more Lambda function associations for a cache behavior.

              • Quantity — required — (Integer)

                The number of Lambda function associations for this cache behavior.

              • Items — (Array<map>)

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

                • LambdaFunctionARN — required — (String)

                  The ARN of the Lambda function. You must specify the ARN of a function version; you can't specify a Lambda alias or $LATEST.

                • EventType — required — (String)

                  Specifies the event type that triggers a Lambda 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.

                  Possible values include:
                  • "viewer-request"
                  • "viewer-response"
                  • "origin-request"
                  • "origin-response"
                • IncludeBody — (Boolean)

                  A flag that allows a Lambda 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.

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

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

            • ForwardedValues — (map)

              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 complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.

              • QueryString — required — (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 — required — (map)

                This field 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 — required — (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.

                  Possible values include:
                  • "none"
                  • "whitelist"
                  • "all"
                • WhitelistedNames — (map)

                  This field 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 AWS General Reference.

                  • Quantity — required — (Integer)

                    The number of cookie names in the Items list.

                  • Items — (Array<String>)

                    A list of cookie names.

              • Headers — (map)

                This field 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 — required — (Integer)

                  The number of header names in the Items list.

                • Items — (Array<String>)

                  A list of HTTP header names.

              • QueryStringCacheKeys — (map)

                This field 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 — required — (Integer)

                  The number of whitelisted query string parameters for a cache behavior.

                • Items — (Array<String>)

                  A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items.

            • MinTTL — (Integer)

              This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

              The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

              You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

            • DefaultTTL — (Integer)

              This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

              The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

            • MaxTTL — (Integer)

              This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

              The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

          • CacheBehaviors — (map)

            A complex type that contains zero or more CacheBehavior elements.

            • Quantity — required — (Integer)

              The number of cache behaviors for this distribution.

            • Items — (Array<map>)

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

              • PathPattern — required — (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 — required — (String)

                The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.

              • TrustedSigners — (map)

                We recommend using TrustedKeyGroups instead of TrustedSigners.

                A list of AWS 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 AWS 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 — required — (Boolean)

                  This field is true if any of the AWS accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.

                • Quantity — required — (Integer)

                  The number of AWS accounts in the list.

                • Items — (Array<String>)

                  A list of AWS account identifiers.

              • TrustedKeyGroups — (map)

                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 — required — (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 — required — (Integer)

                  The number of key groups in the list.

                • Items — (Array<String>)

                  A list of key groups identifiers.

              • ViewerProtocolPolicy — required — (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.
                Possible values include:
                • "allow-all"
                • "https-only"
                • "redirect-to-https"
              • AllowedMethods — (map)

                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 — required — (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 — required — (Array<String>)

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

                • CachedMethods — (map)

                  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 — required — (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 — required — (Array<String>)

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

              • SmoothStreaming — (Boolean)

                Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

              • Compress — (Boolean)

                Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

              • LambdaFunctionAssociations — (map)

                A complex type that contains zero or more Lambda function associations for a cache behavior.

                • Quantity — required — (Integer)

                  The number of Lambda function associations for this cache behavior.

                • Items — (Array<map>)

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

                  • LambdaFunctionARN — required — (String)

                    The ARN of the Lambda function. You must specify the ARN of a function version; you can't specify a Lambda alias or $LATEST.

                  • EventType — required — (String)

                    Specifies the event type that triggers a Lambda 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.

                    Possible values include:
                    • "viewer-request"
                    • "viewer-response"
                    • "origin-request"
                    • "origin-response"
                  • IncludeBody — (Boolean)

                    A flag that allows a Lambda 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.

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

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

              • ForwardedValues — (map)

                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 complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.

                • QueryString — required — (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 — required — (map)

                  This field 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 — required — (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.

                    Possible values include:
                    • "none"
                    • "whitelist"
                    • "all"
                  • WhitelistedNames — (map)

                    This field 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 AWS General Reference.

                    • Quantity — required — (Integer)

                      The number of cookie names in the Items list.

                    • Items — (Array<String>)

                      A list of cookie names.

                • Headers — (map)

                  This field 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 — required — (Integer)

                    The number of header names in the Items list.

                  • Items — (Array<String>)

                    A list of HTTP header names.

                • QueryStringCacheKeys — (map)

                  This field 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 — required — (Integer)

                    The number of whitelisted query string parameters for a cache behavior.

                  • Items — (Array<String>)

                    A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items.

              • MinTTL — (Integer)

                This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

                The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

                You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

              • DefaultTTL — (Integer)

                This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

                The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

              • MaxTTL — (Integer)

                This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

                The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

          • CustomErrorResponses — (map)

            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 — required — (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 — (Array<map>)

              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.

              • ErrorCode — required — (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 — required — (String)

            Any comments you want to include about the distribution.

            If you don't want to specify a comment, include an empty Comment element.

            To delete an existing comment, update the distribution configuration and include an empty Comment element.

            To add or change a comment, update the distribution configuration and specify the new comment.

          • Logging — (map)

            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 — required — (Boolean)

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

            • IncludeCookies — required — (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 — required — (String)

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

            • Prefix — required — (String)

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

          • PriceClass — (String)

            The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations.

            If you specify a price class other than PriceClass_All, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.

            For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing.

            Possible values include:
            • "PriceClass_100"
            • "PriceClass_200"
            • "PriceClass_All"
          • Enabled — required — (Boolean)

            From this field, you can enable or disable the selected distribution.

          • ViewerCertificate — (map)

            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)

              If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in AWS Identity and Access Management (AWS IAM), provide the ID of the IAM certificate.

              If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVerison and SSLSupportMethod.

            • ACMCertificateArn — (String)

              If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in AWS 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 MinimumProtocolVerison 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 AWS Support Center.

              If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net, don’t set a value for this field.

              Possible values include:
              • "sni-only"
              • "vip"
              • "static-ip"
            • 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.

              Possible values include:
              • "SSLv3"
              • "TLSv1"
              • "TLSv1_2016"
              • "TLSv1.1_2016"
              • "TLSv1.2_2018"
              • "TLSv1.2_2019"
            • 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

              Possible values include:
              • "cloudfront"
              • "iam"
              • "acm"
          • Restrictions — (map)

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

            • GeoRestriction — required — (map)

              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 — required — (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.

                Possible values include:
                • "blacklist"
                • "whitelist"
                • "none"
              • Quantity — required — (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 — (Array<String>)

                A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist).

                The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country.

                CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.

          • WebACLId — (String)

            A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a.

            AWS 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 AWS WAF, see the AWS WAF Developer Guide.

          • HttpVersion — (String)

            (Optional) 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 automatically use an earlier HTTP version.

            For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).

            In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for "http/2 optimization."

            Possible values include:
            • "http1.1"
            • "http2"
          • IsIPV6Enabled — (Boolean)

            If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true. If you specify false, CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.

            In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide.

            If you're using an Amazon Route 53 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 Amazon Route 53 Developer Guide.

            If you created a CNAME resource record set, either with Amazon Route 53 or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.

        • AliasICPRecordals — (Array<map>)

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

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

          • CNAME — (String)

            A domain name associated with a distribution.

          • ICPRecordalStatus — (String)

            The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in regions outside of China.

            The status values returned are the following:

            • 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 China region, 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.

            Possible values include:
            • "APPROVED"
            • "SUSPENDED"
            • "PENDING"
      • Location — (String)

        The fully qualified URI of the new distribution resource just created.

      • ETag — (String)

        The current version of the distribution created.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createFieldLevelEncryptionConfig(params = {}, callback) ⇒ AWS.Request

Create a new field-level encryption configuration.

Service Reference:

Examples:

Calling the createFieldLevelEncryptionConfig operation

var params = {
  FieldLevelEncryptionConfig: { /* required */
    CallerReference: 'STRING_VALUE', /* required */
    Comment: 'STRING_VALUE',
    ContentTypeProfileConfig: {
      ForwardWhenContentTypeIsUnknown: true || false, /* required */
      ContentTypeProfiles: {
        Quantity: 'NUMBER_VALUE', /* required */
        Items: [
          {
            ContentType: 'STRING_VALUE', /* required */
            Format: URLEncoded, /* required */
            ProfileId: 'STRING_VALUE'
          },
          /* more items */
        ]
      }
    },
    QueryArgProfileConfig: {
      ForwardWhenQueryArgProfileIsUnknown: true || false, /* required */
      QueryArgProfiles: {
        Quantity: 'NUMBER_VALUE', /* required */
        Items: [
          {
            ProfileId: 'STRING_VALUE', /* required */
            QueryArg: 'STRING_VALUE' /* required */
          },
          /* more items */
        ]
      }
    }
  }
};
cloudfront.createFieldLevelEncryptionConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • FieldLevelEncryptionConfig — (map)

      The request to create a new field-level encryption configuration.

      • CallerReference — required — (String)

        A unique number that ensures the request can't be replayed.

      • Comment — (String)

        An optional comment about the configuration.

      • QueryArgProfileConfig — (map)

        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 — required — (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 — (map)

          Profiles specified for query argument-profile mapping for field-level encryption.

          • Quantity — required — (Integer)

            Number of profiles for query argument-profile mapping for field-level encryption.

          • Items — (Array<map>)

            Number of items for query argument-profile mapping for field-level encryption.

            • QueryArg — required — (String)

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

            • ProfileId — required — (String)

              ID of profile to use for field-level encryption query argument-profile mapping

      • ContentTypeProfileConfig — (map)

        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 — required — (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 — (map)

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

          • Quantity — required — (Integer)

            The number of field-level encryption content type-profile mappings.

          • Items — (Array<map>)

            Items in a field-level encryption content type-profile mapping.

            • Format — required — (String)

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

              Possible values include:
              • "URLEncoded"
            • ProfileId — (String)

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

            • ContentType — required — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FieldLevelEncryption — (map)

        Returned when you create a new field-level encryption configuration.

        • Id — required — (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 — required — (Date)

          The last time the field-level encryption configuration was changed.

        • FieldLevelEncryptionConfig — required — (map)

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

          • CallerReference — required — (String)

            A unique number that ensures the request can't be replayed.

          • Comment — (String)

            An optional comment about the configuration.

          • QueryArgProfileConfig — (map)

            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 — required — (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 — (map)

              Profiles specified for query argument-profile mapping for field-level encryption.

              • Quantity — required — (Integer)

                Number of profiles for query argument-profile mapping for field-level encryption.

              • Items — (Array<map>)

                Number of items for query argument-profile mapping for field-level encryption.

                • QueryArg — required — (String)

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

                • ProfileId — required — (String)

                  ID of profile to use for field-level encryption query argument-profile mapping

          • ContentTypeProfileConfig — (map)

            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 — required — (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 — (map)

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

              • Quantity — required — (Integer)

                The number of field-level encryption content type-profile mappings.

              • Items — (Array<map>)

                Items in a field-level encryption content type-profile mapping.

                • Format — required — (String)

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

                  Possible values include:
                  • "URLEncoded"
                • ProfileId — (String)

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

                • ContentType — required — (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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createFieldLevelEncryptionProfile(params = {}, callback) ⇒ AWS.Request

Create a field-level encryption profile.

Service Reference:

Examples:

Calling the createFieldLevelEncryptionProfile operation

var params = {
  FieldLevelEncryptionProfileConfig: { /* required */
    CallerReference: 'STRING_VALUE', /* required */
    EncryptionEntities: { /* required */
      Quantity: 'NUMBER_VALUE', /* required */
      Items: [
        {
          FieldPatterns: { /* required */
            Quantity: 'NUMBER_VALUE', /* required */
            Items: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          ProviderId: 'STRING_VALUE', /* required */
          PublicKeyId: 'STRING_VALUE' /* required */
        },
        /* more items */
      ]
    },
    Name: 'STRING_VALUE', /* required */
    Comment: 'STRING_VALUE'
  }
};
cloudfront.createFieldLevelEncryptionProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • FieldLevelEncryptionProfileConfig — (map)

      The request to create a field-level encryption profile.

      • Name — required — (String)

        Profile name for the field-level encryption profile.

      • CallerReference — required — (String)

        A unique number that ensures that the request can't be replayed.

      • Comment — (String)

        An optional comment for the field-level encryption profile.

      • EncryptionEntities — required — (map)

        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 — required — (Integer)

          Number of field pattern items in a field-level encryption content type-profile mapping.

        • Items — (Array<map>)

          An array of field patterns in a field-level encryption content type-profile mapping.

          • PublicKeyId — required — (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 — required — (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 — required — (map)

            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 — required — (Integer)

              The number of field-level encryption field patterns.

            • Items — (Array<String>)

              An array of the field-level encryption field patterns.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FieldLevelEncryptionProfile — (map)

        Returned when you create a new field-level encryption profile.

        • Id — required — (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 — required — (Date)

          The last time the field-level encryption profile was updated.

        • FieldLevelEncryptionProfileConfig — required — (map)

          A complex data type that includes the profile name and the encryption entities for the field-level encryption profile.

          • Name — required — (String)

            Profile name for the field-level encryption profile.

          • CallerReference — required — (String)

            A unique number that ensures that the request can't be replayed.

          • Comment — (String)

            An optional comment for the field-level encryption profile.

          • EncryptionEntities — required — (map)

            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 — required — (Integer)

              Number of field pattern items in a field-level encryption content type-profile mapping.

            • Items — (Array<map>)

              An array of field patterns in a field-level encryption content type-profile mapping.

              • PublicKeyId — required — (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 — required — (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 — required — (map)

                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 — required — (Integer)

                  The number of field-level encryption field patterns.

                • Items — (Array<String>)

                  An array of the field-level encryption field patterns.

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createInvalidation(params = {}, callback) ⇒ AWS.Request

Create a new invalidation.

Service Reference:

Examples:

Calling the createInvalidation operation

var params = {
  DistributionId: 'STRING_VALUE', /* required */
  InvalidationBatch: { /* required */
    CallerReference: 'STRING_VALUE', /* required */
    Paths: { /* required */
      Quantity: 'NUMBER_VALUE', /* required */
      Items: [
        'STRING_VALUE',
        /* more items */
      ]
    }
  }
};
cloudfront.createInvalidation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DistributionId — (String)

      The distribution's id.

    • InvalidationBatch — (map)

      The batch information for the invalidation.

      • Paths — required — (map)

        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 — required — (Integer)

          The number of invalidation paths specified for the objects that you want to invalidate.

        • Items — (Array<String>)

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

      • CallerReference — required — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Location — (String)

        The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.

      • Invalidation — (map)

        The invalidation's information.

        • Id — required — (String)

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

        • Status — required — (String)

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

        • CreateTime — required — (Date)

          The date and time the invalidation request was first made.

        • InvalidationBatch — required — (map)

          The current invalidation information for the batch request.

          • Paths — required — (map)

            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 — required — (Integer)

              The number of invalidation paths specified for the objects that you want to invalidate.

            • Items — (Array<String>)

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

          • CallerReference — required — (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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createKeyGroup(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createKeyGroup operation

var params = {
  KeyGroupConfig: { /* required */
    Items: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    Name: 'STRING_VALUE', /* required */
    Comment: 'STRING_VALUE'
  }
};
cloudfront.createKeyGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • KeyGroupConfig — (map)

      A key group configuration.

      • Name — required — (String)

        A name to identify the key group.

      • Items — required — (Array<String>)

        A list of the identifiers of the public keys in the key group.

      • Comment — (String)

        A comment to describe the key group.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • KeyGroup — (map)

        The key group that was just created.

        • Id — required — (String)

          The identifier for the key group.

        • LastModifiedTime — required — (Date)

          The date and time when the key group was last modified.

        • KeyGroupConfig — required — (map)

          The key group configuration.

          • Name — required — (String)

            A name to identify the key group.

          • Items — required — (Array<String>)

            A list of the identifiers of the public keys in the key group.

          • Comment — (String)

            A comment to describe the key group.

      • Location — (String)

        The URL of the key group.

      • ETag — (String)

        The identifier for this version of the key group.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createMonitoringSubscription(params = {}, callback) ⇒ AWS.Request

Enables additional CloudWatch metrics for the specified CloudFront distribution. The additional metrics incur an additional cost.

For more information, see Viewing additional CloudFront distribution metrics in the Amazon CloudFront Developer Guide.

Service Reference:

Examples:

Calling the createMonitoringSubscription operation

var params = {
  DistributionId: 'STRING_VALUE', /* required */
  MonitoringSubscription: { /* required */
    RealtimeMetricsSubscriptionConfig: {
      RealtimeMetricsSubscriptionStatus: Enabled | Disabled /* required */
    }
  }
};
cloudfront.createMonitoringSubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DistributionId — (String)

      The ID of the distribution that you are enabling metrics for.

    • MonitoringSubscription — (map)

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

      • RealtimeMetricsSubscriptionConfig — (map)

        A subscription configuration for additional CloudWatch metrics.

        • RealtimeMetricsSubscriptionStatus — required — (String)

          A flag that indicates whether additional CloudWatch metrics are enabled for a given CloudFront distribution.

          Possible values include:
          • "Enabled"
          • "Disabled"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MonitoringSubscription — (map)

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

        • RealtimeMetricsSubscriptionConfig — (map)

          A subscription configuration for additional CloudWatch metrics.

          • RealtimeMetricsSubscriptionStatus — required — (String)

            A flag that indicates whether additional CloudWatch metrics are enabled for a given CloudFront distribution.

            Possible values include:
            • "Enabled"
            • "Disabled"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createOriginRequestPolicy(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createOriginRequestPolicy operation

var params = {
  OriginRequestPolicyConfig: { /* required */
    CookiesConfig: { /* required */
      CookieBehavior: none | whitelist | all, /* required */
      Cookies: {
        Quantity: 'NUMBER_VALUE', /* required */
        Items: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    HeadersConfig: { /* required */
      HeaderBehavior: none | whitelist | allViewer | allViewerAndWhitelistCloudFront, /* required */
      Headers: {
        Quantity: 'NUMBER_VALUE', /* required */
        Items: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    Name: 'STRING_VALUE', /* required */
    QueryStringsConfig: { /* required */
      QueryStringBehavior: none | whitelist | all, /* required */
      QueryStrings: {
        Quantity: 'NUMBER_VALUE', /* required */
        Items: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    Comment: 'STRING_VALUE'
  }
};
cloudfront.createOriginRequestPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • OriginRequestPolicyConfig — (map)

      An origin request policy configuration.

      • Comment — (String)

        A comment to describe the origin request policy.

      • Name — required — (String)

        A unique name to identify the origin request policy.

      • HeadersConfig — required — (map)

        The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.

        • HeaderBehavior — required — (String)

          Determines whether any HTTP headers are included in requests that CloudFront sends to the origin. Valid values are:

          • none – HTTP headers are not included in requests that CloudFront sends to the origin. Even when this field is set to none, any headers that are listed in a CachePolicy are included in origin requests.

          • whitelist – The HTTP headers that are listed in the Headers type are included in requests that CloudFront sends to the origin.

          • allViewer – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin.

          • allViewerAndWhitelistCloudFront – All HTTP headers in viewer requests and the additional CloudFront headers that are listed in the Headers type are included in requests that CloudFront sends to the origin. The additional headers are added by CloudFront.

          Possible values include:
          • "none"
          • "whitelist"
          • "allViewer"
          • "allViewerAndWhitelistCloudFront"
        • Headers — (map)

          Contains a list of HTTP header names.

          • Quantity — required — (Integer)

            The number of header names in the Items list.

          • Items — (Array<String>)

            A list of HTTP header names.

      • CookiesConfig — required — (map)

        The cookies from viewer requests to include in origin requests.

        • CookieBehavior — required — (String)

          Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:

          • none – Cookies in viewer requests are not included in requests that CloudFront sends to the origin. Even when this field is set to none, any cookies that are listed in a CachePolicy are included in origin requests.

          • whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in requests that CloudFront sends to the origin.

          • all – All cookies in viewer requests are included in requests that CloudFront sends to the origin.

          Possible values include:
          • "none"
          • "whitelist"
          • "all"
        • Cookies — (map)

          Contains a list of cookie names.

          • Quantity — required — (Integer)

            The number of cookie names in the Items list.

          • Items — (Array<String>)

            A list of cookie names.

      • QueryStringsConfig — required — (map)

        The URL query strings from viewer requests to include in origin requests.

        • QueryStringBehavior — required — (String)

          Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:

          • none – Query strings in viewer requests are not included in requests that CloudFront sends to the origin. Even when this field is set to none, any query strings that are listed in a CachePolicy are included in origin requests.

          • whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in requests that CloudFront sends to the origin.

          • all – All query strings in viewer requests are included in requests that CloudFront sends to the origin.

          Possible values include:
          • "none"
          • "whitelist"
          • "all"
        • QueryStrings — (map)

          Contains a list of the query strings in viewer requests that are included in requests that CloudFront sends to the origin.

          • Quantity — required — (Integer)

            The number of query string names in the Items list.

          • Items — (Array<String>)

            A list of query string names.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OriginRequestPolicy — (map)

        An origin request policy.

        • Id — required — (String)

          The unique identifier for the origin request policy.

        • LastModifiedTime — required — (Date)

          The date and time when the origin request policy was last modified.

        • OriginRequestPolicyConfig — required — (map)

          The origin request policy configuration.

          • Comment — (String)

            A comment to describe the origin request policy.

          • Name — required — (String)

            A unique name to identify the origin request policy.

          • HeadersConfig — required — (map)

            The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.

            • HeaderBehavior — required — (String)

              Determines whether any HTTP headers are included in requests that CloudFront sends to the origin. Valid values are:

              • none – HTTP headers are not included in requests that CloudFront sends to the origin. Even when this field is set to none, any headers that are listed in a CachePolicy are included in origin requests.

              • whitelist – The HTTP headers that are listed in the Headers type are included in requests that CloudFront sends to the origin.

              • allViewer – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin.

              • allViewerAndWhitelistCloudFront – All HTTP headers in viewer requests and the additional CloudFront headers that are listed in the Headers type are included in requests that CloudFront sends to the origin. The additional headers are added by CloudFront.

              Possible values include:
              • "none"
              • "whitelist"
              • "allViewer"
              • "allViewerAndWhitelistCloudFront"
            • Headers — (map)

              Contains a list of HTTP header names.

              • Quantity — required — (Integer)

                The number of header names in the Items list.

              • Items — (Array<String>)

                A list of HTTP header names.

          • CookiesConfig — required — (map)

            The cookies from viewer requests to include in origin requests.

            • CookieBehavior — required — (String)

              Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:

              • none – Cookies in viewer requests are not included in requests that CloudFront sends to the origin. Even when this field is set to none, any cookies that are listed in a CachePolicy are included in origin requests.

              • whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in requests that CloudFront sends to the origin.

              • all – All cookies in viewer requests are included in requests that CloudFront sends to the origin.

              Possible values include:
              • "none"
              • "whitelist"
              • "all"
            • Cookies — (map)

              Contains a list of cookie names.

              • Quantity — required — (Integer)

                The number of cookie names in the Items list.

              • Items — (Array<String>)

                A list of cookie names.

          • QueryStringsConfig — required — (map)

            The URL query strings from viewer requests to include in origin requests.

            • QueryStringBehavior — required — (String)

              Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:

              • none – Query strings in viewer requests are not included in requests that CloudFront sends to the origin. Even when this field is set to none, any query strings that are listed in a CachePolicy are included in origin requests.

              • whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in requests that CloudFront sends to the origin.

              • all – All query strings in viewer requests are included in requests that CloudFront sends to the origin.

              Possible values include:
              • "none"
              • "whitelist"
              • "all"
            • QueryStrings — (map)

              Contains a list of the query strings in viewer requests that are included in requests that CloudFront sends to the origin.

              • Quantity — required — (Integer)

                The number of query string names in the Items list.

              • Items — (Array<String>)

                A list of query string names.

      • Location — (String)

        The fully qualified URI of the origin request policy just created.

      • ETag — (String)

        The current version of the origin request policy.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createPublicKey(params = {}, callback) ⇒ AWS.Request

Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.

Service Reference:

Examples:

Calling the createPublicKey operation

var params = {
  PublicKeyConfig: { /* required */
    CallerReference: 'STRING_VALUE', /* required */
    EncodedKey: 'STRING_VALUE', /* required */
    Name: 'STRING_VALUE', /* required */
    Comment: 'STRING_VALUE'
  }
};
cloudfront.createPublicKey(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PublicKeyConfig — (map)

      A CloudFront public key configuration.

      • CallerReference — required — (String)

        A string included in the request to help make sure that the request can’t be replayed.

      • Name — required — (String)

        A name to help identify the public key.

      • EncodedKey — required — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PublicKey — (map)

        The public key.

        • Id — required — (String)

          The identifier of the public key.

        • CreatedTime — required — (Date)

          The date and time when the public key was uploaded.

        • PublicKeyConfig — required — (map)

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

          • CallerReference — required — (String)

            A string included in the request to help make sure that the request can’t be replayed.

          • Name — required — (String)

            A name to help identify the public key.

          • EncodedKey — required — (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.

      • Location — (String)

        The URL of the public key.

      • ETag — (String)

        The identifier for this version of the public key.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createRealtimeLogConfig(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createRealtimeLogConfig operation

var params = {
  EndPoints: [ /* required */
    {
      StreamType: 'STRING_VALUE', /* required */
      KinesisStreamConfig: {
        RoleARN: 'STRING_VALUE', /* required */
        StreamARN: 'STRING_VALUE' /* required */
      }
    },
    /* more items */
  ],
  Fields: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Name: 'STRING_VALUE', /* required */
  SamplingRate: 'NUMBER_VALUE' /* required */
};
cloudfront.createRealtimeLogConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • EndPoints — (Array<map>)

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

      • StreamType — required — (String)

        The type of data stream where you are sending real-time log data. The only valid value is Kinesis.

      • KinesisStreamConfig — (map)

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

        • RoleARN — required — (String)

          The Amazon Resource Name (ARN) of an AWS 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 — required — (String)

          The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data.

    • Fields — (Array<String>)

      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.

    • Name — (String)

      A unique name to identify 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RealtimeLogConfig — (map)

        A real-time log configuration.

        • ARN — required — (String)

          The Amazon Resource Name (ARN) of this real-time log configuration.

        • Name — required — (String)

          The unique name of this real-time log configuration.

        • SamplingRate — required — (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 — required — (Array<map>)

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

          • StreamType — required — (String)

            The type of data stream where you are sending real-time log data. The only valid value is Kinesis.

          • KinesisStreamConfig — (map)

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

            • RoleARN — required — (String)

              The Amazon Resource Name (ARN) of an AWS 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 — required — (String)

              The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data.

        • Fields — required — (Array<String>)

          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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createStreamingDistribution(params = {}, callback) ⇒ AWS.Request

Creates a new RTMP distribution. An RTMP distribution is similar to a web distribution, but an RTMP distribution streams media files using the Adobe Real-Time Messaging Protocol (RTMP) instead of serving files using HTTP.

To create a new distribution, submit a POST request to the CloudFront API version/distribution resource. The request body must include a document with a StreamingDistributionConfig element. The response echoes the StreamingDistributionConfig element and returns other information about the RTMP distribution.

To get the status of your request, use the GET StreamingDistribution API action. When the value of Enabled is true and the value of Status is Deployed, your distribution is ready. A distribution usually deploys in less than 15 minutes.

For more information about web distributions, see Working with RTMP Distributions in the Amazon CloudFront Developer Guide.

Beginning with the 2012-05-05 version of the CloudFront API, we made substantial changes to the format of the XML document that you include in the request body when you create or update a web distribution or an RTMP distribution, and when you invalidate objects. With previous versions of the API, we discovered that it was too easy to accidentally delete one or more values for an element that accepts multiple values, for example, CNAMEs and trusted signers. Our changes for the 2012-05-05 release are intended to prevent these accidental deletions and to notify you when there's a mismatch between the number of values you say you're specifying in the Quantity element and the number of values specified.

Service Reference:

Examples:

Calling the createStreamingDistribution operation

var params = {
  StreamingDistributionConfig: { /* required */
    CallerReference: 'STRING_VALUE', /* required */
    Comment: 'STRING_VALUE', /* required */
    Enabled: true || false, /* required */
    S3Origin: { /* required */
      DomainName: 'STRING_VALUE', /* required */
      OriginAccessIdentity: 'STRING_VALUE' /* required */
    },
    TrustedSigners: { /* required */
      Enabled: true || false, /* required */
      Quantity: 'NUMBER_VALUE', /* required */
      Items: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    Aliases: {
      Quantity: 'NUMBER_VALUE', /* required */
      Items: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    Logging: {
      Bucket: 'STRING_VALUE', /* required */
      Enabled: true || false, /* required */
      Prefix: 'STRING_VALUE' /* required */
    },
    PriceClass: PriceClass_100 | PriceClass_200 | PriceClass_All
  }
};
cloudfront.createStreamingDistribution(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • StreamingDistributionConfig — (map)

      The streaming distribution's configuration information.

      • CallerReference — required — (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 — required — (map)

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

        • DomainName — required — (String)

          The DNS name of the Amazon S3 origin.

        • OriginAccessIdentity — required — (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 — (map)

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

        • Quantity — required — (Integer)

          The number of CNAME aliases, if any, that you want to associate with this distribution.

        • Items — (Array<String>)

          A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.

      • Comment — required — (String)

        Any comments you want to include about the streaming distribution.

      • Logging — (map)

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

        • Enabled — required — (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 — required — (String)

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

        • Prefix — required — (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 — required — (map)

        A complex type that specifies any AWS 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 — required — (Boolean)

          This field is true if any of the AWS accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.

        • Quantity — required — (Integer)

          The number of AWS accounts in the list.

        • Items — (Array<String>)

          A list of AWS account identifiers.

      • PriceClass — (String)

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

        Possible values include:
        • "PriceClass_100"
        • "PriceClass_200"
        • "PriceClass_All"
      • Enabled — required — (Boolean)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • StreamingDistribution — (map)

        The streaming distribution's information.

        • Id — required — (String)

          The identifier for the RTMP distribution. For example: EGTXBD79EXAMPLE.

        • ARN — required — (String)

          The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

        • Status — required — (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 — (Date)

          The date and time that the distribution was last modified.

        • DomainName — required — (String)

          The domain name that corresponds to the streaming distribution, for example, s5c39gqb8ow64r.cloudfront.net.

        • ActiveTrustedSigners — required — (map)

          A complex type that lists the AWS 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 AWS account number of the trusted signer or self if the signer is the AWS 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 AWS 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 — required — (Boolean)

            This field is true if any of the AWS accounts in the list have active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.

          • Quantity — required — (Integer)

            The number of AWS accounts in the list.

          • Items — (Array<map>)

            A list of AWS 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.

            • AwsAccountNumber — (String)

              An AWS account number that contains active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If the AWS account that owns the key pairs is the same account that owns the CloudFront distribution, the value of this field is self.

            • KeyPairIds — (map)

              A list of CloudFront key pair identifiers.

              • Quantity — required — (Integer)

                The number of key pair identifiers in the list.

              • Items — (Array<String>)

                A list of CloudFront key pair identifiers.

        • StreamingDistributionConfig — required — (map)

          The current configuration information for the RTMP distribution.

          • CallerReference — required — (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 — required — (map)

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

            • DomainName — required — (String)

              The DNS name of the Amazon S3 origin.

            • OriginAccessIdentity — required — (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 — (map)

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

            • Quantity — required — (Integer)

              The number of CNAME aliases, if any, that you want to associate with this distribution.

            • Items — (Array<String>)

              A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.

          • Comment — required — (String)

            Any comments you want to include about the streaming distribution.

          • Logging — (map)

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

            • Enabled — required — (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 — required — (String)

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

            • Prefix — required — (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 — required — (map)

            A complex type that specifies any AWS 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 — required — (Boolean)

              This field is true if any of the AWS accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.

            • Quantity — required — (Integer)

              The number of AWS accounts in the list.

            • Items — (Array<String>)

              A list of AWS account identifiers.

          • PriceClass — (String)

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

            Possible values include:
            • "PriceClass_100"
            • "PriceClass_200"
            • "PriceClass_All"
          • Enabled — required — (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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createStreamingDistributionWithTags(params = {}, callback) ⇒ AWS.Request

Create a new streaming distribution with tags.

Service Reference:

Examples:

Calling the createStreamingDistributionWithTags operation

var params = {
  StreamingDistributionConfigWithTags: { /* required */
    StreamingDistributionConfig: { /* required */
      CallerReference: 'STRING_VALUE', /* required */
      Comment: 'STRING_VALUE', /* required */
      Enabled: true || false, /* required */
      S3Origin: { /* required */
        DomainName: 'STRING_VALUE', /* required */
        OriginAccessIdentity: 'STRING_VALUE' /* required */
      },
      TrustedSigners: { /* required */
        Enabled: true || false, /* required */
        Quantity: 'NUMBER_VALUE', /* required */
        Items: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      Aliases: {
        Quantity: 'NUMBER_VALUE', /* required */
        Items: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      Logging: {
        Bucket: 'STRING_VALUE', /* required */
        Enabled: true || false, /* required */
        Prefix: 'STRING_VALUE' /* required */
      },
      PriceClass: PriceClass_100 | PriceClass_200 | PriceClass_All
    },
    Tags: { /* required */
      Items: [
        {
          Key: 'STRING_VALUE', /* required */
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    }
  }
};
cloudfront.createStreamingDistributionWithTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • StreamingDistributionConfigWithTags — (map)

      The streaming distribution's configuration information.

      • StreamingDistributionConfig — required — (map)

        A streaming distribution Configuration.

        • CallerReference — required — (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 — required — (map)

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

          • DomainName — required — (String)

            The DNS name of the Amazon S3 origin.

          • OriginAccessIdentity — required — (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 — (map)

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

          • Quantity — required — (Integer)

            The number of CNAME aliases, if any, that you want to associate with this distribution.

          • Items — (Array<String>)

            A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.

        • Comment — required — (String)

          Any comments you want to include about the streaming distribution.

        • Logging — (map)

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

          • Enabled — required — (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 — required — (String)

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

          • Prefix — required — (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 — required — (map)

          A complex type that specifies any AWS 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 — required — (Boolean)

            This field is true if any of the AWS accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.

          • Quantity — required — (Integer)

            The number of AWS accounts in the list.

          • Items — (Array<String>)

            A list of AWS account identifiers.

        • PriceClass — (String)

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

          Possible values include:
          • "PriceClass_100"
          • "PriceClass_200"
          • "PriceClass_All"
        • Enabled — required — (Boolean)

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

      • Tags — required — (map)

        A complex type that contains zero or more Tag elements.

        • Items — (Array<map>)

          A complex type that contains Tag elements.

          • Key — required — (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 _ - . : / = + @.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • StreamingDistribution — (map)

        The streaming distribution's information.

        • Id — required — (String)

          The identifier for the RTMP distribution. For example: EGTXBD79EXAMPLE.

        • ARN — required — (String)

          The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

        • Status — required — (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 — (Date)

          The date and time that the distribution was last modified.

        • DomainName — required — (String)

          The domain name that corresponds to the streaming distribution, for example, s5c39gqb8ow64r.cloudfront.net.

        • ActiveTrustedSigners — required — (map)

          A complex type that lists the AWS 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 AWS account number of the trusted signer or self if the signer is the AWS 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 AWS 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 — required — (Boolean)

            This field is true if any of the AWS accounts in the list have active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.

          • Quantity — required — (Integer)

            The number of AWS accounts in the list.

          • Items — (Array<map>)

            A list of AWS 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.

            • AwsAccountNumber — (String)

              An AWS account number that contains active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If the AWS account that owns the key pairs is the same account that owns the CloudFront distribution, the value of this field is self.

            • KeyPairIds — (map)

              A list of CloudFront key pair identifiers.

              • Quantity — required — (Integer)

                The number of key pair identifiers in the list.

              • Items — (Array<String>)

                A list of CloudFront key pair identifiers.

        • StreamingDistributionConfig — required — (map)

          The current configuration information for the RTMP distribution.

          • CallerReference — required — (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 — required — (map)

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

            • DomainName — required — (String)

              The DNS name of the Amazon S3 origin.

            • OriginAccessIdentity — required — (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 — (map)

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

            • Quantity — required — (Integer)

              The number of CNAME aliases, if any, that you want to associate with this distribution.

            • Items — (Array<String>)

              A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.

          • Comment — required — (String)

            Any comments you want to include about the streaming distribution.

          • Logging — (map)

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

            • Enabled — required — (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 — required — (String)

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

            • Prefix — required — (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 — required — (map)

            A complex type that specifies any AWS 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 — required — (Boolean)

              This field is true if any of the AWS accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.

            • Quantity — required — (Integer)

              The number of AWS accounts in the list.

            • Items — (Array<String>)

              A list of AWS account identifiers.

          • PriceClass — (String)

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

            Possible values include:
            • "PriceClass_100"
            • "PriceClass_200"
            • "PriceClass_All"
          • Enabled — required — (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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteCachePolicy(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteCachePolicy operation

var params = {
  Id: 'STRING_VALUE', /* required */
  IfMatch: 'STRING_VALUE'
};
cloudfront.deleteCachePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteCloudFrontOriginAccessIdentity(params = {}, callback) ⇒ AWS.Request

Delete an origin access identity.

Service Reference:

Examples:

Calling the deleteCloudFrontOriginAccessIdentity operation

var params = {
  Id: 'STRING_VALUE', /* required */
  IfMatch: 'STRING_VALUE'
};
cloudfront.deleteCloudFrontOriginAccessIdentity(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteDistribution(params = {}, callback) ⇒ AWS.Request

Delete a distribution.

Service Reference:

Examples:

Calling the deleteDistribution operation

var params = {
  Id: 'STRING_VALUE', /* required */
  IfMatch: 'STRING_VALUE'
};
cloudfront.deleteDistribution(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      The distribution ID.

    • IfMatch — (String)

      The value of the ETag header that you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteFieldLevelEncryptionConfig(params = {}, callback) ⇒ AWS.Request

Remove a field-level encryption configuration.

Service Reference:

Examples:

Calling the deleteFieldLevelEncryptionConfig operation

var params = {
  Id: 'STRING_VALUE', /* required */
  IfMatch: 'STRING_VALUE'
};
cloudfront.deleteFieldLevelEncryptionConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteFieldLevelEncryptionProfile(params = {}, callback) ⇒ AWS.Request

Remove a field-level encryption profile.

Service Reference:

Examples:

Calling the deleteFieldLevelEncryptionProfile operation

var params = {
  Id: 'STRING_VALUE', /* required */
  IfMatch: 'STRING_VALUE'
};
cloudfront.deleteFieldLevelEncryptionProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteKeyGroup(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteKeyGroup operation

var params = {
  Id: 'STRING_VALUE', /* required */
  IfMatch: 'STRING_VALUE'
};
cloudfront.deleteKeyGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteMonitoringSubscription(params = {}, callback) ⇒ AWS.Request

Disables additional CloudWatch metrics for the specified CloudFront distribution.

Service Reference:

Examples:

Calling the deleteMonitoringSubscription operation

var params = {
  DistributionId: 'STRING_VALUE' /* required */
};
cloudfront.deleteMonitoringSubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DistributionId — (String)

      The ID of the distribution that you are disabling metrics for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteOriginRequestPolicy(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteOriginRequestPolicy operation

var params = {
  Id: 'STRING_VALUE', /* required */
  IfMatch: 'STRING_VALUE'
};
cloudfront.deleteOriginRequestPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deletePublicKey(params = {}, callback) ⇒ AWS.Request

Remove a public key you previously added to CloudFront.

Service Reference:

Examples:

Calling the deletePublicKey operation

var params = {
  Id: 'STRING_VALUE', /* required */
  IfMatch: 'STRING_VALUE'
};
cloudfront.deletePublicKey(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteRealtimeLogConfig(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteRealtimeLogConfig operation

var params = {
  ARN: 'STRING_VALUE',
  Name: 'STRING_VALUE'
};
cloudfront.deleteRealtimeLogConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteStreamingDistribution(params = {}, callback) ⇒ AWS.Request

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:

  1. Disable the RTMP distribution.

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

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

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

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

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

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

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

Service Reference:

Examples:

Calling the deleteStreamingDistribution operation

var params = {
  Id: 'STRING_VALUE', /* required */
  IfMatch: 'STRING_VALUE'
};
cloudfront.deleteStreamingDistribution(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      The distribution ID.

    • IfMatch — (String)

      The value of the ETag header that you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getCachePolicy(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getCachePolicy operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
cloudfront.getCachePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CachePolicy — (map)

        The cache policy.

        • Id — required — (String)

          The unique identifier for the cache policy.

        • LastModifiedTime — required — (Date)

          The date and time when the cache policy was last modified.

        • CachePolicyConfig — required — (map)

          The cache policy configuration.

          • Comment — (String)

            A comment to describe the cache policy.

          • Name — required — (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 — required — (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 — (map)

            The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are automatically included in requests that CloudFront sends to the origin.

            • EnableAcceptEncodingGzip — required — (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 — required — (map)

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

              • HeaderBehavior — required — (String)

                Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:

                • none – HTTP headers are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none, any headers that are listed in an OriginRequestPolicy are included in origin requests.

                • whitelist – The HTTP headers that are listed in the Headers type are included in the cache key and are automatically included in requests that CloudFront sends to the origin.

                Possible values include:
                • "none"
                • "whitelist"
              • Headers — (map)

                Contains a list of HTTP header names.

                • Quantity — required — (Integer)

                  The number of header names in the Items list.

                • Items — (Array<String>)

                  A list of HTTP header names.

            • CookiesConfig — required — (map)

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

              • CookieBehavior — required — (String)

                Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:

                • none – Cookies in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none, any cookies that are listed in an OriginRequestPolicy are included in origin requests.

                • whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.

                • allExcept – All cookies in viewer requests that are not listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.

                • all – All cookies in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.

                Possible values include:
                • "none"
                • "whitelist"
                • "allExcept"
                • "all"
              • Cookies — (map)

                Contains a list of cookie names.

                • Quantity — required — (Integer)

                  The number of cookie names in the Items list.

                • Items — (Array<String>)

                  A list of cookie names.

            • QueryStringsConfig — required — (map)

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

              • QueryStringBehavior — required — (String)

                Determines whether any URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:

                • none – Query strings in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none, any query strings that are listed in an OriginRequestPolicy are included in origin requests.

                • whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.

                • allExcept – All query strings in viewer requests that are not listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.

                • all – All query strings in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.

                Possible values include:
                • "none"
                • "whitelist"
                • "allExcept"
                • "all"
              • QueryStrings — (map)

                Contains the specific query strings in viewer requests that either are or are not included in the cache key and automatically included in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the CachePolicyQueryStringsConfig type is set to whitelist (the listed query strings are included) or allExcept (the listed query strings are not included, but all other query strings are).

                • Quantity — required — (Integer)

                  The number of query string names in the Items list.

                • Items — (Array<String>)

                  A list of query string names.

      • ETag — (String)

        The current version of the cache policy.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getCachePolicyConfig(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getCachePolicyConfig operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
cloudfront.getCachePolicyConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CachePolicyConfig — (map)

        The cache policy configuration.

        • Comment — (String)

          A comment to describe the cache policy.

        • Name — required — (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 — required — (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 — (map)

          The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are automatically included in requests that CloudFront sends to the origin.

          • EnableAcceptEncodingGzip — required — (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 — required — (map)

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

            • HeaderBehavior — required — (String)

              Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:

              • none – HTTP headers are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none, any headers that are listed in an OriginRequestPolicy are included in origin requests.

              • whitelist – The HTTP headers that are listed in the Headers type are included in the cache key and are automatically included in requests that CloudFront sends to the origin.

              Possible values include:
              • "none"
              • "whitelist"
            • Headers — (map)

              Contains a list of HTTP header names.

              • Quantity — required — (Integer)

                The number of header names in the Items list.

              • Items — (Array<String>)

                A list of HTTP header names.

          • CookiesConfig — required — (map)

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

            • CookieBehavior — required — (String)

              Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:

              • none – Cookies in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none, any cookies that are listed in an OriginRequestPolicy are included in origin requests.

              • whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.

              • allExcept – All cookies in viewer requests that are not listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.

              • all – All cookies in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.

              Possible values include:
              • "none"
              • "whitelist"
              • "allExcept"
              • "all"
            • Cookies — (map)

              Contains a list of cookie names.

              • Quantity — required — (Integer)

                The number of cookie names in the Items list.

              • Items — (Array<String>)

                A list of cookie names.

          • QueryStringsConfig — required — (map)

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

            • QueryStringBehavior — required — (String)

              Determines whether any URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:

              • none – Query strings in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none, any query strings that are listed in an OriginRequestPolicy are included in origin requests.

              • whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.

              • allExcept – All query strings in viewer requests that are not listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.

              • all – All query strings in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.

              Possible values include:
              • "none"
              • "whitelist"
              • "allExcept"
              • "all"
            • QueryStrings — (map)

              Contains the specific query strings in viewer requests that either are or are not included in the cache key and automatically included in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the CachePolicyQueryStringsConfig type is set to whitelist (the listed query strings are included) or allExcept (the listed query strings are not included, but all other query strings are).

              • Quantity — required — (Integer)

                The number of query string names in the Items list.

              • Items — (Array<String>)

                A list of query string names.

      • ETag — (String)

        The current version of the cache policy.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getCloudFrontOriginAccessIdentity(params = {}, callback) ⇒ AWS.Request

Get the information about an origin access identity.

Service Reference:

Examples:

Calling the getCloudFrontOriginAccessIdentity operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
cloudfront.getCloudFrontOriginAccessIdentity(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      The identity's ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CloudFrontOriginAccessIdentity — (map)

        The origin access identity's information.

        • Id — required — (String)

          The ID for the origin access identity, for example, E74FTE3AJFJ256A.

        • S3CanonicalUserId — required — (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 — (map)

          The current configuration information for the identity.

          • CallerReference — required — (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 — required — (String)

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

      • ETag — (String)

        The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getCloudFrontOriginAccessIdentityConfig(params = {}, callback) ⇒ AWS.Request

Get the configuration information about an origin access identity.

Service Reference:

Examples:

Calling the getCloudFrontOriginAccessIdentityConfig operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
cloudfront.getCloudFrontOriginAccessIdentityConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      The identity's ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CloudFrontOriginAccessIdentityConfig — (map)

        The origin access identity's configuration information.

        • CallerReference — required — (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 — required — (String)

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

      • ETag — (String)

        The current version of the configuration. For example: E2QWRUHAPOMQZL.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getDistribution(params = {}, callback) ⇒ AWS.Request

Get the information about a distribution.

Service Reference:

Examples:

Calling the getDistribution operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
cloudfront.getDistribution(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      The distribution's ID. If the ID is empty, an empty distribution configuration is returned.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Distribution — (map)

        The distribution's information.

        • Id — required — (String)

          The identifier for the distribution. For example: EDFDVBD632BHDS5.

        • ARN — required — (String)

          The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

        • Status — required — (String)

          This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated to all CloudFront edge locations.

        • LastModifiedTime — required — (Date)

          The date and time the distribution was last modified.

        • InProgressInvalidationBatches — required — (Integer)

          The number of invalidation batches currently in progress.

        • DomainName — required — (String)

          The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.

        • ActiveTrustedSigners — (map)

          We recommend using TrustedKeyGroups instead of TrustedSigners.

          CloudFront automatically adds this field to the response if you’ve configured a cache behavior in this distribution to serve private content using trusted signers. This field contains a list of AWS 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 — required — (Boolean)

            This field is true if any of the AWS accounts in the list have active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.

          • Quantity — required — (Integer)

            The number of AWS accounts in the list.

          • Items — (Array<map>)

            A list of AWS 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.

            • AwsAccountNumber — (String)

              An AWS account number that contains active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If the AWS account that owns the key pairs is the same account that owns the CloudFront distribution, the value of this field is self.

            • KeyPairIds — (map)

              A list of CloudFront key pair identifiers.

              • Quantity — required — (Integer)

                The number of key pair identifiers in the list.

              • Items — (Array<String>)

                A list of CloudFront key pair identifiers.

        • ActiveTrustedKeyGroups — (map)

          CloudFront automatically adds this field to the response if you’ve configured a cache behavior in this distribution to serve private content using key groups. This field contains a list of key groups and the public keys in each key group that CloudFront can use to verify the signatures of signed URLs or signed cookies.

          • Enabled — required — (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 — required — (Integer)

            The number of key groups in the list.

          • Items — (Array<map>)

            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.

            • KeyGroupId — (String)

              The identifier of the key group that contains the public keys.

            • KeyPairIds — (map)

              A list of CloudFront key pair identifiers.

              • Quantity — required — (Integer)

                The number of key pair identifiers in the list.

              • Items — (Array<String>)

                A list of CloudFront key pair identifiers.

        • DistributionConfig — required — (map)

          The current configuration information for the distribution. Send a GET request to the /CloudFront API version/distribution ID/config resource.

          • CallerReference — required — (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 — (map)

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

            • Quantity — required — (Integer)

              The number of CNAME aliases, if any, that you want to associate with this distribution.

            • Items — (Array<String>)

              A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.

          • DefaultRootObject — (String)

            The object that you want CloudFront to request from your origin (for example, index.html) when a viewer requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/product-description.html). Specifying a default root object avoids exposing the contents of your distribution.

            Specify only the object name, for example, index.html. Don't add a / before the object name.

            If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element.

            To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element.

            To replace the default root object, update the distribution configuration and specify the new object.

            For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide.

          • Origins — required — (map)

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

            • Quantity — required — (Integer)

              The number of origins for this distribution.

            • Items — required — (Array<map>)

              A list of origins.

              • Id — required — (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 — required — (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 — (map)

                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 — required — (Integer)

                  The number of custom headers, if any, for this distribution.

                • Items — (Array<map>)

                  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.

                  • HeaderName — required — (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 — required — (String)

                    The value for the header that you specified in the HeaderName field.

              • S3OriginConfig — (map)

                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 — required — (String)

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

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

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

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

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

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

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

              • CustomOriginConfig — (map)

                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 — required — (Integer)

                  The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.

                • HTTPSPort — required — (Integer)

                  The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.

                • OriginProtocolPolicy — required — (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.

                  Possible values include:
                  • "http-only"
                  • "match-viewer"
                  • "https-only"
                • OriginSslProtocols — (map)

                  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 — required — (Integer)

                    The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.

                  • Items — required — (Array<String>)

                    A list that contains allowed SSL/TLS protocols for this distribution.

                • OriginReadTimeout — (Integer)

                  Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 30 seconds.

                  For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide.

                • OriginKeepaliveTimeout — (Integer)

                  Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 5 seconds.

                  For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide.

              • ConnectionAttempts — (Integer)

                The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don’t specify otherwise) is 3.

                For a custom origin (including an Amazon S3 bucket that’s configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout.

                For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide.

              • ConnectionTimeout — (Integer)

                The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don’t specify otherwise) is 10 seconds.

                For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide.

              • OriginShield — (map)

                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 — required — (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 AWS Region for Origin Shield.

                  Specify the AWS 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 AWS Region for Origin Shield. For the list of AWS Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the AWS Region for Origin Shield in the Amazon CloudFront Developer Guide.

          • OriginGroups — (map)

            A complex type that contains information about origin groups for this distribution.

            • Quantity — required — (Integer)

              The number of origin groups.

            • Items — (Array<map>)

              The items (origin groups) in a distribution.

              • Id — required — (String)

                The origin group's ID.

              • FailoverCriteria — required — (map)

                A complex type that contains information about the failover criteria for an origin group.

                • StatusCodes — required — (map)

                  The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.

                  • Quantity — required — (Integer)

                    The number of status codes.

                  • Items — required — (Array<Integer>)

                    The items (status codes) for an origin group.

              • Members — required — (map)

                A complex type that contains information about the origins in an origin group.

                • Quantity — required — (Integer)

                  The number of origins in an origin group.

                • Items — required — (Array<map>)

                  Items (origins) in an origin group.

                  • OriginId — required — (String)

                    The ID for an origin in an origin group.

          • DefaultCacheBehavior — required — (map)

            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 — required — (String)

              The value of ID for the origin that you want CloudFront to route requests to when they use the default cache behavior.

            • TrustedSigners — (map)

              We recommend using TrustedKeyGroups instead of TrustedSigners.

              A list of AWS 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 AWS 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 — required — (Boolean)

                This field is true if any of the AWS accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.

              • Quantity — required — (Integer)

                The number of AWS accounts in the list.

              • Items — (Array<String>)

                A list of AWS account identifiers.

            • TrustedKeyGroups — (map)

              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 — required — (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 — required — (Integer)

                The number of key groups in the list.

              • Items — (Array<String>)

                A list of key groups identifiers.

            • ViewerProtocolPolicy — required — (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.
              Possible values include:
              • "allow-all"
              • "https-only"
              • "redirect-to-https"
            • AllowedMethods — (map)

              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 — required — (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 — required — (Array<String>)

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

              • CachedMethods — (map)

                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 — required — (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 — required — (Array<String>)

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

            • SmoothStreaming — (Boolean)

              Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

            • Compress — (Boolean)

              Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

            • LambdaFunctionAssociations — (map)

              A complex type that contains zero or more Lambda function associations for a cache behavior.

              • Quantity — required — (Integer)

                The number of Lambda function associations for this cache behavior.

              • Items — (Array<map>)

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

                • LambdaFunctionARN — required — (String)

                  The ARN of the Lambda function. You must specify the ARN of a function version; you can't specify a Lambda alias or $LATEST.

                • EventType — required — (String)

                  Specifies the event type that triggers a Lambda 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.

                  Possible values include:
                  • "viewer-request"
                  • "viewer-response"
                  • "origin-request"
                  • "origin-response"
                • IncludeBody — (Boolean)

                  A flag that allows a Lambda 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.

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

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

            • ForwardedValues — (map)

              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 complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.

              • QueryString — required — (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 — required — (map)

                This field 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 — required — (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.

                  Possible values include:
                  • "none"
                  • "whitelist"
                  • "all"
                • WhitelistedNames — (map)

                  This field 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 AWS General Reference.

                  • Quantity — required — (Integer)

                    The number of cookie names in the Items list.

                  • Items — (Array<String>)

                    A list of cookie names.

              • Headers — (map)

                This field 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 — required — (Integer)

                  The number of header names in the Items list.

                • Items — (Array<String>)

                  A list of HTTP header names.

              • QueryStringCacheKeys — (map)

                This field 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 — required — (Integer)

                  The number of whitelisted query string parameters for a cache behavior.

                • Items — (Array<String>)

                  A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items.

            • MinTTL — (Integer)

              This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

              The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

              You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

            • DefaultTTL — (Integer)

              This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

              The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

            • MaxTTL — (Integer)

              This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

              The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

          • CacheBehaviors — (map)

            A complex type that contains zero or more CacheBehavior elements.

            • Quantity — required — (Integer)

              The number of cache behaviors for this distribution.

            • Items — (Array<map>)

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

              • PathPattern — required — (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 — required — (String)

                The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.

              • TrustedSigners — (map)

                We recommend using TrustedKeyGroups instead of TrustedSigners.

                A list of AWS 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 AWS 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 — required — (Boolean)

                  This field is true if any of the AWS accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.

                • Quantity — required — (Integer)

                  The number of AWS accounts in the list.

                • Items — (Array<String>)

                  A list of AWS account identifiers.

              • TrustedKeyGroups — (map)

                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 — required — (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 — required — (Integer)

                  The number of key groups in the list.

                • Items — (Array<String>)

                  A list of key groups identifiers.

              • ViewerProtocolPolicy — required — (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.
                Possible values include:
                • "allow-all"
                • "https-only"
                • "redirect-to-https"
              • AllowedMethods — (map)

                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 — required — (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 — required — (Array<String>)

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

                • CachedMethods — (map)

                  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 — required — (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 — required — (Array<String>)

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

              • SmoothStreaming — (Boolean)

                Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

              • Compress — (Boolean)

                Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

              • LambdaFunctionAssociations — (map)

                A complex type that contains zero or more Lambda function associations for a cache behavior.

                • Quantity — required — (Integer)

                  The number of Lambda function associations for this cache behavior.

                • Items — (Array<map>)

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

                  • LambdaFunctionARN — required — (String)

                    The ARN of the Lambda function. You must specify the ARN of a function version; you can't specify a Lambda alias or $LATEST.

                  • EventType — required — (String)

                    Specifies the event type that triggers a Lambda 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.

                    Possible values include:
                    • "viewer-request"
                    • "viewer-response"
                    • "origin-request"
                    • "origin-response"
                  • IncludeBody — (Boolean)

                    A flag that allows a Lambda 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.

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

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

              • ForwardedValues — (map)

                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 complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.

                • QueryString — required — (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 — required — (map)

                  This field 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 — required — (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.

                    Possible values include:
                    • "none"
                    • "whitelist"
                    • "all"
                  • WhitelistedNames — (map)

                    This field 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 AWS General Reference.

                    • Quantity — required — (Integer)

                      The number of cookie names in the Items list.

                    • Items — (Array<String>)

                      A list of cookie names.

                • Headers — (map)

                  This field 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 — required — (Integer)

                    The number of header names in the Items list.

                  • Items — (Array<String>)

                    A list of HTTP header names.

                • QueryStringCacheKeys — (map)

                  This field 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 — required — (Integer)

                    The number of whitelisted query string parameters for a cache behavior.

                  • Items — (Array<String>)

                    A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items.

              • MinTTL — (Integer)

                This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

                The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

                You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

              • DefaultTTL — (Integer)

                This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

                The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

              • MaxTTL — (Integer)

                This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

                The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

          • CustomErrorResponses — (map)

            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 — required — (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 — (Array<map>)

              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.

              • ErrorCode — required — (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 — required — (String)

            Any comments you want to include about the distribution.

            If you don't want to specify a comment, include an empty Comment element.

            To delete an existing comment, update the distribution configuration and include an empty Comment element.

            To add or change a comment, update the distribution configuration and specify the new comment.

          • Logging — (map)

            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 — required — (Boolean)

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

            • IncludeCookies — required — (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 — required — (String)

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

            • Prefix — required — (String)

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

          • PriceClass — (String)

            The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations.

            If you specify a price class other than PriceClass_All, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.

            For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing.

            Possible values include:
            • "PriceClass_100"
            • "PriceClass_200"
            • "PriceClass_All"
          • Enabled — required — (Boolean)

            From this field, you can enable or disable the selected distribution.

          • ViewerCertificate — (map)

            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)

              If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in AWS Identity and Access Management (AWS IAM), provide the ID of the IAM certificate.

              If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVerison and SSLSupportMethod.

            • ACMCertificateArn — (String)

              If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in AWS 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 MinimumProtocolVerison 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 AWS Support Center.

              If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net, don’t set a value for this field.

              Possible values include:
              • "sni-only"
              • "vip"
              • "static-ip"
            • 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.

              Possible values include:
              • "SSLv3"
              • "TLSv1"
              • "TLSv1_2016"
              • "TLSv1.1_2016"
              • "TLSv1.2_2018"
              • "TLSv1.2_2019"
            • 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

              Possible values include:
              • "cloudfront"
              • "iam"
              • "acm"
          • Restrictions — (map)

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

            • GeoRestriction — required — (map)

              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 — required — (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.

                Possible values include:
                • "blacklist"
                • "whitelist"
                • "none"
              • Quantity — required — (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 — (Array<String>)

                A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist).

                The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country.

                CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.

          • WebACLId — (String)

            A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a.

            AWS 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 AWS WAF, see the AWS WAF Developer Guide.

          • HttpVersion — (String)

            (Optional) 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 automatically use an earlier HTTP version.

            For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).

            In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for "http/2 optimization."

            Possible values include:
            • "http1.1"
            • "http2"
          • IsIPV6Enabled — (Boolean)

            If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true. If you specify false, CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.

            In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide.

            If you're using an Amazon Route 53 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 Amazon Route 53 Developer Guide.

            If you created a CNAME resource record set, either with Amazon Route 53 or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.

        • AliasICPRecordals — (Array<map>)

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

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

          • CNAME — (String)

            A domain name associated with a distribution.

          • ICPRecordalStatus — (String)

            The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in regions outside of China.

            The status values returned are the following:

            • 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 China region, 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.

            Possible values include:
            • "APPROVED"
            • "SUSPENDED"
            • "PENDING"
      • ETag — (String)

        The current version of the distribution's information. For example: E2QWRUHAPOMQZL.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

getDistributionConfig(params = {}, callback) ⇒ AWS.Request

Get the configuration information about a distribution.

Service Reference:

Examples:

Calling the getDistributionConfig operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
cloudfront.getDistributionConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      The distribution's ID. If the ID is empty, an empty distribution configuration is returned.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DistributionConfig — (map)

        The distribution's configuration information.

        • CallerReference — required — (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 — (map)

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

          • Quantity — required — (Integer)

            The number of CNAME aliases, if any, that you want to associate with this distribution.

          • Items — (Array<String>)

            A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.

        • DefaultRootObject — (String)

          The object that you want CloudFront to request from your origin (for example, index.html) when a viewer requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/product-description.html). Specifying a default root object avoids exposing the contents of your distribution.

          Specify only the object name, for example, index.html. Don't add a / before the object name.

          If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element.

          To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element.

          To replace the default root object, update the distribution configuration and specify the new object.

          For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide.

        • Origins — required — (map)

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

          • Quantity — required — (Integer)

            The number of origins for this distribution.

          • Items — required — (Array<map>)

            A list of origins.

            • Id — required — (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 — required — (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 — (map)

              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 — required — (Integer)

                The number of custom headers, if any, for this distribution.

              • Items — (Array<map>)

                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.

                • HeaderName — required — (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 — required — (String)

                  The value for the header that you specified in the HeaderName field.

            • S3OriginConfig — (map)

              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 — required — (String)

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

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

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

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

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

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

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

            • CustomOriginConfig — (map)

              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 — required — (Integer)

                The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.

              • HTTPSPort — required — (Integer)

                The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.

              • OriginProtocolPolicy — required — (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.

                Possible values include:
                • "http-only"
                • "match-viewer"
                • "https-only"
              • OriginSslProtocols — (map)

                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 — required — (Integer)

                  The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.

                • Items — required — (Array<String>)

                  A list that contains allowed SSL/TLS protocols for this distribution.

              • OriginReadTimeout — (Integer)

                Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 30 seconds.

                For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide.

              • OriginKeepaliveTimeout — (Integer)

                Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 5 seconds.

                For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide.

            • ConnectionAttempts — (Integer)

              The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don’t specify otherwise) is 3.

              For a custom origin (including an Amazon S3 bucket that’s configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout.

              For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide.

            • ConnectionTimeout — (Integer)

              The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don’t specify otherwise) is 10 seconds.

              For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide.

            • OriginShield — (map)

              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 — required — (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 AWS Region for Origin Shield.

                Specify the AWS 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 AWS Region for Origin Shield. For the list of AWS Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the AWS Region for Origin Shield in the Amazon CloudFront Developer Guide.

        • OriginGroups — (map)

          A complex type that contains information about origin groups for this distribution.

          • Quantity — required — (Integer)

            The number of origin groups.

          • Items — (Array<map>)

            The items (origin groups) in a distribution.

            • Id — required — (String)

              The origin group's ID.

            • FailoverCriteria — required — (map)

              A complex type that contains information about the failover criteria for an origin group.

              • StatusCodes — required — (map)

                The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.

                • Quantity — required — (Integer)

                  The number of status codes.

                • Items — required — (Array<Integer>)

                  The items (status codes) for an origin group.

            • Members — required — (map)

              A complex type that contains information about the origins in an origin group.

              • Quantity — required — (Integer)

                The number of origins in an origin group.

              • Items — required — (Array<map>)

                Items (origins) in an origin group.

                • OriginId — required — (String)

                  The ID for an origin in an origin group.

        • DefaultCacheBehavior — required — (map)

          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 — required — (String)

            The value of ID for the origin that you want CloudFront to route requests to when they use the default cache behavior.

          • TrustedSigners — (map)

            We recommend using TrustedKeyGroups instead of TrustedSigners.

            A list of AWS 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 AWS 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 — required — (Boolean)

              This field is true if any of the AWS accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.

            • Quantity — required — (Integer)

              The number of AWS accounts in the list.

            • Items — (Array<String>)

              A list of AWS account identifiers.

          • TrustedKeyGroups — (map)

            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 — required — (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 — required — (Integer)

              The number of key groups in the list.

            • Items — (Array<String>)

              A list of key groups identifiers.

          • ViewerProtocolPolicy — required — (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.
            Possible values include:
            • "allow-all"
            • "https-only"
            • "redirect-to-https"
          • AllowedMethods — (map)

            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 — required — (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 — required — (Array<String>)

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

            • CachedMethods — (map)

              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 — required — (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 — required — (Array<String>)

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

          • SmoothStreaming — (Boolean)

            Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

          • Compress — (Boolean)

            Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

          • LambdaFunctionAssociations — (map)

            A complex type that contains zero or more Lambda function associations for a cache behavior.

            • Quantity — required — (Integer)

              The number of Lambda function associations for this cache behavior.

            • Items — (Array<map>)

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

              • LambdaFunctionARN — required — (String)

                The ARN of the Lambda function. You must specify the ARN of a function version; you can't specify a Lambda alias or $LATEST.

              • EventType — required — (String)

                Specifies the event type that triggers a Lambda 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.

                Possible values include:
                • "viewer-request"
                • "viewer-response"
                • "origin-request"
                • "origin-response"
              • IncludeBody — (Boolean)

                A flag that allows a Lambda 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.

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

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

          • ForwardedValues — (map)

            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 complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.

            • QueryString — required — (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 — required — (map)

              This field 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 — required — (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.

                Possible values include:
                • "none"
                • "whitelist"
                • "all"
              • WhitelistedNames — (map)

                This field 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 AWS General Reference.

                • Quantity — required — (Integer)

                  The number of cookie names in the Items list.

                • Items — (Array<String>)

                  A list of cookie names.

            • Headers — (map)

              This field 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 — required — (Integer)

                The number of header names in the Items list.

              • Items — (Array<String>)

                A list of HTTP header names.

            • QueryStringCacheKeys — (map)

              This field 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 — required — (Integer)

                The number of whitelisted query string parameters for a cache behavior.

              • Items — (Array<String>)

                A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items.

          • MinTTL — (Integer)

            This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

            The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

            You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

          • DefaultTTL — (Integer)

            This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

            The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

          • MaxTTL — (Integer)

            This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

            The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

        • CacheBehaviors — (map)

          A complex type that contains zero or more CacheBehavior elements.

          • Quantity — required — (Integer)

            The number of cache behaviors for this distribution.

          • Items — (Array<map>)

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

            • PathPattern — required — (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 — required — (String)

              The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.

            • TrustedSigners — (map)

              We recommend using TrustedKeyGroups instead of TrustedSigners.

              A list of AWS 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 AWS 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 — required — (Boolean)

                This field is true if any of the AWS accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.

              • Quantity — required — (Integer)

                The number of AWS accounts in the list.

              • Items — (Array<String>)

                A list of AWS account identifiers.

            • TrustedKeyGroups — (map)

              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 — required — (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 — required — (Integer)

                The number of key groups in the list.

              • Items — (Array<String>)

                A list of key groups identifiers.

            • ViewerProtocolPolicy — required — (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.
              Possible values include:
              • "allow-all"
              • "https-only"
              • "redirect-to-https"
            • AllowedMethods — (map)

              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 — required — (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 — required — (Array<String>)

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

              • CachedMethods — (map)

                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 — required — (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 — required — (Array<String>)

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

            • SmoothStreaming — (Boolean)

              Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

            • Compress — (Boolean)

              Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

            • LambdaFunctionAssociations — (map)

              A complex type that contains zero or more Lambda function associations for a cache behavior.

              • Quantity — required — (Integer)

                The number of Lambda function associations for this cache behavior.

              • Items — (Array<map>)

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

                • LambdaFunctionARN — required — (String)

                  The ARN of the Lambda function. You must specify the ARN of a function version; you can't specify a Lambda alias or $LATEST.

                • EventType — required — (String)

                  Specifies the event type that triggers a Lambda 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.

                  Possible values include:
                  • "viewer-request"
                  • "viewer-response"
                  • "origin-request"
                  • "origin-response"
                • IncludeBody — (Boolean)

                  A flag that allows a Lambda 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.

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

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

            • ForwardedValues — (map)

              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 complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.

              • QueryString — required — (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 — required — (map)

                This field 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 — required — (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.

                  Possible values include:
                  • "none"
                  • "whitelist"
                  • "all"
                • WhitelistedNames — (map)

                  This field 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 AWS General Reference.

                  • Quantity — required — (Integer)

                    The number of cookie names in the Items list.

                  • Items — (Array<String>)

                    A list of cookie names.

              • Headers — (map)

                This field 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 — required — (Integer)

                  The number of header names in the Items list.

                • Items — (Array<String>)

                  A list of HTTP header names.

              • QueryStringCacheKeys — (map)

                This field 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 — required — (Integer)

                  The number of whitelisted query string parameters for a cache behavior.

                • Items — (Array<String>)

                  A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items.

            • MinTTL — (Integer)

              This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

              The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

              You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

            • DefaultTTL — (Integer)

              This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

              The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

            • MaxTTL — (Integer)

              This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

              The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

        • CustomErrorResponses — (map)

          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 — required — (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 — (Array<map>)

            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.

            • ErrorCode — required — (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 — required — (String)

          Any comments you want to include about the distribution.

          If you don't want to specify a comment, include an empty Comment element.

          To delete an existing comment, update the distribution configuration and include an empty Comment element.

          To add or change a comment, update the distribution configuration and specify the new comment.

        • Logging — (map)

          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 — required — (Boolean)

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

          • IncludeCookies — required — (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 — required — (String)

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

          • Prefix — required — (String)

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

        • PriceClass — (String)

          The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations.

          If you specify a price class other than PriceClass_All, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.

          For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing.

          Possible values include:
          • "PriceClass_100"
          • "PriceClass_200"
          • "PriceClass_All"
        • Enabled — required — (Boolean)

          From this field, you can enable or disable the selected distribution.

        • ViewerCertificate — (map)

          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)

            If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in AWS Identity and Access Management (AWS IAM), provide the ID of the IAM certificate.

            If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVerison and SSLSupportMethod.

          • ACMCertificateArn — (String)

            If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in AWS 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 MinimumProtocolVerison 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 AWS Support Center.

            If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net, don’t set a value for this field.

            Possible values include:
            • "sni-only"
            • "vip"
            • "static-ip"
          • 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.

            Possible values include:
            • "SSLv3"
            • "TLSv1"
            • "TLSv1_2016"
            • "TLSv1.1_2016"
            • "TLSv1.2_2018"
            • "TLSv1.2_2019"
          • 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

            Possible values include:
            • "cloudfront"
            • "iam"
            • "acm"
        • Restrictions — (map)

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

          • GeoRestriction — required — (map)

            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 — required — (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.

              Possible values include:
              • "blacklist"
              • "whitelist"
              • "none"
            • Quantity — required — (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 — (Array<String>)

              A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist).

              The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country.

              CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.

        • WebACLId — (String)

          A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a.

          AWS 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 AWS WAF, see the AWS WAF Developer Guide.

        • HttpVersion — (String)

          (Optional) 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 automatically use an earlier HTTP version.

          For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).

          In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for "http/2 optimization."

          Possible values include:
          • "http1.1"
          • "http2"
        • IsIPV6Enabled — (Boolean)

          If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true. If you specify false, CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.

          In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide.

          If you're using an Amazon Route 53 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 Amazon Route 53 Developer Guide.

          If you created a CNAME resource record set, either with Amazon Route 53 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.

      • ETag — (String)

        The current version of the configuration. For example: E2QWRUHAPOMQZL.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getFieldLevelEncryption(params = {}, callback) ⇒ AWS.Request

Get the field-level encryption configuration information.

Service Reference:

Examples:

Calling the getFieldLevelEncryption operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
cloudfront.getFieldLevelEncryption(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      Request the ID for the field-level encryption configuration information.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FieldLevelEncryption — (map)

        Return the field-level encryption configuration information.

        • Id — required — (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 — required — (Date)

          The last time the field-level encryption configuration was changed.

        • FieldLevelEncryptionConfig — required — (map)

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

          • CallerReference — required — (String)

            A unique number that ensures the request can't be replayed.

          • Comment — (String)

            An optional comment about the configuration.

          • QueryArgProfileConfig — (map)

            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 — required — (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 — (map)

              Profiles specified for query argument-profile mapping for field-level encryption.

              • Quantity — required — (Integer)

                Number of profiles for query argument-profile mapping for field-level encryption.

              • Items — (Array<map>)

                Number of items for query argument-profile mapping for field-level encryption.

                • QueryArg — required — (String)

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

                • ProfileId — required — (String)

                  ID of profile to use for field-level encryption query argument-profile mapping

          • ContentTypeProfileConfig — (map)

            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 — required — (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 — (map)

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

              • Quantity — required — (Integer)

                The number of field-level encryption content type-profile mappings.

              • Items — (Array<map>)

                Items in a field-level encryption content type-profile mapping.

                • Format — required — (String)

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

                  Possible values include:
                  • "URLEncoded"
                • ProfileId — (String)

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

                • ContentType — required — (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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getFieldLevelEncryptionConfig(params = {}, callback) ⇒ AWS.Request

Get the field-level encryption configuration information.

Service Reference:

Examples:

Calling the getFieldLevelEncryptionConfig operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
cloudfront.getFieldLevelEncryptionConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      Request the ID for the field-level encryption configuration information.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FieldLevelEncryptionConfig — (map)

        Return the field-level encryption configuration information.

        • CallerReference — required — (String)

          A unique number that ensures the request can't be replayed.

        • Comment — (String)

          An optional comment about the configuration.

        • QueryArgProfileConfig — (map)

          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 — required — (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 — (map)

            Profiles specified for query argument-profile mapping for field-level encryption.

            • Quantity — required — (Integer)

              Number of profiles for query argument-profile mapping for field-level encryption.

            • Items — (Array<map>)

              Number of items for query argument-profile mapping for field-level encryption.

              • QueryArg — required — (String)

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

              • ProfileId — required — (String)

                ID of profile to use for field-level encryption query argument-profile mapping

        • ContentTypeProfileConfig — (map)

          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 — required — (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 — (map)

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

            • Quantity — required — (Integer)

              The number of field-level encryption content type-profile mappings.

            • Items — (Array<map>)

              Items in a field-level encryption content type-profile mapping.

              • Format — required — (String)

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

                Possible values include:
                • "URLEncoded"
              • ProfileId — (String)

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

              • ContentType — required — (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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getFieldLevelEncryptionProfile(params = {}, callback) ⇒ AWS.Request

Get the field-level encryption profile information.

Service Reference:

Examples:

Calling the getFieldLevelEncryptionProfile operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
cloudfront.getFieldLevelEncryptionProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      Get the ID for the field-level encryption profile information.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FieldLevelEncryptionProfile — (map)

        Return the field-level encryption profile information.

        • Id — required — (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 — required — (Date)

          The last time the field-level encryption profile was updated.

        • FieldLevelEncryptionProfileConfig — required — (map)

          A complex data type that includes the profile name and the encryption entities for the field-level encryption profile.

          • Name — required — (String)

            Profile name for the field-level encryption profile.

          • CallerReference — required — (String)

            A unique number that ensures that the request can't be replayed.

          • Comment — (String)

            An optional comment for the field-level encryption profile.

          • EncryptionEntities — required — (map)

            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 — required — (Integer)

              Number of field pattern items in a field-level encryption content type-profile mapping.

            • Items — (Array<map>)

              An array of field patterns in a field-level encryption content type-profile mapping.

              • PublicKeyId — required — (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 — required — (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 — required — (map)

                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 — required — (Integer)

                  The number of field-level encryption field patterns.

                • Items — (Array<String>)

                  An array of the field-level encryption field patterns.

      • ETag — (String)

        The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getFieldLevelEncryptionProfileConfig(params = {}, callback) ⇒ AWS.Request

Get the field-level encryption profile configuration information.

Service Reference:

Examples:

Calling the getFieldLevelEncryptionProfileConfig operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
cloudfront.getFieldLevelEncryptionProfileConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      Get the ID for the field-level encryption profile configuration information.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FieldLevelEncryptionProfileConfig — (map)

        Return the field-level encryption profile configuration information.

        • Name — required — (String)

          Profile name for the field-level encryption profile.

        • CallerReference — required — (String)

          A unique number that ensures that the request can't be replayed.

        • Comment — (String)

          An optional comment for the field-level encryption profile.

        • EncryptionEntities — required — (map)

          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 — required — (Integer)

            Number of field pattern items in a field-level encryption content type-profile mapping.

          • Items — (Array<map>)

            An array of field patterns in a field-level encryption content type-profile mapping.

            • PublicKeyId — required — (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 — required — (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 — required — (map)

              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 — required — (Integer)

                The number of field-level encryption field patterns.

              • Items — (Array<String>)

                An array of the field-level encryption field patterns.

      • ETag — (String)

        The current version of the field-level encryption profile configuration result. For example: E2QWRUHAPOMQZL.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getInvalidation(params = {}, callback) ⇒ AWS.Request

Get the information about an invalidation.

Service Reference:

Examples:

Calling the getInvalidation operation

var params = {
  DistributionId: 'STRING_VALUE', /* required */
  Id: 'STRING_VALUE' /* required */
};
cloudfront.getInvalidation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DistributionId — (String)

      The distribution's ID.

    • Id — (String)

      The identifier for the invalidation request, for example, IDFDVBD632BHDS5.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Invalidation — (map)

        The invalidation's information. For more information, see Invalidation Complex Type.

        • Id — required — (String)

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

        • Status — required — (String)

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

        • CreateTime — required — (Date)

          The date and time the invalidation request was first made.

        • InvalidationBatch — required — (map)

          The current invalidation information for the batch request.

          • Paths — required — (map)

            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 — required — (Integer)

              The number of invalidation paths specified for the objects that you want to invalidate.

            • Items — (Array<String>)

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

          • CallerReference — required — (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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

getKeyGroup(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getKeyGroup operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
cloudfront.getKeyGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      The identifier of the key group that you are getting. To get the identifier, use ListKeyGroups.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • KeyGroup — (map)

        The key group.

        • Id — required — (String)

          The identifier for the key group.

        • LastModifiedTime — required — (Date)

          The date and time when the key group was last modified.

        • KeyGroupConfig — required — (map)

          The key group configuration.

          • Name — required — (String)

            A name to identify the key group.

          • Items — required — (Array<String>)

            A list of the identifiers of the public keys in the key group.

          • Comment — (String)

            A comment to describe the key group.

      • ETag — (String)

        The identifier for this version of the key group.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getKeyGroupConfig(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getKeyGroupConfig operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
cloudfront.getKeyGroupConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      The identifier of the key group whose configuration you are getting. To get the identifier, use ListKeyGroups.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • KeyGroupConfig — (map)

        The key group configuration.

        • Name — required — (String)

          A name to identify the key group.

        • Items — required — (Array<String>)

          A list of the identifiers of the public keys in the key group.

        • Comment — (String)

          A comment to describe the key group.

      • ETag — (String)

        The identifier for this version of the key group.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getMonitoringSubscription(params = {}, callback) ⇒ AWS.Request

Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.

Service Reference:

Examples:

Calling the getMonitoringSubscription operation

var params = {
  DistributionId: 'STRING_VALUE' /* required */
};
cloudfront.getMonitoringSubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DistributionId — (String)

      The ID of the distribution that you are getting metrics information for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MonitoringSubscription — (map)

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

        • RealtimeMetricsSubscriptionConfig — (map)

          A subscription configuration for additional CloudWatch metrics.

          • RealtimeMetricsSubscriptionStatus — required — (String)

            A flag that indicates whether additional CloudWatch metrics are enabled for a given CloudFront distribution.

            Possible values include:
            • "Enabled"
            • "Disabled"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getOriginRequestPolicy(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getOriginRequestPolicy operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
cloudfront.getOriginRequestPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OriginRequestPolicy — (map)

        The origin request policy.

        • Id — required — (String)

          The unique identifier for the origin request policy.

        • LastModifiedTime — required — (Date)

          The date and time when the origin request policy was last modified.

        • OriginRequestPolicyConfig — required — (map)

          The origin request policy configuration.

          • Comment — (String)

            A comment to describe the origin request policy.

          • Name — required — (String)

            A unique name to identify the origin request policy.

          • HeadersConfig — required — (map)

            The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.

            • HeaderBehavior — required — (String)

              Determines whether any HTTP headers are included in requests that CloudFront sends to the origin. Valid values are:

              • none – HTTP headers are not included in requests that CloudFront sends to the origin. Even when this field is set to none, any headers that are listed in a CachePolicy are included in origin requests.

              • whitelist – The HTTP headers that are listed in the Headers type are included in requests that CloudFront sends to the origin.

              • allViewer – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin.

              • allViewerAndWhitelistCloudFront – All HTTP headers in viewer requests and the additional CloudFront headers that are listed in the Headers type are included in requests that CloudFront sends to the origin. The additional headers are added by CloudFront.

              Possible values include:
              • "none"
              • "whitelist"
              • "allViewer"
              • "allViewerAndWhitelistCloudFront"
            • Headers — (map)

              Contains a list of HTTP header names.

              • Quantity — required — (Integer)

                The number of header names in the Items list.

              • Items — (Array<String>)

                A list of HTTP header names.

          • CookiesConfig — required — (map)

            The cookies from viewer requests to include in origin requests.

            • CookieBehavior — required — (String)

              Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:

              • none – Cookies in viewer requests are not included in requests that CloudFront sends to the origin. Even when this field is set to none, any cookies that are listed in a CachePolicy are included in origin requests.

              • whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in requests that CloudFront sends to the origin.

              • all – All cookies in viewer requests are included in requests that CloudFront sends to the origin.

              Possible values include:
              • "none"
              • "whitelist"
              • "all"
            • Cookies — (map)

              Contains a list of cookie names.

              • Quantity — required — (Integer)

                The number of cookie names in the Items list.

              • Items — (Array<String>)

                A list of cookie names.

          • QueryStringsConfig — required — (map)

            The URL query strings from viewer requests to include in origin requests.

            • QueryStringBehavior — required — (String)

              Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:

              • none – Query strings in viewer requests are not included in requests that CloudFront sends to the origin. Even when this field is set to none, any query strings that are listed in a CachePolicy are included in origin requests.

              • whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in requests that CloudFront sends to the origin.

              • all – All query strings in viewer requests are included in requests that CloudFront sends to the origin.

              Possible values include:
              • "none"
              • "whitelist"
              • "all"
            • QueryStrings — (map)

              Contains a list of the query strings in viewer requests that are included in requests that CloudFront sends to the origin.

              • Quantity — required — (Integer)

                The number of query string names in the Items list.

              • Items — (Array<String>)

                A list of query string names.

      • ETag — (String)

        The current version of the origin request policy.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getOriginRequestPolicyConfig(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getOriginRequestPolicyConfig operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
cloudfront.getOriginRequestPolicyConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OriginRequestPolicyConfig — (map)

        The origin request policy configuration.

        • Comment — (String)

          A comment to describe the origin request policy.

        • Name — required — (String)

          A unique name to identify the origin request policy.

        • HeadersConfig — required — (map)

          The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.

          • HeaderBehavior