Class: AWS.CloudFront

Inherits:
AWS.Service show all
Identifier:
cloudfront
API Version:
2018-11-05
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.createCloudFrontOriginAccessIdentity(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: '2018-11-05'});

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

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

var cloudfront = new AWS.CloudFront();

Version:

  • 2018-11-05

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: '2018-11-05'});

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

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

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

  • 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 returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • 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) —

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

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

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

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. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A.

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

If you are using Adobe Flash Media Server's RTMP protocol, you set up a different kind of CloudFront distribution. For more information, see CreateStreamingDistribution.

Service Reference:

Examples:

Calling the createDistribution operation

var params = {
  DistributionConfig: { /* required */
    CallerReference: 'STRING_VALUE', /* required */
    Comment: 'STRING_VALUE', /* required */
    DefaultCacheBehavior: { /* required */
      ForwardedValues: { /* required */
        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 */
          ]
        }
      },
      MinTTL: 'NUMBER_VALUE', /* required */
      TargetOriginId: 'STRING_VALUE', /* required */
      TrustedSigners: { /* required */
        Enabled: true || false, /* required */
        Quantity: 'NUMBER_VALUE', /* required */
        Items: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      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 */
        }
      },
      Compress: true || false,
      DefaultTTL: 'NUMBER_VALUE',
      FieldLevelEncryptionId: 'STRING_VALUE',
      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',
      SmoothStreaming: true || false
    },
    Enabled: true || false, /* required */
    Origins: { /* required */
      Items: [ /* required */
        {
          DomainName: 'STRING_VALUE', /* required */
          Id: 'STRING_VALUE', /* required */
          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',
          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: [
        {
          ForwardedValues: { /* required */
            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 */
              ]
            }
          },
          MinTTL: 'NUMBER_VALUE', /* required */
          PathPattern: 'STRING_VALUE', /* required */
          TargetOriginId: 'STRING_VALUE', /* required */
          TrustedSigners: { /* required */
            Enabled: true || false, /* required */
            Quantity: 'NUMBER_VALUE', /* required */
            Items: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          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 */
            }
          },
          Compress: true || false,
          DefaultTTL: 'NUMBER_VALUE',
          FieldLevelEncryptionId: 'STRING_VALUE',
          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',
          SmoothStreaming: true || false
        },
        /* 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,
      SSLSupportMethod: sni-only | vip
    },
    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 or origin groups for this distribution.

        • Items — required — (Array<map>)

          A complex type that contains origins or origin groups for this distribution.

          • Id — required — (String)

            A unique identifier for the origin or origin group. The value of Id must be unique within the distribution.

            When you specify the value of TargetOriginId for the default cache behavior or for another cache behavior, you indicate the origin to which you want the cache behavior to route requests by specifying the value of the Id element for that origin. When a request matches the path pattern for that cache behavior, CloudFront routes the request to the specified origin. For more information, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.

          • DomainName — required — (String)

            Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. If you set up your bucket to be configured as a website endpoint, enter the Amazon S3 static website hosting endpoint for the bucket.

            For more information about specifying this value for different types of origins, see Origin Domain Name in the Amazon CloudFront Developer Guide.

            Constraints for Amazon S3 origins:

            • If you configured Amazon S3 Transfer Acceleration for your bucket, don't specify the s3-accelerate endpoint for DomainName.

            • The bucket name must be between 3 and 63 characters long (inclusive).

            • The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.

            • The bucket name must not contain adjacent periods.

            Custom Origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com.

            Constraints for custom origins:

            • DomainName must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or underscore (_) characters.

            • The name cannot exceed 128 characters.

          • OriginPath — (String)

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

            For example, suppose you've specified the following values for your distribution:

            • DomainName: An Amazon S3 bucket named myawsbucket.

            • OriginPath: /production

            • CNAME: example.com

            When a user enters example.com/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/index.html.

            When a user enters example.com/acme/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/acme/index.html.

          • CustomHeaders — (map)

            A complex type that contains names and values for the custom headers that you want.

            • 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 forward to your origin. For more information, see Forwarding Custom Headers to Your Origin (Web Distributions Only) in the Amazon Amazon CloudFront Developer Guide.

              • HeaderValue — required — (String)

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

          • S3OriginConfig — (map)

            A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element 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)

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

            • HTTPPort — required — (Integer)

              The HTTP port the custom origin listens on.

            • HTTPSPort — required — (Integer)

              The HTTPS port the custom origin listens on.

            • OriginProtocolPolicy — required — (String)

              The origin protocol policy to apply to your origin.

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

              The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS.

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

              You can create a custom origin read timeout. All timeout units are in seconds. The default origin read timeout is 30 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 4 seconds; the maximum is 60 seconds.

              If you need to increase the maximum time limit, contact the AWS Support Center.

            • OriginKeepaliveTimeout — (Integer)

              You can create a custom keep-alive timeout. All timeout units are in seconds. The default keep-alive timeout is 5 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 1 second; the maximum is 60 seconds.

              If you need to increase the maximum time limit, contact the AWS Support Center.

      • 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 a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.

        • ForwardedValues — required — (map)

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

          • QueryString — required — (Boolean)

            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)

            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)

              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)

              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 Amazon CloudFront Limits in the AWS General Reference.

              • Quantity — required — (Integer)

                The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.

              • Items — (Array<String>)

                A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior.

          • Headers — (map)

            A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for this cache behavior.

            • Quantity — required — (Integer)

              The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:

              • Forward all headers to your origin: Specify 1 for Quantity and * for Name.

                CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.

              • Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers.

              • Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.

              Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:

            • Items — (Array<String>)

              A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.

          • QueryStringCacheKeys — (map)

            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 this cache behavior.

            • Items — (Array<String>)

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

        • TrustedSigners — required — (map)

          A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

          If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

          If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

          To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

          • Enabled — required — (Boolean)

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

          • Quantity — required — (Integer)

            The number of trusted signers for this cache behavior.

          • Items — (Array<String>)

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

        • 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 Using an HTTPS Connection to Access Your Objects 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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
          Possible values include:
          • "allow-all"
          • "https-only"
          • "redirect-to-https"
        • MinTTL — required — (Integer)

          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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon 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).

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

        • DefaultTTL — (Integer)

          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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

        • MaxTTL — (Integer)
        • 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 forwards 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 a cache behavior or for the default cache behavior in your distribution.

      • 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 a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.

          • ForwardedValues — required — (map)

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

            • QueryString — required — (Boolean)

              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)

              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)

                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)

                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 Amazon CloudFront Limits in the AWS General Reference.

                • Quantity — required — (Integer)

                  The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.

                • Items — (Array<String>)

                  A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior.

            • Headers — (map)

              A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for this cache behavior.

              • Quantity — required — (Integer)

                The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:

                • Forward all headers to your origin: Specify 1 for Quantity and * for Name.

                  CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.

                • Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers.

                • Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.

                Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:

              • Items — (Array<String>)

                A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.

            • QueryStringCacheKeys — (map)

              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 this cache behavior.

              • Items — (Array<String>)

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

          • TrustedSigners — required — (map)

            A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

            If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

            If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

            To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

            • Enabled — required — (Boolean)

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

            • Quantity — required — (Integer)

              The number of trusted signers for this cache behavior.

            • Items — (Array<String>)

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

          • 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 Using an HTTPS Connection to Access Your Objects 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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
            Possible values include:
            • "allow-all"
            • "https-only"
            • "redirect-to-https"
          • MinTTL — required — (Integer)

            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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon 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).

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

          • DefaultTTL — (Integer)

            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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

          • MaxTTL — (Integer)

            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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

          • 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 forwards 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 a cache behavior or for the default cache behavior in your distribution.

      • 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. If you don't want to specify a value, include an empty element, <ResponsePagePath>, in the XML document.

            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. If you don't want to specify a value, include an empty element, <ResponseCode>, in the XML document.

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

            If you don't want to specify a value, include an empty element, <ErrorCachingMinTTL>, in the XML document.

            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. For price class information, scroll down to see the table at the bottom of the page.

        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)

        • CloudFrontDefaultCertificate — (Boolean)

          For information about how and when to use CloudFrontDefaultCertificate, see ViewerCertificate.

        • IAMCertificateId — (String)

          For information about how and when to use IAMCertificateId, see ViewerCertificate.

        • ACMCertificateArn — (String)

          For information about how and when to use ACMCertificateArn, see ViewerCertificate.

        • SSLSupportMethod — (String)

          If you specify a value for ViewerCertificate$ACMCertificateArn or for ViewerCertificate$IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for all clients or one that works for most clients:

          • vip: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you will incur additional monthly charges.

          • sni-only: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. If some of your users' browsers don't support SNI, we recommend that you do one of the following:

            • Use the vip option (dedicated IP addresses) instead of sni-only.

            • Use the CloudFront SSL/TLS certificate instead of a custom certificate. This requires that you use the CloudFront domain name of your distribution in the URLs for your objects, for example, https://d111111abcdef8.cloudfront.net/logo.png.

            • If you can control which browser your users use, upgrade the browser to one that supports SNI.

            • Use HTTP instead of HTTPS.

          Don't specify a value for SSLSupportMethod if you specified <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>.

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

          Possible values include:
          • "sni-only"
          • "vip"
        • MinimumProtocolVersion — (String)

          Specify the security policy that you want CloudFront to use for HTTPS connections. A security policy determines two settings:

          • The minimum SSL/TLS protocol that CloudFront uses to communicate with viewers

          • The cipher that CloudFront uses to encrypt the content that it returns to viewers

          Note: On the CloudFront console, this setting is called Security policy.

          We recommend that you specify TLSv1.1_2016 unless your users are using browsers or devices that do not support TLSv1.1 or later.

          When both of the following are true, you must specify TLSv1 or later for the security policy:

          • You're using a custom certificate: you specified a value for ACMCertificateArn or for IAMCertificateId

          • You're using SNI: you specified sni-only for SSLSupportMethod

          If you specify true for CloudFrontDefaultCertificate, CloudFront automatically sets the security policy to TLSv1 regardless of the value that you specify for MinimumProtocolVersion.

          For information about the relationship between the security policy that you choose and the protocols and ciphers that CloudFront uses to communicate with viewers, see Supported SSL/TLS Protocols and Ciphers for Communication Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

          Possible values include:
          • "SSLv3"
          • "TLSv1"
          • "TLSv1_2016"
          • "TLSv1.1_2016"
          • "TLSv1.2_2018"
        • Certificate — (String)

          This field has been deprecated. Use one of the following fields instead:

        • CertificateSource — (String)

          This field has been deprecated. Use one of the following fields instead:

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

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

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

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

          • Enabled — required — (Boolean)

            Enabled is true if any of the AWS accounts listed in the TrustedSigners complex type for this RTMP distribution have active CloudFront key pairs. If not, Enabled is false.

            For more information, see ActiveTrustedSigners.

          • Quantity — required — (Integer)

            A complex type that contains one Signer complex type for each trusted signer specified in the TrustedSigners complex type.

            For more information, see ActiveTrustedSigners.

          • Items — (Array<map>)

            A complex type that contains one Signer complex type for each trusted signer that is specified in the TrustedSigners complex type.

            For more information, see ActiveTrustedSigners.

            • AwsAccountNumber — (String)

              An AWS account that is included in the TrustedSigners complex type for this RTMP distribution. Valid values include:

              • self, which is the AWS account used to create the distribution.

              • An AWS account number.

            • KeyPairIds — (map)

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

              • Quantity — required — (Integer)

                The number of active CloudFront key pairs for AwsAccountNumber.

                For more information, see ActiveTrustedSigners.

              • Items — (Array<String>)

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

                For more information, see ActiveTrustedSigners.

        • 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 or origin groups for this distribution.

            • Items — required — (Array<map>)

              A complex type that contains origins or origin groups for this distribution.

              • Id — required — (String)

                A unique identifier for the origin or origin group. The value of Id must be unique within the distribution.

                When you specify the value of TargetOriginId for the default cache behavior or for another cache behavior, you indicate the origin to which you want the cache behavior to route requests by specifying the value of the Id element for that origin. When a request matches the path pattern for that cache behavior, CloudFront routes the request to the specified origin. For more information, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.

              • DomainName — required — (String)

                Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. If you set up your bucket to be configured as a website endpoint, enter the Amazon S3 static website hosting endpoint for the bucket.

                For more information about specifying this value for different types of origins, see Origin Domain Name in the Amazon CloudFront Developer Guide.

                Constraints for Amazon S3 origins:

                • If you configured Amazon S3 Transfer Acceleration for your bucket, don't specify the s3-accelerate endpoint for DomainName.

                • The bucket name must be between 3 and 63 characters long (inclusive).

                • The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.

                • The bucket name must not contain adjacent periods.

                Custom Origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com.

                Constraints for custom origins:

                • DomainName must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or underscore (_) characters.

                • The name cannot exceed 128 characters.

              • OriginPath — (String)

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

                For example, suppose you've specified the following values for your distribution:

                • DomainName: An Amazon S3 bucket named myawsbucket.

                • OriginPath: /production

                • CNAME: example.com

                When a user enters example.com/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/index.html.

                When a user enters example.com/acme/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/acme/index.html.

              • CustomHeaders — (map)

                A complex type that contains names and values for the custom headers that you want.

                • 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 forward to your origin. For more information, see Forwarding Custom Headers to Your Origin (Web Distributions Only) in the Amazon Amazon CloudFront Developer Guide.

                  • HeaderValue — required — (String)

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

              • S3OriginConfig — (map)

                A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element 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)

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

                • HTTPPort — required — (Integer)

                  The HTTP port the custom origin listens on.

                • HTTPSPort — required — (Integer)

                  The HTTPS port the custom origin listens on.

                • OriginProtocolPolicy — required — (String)

                  The origin protocol policy to apply to your origin.

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

                  The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS.

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

                  You can create a custom origin read timeout. All timeout units are in seconds. The default origin read timeout is 30 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 4 seconds; the maximum is 60 seconds.

                  If you need to increase the maximum time limit, contact the AWS Support Center.

                • OriginKeepaliveTimeout — (Integer)

                  You can create a custom keep-alive timeout. All timeout units are in seconds. The default keep-alive timeout is 5 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 1 second; the maximum is 60 seconds.

                  If you need to increase the maximum time limit, contact the AWS Support Center.

          • 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 a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.

            • ForwardedValues — required — (map)

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

              • QueryString — required — (Boolean)

                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)

                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)

                  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)

                  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 Amazon CloudFront Limits in the AWS General Reference.

                  • Quantity — required — (Integer)

                    The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.

                  • Items — (Array<String>)

                    A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior.

              • Headers — (map)

                A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for this cache behavior.

                • Quantity — required — (Integer)

                  The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:

                  • Forward all headers to your origin: Specify 1 for Quantity and * for Name.

                    CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.

                  • Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers.

                  • Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.

                  Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:

                • Items — (Array<String>)

                  A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.

              • QueryStringCacheKeys — (map)

                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 this cache behavior.

                • Items — (Array<String>)

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

            • TrustedSigners — required — (map)

              A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

              If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

              If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

              To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

              • Enabled — required — (Boolean)

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

              • Quantity — required — (Integer)

                The number of trusted signers for this cache behavior.

              • Items — (Array<String>)

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

            • 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 Using an HTTPS Connection to Access Your Objects 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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
              Possible values include:
              • "allow-all"
              • "https-only"
              • "redirect-to-https"
            • MinTTL — required — (Integer)

              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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon 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).

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

            • DefaultTTL — (Integer)

              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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

            • MaxTTL — (Integer)
            • 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 forwards 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 a cache behavior or for the default cache behavior in your distribution.

          • 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 a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.

              • ForwardedValues — required — (map)

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

                • QueryString — required — (Boolean)

                  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)

                  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)

                    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)

                    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 Amazon CloudFront Limits in the AWS General Reference.

                    • Quantity — required — (Integer)

                      The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.

                    • Items — (Array<String>)

                      A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior.

                • Headers — (map)

                  A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for this cache behavior.

                  • Quantity — required — (Integer)

                    The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:

                    • Forward all headers to your origin: Specify 1 for Quantity and * for Name.

                      CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.

                    • Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers.

                    • Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.

                    Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:

                  • Items — (Array<String>)

                    A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.

                • QueryStringCacheKeys — (map)

                  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 this cache behavior.

                  • Items — (Array<String>)

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

              • TrustedSigners — required — (map)

                A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

                If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

                If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

                To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

                • Enabled — required — (Boolean)

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

                • Quantity — required — (Integer)

                  The number of trusted signers for this cache behavior.

                • Items — (Array<String>)

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

              • 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 Using an HTTPS Connection to Access Your Objects 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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
                Possible values include:
                • "allow-all"
                • "https-only"
                • "redirect-to-https"
              • MinTTL — required — (Integer)

                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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon 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).

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

              • DefaultTTL — (Integer)

                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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

              • MaxTTL — (Integer)

                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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

              • 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 forwards 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 a cache behavior or for the default cache behavior in your distribution.

          • 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. If you don't want to specify a value, include an empty element, <ResponsePagePath>, in the XML document.

                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. If you don't want to specify a value, include an empty element, <ResponseCode>, in the XML document.

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

                If you don't want to specify a value, include an empty element, <ErrorCachingMinTTL>, in the XML document.

                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. For price class information, scroll down to see the table at the bottom of the page.

            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)

            • CloudFrontDefaultCertificate — (Boolean)

              For information about how and when to use CloudFrontDefaultCertificate, see ViewerCertificate.

            • IAMCertificateId — (String)

              For information about how and when to use IAMCertificateId, see ViewerCertificate.

            • ACMCertificateArn — (String)

              For information about how and when to use ACMCertificateArn, see ViewerCertificate.

            • SSLSupportMethod — (String)

              If you specify a value for ViewerCertificate$ACMCertificateArn or for ViewerCertificate$IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for all clients or one that works for most clients:

              • vip: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you will incur additional monthly charges.

              • sni-only: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. If some of your users' browsers don't support SNI, we recommend that you do one of the following:

                • Use the vip option (dedicated IP addresses) instead of sni-only.

                • Use the CloudFront SSL/TLS certificate instead of a custom certificate. This requires that you use the CloudFront domain name of your distribution in the URLs for your objects, for example, https://d111111abcdef8.cloudfront.net/logo.png.

                • If you can control which browser your users use, upgrade the browser to one that supports SNI.

                • Use HTTP instead of HTTPS.

              Don't specify a value for SSLSupportMethod if you specified <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>.

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

              Possible values include:
              • "sni-only"
              • "vip"
            • MinimumProtocolVersion — (String)

              Specify the security policy that you want CloudFront to use for HTTPS connections. A security policy determines two settings:

              • The minimum SSL/TLS protocol that CloudFront uses to communicate with viewers

              • The cipher that CloudFront uses to encrypt the content that it returns to viewers

              Note: On the CloudFront console, this setting is called Security policy.

              We recommend that you specify TLSv1.1_2016 unless your users are using browsers or devices that do not support TLSv1.1 or later.

              When both of the following are true, you must specify TLSv1 or later for the security policy:

              • You're using a custom certificate: you specified a value for ACMCertificateArn or for IAMCertificateId

              • You're using SNI: you specified sni-only for SSLSupportMethod

              If you specify true for CloudFrontDefaultCertificate, CloudFront automatically sets the security policy to TLSv1 regardless of the value that you specify for MinimumProtocolVersion.

              For information about the relationship between the security policy that you choose and the protocols and ciphers that CloudFront uses to communicate with viewers, see Supported SSL/TLS Protocols and Ciphers for Communication Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

              Possible values include:
              • "SSLv3"
              • "TLSv1"
              • "TLSv1_2016"
              • "TLSv1.1_2016"
              • "TLSv1.2_2018"
            • Certificate — (String)

              This field has been deprecated. Use one of the following fields instead:

            • CertificateSource — (String)

              This field has been deprecated. Use one of the following fields instead:

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

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

            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.

      • Location — (String)

        The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.

      • 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 */
        ForwardedValues: { /* required */
          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 */
            ]
          }
        },
        MinTTL: 'NUMBER_VALUE', /* required */
        TargetOriginId: 'STRING_VALUE', /* required */
        TrustedSigners: { /* required */
          Enabled: true || false, /* required */
          Quantity: 'NUMBER_VALUE', /* required */
          Items: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        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 */
          }
        },
        Compress: true || false,
        DefaultTTL: 'NUMBER_VALUE',
        FieldLevelEncryptionId: 'STRING_VALUE',
        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',
        SmoothStreaming: true || false
      },
      Enabled: true || false, /* required */
      Origins: { /* required */
        Items: [ /* required */
          {
            DomainName: 'STRING_VALUE', /* required */
            Id: 'STRING_VALUE', /* required */
            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',
            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: [
          {
            ForwardedValues: { /* required */
              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 */
                ]
              }
            },
            MinTTL: 'NUMBER_VALUE', /* required */
            PathPattern: 'STRING_VALUE', /* required */
            TargetOriginId: 'STRING_VALUE', /* required */
            TrustedSigners: { /* required */
              Enabled: true || false, /* required */
              Quantity: 'NUMBER_VALUE', /* required */
              Items: [
                'STRING_VALUE',
                /* more items */
              ]
            },
            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 */
              }
            },
            Compress: true || false,
            DefaultTTL: 'NUMBER_VALUE',
            FieldLevelEncryptionId: 'STRING_VALUE',
            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',
            SmoothStreaming: true || false
          },
          /* 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,
        SSLSupportMethod: sni-only | vip
      },
      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 or origin groups for this distribution.

          • Items — required — (Array<map>)

            A complex type that contains origins or origin groups for this distribution.

            • Id — required — (String)

              A unique identifier for the origin or origin group. The value of Id must be unique within the distribution.

              When you specify the value of TargetOriginId for the default cache behavior or for another cache behavior, you indicate the origin to which you want the cache behavior to route requests by specifying the value of the Id element for that origin. When a request matches the path pattern for that cache behavior, CloudFront routes the request to the specified origin. For more information, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.

            • DomainName — required — (String)

              Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. If you set up your bucket to be configured as a website endpoint, enter the Amazon S3 static website hosting endpoint for the bucket.

              For more information about specifying this value for different types of origins, see Origin Domain Name in the Amazon CloudFront Developer Guide.

              Constraints for Amazon S3 origins:

              • If you configured Amazon S3 Transfer Acceleration for your bucket, don't specify the s3-accelerate endpoint for DomainName.

              • The bucket name must be between 3 and 63 characters long (inclusive).

              • The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.

              • The bucket name must not contain adjacent periods.

              Custom Origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com.

              Constraints for custom origins:

              • DomainName must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or underscore (_) characters.

              • The name cannot exceed 128 characters.

            • OriginPath — (String)

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

              For example, suppose you've specified the following values for your distribution:

              • DomainName: An Amazon S3 bucket named myawsbucket.

              • OriginPath: /production

              • CNAME: example.com

              When a user enters example.com/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/index.html.

              When a user enters example.com/acme/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/acme/index.html.

            • CustomHeaders — (map)

              A complex type that contains names and values for the custom headers that you want.

              • 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 forward to your origin. For more information, see Forwarding Custom Headers to Your Origin (Web Distributions Only) in the Amazon Amazon CloudFront Developer Guide.

                • HeaderValue — required — (String)

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

            • S3OriginConfig — (map)

              A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element 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)

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

              • HTTPPort — required — (Integer)

                The HTTP port the custom origin listens on.

              • HTTPSPort — required — (Integer)

                The HTTPS port the custom origin listens on.

              • OriginProtocolPolicy — required — (String)

                The origin protocol policy to apply to your origin.

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

                The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS.

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

                You can create a custom origin read timeout. All timeout units are in seconds. The default origin read timeout is 30 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 4 seconds; the maximum is 60 seconds.

                If you need to increase the maximum time limit, contact the AWS Support Center.

              • OriginKeepaliveTimeout — (Integer)

                You can create a custom keep-alive timeout. All timeout units are in seconds. The default keep-alive timeout is 5 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 1 second; the maximum is 60 seconds.

                If you need to increase the maximum time limit, contact the AWS Support Center.

        • 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 a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.

          • ForwardedValues — required — (map)

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

            • QueryString — required — (Boolean)

              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)

              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)

                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)

                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 Amazon CloudFront Limits in the AWS General Reference.

                • Quantity — required — (Integer)

                  The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.

                • Items — (Array<String>)

                  A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior.

            • Headers — (map)

              A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for this cache behavior.

              • Quantity — required — (Integer)

                The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:

                • Forward all headers to your origin: Specify 1 for Quantity and * for Name.

                  CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.

                • Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers.

                • Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.

                Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:

              • Items — (Array<String>)

                A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.

            • QueryStringCacheKeys — (map)

              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 this cache behavior.

              • Items — (Array<String>)

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

          • TrustedSigners — required — (map)

            A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

            If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

            If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

            To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

            • Enabled — required — (Boolean)

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

            • Quantity — required — (Integer)

              The number of trusted signers for this cache behavior.

            • Items — (Array<String>)

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

          • 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 Using an HTTPS Connection to Access Your Objects 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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
            Possible values include:
            • "allow-all"
            • "https-only"
            • "redirect-to-https"
          • MinTTL — required — (Integer)

            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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon 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).

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

          • DefaultTTL — (Integer)

            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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

          • MaxTTL — (Integer)
          • 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 forwards 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 a cache behavior or for the default cache behavior in your distribution.

        • 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 a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.

            • ForwardedValues — required — (map)

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

              • QueryString — required — (Boolean)

                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)

                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)

                  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)

                  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 Amazon CloudFront Limits in the AWS General Reference.

                  • Quantity — required — (Integer)

                    The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.

                  • Items — (Array<String>)

                    A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior.

              • Headers — (map)

                A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for this cache behavior.

                • Quantity — required — (Integer)

                  The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:

                  • Forward all headers to your origin: Specify 1 for Quantity and * for Name.

                    CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.

                  • Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers.

                  • Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.

                  Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:

                • Items — (Array<String>)

                  A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.

              • QueryStringCacheKeys — (map)

                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 this cache behavior.

                • Items — (Array<String>)

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

            • TrustedSigners — required — (map)

              A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

              If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

              If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

              To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

              • Enabled — required — (Boolean)

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

              • Quantity — required — (Integer)

                The number of trusted signers for this cache behavior.

              • Items — (Array<String>)

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

            • 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 Using an HTTPS Connection to Access Your Objects 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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
              Possible values include:
              • "allow-all"
              • "https-only"
              • "redirect-to-https"
            • MinTTL — required — (Integer)

              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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon 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).

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

            • DefaultTTL — (Integer)

              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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

            • MaxTTL — (Integer)

              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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

            • 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 forwards 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 a cache behavior or for the default cache behavior in your distribution.

        • 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. If you don't want to specify a value, include an empty element, <ResponsePagePath>, in the XML document.

              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. If you don't want to specify a value, include an empty element, <ResponseCode>, in the XML document.

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

              If you don't want to specify a value, include an empty element, <ErrorCachingMinTTL>, in the XML document.

              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. For price class information, scroll down to see the table at the bottom of the page.

          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)

          • CloudFrontDefaultCertificate — (Boolean)

            For information about how and when to use CloudFrontDefaultCertificate, see ViewerCertificate.

          • IAMCertificateId — (String)

            For information about how and when to use IAMCertificateId, see ViewerCertificate.

          • ACMCertificateArn — (String)

            For information about how and when to use ACMCertificateArn, see ViewerCertificate.

          • SSLSupportMethod — (String)

            If you specify a value for ViewerCertificate$ACMCertificateArn or for ViewerCertificate$IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for all clients or one that works for most clients:

            • vip: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you will incur additional monthly charges.

            • sni-only: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. If some of your users' browsers don't support SNI, we recommend that you do one of the following:

              • Use the vip option (dedicated IP addresses) instead of sni-only.

              • Use the CloudFront SSL/TLS certificate instead of a custom certificate. This requires that you use the CloudFront domain name of your distribution in the URLs for your objects, for example, https://d111111abcdef8.cloudfront.net/logo.png.

              • If you can control which browser your users use, upgrade the browser to one that supports SNI.

              • Use HTTP instead of HTTPS.

            Don't specify a value for SSLSupportMethod if you specified <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>.

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

            Possible values include:
            • "sni-only"
            • "vip"
          • MinimumProtocolVersion — (String)

            Specify the security policy that you want CloudFront to use for HTTPS connections. A security policy determines two settings:

            • The minimum SSL/TLS protocol that CloudFront uses to communicate with viewers

            • The cipher that CloudFront uses to encrypt the content that it returns to viewers

            Note: On the CloudFront console, this setting is called Security policy.

            We recommend that you specify TLSv1.1_2016 unless your users are using browsers or devices that do not support TLSv1.1 or later.

            When both of the following are true, you must specify TLSv1 or later for the security policy:

            • You're using a custom certificate: you specified a value for ACMCertificateArn or for IAMCertificateId

            • You're using SNI: you specified sni-only for SSLSupportMethod

            If you specify true for CloudFrontDefaultCertificate, CloudFront automatically sets the security policy to TLSv1 regardless of the value that you specify for MinimumProtocolVersion.

            For information about the relationship between the security policy that you choose and the protocols and ciphers that CloudFront uses to communicate with viewers, see Supported SSL/TLS Protocols and Ciphers for Communication Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

            Possible values include:
            • "SSLv3"
            • "TLSv1"
            • "TLSv1_2016"
            • "TLSv1.1_2016"
            • "TLSv1.2_2018"
          • Certificate — (String)

            This field has been deprecated. Use one of the following fields instead:

          • CertificateSource — (String)

            This field has been deprecated. Use one of the following fields instead:

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

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

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

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

          • Enabled — required — (Boolean)

            Enabled is true if any of the AWS accounts listed in the TrustedSigners complex type for this RTMP distribution have active CloudFront key pairs. If not, Enabled is false.

            For more information, see ActiveTrustedSigners.

          • Quantity — required — (Integer)

            A complex type that contains one Signer complex type for each trusted signer specified in the TrustedSigners complex type.

            For more information, see ActiveTrustedSigners.

          • Items — (Array<map>)

            A complex type that contains one Signer complex type for each trusted signer that is specified in the TrustedSigners complex type.

            For more information, see ActiveTrustedSigners.

            • AwsAccountNumber — (String)

              An AWS account that is included in the TrustedSigners complex type for this RTMP distribution. Valid values include:

              • self, which is the AWS account used to create the distribution.

              • An AWS account number.

            • KeyPairIds — (map)

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

              • Quantity — required — (Integer)

                The number of active CloudFront key pairs for AwsAccountNumber.

                For more information, see ActiveTrustedSigners.

              • Items — (Array<String>)

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

                For more information, see ActiveTrustedSigners.

        • 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 or origin groups for this distribution.

            • Items — required — (Array<map>)

              A complex type that contains origins or origin groups for this distribution.

              • Id — required — (String)

                A unique identifier for the origin or origin group. The value of Id must be unique within the distribution.

                When you specify the value of TargetOriginId for the default cache behavior or for another cache behavior, you indicate the origin to which you want the cache behavior to route requests by specifying the value of the Id element for that origin. When a request matches the path pattern for that cache behavior, CloudFront routes the request to the specified origin. For more information, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.

              • DomainName — required — (String)

                Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. If you set up your bucket to be configured as a website endpoint, enter the Amazon S3 static website hosting endpoint for the bucket.

                For more information about specifying this value for different types of origins, see Origin Domain Name in the Amazon CloudFront Developer Guide.

                Constraints for Amazon S3 origins:

                • If you configured Amazon S3 Transfer Acceleration for your bucket, don't specify the s3-accelerate endpoint for DomainName.

                • The bucket name must be between 3 and 63 characters long (inclusive).

                • The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.

                • The bucket name must not contain adjacent periods.

                Custom Origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com.

                Constraints for custom origins:

                • DomainName must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or underscore (_) characters.

                • The name cannot exceed 128 characters.

              • OriginPath — (String)

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

                For example, suppose you've specified the following values for your distribution:

                • DomainName: An Amazon S3 bucket named myawsbucket.

                • OriginPath: /production

                • CNAME: example.com

                When a user enters example.com/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/index.html.

                When a user enters example.com/acme/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/acme/index.html.

              • CustomHeaders — (map)

                A complex type that contains names and values for the custom headers that you want.

                • 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 forward to your origin. For more information, see Forwarding Custom Headers to Your Origin (Web Distributions Only) in the Amazon Amazon CloudFront Developer Guide.

                  • HeaderValue — required — (String)

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

              • S3OriginConfig — (map)

                A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element 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)

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

                • HTTPPort — required — (Integer)

                  The HTTP port the custom origin listens on.

                • HTTPSPort — required — (Integer)

                  The HTTPS port the custom origin listens on.

                • OriginProtocolPolicy — required — (String)

                  The origin protocol policy to apply to your origin.

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

                  The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS.

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

                  You can create a custom origin read timeout. All timeout units are in seconds. The default origin read timeout is 30 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 4 seconds; the maximum is 60 seconds.

                  If you need to increase the maximum time limit, contact the AWS Support Center.

                • OriginKeepaliveTimeout — (Integer)

                  You can create a custom keep-alive timeout. All timeout units are in seconds. The default keep-alive timeout is 5 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 1 second; the maximum is 60 seconds.

                  If you need to increase the maximum time limit, contact the AWS Support Center.

          • 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 a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.

            • ForwardedValues — required — (map)

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

              • QueryString — required — (Boolean)

                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)

                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)

                  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)

                  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 Amazon CloudFront Limits in the AWS General Reference.

                  • Quantity — required — (Integer)

                    The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.

                  • Items — (Array<String>)

                    A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior.

              • Headers — (map)

                A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for this cache behavior.

                • Quantity — required — (Integer)

                  The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:

                  • Forward all headers to your origin: Specify 1 for Quantity and * for Name.

                    CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.

                  • Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers.

                  • Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.

                  Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:

                • Items — (Array<String>)

                  A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.

              • QueryStringCacheKeys — (map)

                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 this cache behavior.

                • Items — (Array<String>)

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

            • TrustedSigners — required — (map)

              A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

              If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

              If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

              To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

              • Enabled — required — (Boolean)

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

              • Quantity — required — (Integer)

                The number of trusted signers for this cache behavior.

              • Items — (Array<String>)

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

            • 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 Using an HTTPS Connection to Access Your Objects 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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
              Possible values include:
              • "allow-all"
              • "https-only"
              • "redirect-to-https"
            • MinTTL — required — (Integer)

              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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon 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).

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

            • DefaultTTL — (Integer)

              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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

            • MaxTTL — (Integer)
            • 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 forwards 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 a cache behavior or for the default cache behavior in your distribution.

          • 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 a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.

              • ForwardedValues — required — (map)

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

                • QueryString — required — (Boolean)

                  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)

                  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)

                    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)

                    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 Amazon CloudFront Limits in the AWS General Reference.

                    • Quantity — required — (Integer)

                      The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.

                    • Items — (Array<String>)

                      A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior.

                • Headers — (map)

                  A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for this cache behavior.

                  • Quantity — required — (Integer)

                    The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:

                    • Forward all headers to your origin: Specify 1 for Quantity and * for Name.

                      CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.

                    • Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers.

                    • Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.

                    Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:

                  • Items — (Array<String>)

                    A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.

                • QueryStringCacheKeys — (map)

                  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 this cache behavior.

                  • Items — (Array<String>)

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

              • TrustedSigners — required — (map)

                A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

                If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

                If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

                To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

                • Enabled — required — (Boolean)

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

                • Quantity — required — (Integer)

                  The number of trusted signers for this cache behavior.

                • Items — (Array<String>)

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

              • 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 Using an HTTPS Connection to Access Your Objects 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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
                Possible values include:
                • "allow-all"
                • "https-only"
                • "redirect-to-https"
              • MinTTL — required — (Integer)

                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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon 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).

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

              • DefaultTTL — (Integer)

                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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

              • MaxTTL — (Integer)

                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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

              • 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 forwards 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 a cache behavior or for the default cache behavior in your distribution.

          • 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. If you don't want to specify a value, include an empty element, <ResponsePagePath>, in the XML document.

                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. If you don't want to specify a value, include an empty element, <ResponseCode>, in the XML document.

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

                If you don't want to specify a value, include an empty element, <ErrorCachingMinTTL>, in the XML document.

                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. For price class information, scroll down to see the table at the bottom of the page.

            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)

            • CloudFrontDefaultCertificate — (Boolean)

              For information about how and when to use CloudFrontDefaultCertificate, see ViewerCertificate.

            • IAMCertificateId — (String)

              For information about how and when to use IAMCertificateId, see ViewerCertificate.

            • ACMCertificateArn — (String)

              For information about how and when to use ACMCertificateArn, see ViewerCertificate.

            • SSLSupportMethod — (String)

              If you specify a value for ViewerCertificate$ACMCertificateArn or for ViewerCertificate$IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for all clients or one that works for most clients:

              • vip: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you will incur additional monthly charges.

              • sni-only: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. If some of your users' browsers don't support SNI, we recommend that you do one of the following:

                • Use the vip option (dedicated IP addresses) instead of sni-only.

                • Use the CloudFront SSL/TLS certificate instead of a custom certificate. This requires that you use the CloudFront domain name of your distribution in the URLs for your objects, for example, https://d111111abcdef8.cloudfront.net/logo.png.

                • If you can control which browser your users use, upgrade the browser to one that supports SNI.

                • Use HTTP instead of HTTPS.

              Don't specify a value for SSLSupportMethod if you specified <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>.

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

              Possible values include:
              • "sni-only"
              • "vip"
            • MinimumProtocolVersion — (String)

              Specify the security policy that you want CloudFront to use for HTTPS connections. A security policy determines two settings:

              • The minimum SSL/TLS protocol that CloudFront uses to communicate with viewers

              • The cipher that CloudFront uses to encrypt the content that it returns to viewers

              Note: On the CloudFront console, this setting is called Security policy.

              We recommend that you specify TLSv1.1_2016 unless your users are using browsers or devices that do not support TLSv1.1 or later.

              When both of the following are true, you must specify TLSv1 or later for the security policy:

              • You're using a custom certificate: you specified a value for ACMCertificateArn or for IAMCertificateId

              • You're using SNI: you specified sni-only for SSLSupportMethod

              If you specify true for CloudFrontDefaultCertificate, CloudFront automatically sets the security policy to TLSv1 regardless of the value that you specify for MinimumProtocolVersion.

              For information about the relationship between the security policy that you choose and the protocols and ciphers that CloudFront uses to communicate with viewers, see Supported SSL/TLS Protocols and Ciphers for Communication Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

              Possible values include:
              • "SSLv3"
              • "TLSv1"
              • "TLSv1_2016"
              • "TLSv1.1_2016"
              • "TLSv1.2_2018"
            • Certificate — (String)

              This field has been deprecated. Use one of the following fields instead:

            • CertificateSource — (String)

              This field has been deprecated. Use one of the following fields instead:

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

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

            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.

      • Location — (String)

        The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.

      • 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. For example: https://cloudfront.amazonaws.com/2010-11-01/field-level-encryption-config/EDFDVBD632BHDS5.

      • 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. For example: https://cloudfront.amazonaws.com/2010-11-01/field-level-encryption-profile/EDFDVBD632BHDS5.

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

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

Add a new public key to CloudFront to use, for example, for field-level encryption. You can add a maximum of 10 public keys with one AWS account.

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)

      The request to add a public key to CloudFront.

      • CallerReference — required — (String)

        A unique number that ensures that the request can't be replayed.

      • Name — required — (String)

        The name for a public key you add to CloudFront to use with features like field-level encryption.

      • EncodedKey — required — (String)

        The encoded public key that you want to add to CloudFront to use with features like field-level encryption.

      • Comment — (String)

        An optional comment about a 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)

        Returned when you add a public key.

        • Id — required — (String)

          A unique ID assigned to a public key you've added to CloudFront.

        • CreatedTime — required — (Date)

          A time you added a public key to CloudFront.

        • PublicKeyConfig — required — (map)

          A complex data type for a public key you add to CloudFront to use with features like field-level encryption.

          • CallerReference — required — (String)

            A unique number that ensures that the request can't be replayed.

          • Name — required — (String)

            The name for a public key you add to CloudFront to use with features like field-level encryption.

          • EncodedKey — required — (String)

            The encoded public key that you want to add to CloudFront to use with features like field-level encryption.

          • Comment — (String)

            An optional comment about a public key.

      • Location — (String)

        The fully qualified URI of the new public key resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/cloudfront-public-key/EDFDVBD632BHDS5.

      • ETag — (String)

        The current version of the public key. For example: E2QWRUHAPOMQZL.

Returns:

  • (AWS.Request) —

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

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

Creates a new RMTP 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 web 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 RTMP 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 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)

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

        • Quantity — required — (Integer)

          The number of trusted signers for this cache behavior.

        • Items — (Array<String>)

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

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

            Enabled is true if any of the AWS accounts listed in the TrustedSigners complex type for this RTMP distribution have active CloudFront key pairs. If not, Enabled is false.

            For more information, see ActiveTrustedSigners.

          • Quantity — required — (Integer)

            A complex type that contains one Signer complex type for each trusted signer specified in the TrustedSigners complex type.

            For more information, see ActiveTrustedSigners.

          • Items — (Array<map>)

            A complex type that contains one Signer complex type for each trusted signer that is specified in the TrustedSigners complex type.

            For more information, see ActiveTrustedSigners.

            • AwsAccountNumber — (String)

              An AWS account that is included in the TrustedSigners complex type for this RTMP distribution. Valid values include:

              • self, which is the AWS account used to create the distribution.

              • An AWS account number.

            • KeyPairIds — (map)

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

              • Quantity — required — (Integer)

                The number of active CloudFront key pairs for AwsAccountNumber.

                For more information, see ActiveTrustedSigners.

              • Items — (Array<String>)

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

                For more information, see ActiveTrustedSigners.

        • 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 RTMP 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 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)

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

            • Quantity — required — (Integer)

              The number of trusted signers for this cache behavior.

            • Items — (Array<String>)

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

          • 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. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.

      • 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 RTMP 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 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)

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

          • Quantity — required — (Integer)

            The number of trusted signers for this cache behavior.

          • Items — (Array<String>)

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

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

            Enabled is true if any of the AWS accounts listed in the TrustedSigners complex type for this RTMP distribution have active CloudFront key pairs. If not, Enabled is false.

            For more information, see ActiveTrustedSigners.

          • Quantity — required — (Integer)

            A complex type that contains one Signer complex type for each trusted signer specified in the TrustedSigners complex type.

            For more information, see ActiveTrustedSigners.

          • Items — (Array<map>)

            A complex type that contains one Signer complex type for each trusted signer that is specified in the TrustedSigners complex type.

            For more information, see ActiveTrustedSigners.

            • AwsAccountNumber — (String)

              An AWS account that is included in the TrustedSigners complex type for this RTMP distribution. Valid values include:

              • self, which is the AWS account used to create the distribution.

              • An AWS account number.

            • KeyPairIds — (map)

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

              • Quantity — required — (Integer)

                The number of active CloudFront key pairs for AwsAccountNumber.

                For more information, see ActiveTrustedSigners.

              • Items — (Array<String>)

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

                For more information, see ActiveTrustedSigners.

        • 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 RTMP 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 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)

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

            • Quantity — required — (Integer)

              The number of trusted signers for this cache behavior.

            • Items — (Array<String>)

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

          • 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. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.

      • ETag — (String)

        The current version of the distribution created.

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.

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.

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.

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.

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

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

          • Enabled — required — (Boolean)

            Enabled is true if any of the AWS accounts listed in the TrustedSigners complex type for this RTMP distribution have active CloudFront key pairs. If not, Enabled is false.

            For more information, see ActiveTrustedSigners.

          • Quantity — required — (Integer)

            A complex type that contains one Signer complex type for each trusted signer specified in the TrustedSigners complex type.

            For more information, see ActiveTrustedSigners.

          • Items — (Array<map>)

            A complex type that contains one Signer complex type for each trusted signer that is specified in the TrustedSigners complex type.

            For more information, see ActiveTrustedSigners.

            • AwsAccountNumber — (String)

              An AWS account that is included in the TrustedSigners complex type for this RTMP distribution. Valid values include:

              • self, which is the AWS account used to create the distribution.

              • An AWS account number.

            • KeyPairIds — (map)

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

              • Quantity — required — (Integer)

                The number of active CloudFront key pairs for AwsAccountNumber.

                For more information, see ActiveTrustedSigners.

              • Items — (Array<String>)

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

                For more information, see ActiveTrustedSigners.

        • 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 or origin groups for this distribution.

            • Items — required — (Array<map>)

              A complex type that contains origins or origin groups for this distribution.

              • Id — required — (String)

                A unique identifier for the origin or origin group. The value of Id must be unique within the distribution.

                When you specify the value of TargetOriginId for the default cache behavior or for another cache behavior, you indicate the origin to which you want the cache behavior to route requests by specifying the value of the Id element for that origin. When a request matches the path pattern for that cache behavior, CloudFront routes the request to the specified origin. For more information, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.

              • DomainName — required — (String)

                Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. If you set up your bucket to be configured as a website endpoint, enter the Amazon S3 static website hosting endpoint for the bucket.

                For more information about specifying this value for different types of origins, see Origin Domain Name in the Amazon CloudFront Developer Guide.

                Constraints for Amazon S3 origins:

                • If you configured Amazon S3 Transfer Acceleration for your bucket, don't specify the s3-accelerate endpoint for DomainName.

                • The bucket name must be between 3 and 63 characters long (inclusive).

                • The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.

                • The bucket name must not contain adjacent periods.

                Custom Origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com.

                Constraints for custom origins:

                • DomainName must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or underscore (_) characters.

                • The name cannot exceed 128 characters.

              • OriginPath — (String)

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

                For example, suppose you've specified the following values for your distribution:

                • DomainName: An Amazon S3 bucket named myawsbucket.

                • OriginPath: /production

                • CNAME: example.com

                When a user enters example.com/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/index.html.

                When a user enters example.com/acme/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/acme/index.html.

              • CustomHeaders — (map)

                A complex type that contains names and values for the custom headers that you want.

                • 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 forward to your origin. For more information, see Forwarding Custom Headers to Your Origin (Web Distributions Only) in the Amazon Amazon CloudFront Developer Guide.

                  • HeaderValue — required — (String)

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

              • S3OriginConfig — (map)

                A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element 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)

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

                • HTTPPort — required — (Integer)

                  The HTTP port the custom origin listens on.

                • HTTPSPort — required — (Integer)

                  The HTTPS port the custom origin listens on.

                • OriginProtocolPolicy — required — (String)

                  The origin protocol policy to apply to your origin.

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

                  The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS.

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

                  You can create a custom origin read timeout. All timeout units are in seconds. The default origin read timeout is 30 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 4 seconds; the maximum is 60 seconds.

                  If you need to increase the maximum time limit, contact the AWS Support Center.

                • OriginKeepaliveTimeout — (Integer)

                  You can create a custom keep-alive timeout. All timeout units are in seconds. The default keep-alive timeout is 5 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 1 second; the maximum is 60 seconds.

                  If you need to increase the maximum time limit, contact the AWS Support Center.

          • 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 a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.

            • ForwardedValues — required — (map)

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

              • QueryString — required — (Boolean)

                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)

                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)

                  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)

                  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 Amazon CloudFront Limits in the AWS General Reference.

                  • Quantity — required — (Integer)

                    The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.

                  • Items — (Array<String>)

                    A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior.

              • Headers — (map)

                A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for this cache behavior.

                • Quantity — required — (Integer)

                  The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:

                  • Forward all headers to your origin: Specify 1 for Quantity and * for Name.

                    CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.

                  • Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers.

                  • Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.

                  Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:

                • Items — (Array<String>)

                  A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.

              • QueryStringCacheKeys — (map)

                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 this cache behavior.

                • Items — (Array<String>)

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

            • TrustedSigners — required — (map)

              A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

              If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

              If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

              To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

              • Enabled — required — (Boolean)

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

              • Quantity — required — (Integer)

                The number of trusted signers for this cache behavior.

              • Items — (Array<String>)

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

            • 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 Using an HTTPS Connection to Access Your Objects 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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
              Possible values include:
              • "allow-all"
              • "https-only"
              • "redirect-to-https"
            • MinTTL — required — (Integer)

              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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon 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).

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

            • DefaultTTL — (Integer)

              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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

            • MaxTTL — (Integer)
            • 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 forwards 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 a cache behavior or for the default cache behavior in your distribution.

          • 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 a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.

              • ForwardedValues — required — (map)

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

                • QueryString — required — (Boolean)

                  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)

                  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)

                    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)

                    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 Amazon CloudFront Limits in the AWS General Reference.

                    • Quantity — required — (Integer)

                      The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.

                    • Items — (Array<String>)

                      A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior.

                • Headers — (map)

                  A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for this cache behavior.

                  • Quantity — required — (Integer)

                    The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:

                    • Forward all headers to your origin: Specify 1 for Quantity and * for Name.

                      CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.

                    • Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers.

                    • Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.

                    Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:

                  • Items — (Array<String>)

                    A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.

                • QueryStringCacheKeys — (map)

                  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 this cache behavior.

                  • Items — (Array<String>)

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

              • TrustedSigners — required — (map)

                A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

                If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

                If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

                To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

                • Enabled — required — (Boolean)

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

                • Quantity — required — (Integer)

                  The number of trusted signers for this cache behavior.

                • Items — (Array<String>)

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

              • 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 Using an HTTPS Connection to Access Your Objects 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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
                Possible values include:
                • "allow-all"
                • "https-only"
                • "redirect-to-https"
              • MinTTL — required — (Integer)

                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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon 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).

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

              • DefaultTTL — (Integer)

                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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

              • MaxTTL — (Integer)

                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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

              • 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 forwards 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 a cache behavior or for the default cache behavior in your distribution.

          • 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. If you don't want to specify a value, include an empty element, <ResponsePagePath>, in the XML document.

                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. If you don't want to specify a value, include an empty element, <ResponseCode>, in the XML document.

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

                If you don't want to specify a value, include an empty element, <ErrorCachingMinTTL>, in the XML document.

                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. For price class information, scroll down to see the table at the bottom of the page.

            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)

            • CloudFrontDefaultCertificate — (Boolean)

              For information about how and when to use CloudFrontDefaultCertificate, see ViewerCertificate.

            • IAMCertificateId — (String)

              For information about how and when to use IAMCertificateId, see ViewerCertificate.

            • ACMCertificateArn — (String)

              For information about how and when to use ACMCertificateArn, see ViewerCertificate.

            • SSLSupportMethod — (String)

              If you specify a value for ViewerCertificate$ACMCertificateArn or for ViewerCertificate$IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for all clients or one that works for most clients:

              • vip: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you will incur additional monthly charges.

              • sni-only: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. If some of your users' browsers don't support SNI, we recommend that you do one of the following:

                • Use the vip option (dedicated IP addresses) instead of sni-only.

                • Use the CloudFront SSL/TLS certificate instead of a custom certificate. This requires that you use the CloudFront domain name of your distribution in the URLs for your objects, for example, https://d111111abcdef8.cloudfront.net/logo.png.

                • If you can control which browser your users use, upgrade the browser to one that supports SNI.

                • Use HTTP instead of HTTPS.

              Don't specify a value for SSLSupportMethod if you specified <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>.

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

              Possible values include:
              • "sni-only"
              • "vip"
            • MinimumProtocolVersion — (String)

              Specify the security policy that you want CloudFront to use for HTTPS connections. A security policy determines two settings:

              • The minimum SSL/TLS protocol that CloudFront uses to communicate with viewers

              • The cipher that CloudFront uses to encrypt the content that it returns to viewers

              Note: On the CloudFront console, this setting is called Security policy.

              We recommend that you specify TLSv1.1_2016 unless your users are using browsers or devices that do not support TLSv1.1 or later.

              When both of the following are true, you must specify TLSv1 or later for the security policy:

              • You're using a custom certificate: you specified a value for ACMCertificateArn or for IAMCertificateId

              • You're using SNI: you specified sni-only for SSLSupportMethod

              If you specify true for CloudFrontDefaultCertificate, CloudFront automatically sets the security policy to TLSv1 regardless of the value that you specify for MinimumProtocolVersion.

              For information about the relationship between the security policy that you choose and the protocols and ciphers that CloudFront uses to communicate with viewers, see Supported SSL/TLS Protocols and Ciphers for Communication Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

              Possible values include:
              • "SSLv3"
              • "TLSv1"
              • "TLSv1_2016"
              • "TLSv1.1_2016"
              • "TLSv1.2_2018"
            • Certificate — (String)

              This field has been deprecated. Use one of the following fields instead:

            • CertificateSource — (String)

              This field has been deprecated. Use one of the following fields instead:

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

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

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

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 or origin groups for this distribution.

          • Items — required — (Array<map>)

            A complex type that contains origins or origin groups for this distribution.

            • Id — required — (String)

              A unique identifier for the origin or origin group. The value of Id must be unique within the distribution.

              When you specify the value of TargetOriginId for the default cache behavior or for another cache behavior, you indicate the origin to which you want the cache behavior to route requests by specifying the value of the Id element for that origin. When a request matches the path pattern for that cache behavior, CloudFront routes the request to the specified origin. For more information, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.

            • DomainName — required — (String)

              Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. If you set up your bucket to be configured as a website endpoint, enter the Amazon S3 static website hosting endpoint for the bucket.

              For more information about specifying this value for different types of origins, see Origin Domain Name in the Amazon CloudFront Developer Guide.

              Constraints for Amazon S3 origins:

              • If you configured Amazon S3 Transfer Acceleration for your bucket, don't specify the s3-accelerate endpoint for DomainName.

              • The bucket name must be between 3 and 63 characters long (inclusive).

              • The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.

              • The bucket name must not contain adjacent periods.

              Custom Origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com.

              Constraints for custom origins:

              • DomainName must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or underscore (_) characters.

              • The name cannot exceed 128 characters.

            • OriginPath — (String)

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

              For example, suppose you've specified the following values for your distribution:

              • DomainName: An Amazon S3 bucket named myawsbucket.

              • OriginPath: /production

              • CNAME: example.com

              When a user enters example.com/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/index.html.

              When a user enters example.com/acme/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/acme/index.html.

            • CustomHeaders — (map)

              A complex type that contains names and values for the custom headers that you want.

              • 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 forward to your origin. For more information, see Forwarding Custom Headers to Your Origin (Web Distributions Only) in the Amazon Amazon CloudFront Developer Guide.

                • HeaderValue — required — (String)

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

            • S3OriginConfig — (map)

              A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element 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)

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

              • HTTPPort — required — (Integer)

                The HTTP port the custom origin listens on.

              • HTTPSPort — required — (Integer)

                The HTTPS port the custom origin listens on.

              • OriginProtocolPolicy — required — (String)

                The origin protocol policy to apply to your origin.

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

                The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS.

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

                You can create a custom origin read timeout. All timeout units are in seconds. The default origin read timeout is 30 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 4 seconds; the maximum is 60 seconds.

                If you need to increase the maximum time limit, contact the AWS Support Center.

              • OriginKeepaliveTimeout — (Integer)

                You can create a custom keep-alive timeout. All timeout units are in seconds. The default keep-alive timeout is 5 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 1 second; the maximum is 60 seconds.

                If you need to increase the maximum time limit, contact the AWS Support Center.

        • 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 a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.

          • ForwardedValues — required — (map)

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

            • QueryString — required — (Boolean)

              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)

              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)

                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)

                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 Amazon CloudFront Limits in the AWS General Reference.

                • Quantity — required — (Integer)

                  The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.

                • Items — (Array<String>)

                  A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior.

            • Headers — (map)

              A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for this cache behavior.

              • Quantity — required — (Integer)

                The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:

                • Forward all headers to your origin: Specify 1 for Quantity and * for Name.

                  CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.

                • Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers.

                • Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.

                Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:

              • Items — (Array<String>)

                A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.

            • QueryStringCacheKeys — (map)

              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 this cache behavior.

              • Items — (Array<String>)

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

          • TrustedSigners — required — (map)

            A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

            If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

            If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

            To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

            • Enabled — required — (Boolean)

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

            • Quantity — required — (Integer)

              The number of trusted signers for this cache behavior.

            • Items — (Array<String>)

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

          • 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 Using an HTTPS Connection to Access Your Objects 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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
            Possible values include:
            • "allow-all"
            • "https-only"
            • "redirect-to-https"
          • MinTTL — required — (Integer)

            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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon 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).

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

          • DefaultTTL — (Integer)

            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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

          • MaxTTL — (Integer)
          • 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 forwards 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 a cache behavior or for the default cache behavior in your distribution.

        • 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 a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.

            • ForwardedValues — required — (map)

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

              • QueryString — required — (Boolean)

                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)

                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)

                  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)

                  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 Amazon CloudFront Limits in the AWS General Reference.

                  • Quantity — required — (Integer)

                    The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.

                  • Items — (Array<String>)

                    A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior.

              • Headers — (map)

                A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for this cache behavior.

                • Quantity — required — (Integer)

                  The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:

                  • Forward all headers to your origin: Specify 1 for Quantity and * for Name.

                    CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.

                  • Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers.

                  • Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.

                  Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:

                • Items — (Array<String>)

                  A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.

              • QueryStringCacheKeys — (map)

                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 this cache behavior.

                • Items — (Array<String>)

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

            • TrustedSigners — required — (map)

              A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

              If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

              If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

              To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

              • Enabled — required — (Boolean)

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

              • Quantity — required — (Integer)

                The number of trusted signers for this cache behavior.

              • Items — (Array<String>)

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

            • 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 Using an HTTPS Connection to Access Your Objects 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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
              Possible values include:
              • "allow-all"
              • "https-only"
              • "redirect-to-https"
            • MinTTL — required — (Integer)

              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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon 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).

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

            • DefaultTTL — (Integer)

              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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

            • MaxTTL — (Integer)

              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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

            • 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 forwards 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 a cache behavior or for the default cache behavior in your distribution.

        • 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. If you don't want to specify a value, include an empty element, <ResponsePagePath>, in the XML document.

              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. If you don't want to specify a value, include an empty element, <ResponseCode>, in the XML document.

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

              If you don't want to specify a value, include an empty element, <ErrorCachingMinTTL>, in the XML document.

              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. For price class information, scroll down to see the table at the bottom of the page.

          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)

          • CloudFrontDefaultCertificate — (Boolean)

            For information about how and when to use CloudFrontDefaultCertificate, see ViewerCertificate.

          • IAMCertificateId — (String)

            For information about how and when to use IAMCertificateId, see ViewerCertificate.

          • ACMCertificateArn — (String)

            For information about how and when to use ACMCertificateArn, see ViewerCertificate.

          • SSLSupportMethod — (String)

            If you specify a value for ViewerCertificate$ACMCertificateArn or for ViewerCertificate$IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for all clients or one that works for most clients:

            • vip: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you will incur additional monthly charges.

            • sni-only: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. If some of your users' browsers don't support SNI, we recommend that you do one of the following:

              • Use the vip option (dedicated IP addresses) instead of sni-only.

              • Use the CloudFront SSL/TLS certificate instead of a custom certificate. This requires that you use the CloudFront domain name of your distribution in the URLs for your objects, for example, https://d111111abcdef8.cloudfront.net/logo.png.

              • If you can control which browser your users use, upgrade the browser to one that supports SNI.

              • Use HTTP instead of HTTPS.

            Don't specify a value for SSLSupportMethod if you specified <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>.

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

            Possible values include:
            • "sni-only"
            • "vip"
          • MinimumProtocolVersion — (String)

            Specify the security policy that you want CloudFront to use for HTTPS connections. A security policy determines two settings:

            • The minimum SSL/TLS protocol that CloudFront uses to communicate with viewers

            • The cipher that CloudFront uses to encrypt the content that it returns to viewers

            Note: On the CloudFront console, this setting is called Security policy.

            We recommend that you specify TLSv1.1_2016 unless your users are using browsers or devices that do not support TLSv1.1 or later.

            When both of the following are true, you must specify TLSv1 or later for the security policy:

            • You're using a custom certificate: you specified a value for ACMCertificateArn or for IAMCertificateId

            • You're using SNI: you specified sni-only for SSLSupportMethod

            If you specify true for CloudFrontDefaultCertificate, CloudFront automatically sets the security policy to TLSv1 regardless of the value that you specify for MinimumProtocolVersion.

            For information about the relationship between the security policy that you choose and the protocols and ciphers that CloudFront uses to communicate with viewers, see Supported SSL/TLS Protocols and Ciphers for Communication Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

            Possible values include:
            • "SSLv3"
            • "TLSv1"
            • "TLSv1_2016"
            • "TLSv1.1_2016"
            • "TLSv1.2_2018"
          • Certificate — (String)

            This field has been deprecated. Use one of the following fields instead:

          • CertificateSource — (String)

            This field has been deprecated. Use one of the following fields instead:

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

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

          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 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:

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

Get the public key information.

Service Reference:

Examples:

Calling the getPublicKey operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
cloudfront.getPublicKey(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 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)

        Return the public key.

        • Id — required — (String)

          A unique ID assigned to a public key you've added to CloudFront.

        • CreatedTime — required — (Date)

          A time you added a public key to CloudFront.

        • PublicKeyConfig — required — (map)

          A complex data type for a public key you add to CloudFront to use with features like field-level encryption.

          • CallerReference — required — (String)

            A unique number that ensures that the request can't be replayed.

          • Name — required — (String)

            The name for a public key you add to CloudFront to use with features like field-level encryption.

          • EncodedKey — required — (String)

            The encoded public key that you want to add to CloudFront to use with features like field-level encryption.

          • Comment — (String)

            An optional comment about a public key.

      • ETag — (String)

        The current version of the public key. For example: E2QWRUHAPOMQZL.

Returns:

  • (AWS.Request) —

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

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

Return public key configuration informaation

Service Reference:

Examples:

Calling the getPublicKeyConfig operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
cloudfront.getPublicKeyConfig(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 public key configuration.

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:

      • PublicKeyConfig — (map)

        Return the result for the public key configuration.

        • CallerReference — required — (String)

          A unique number that ensures that the request can't be replayed.

        • Name — required — (String)

          The name for a public key you add to CloudFront to use with features like field-level encryption.

        • EncodedKey — required — (String)

          The encoded public key that you want to add to CloudFront to use with features like field-level encryption.

        • Comment — (String)

          An optional comment about a public key.

      • ETag — (String)

        The current version of the public key configuration. For example: E2QWRUHAPOMQZL.

Returns:

  • (AWS.Request) —

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

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

Gets information about a specified RTMP distribution, including the distribution configuration.

Service Reference:

Examples:

Calling the getStreamingDistribution operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
cloudfront.getStreamingDistribution(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 streaming distribution'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:

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

            Enabled is true if any of the AWS accounts listed in the TrustedSigners complex type for this RTMP distribution have active CloudFront key pairs. If not, Enabled is false.

            For more information, see ActiveTrustedSigners.

          • Quantity — required — (Integer)

            A complex type that contains one Signer complex type for each trusted signer specified in the TrustedSigners complex type.

            For more information, see ActiveTrustedSigners.

          • Items — (Array<map>)

            A complex type that contains one Signer complex type for each trusted signer that is specified in the TrustedSigners complex type.

            For more information, see ActiveTrustedSigners.

            • AwsAccountNumber — (String)

              An AWS account that is included in the TrustedSigners complex type for this RTMP distribution. Valid values include:

              • self, which is the AWS account used to create the distribution.

              • An AWS account number.

            • KeyPairIds — (map)

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

              • Quantity — required — (Integer)

                The number of active CloudFront key pairs for AwsAccountNumber.

                For more information, see ActiveTrustedSigners.

              • Items — (Array<String>)

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

                For more information, see ActiveTrustedSigners.

        • 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 RTMP 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 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)

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

            • Quantity — required — (Integer)

              The number of trusted signers for this cache behavior.

            • Items — (Array<String>)

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

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

      • ETag — (String)

        The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.

Returns:

  • (AWS.Request) —

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

Waiter Resource States:

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

Get the configuration information about a streaming distribution.

Service Reference:

Examples:

Calling the getStreamingDistributionConfig operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
cloudfront.getStreamingDistributionConfig(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 streaming distribution'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:

      • 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 RTMP 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 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)

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

          • Quantity — required — (Integer)

            The number of trusted signers for this cache behavior.

          • Items — (Array<String>)

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

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

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

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

Lists origin access identities.

Service Reference:

Examples:

Calling the listCloudFrontOriginAccessIdentities operation

var params = {
  Marker: 'STRING_VALUE',
  MaxItems: 'STRING_VALUE'
};
cloudfront.listCloudFrontOriginAccessIdentities(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: {}) —
    • Marker — (String)

      Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).

    • MaxItems — (String)

      The maximum number of origin access identities you want in the response body.

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:

      • CloudFrontOriginAccessIdentityList — (map)

        The CloudFrontOriginAccessIdentityList type.

        • Marker — required — (String)

          Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).

        • NextMarker — (String)

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

        • MaxItems — required — (Integer)

          The maximum number of origin access identities you want in the response body.

        • IsTruncated — required — (Boolean)

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

        • Quantity — required — (Integer)

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

        • Items — (Array<map>)

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

          • 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, which you use when giving the origin access identity read permission to an object in Amazon S3.

          • Comment — required — (String)

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

Returns:

  • (AWS.Request) —

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

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

List distributions.

Service Reference:

Examples:

Calling the listDistributions operation

var params = {
  Marker: 'STRING_VALUE',
  MaxItems: 'STRING_VALUE'
};
cloudfront.listDistributions(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: {}) —
    • Marker — (String)

      Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page).

    • MaxItems — (String)

      The maximum number of distributions you want in the response body.

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:

      • DistributionList — (map)

        The DistributionList type.

        • Marker — required — (String)

          The value you provided for the Marker request parameter.

        • NextMarker — (String)

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

        • MaxItems — required — (Integer)

          The value you provided for the MaxItems request parameter.

        • IsTruncated — required — (Boolean)

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

        • Quantity — required — (Integer)

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

        • Items — (Array<map>)

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

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

            The current status of the distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.

          • LastModifiedTime — required — (Date)

            The date and time the distribution was last modified.

          • DomainName — required — (String)

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

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

          • Origins — required — (map)

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

            • Quantity — required — (Integer)

              The number of origins or origin groups for this distribution.

            • Items — required — (Array<map>)

              A complex type that contains origins or origin groups for this distribution.

              • Id — required — (String)

                A unique identifier for the origin or origin group. The value of Id must be unique within the distribution.

                When you specify the value of TargetOriginId for the default cache behavior or for another cache behavior, you indicate the origin to which you want the cache behavior to route requests by specifying the value of the Id element for that origin. When a request matches the path pattern for that cache behavior, CloudFront routes the request to the specified origin. For more information, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.

              • DomainName — required — (String)

                Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. If you set up your bucket to be configured as a website endpoint, enter the Amazon S3 static website hosting endpoint for the bucket.

                For more information about specifying this value for different types of origins, see Origin Domain Name in the Amazon CloudFront Developer Guide.

                Constraints for Amazon S3 origins:

                • If you configured Amazon S3 Transfer Acceleration for your bucket, don't specify the s3-accelerate endpoint for DomainName.

                • The bucket name must be between 3 and 63 characters long (inclusive).

                • The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.

                • The bucket name must not contain adjacent periods.

                Custom Origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com.

                Constraints for custom origins:

                • DomainName must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or underscore (_) characters.

                • The name cannot exceed 128 characters.

              • OriginPath — (String)

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

                For example, suppose you've specified the following values for your distribution:

                • DomainName: An Amazon S3 bucket named myawsbucket.

                • OriginPath: /production

                • CNAME: example.com

                When a user enters example.com/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/index.html.

                When a user enters example.com/acme/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/acme/index.html.

              • CustomHeaders — (map)

                A complex type that contains names and values for the custom headers that you want.

                • 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 forward to your origin. For more information, see Forwarding Custom Headers to Your Origin (Web Distributions Only) in the Amazon Amazon CloudFront Developer Guide.

                  • HeaderValue — required — (String)

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

              • S3OriginConfig — (map)

                A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element 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)

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

                • HTTPPort — required — (Integer)

                  The HTTP port the custom origin listens on.

                • HTTPSPort — required — (Integer)

                  The HTTPS port the custom origin listens on.

                • OriginProtocolPolicy — required — (String)

                  The origin protocol policy to apply to your origin.

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

                  The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS.

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

                  You can create a custom origin read timeout. All timeout units are in seconds. The default origin read timeout is 30 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 4 seconds; the maximum is 60 seconds.

                  If you need to increase the maximum time limit, contact the AWS Support Center.

                • OriginKeepaliveTimeout — (Integer)

                  You can create a custom keep-alive timeout. All timeout units are in seconds. The default keep-alive timeout is 5 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 1 second; the maximum is 60 seconds.

                  If you need to increase the maximum time limit, contact the AWS Support Center.

          • 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 a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.

            • ForwardedValues — required — (map)

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

              • QueryString — required — (Boolean)

                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)

                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)

                  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)

                  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 Amazon CloudFront Limits in the AWS General Reference.

                  • Quantity — required — (Integer)

                    The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.

                  • Items — (Array<String>)

                    A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior.

              • Headers — (map)

                A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for this cache behavior.

                • Quantity — required — (Integer)

                  The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:

                  • Forward all headers to your origin: Specify 1 for Quantity and * for Name.

                    CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.

                  • Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers.

                  • Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.

                  Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:

                • Items — (Array<String>)

                  A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.

              • QueryStringCacheKeys — (map)

                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 this cache behavior.

                • Items — (Array<String>)

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

            • TrustedSigners — required — (map)

              A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

              If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

              If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

              To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

              • Enabled — required — (Boolean)

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

              • Quantity — required — (Integer)

                The number of trusted signers for this cache behavior.

              • Items — (Array<String>)

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

            • 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 Using an HTTPS Connection to Access Your Objects 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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
              Possible values include:
              • "allow-all"
              • "https-only"
              • "redirect-to-https"
            • MinTTL — required — (Integer)

              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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon 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).

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

            • DefaultTTL — (Integer)

              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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

            • MaxTTL — (Integer)
            • 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 forwards 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 a cache behavior or for the default cache behavior in your distribution.

          • CacheBehaviors — required — (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 a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.

              • ForwardedValues — required — (map)

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

                • QueryString — required — (Boolean)

                  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)

                  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)

                    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)

                    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 Amazon CloudFront Limits in the AWS General Reference.

                    • Quantity — required — (Integer)

                      The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.

                    • Items — (Array<String>)

                      A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior.

                • Headers — (map)

                  A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for this cache behavior.

                  • Quantity — required — (Integer)

                    The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:

                    • Forward all headers to your origin: Specify 1 for Quantity and * for Name.

                      CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.

                    • Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers.

                    • Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.

                    Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:

                  • Items — (Array<String>)

                    A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.

                • QueryStringCacheKeys — (map)

                  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 this cache behavior.

                  • Items — (Array<String>)

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

              • TrustedSigners — required — (map)

                A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

                If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

                If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

                To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

                • Enabled — required — (Boolean)

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

                • Quantity — required — (Integer)

                  The number of trusted signers for this cache behavior.

                • Items — (Array<String>)

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

              • 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 Using an HTTPS Connection to Access Your Objects 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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
                Possible values include:
                • "allow-all"
                • "https-only"
                • "redirect-to-https"
              • MinTTL — required — (Integer)

                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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon 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).

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

              • DefaultTTL — (Integer)

                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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

              • MaxTTL — (Integer)

                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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

              • 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 forwards 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 a cache behavior or for the default cache behavior in your distribution.

          • CustomErrorResponses — required — (map)

            A complex type that contains zero or more CustomErrorResponses elements.

            • 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. If you don't want to specify a value, include an empty element, <ResponsePagePath>, in the XML document.

                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. If you don't want to specify a value, include an empty element, <ResponseCode>, in the XML document.

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

                If you don't want to specify a value, include an empty element, <ErrorCachingMinTTL>, in the XML document.

                For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

          • Comment — required — (String)

            The comment originally specified when this distribution was created.

          • PriceClass — required — (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 distribution is enabled to accept user requests for content.

          • ViewerCertificate — required — (map)

            • CloudFrontDefaultCertificate — (Boolean)

              For information about how and when to use CloudFrontDefaultCertificate, see ViewerCertificate.

            • IAMCertificateId — (String)

              For information about how and when to use IAMCertificateId, see ViewerCertificate.

            • ACMCertificateArn — (String)

              For information about how and when to use ACMCertificateArn, see ViewerCertificate.

            • SSLSupportMethod — (String)

              If you specify a value for ViewerCertificate$ACMCertificateArn or for ViewerCertificate$IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for all clients or one that works for most clients:

              • vip: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you will incur additional monthly charges.

              • sni-only: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. If some of your users' browsers don't support SNI, we recommend that you do one of the following:

                • Use the vip option (dedicated IP addresses) instead of sni-only.

                • Use the CloudFront SSL/TLS certificate instead of a custom certificate. This requires that you use the CloudFront domain name of your distribution in the URLs for your objects, for example, https://d111111abcdef8.cloudfront.net/logo.png.

                • If you can control which browser your users use, upgrade the browser to one that supports SNI.

                • Use HTTP instead of HTTPS.

              Don't specify a value for SSLSupportMethod if you specified <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>.

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

              Possible values include:
              • "sni-only"
              • "vip"
            • MinimumProtocolVersion — (String)

              Specify the security policy that you want CloudFront to use for HTTPS connections. A security policy determines two settings:

              • The minimum SSL/TLS protocol that CloudFront uses to communicate with viewers

              • The cipher that CloudFront uses to encrypt the content that it returns to viewers

              Note: On the CloudFront console, this setting is called Security policy.

              We recommend that you specify TLSv1.1_2016 unless your users are using browsers or devices that do not support TLSv1.1 or later.

              When both of the following are true, you must specify TLSv1 or later for the security policy:

              • You're using a custom certificate: you specified a value for ACMCertificateArn or for IAMCertificateId

              • You're using SNI: you specified sni-only for SSLSupportMethod

              If you specify true for CloudFrontDefaultCertificate, CloudFront automatically sets the security policy to TLSv1 regardless of the value that you specify for MinimumProtocolVersion.

              For information about the relationship between the security policy that you choose and the protocols and ciphers that CloudFront uses to communicate with viewers, see Supported SSL/TLS Protocols and Ciphers for Communication Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

              Possible values include:
              • "SSLv3"
              • "TLSv1"
              • "TLSv1_2016"
              • "TLSv1.1_2016"
              • "TLSv1.2_2018"
            • Certificate — (String)

              This field has been deprecated. Use one of the following fields instead:

            • CertificateSource — (String)

              This field has been deprecated. Use one of the following fields instead:

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

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

            The Web ACL Id (if any) associated with the distribution.

          • HttpVersion — required — (String)

            Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 will automatically use an earlier version.

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

            Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.

Returns:

  • (AWS.Request) —

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

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

List the distributions that are associated with a specified AWS WAF web ACL.

Service Reference:

Examples:

Calling the listDistributionsByWebACLId operation

var params = {
  WebACLId: 'STRING_VALUE', /* required */
  Marker: 'STRING_VALUE',
  MaxItems: 'STRING_VALUE'
};
cloudfront.listDistributionsByWebACLId(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: {}) —
    • Marker — (String)

      Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)

    • MaxItems — (String)

      The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.

    • WebACLId — (String)

      The ID of the AWS WAF web ACL that you want to list the associated distributions. If you specify "null" for the ID, the request returns a list of the distributions that aren't associated with a web ACL.

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:

      • DistributionList — (map)

        The DistributionList type.

        • Marker — required — (String)

          The value you provided for the Marker request parameter.

        • NextMarker — (String)

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

        • MaxItems — required — (Integer)

          The value you provided for the MaxItems request parameter.

        • IsTruncated — required — (Boolean)

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

        • Quantity — required — (Integer)

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

        • Items — (Array<map>)

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

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

            The current status of the distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.

          • LastModifiedTime — required — (Date)

            The date and time the distribution was last modified.

          • DomainName — required — (String)

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

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

          • Origins — required — (map)

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

            • Quantity — required — (Integer)

              The number of origins or origin groups for this distribution.

            • Items — required — (Array<map>)

              A complex type that contains origins or origin groups for this distribution.

              • Id — required — (String)

                A unique identifier for the origin or origin group. The value of Id must be unique within the distribution.

                When you specify the value of TargetOriginId for the default cache behavior or for another cache behavior, you indicate the origin to which you want the cache behavior to route requests by specifying the value of the Id element for that origin. When a request matches the path pattern for that cache behavior, CloudFront routes the request to the specified origin. For more information, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.

              • DomainName — required — (String)

                Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. If you set up your bucket to be configured as a website endpoint, enter the Amazon S3 static website hosting endpoint for the bucket.

                For more information about specifying this value for different types of origins, see Origin Domain Name in the Amazon CloudFront Developer Guide.

                Constraints for Amazon S3 origins:

                • If you configured Amazon S3 Transfer Acceleration for your bucket, don't specify the s3-accelerate endpoint for DomainName.

                • The bucket name must be between 3 and 63 characters long (inclusive).

                • The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.

                • The bucket name must not contain adjacent periods.

                Custom Origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com.

                Constraints for custom origins:

                • DomainName must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or underscore (_) characters.

                • The name cannot exceed 128 characters.

              • OriginPath — (String)

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

                For example, suppose you've specified the following values for your distribution:

                • DomainName: An Amazon S3 bucket named myawsbucket.

                • OriginPath: /production

                • CNAME: example.com

                When a user enters example.com/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/index.html.

                When a user enters example.com/acme/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/acme/index.html.

              • CustomHeaders — (map)

                A complex type that contains names and values for the custom headers that you want.

                • 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 forward to your origin. For more information, see Forwarding Custom Headers to Your Origin (Web Distributions Only) in the Amazon Amazon CloudFront Developer Guide.

                  • HeaderValue — required — (String)

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

              • S3OriginConfig — (map)

                A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element 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)

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

                • HTTPPort — required — (Integer)

                  The HTTP port the custom origin listens on.

                • HTTPSPort — required — (Integer)

                  The HTTPS port the custom origin listens on.

                • OriginProtocolPolicy — required — (String)

                  The origin protocol policy to apply to your origin.

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

                  The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS.

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

                  You can create a custom origin read timeout. All timeout units are in seconds. The default origin read timeout is 30 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 4 seconds; the maximum is 60 seconds.

                  If you need to increase the maximum time limit, contact the AWS Support Center.

                • OriginKeepaliveTimeout — (Integer)

                  You can create a custom keep-alive timeout. All timeout units are in seconds. The default keep-alive timeout is 5 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 1 second; the maximum is 60 seconds.

                  If you need to increase the maximum time limit, contact the AWS Support Center.

          • 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 a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.

            • ForwardedValues — required — (map)

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

              • QueryString — required — (Boolean)

                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)

                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)

                  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)

                  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 Amazon CloudFront Limits in the AWS General Reference.

                  • Quantity — required — (Integer)

                    The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.

                  • Items — (Array<String>)

                    A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior.

              • Headers — (map)

                A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for this cache behavior.

                • Quantity — required — (Integer)

                  The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:

                  • Forward all headers to your origin: Specify 1 for Quantity and * for Name.

                    CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.

                  • Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers.

                  • Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.

                  Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:

                • Items — (Array<String>)

                  A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.

              • QueryStringCacheKeys — (map)

                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 this cache behavior.

                • Items — (Array<String>)

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

            • TrustedSigners — required — (map)

              A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

              If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

              If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

              To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

              • Enabled — required — (Boolean)

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

              • Quantity — required — (Integer)

                The number of trusted signers for this cache behavior.

              • Items — (Array<String>)

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

            • 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 Using an HTTPS Connection to Access Your Objects 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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
              Possible values include:
              • "allow-all"
              • "https-only"
              • "redirect-to-https"
            • MinTTL — required — (Integer)

              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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon 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).

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

            • DefaultTTL — (Integer)

              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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

            • MaxTTL — (Integer)
            • 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 forwards 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 a cache behavior or for the default cache behavior in your distribution.

          • CacheBehaviors — required — (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 a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.

              • ForwardedValues — required — (map)

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

                • QueryString — required — (Boolean)

                  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)

                  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)

                    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)

                    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 Amazon CloudFront Limits in the AWS General Reference.

                    • Quantity — required — (Integer)

                      The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.

                    • Items — (Array<String>)

                      A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior.

                • Headers — (map)

                  A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for this cache behavior.

                  • Quantity — required — (Integer)

                    The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:

                    • Forward all headers to your origin: Specify 1 for Quantity and * for Name.

                      CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.

                    • Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers.

                    • Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.

                    Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:

                  • Items — (Array<String>)

                    A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.

                • QueryStringCacheKeys — (map)

                  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 this cache behavior.

                  • Items — (Array<String>)

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

              • TrustedSigners — required — (map)

                A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

                If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

                If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

                To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

                • Enabled — required — (Boolean)

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

                • Quantity — required — (Integer)

                  The number of trusted signers for this cache behavior.

                • Items — (Array<String>)

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

              • 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 Using an HTTPS Connection to Access Your Objects 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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
                Possible values include:
                • "allow-all"
                • "https-only"
                • "redirect-to-https"
              • MinTTL — required — (Integer)

                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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon 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).

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

              • DefaultTTL — (Integer)

                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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

              • MaxTTL — (Integer)

                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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

              • 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 forwards 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 a cache behavior or for the default cache behavior in your distribution.

          • CustomErrorResponses — required — (map)

            A complex type that contains zero or more CustomErrorResponses elements.

            • 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. If you don't want to specify a value, include an empty element, <ResponsePagePath>, in the XML document.

                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. If you don't want to specify a value, include an empty element, <ResponseCode>, in the XML document.

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

                If you don't want to specify a value, include an empty element, <ErrorCachingMinTTL>, in the XML document.

                For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

          • Comment — required — (String)

            The comment originally specified when this distribution was created.

          • PriceClass — required — (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 distribution is enabled to accept user requests for content.

          • ViewerCertificate — required — (map)

            • CloudFrontDefaultCertificate — (Boolean)

              For information about how and when to use CloudFrontDefaultCertificate, see ViewerCertificate.

            • IAMCertificateId — (String)

              For information about how and when to use IAMCertificateId, see ViewerCertificate.

            • ACMCertificateArn — (String)

              For information about how and when to use ACMCertificateArn, see ViewerCertificate.

            • SSLSupportMethod — (String)

              If you specify a value for ViewerCertificate$ACMCertificateArn or for ViewerCertificate$IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for all clients or one that works for most clients:

              • vip: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you will incur additional monthly charges.

              • sni-only: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. If some of your users' browsers don't support SNI, we recommend that you do one of the following:

                • Use the vip option (dedicated IP addresses) instead of sni-only.

                • Use the CloudFront SSL/TLS certificate instead of a custom certificate. This requires that you use the CloudFront domain name of your distribution in the URLs for your objects, for example, https://d111111abcdef8.cloudfront.net/logo.png.

                • If you can control which browser your users use, upgrade the browser to one that supports SNI.

                • Use HTTP instead of HTTPS.

              Don't specify a value for SSLSupportMethod if you specified <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>.

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

              Possible values include:
              • "sni-only"
              • "vip"
            • MinimumProtocolVersion — (String)

              Specify the security policy that you want CloudFront to use for HTTPS connections. A security policy determines two settings:

              • The minimum SSL/TLS protocol that CloudFront uses to communicate with viewers

              • The cipher that CloudFront uses to encrypt the content that it returns to viewers

              Note: On the CloudFront console, this setting is called Security policy.

              We recommend that you specify TLSv1.1_2016 unless your users are using browsers or devices that do not support TLSv1.1 or later.

              When both of the following are true, you must specify TLSv1 or later for the security policy:

              • You're using a custom certificate: you specified a value for ACMCertificateArn or for IAMCertificateId

              • You're using SNI: you specified sni-only for SSLSupportMethod

              If you specify true for CloudFrontDefaultCertificate, CloudFront automatically sets the security policy to TLSv1 regardless of the value that you specify for MinimumProtocolVersion.

              For information about the relationship between the security policy that you choose and the protocols and ciphers that CloudFront uses to communicate with viewers, see Supported SSL/TLS Protocols and Ciphers for Communication Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

              Possible values include:
              • "SSLv3"
              • "TLSv1"
              • "TLSv1_2016"
              • "TLSv1.1_2016"
              • "TLSv1.2_2018"
            • Certificate — (String)

              This field has been deprecated. Use one of the following fields instead:

            • CertificateSource — (String)

              This field has been deprecated. Use one of the following fields instead:

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

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

            The Web ACL Id (if any) associated with the distribution.

          • HttpVersion — required — (String)

            Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 will automatically use an earlier version.

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

            Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.

Returns:

  • (AWS.Request) —

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

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

List all field-level encryption configurations that have been created in CloudFront for this account.

Service Reference:

Examples:

Calling the listFieldLevelEncryptionConfigs operation

var params = {
  Marker: 'STRING_VALUE',
  MaxItems: 'STRING_VALUE'
};
cloudfront.listFieldLevelEncryptionConfigs(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: {}) —
    • Marker — (String)

      Use this when paginating results to indicate where to begin in your list of configurations. The results include configurations in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last configuration on that page).

    • MaxItems — (String)

      The maximum number of field-level encryption configurations you want in the response body.

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:

      • FieldLevelEncryptionList — (map)

        Returns a list of all field-level encryption configurations that have been created in CloudFront for this account.

        • NextMarker — (String)

          If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your configurations where you left off.

        • MaxItems — required — (Integer)

          The maximum number of elements you want in the response body.

        • Quantity — required — (Integer)

          The number of field-level encryption items.

        • Items — (Array<map>)

          An array of field-level encryption items.

          • Id — required — (String)

            The unique ID of a field-level encryption item.

          • LastModifiedTime — required — (Date)

            The last time that the summary of field-level encryption items was modified.

          • Comment — (String)

            An optional comment about the field-level encryption item.

          • QueryArgProfileConfig — (map)

            A summary of a query argument-profile mapping.

            • 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 summary of a content type-profile mapping.

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

Returns:

  • (AWS.Request) —

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

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

Request a list of field-level encryption profiles that have been created in CloudFront for this account.

Service Reference:

Examples:

Calling the listFieldLevelEncryptionProfiles operation

var params = {
  Marker: 'STRING_VALUE',
  MaxItems: 'STRING_VALUE'
};
cloudfront.listFieldLevelEncryptionProfiles(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: {}) —
    • Marker — (String)

      Use this when paginating results to indicate where to begin in your list of profiles. The results include profiles in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last profile on that page).

    • MaxItems — (String)

      The maximum number of field-level encryption profiles you want in the response body.

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:

      • FieldLevelEncryptionProfileList — (map)

        Returns a list of the field-level encryption profiles that have been created in CloudFront for this account.

        • NextMarker — (String)

          If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your profiles where you left off.

        • MaxItems — required — (Integer)

          The maximum number of field-level encryption profiles you want in the response body.

        • Quantity — required — (Integer)

          The number of field-level encryption profiles.

        • Items — (Array<map>)

          The field-level encryption profile items.

          • Id — required — (String)

            ID for the field-level encryption profile summary.

          • LastModifiedTime — required — (Date)

            The time when the the field-level encryption profile summary was last updated.

          • Name — required — (String)

            Name for the field-level encryption profile summary.

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

          • Comment — (String)

            An optional comment for the field-level encryption profile summary.

Returns:

  • (AWS.Request) —

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

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

Lists invalidation batches.

Service Reference:

Examples:

Calling the listInvalidations operation

var params = {
  DistributionId: 'STRING_VALUE', /* required */
  Marker: 'STRING_VALUE',
  MaxItems: 'STRING_VALUE'
};
cloudfront.listInvalidations(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.

    • Marker — (String)

      Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.

    • MaxItems — (String)

      The maximum number of invalidation batches that you want in the response body.

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:

      • InvalidationList — (map)

        Information about invalidation batches.

        • Marker — required — (String)

          The value that you provided for the Marker request parameter.

        • NextMarker — (String)

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

        • MaxItems — required — (Integer)

          The value that you provided for the MaxItems request parameter.

        • IsTruncated — required — (Boolean)

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

        • Quantity — required — (Integer)

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

        • Items — (Array<map>)

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

          • Id — required — (String)

            The unique ID for an invalidation request.

          • CreateTime — required — (Date)

            The time that an invalidation request was created.

          • Status — required — (String)

            The status of an invalidation request.

Returns:

  • (AWS.Request) —

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

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

List all public keys that have been added to CloudFront for this account.

Service Reference:

Examples:

Calling the listPublicKeys operation

var params = {
  Marker: 'STRING_VALUE',
  MaxItems: 'STRING_VALUE'
};
cloudfront.listPublicKeys(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: {}) —
    • Marker — (String)

      Use this when paginating results to indicate where to begin in your list of public keys. The results include public keys in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last public key on that page).

    • MaxItems — (String)

      The maximum number of public keys you want in the response body.

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:

      • PublicKeyList — (map)

        Returns a list of all public keys that have been added to CloudFront for this account.

        • NextMarker — (String)

          If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your public keys where you left off.

        • MaxItems — required — (Integer)

          The maximum number of public keys you want in the response body.

        • Quantity — required — (Integer)

          The number of public keys you added to CloudFront to use with features like field-level encryption.

        • Items — (Array<map>)

          An array of information about a public key you add to CloudFront to use with features like field-level encryption.

          • Id — required — (String)

            ID for public key information summary.

          • Name — required — (String)

            Name for public key information summary.

          • CreatedTime — required — (Date)

            Creation time for public key information summary.

          • EncodedKey — required — (String)

            Encoded key for public key information summary.

          • Comment — (String)

            Comment for public key information summary.

Returns:

  • (AWS.Request) —

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

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

List streaming distributions.

Service Reference:

Examples:

Calling the listStreamingDistributions operation

var params = {
  Marker: 'STRING_VALUE',
  MaxItems: 'STRING_VALUE'
};
cloudfront.listStreamingDistributions(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: {}) —
    • Marker — (String)

      The value that you provided for the Marker request parameter.

    • MaxItems — (String)

      The value that you provided for the MaxItems request parameter.

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:

      • StreamingDistributionList — (map)

        The StreamingDistributionList type.

        • Marker — required — (String)

          The value you provided for the Marker request parameter.

        • NextMarker — (String)

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

        • MaxItems — required — (Integer)

          The value you provided for the MaxItems request parameter.

        • IsTruncated — required — (Boolean)

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

        • Quantity — required — (Integer)

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

        • Items — (Array<map>)

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

          • Id — required — (String)

            The identifier for the distribution, for example, EDFDVBD632BHDS5.

          • ARN — required — (String)

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

          • Status — required — (String)

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

          • LastModifiedTime — required — (Date)

            The date and time the distribution was last modified.

          • DomainName — required — (String)

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

          • 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 RTMP 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 Amazon CloudFront Developer Guide.

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

          • TrustedSigners — required — (map)

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

            • Enabled — required — (Boolean)

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

            • Quantity — required — (Integer)

              The number of trusted signers for this cache behavior.

            • Items — (Array<String>)

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

          • Comment — required — (String)

            The comment originally specified when this distribution was created.

          • PriceClass — required — (String)

            Possible values include:

            • "PriceClass_100"
            • "PriceClass_200"
            • "PriceClass_All"
          • Enabled — required — (Boolean)

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

Returns:

  • (AWS.Request) —

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

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

List tags for a CloudFront resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  Resource: 'STRING_VALUE' /* required */
};
cloudfront.listTagsForResource(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: {}) —
    • Resource — (String)

      An ARN of a CloudFront resource.

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:

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

Returns:

  • (AWS.Request) —

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

setupRequestListeners(request) ⇒ void

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

Add tags to a CloudFront resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  Resource: 'STRING_VALUE', /* required */
  Tags: { /* required */
    Items: [
      {
        Key: 'STRING_VALUE', /* required */
        Value: 'STRING_VALUE'
      },
      /* more items */
    ]
  }
};
cloudfront.tagResource(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: {}) —
    • Resource — (String)

      An ARN of a CloudFront resource.

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

Returns:

  • (AWS.Request) —

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

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

Remove tags from a CloudFront resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  Resource: 'STRING_VALUE', /* required */
  TagKeys: { /* required */
    Items: [
      'STRING_VALUE',
      /* more items */
    ]
  }
};
cloudfront.untagResource(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: {}) —
    • Resource — (String)

      An ARN of a CloudFront resource.

    • TagKeys — (map)

      A complex type that contains zero or more Tag key elements.

      • Items — (Array<String>)

        A complex type that contains Tag key elements.

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.

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

Update an origin access identity.

Service Reference:

Examples:

Calling the updateCloudFrontOriginAccessIdentity operation

var params = {
  CloudFrontOriginAccessIdentityConfig: { /* required */
    CallerReference: 'STRING_VALUE', /* required */
    Comment: 'STRING_VALUE' /* required */
  },
  Id: 'STRING_VALUE', /* required */
  IfMatch: 'STRING_VALUE'
};
cloudfront.updateCloudFrontOriginAccessIdentity(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 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.

    • Id — (String)

      The identity's id.

    • IfMatch — (String)

      The value of the ETag header that you received when retrieving the identity's configuration. 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. 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 configuration. For example: E2QWRUHAPOMQZL.

Returns:

  • (AWS.Request) —

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

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

Updates the configuration for a web distribution.

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

The update process includes getting the current distribution configuration, updating the XML document that is returned to make your changes, and then submitting an UpdateDistribution request to make the updates.

For information about updating a distribution using the CloudFront console instead, see Creating a Distribution in the Amazon CloudFront Developer Guide.

To update a web distribution using the CloudFront API

  1. Submit a GetDistributionConfig request to get the current configuration and an Etag header for the distribution.

    Note: If you update the distribution again, you must get a new Etag header.

  2. Update the XML document that was returned in the response to your GetDistributionConfig request to include your changes.

    When you edit the XML file, be aware of the following:

    • You must strip out the ETag parameter that is returned.

    • Additional fields are required when you update a distribution. There may be fields included in the XML file for features that you haven't configured for your distribution. This is expected and required to successfully update the distribution.

    • You can't change the value of CallerReference. If you try to change this value, CloudFront returns an IllegalUpdate error.

    • The new configuration replaces the existing configuration; the values that you specify in an UpdateDistribution request are not merged into your existing configuration. When you add, delete, or replace values in an element that allows multiple values (for example, CNAME), you must specify all of the values that you want to appear in the updated distribution. In addition, you must update the corresponding Quantity element.

  3. Submit an UpdateDistribution request to update the configuration for your distribution:

    • In the request body, include the XML document that you updated in Step 2. The request body must include an XML document with a DistributionConfig element.

    • Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GetDistributionConfig request in Step 1.

  4. Review the response to the UpdateDistribution request to confirm that the configuration was successfully updated.

  5. Optional: Submit a GetDistribution request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

Service Reference:

Examples:

Calling the updateDistribution operation

var params = {
  DistributionConfig: { /* required */
    CallerReference: 'STRING_VALUE', /* required */
    Comment: 'STRING_VALUE', /* required */
    DefaultCacheBehavior: { /* required */
      ForwardedValues: { /* required */
        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 */
          ]
        }
      },
      MinTTL: 'NUMBER_VALUE', /* required */
      TargetOriginId: 'STRING_VALUE', /* required */
      TrustedSigners: { /* required */
        Enabled: true || false, /* required */
        Quantity: 'NUMBER_VALUE', /* required */
        Items: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      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 */
        }
      },
      Compress: true || false,
      DefaultTTL: 'NUMBER_VALUE',
      FieldLevelEncryptionId: 'STRING_VALUE',
      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',
      SmoothStreaming: true || false
    },
    Enabled: true || false, /* required */
    Origins: { /* required */
      Items: [ /* required */
        {
          DomainName: 'STRING_VALUE', /* required */
          Id: 'STRING_VALUE', /* required */
          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',
          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: [
        {
          ForwardedValues: { /* required */
            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 */
              ]
            }
          },
          MinTTL: 'NUMBER_VALUE', /* required */
          PathPattern: 'STRING_VALUE', /* required */
          TargetOriginId: 'STRING_VALUE', /* required */
          TrustedSigners: { /* required */
            Enabled: true || false, /* required */
            Quantity: 'NUMBER_VALUE', /* required */
            Items: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          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 */
            }
          },
          Compress: true || false,
          DefaultTTL: 'NUMBER_VALUE',
          FieldLevelEncryptionId: 'STRING_VALUE',
          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',
          SmoothStreaming: true || false
        },
        /* 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,
      SSLSupportMethod: sni-only | vip
    },
    WebACLId: 'STRING_VALUE'
  },
  Id: 'STRING_VALUE', /* required */
  IfMatch: 'STRING_VALUE'
};
cloudfront.updateDistribution(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 or origin groups for this distribution.

        • Items — required — (Array<map>)

          A complex type that contains origins or origin groups for this distribution.

          • Id — required — (String)

            A unique identifier for the origin or origin group. The value of Id must be unique within the distribution.

            When you specify the value of TargetOriginId for the default cache behavior or for another cache behavior, you indicate the origin to which you want the cache behavior to route requests by specifying the value of the Id element for that origin. When a request matches the path pattern for that cache behavior, CloudFront routes the request to the specified origin. For more information, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.

          • DomainName — required — (String)

            Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. If you set up your bucket to be configured as a website endpoint, enter the Amazon S3 static website hosting endpoint for the bucket.

            For more information about specifying this value for different types of origins, see Origin Domain Name in the Amazon CloudFront Developer Guide.

            Constraints for Amazon S3 origins:

            • If you configured Amazon S3 Transfer Acceleration for your bucket, don't specify the s3-accelerate endpoint for DomainName.

            • The bucket name must be between 3 and 63 characters long (inclusive).

            • The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.

            • The bucket name must not contain adjacent periods.

            Custom Origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com.

            Constraints for custom origins:

            • DomainName must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or underscore (_) characters.

            • The name cannot exceed 128 characters.

          • OriginPath — (String)

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

            For example, suppose you've specified the following values for your distribution:

            • DomainName: An Amazon S3 bucket named myawsbucket.

            • OriginPath: /production

            • CNAME: example.com

            When a user enters example.com/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/index.html.

            When a user enters example.com/acme/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/acme/index.html.

          • CustomHeaders — (map)

            A complex type that contains names and values for the custom headers that you want.

            • 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 forward to your origin. For more information, see Forwarding Custom Headers to Your Origin (Web Distributions Only) in the Amazon Amazon CloudFront Developer Guide.

              • HeaderValue — required — (String)

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

          • S3OriginConfig — (map)

            A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element 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)

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

            • HTTPPort — required — (Integer)

              The HTTP port the custom origin listens on.

            • HTTPSPort — required — (Integer)

              The HTTPS port the custom origin listens on.

            • OriginProtocolPolicy — required — (String)

              The origin protocol policy to apply to your origin.

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

              The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS.

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

              You can create a custom origin read timeout. All timeout units are in seconds. The default origin read timeout is 30 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 4 seconds; the maximum is 60 seconds.

              If you need to increase the maximum time limit, contact the AWS Support Center.

            • OriginKeepaliveTimeout — (Integer)

              You can create a custom keep-alive timeout. All timeout units are in seconds. The default keep-alive timeout is 5 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 1 second; the maximum is 60 seconds.

              If you need to increase the maximum time limit, contact the AWS Support Center.

      • 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 a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.

        • ForwardedValues — required — (map)

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

          • QueryString — required — (Boolean)

            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)

            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)

              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)

              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 Amazon CloudFront Limits in the AWS General Reference.

              • Quantity — required — (Integer)

                The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.

              • Items — (Array<String>)

                A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior.

          • Headers — (map)

            A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for this cache behavior.

            • Quantity — required — (Integer)

              The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:

              • Forward all headers to your origin: Specify 1 for Quantity and * for Name.

                CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.

              • Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers.

              • Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.

              Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:

            • Items — (Array<String>)

              A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.

          • QueryStringCacheKeys — (map)

            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 this cache behavior.

            • Items — (Array<String>)

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

        • TrustedSigners — required — (map)

          A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

          If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

          If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

          To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

          • Enabled — required — (Boolean)

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

          • Quantity — required — (Integer)

            The number of trusted signers for this cache behavior.

          • Items — (Array<String>)

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

        • 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 Using an HTTPS Connection to Access Your Objects 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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
          Possible values include:
          • "allow-all"
          • "https-only"
          • "redirect-to-https"
        • MinTTL — required — (Integer)

          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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon 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).

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

        • DefaultTTL — (Integer)

          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 Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

        • MaxTTL — (Integer)
        • 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 forwards 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 Inclu