Client library for Amazon CloudFront

npm install --save @datafire/amazonaws_cloudfront

let amazonaws_cloudfront = require('@datafire/amazonaws_cloudfront').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_cloudfront.ListDistributions({}).then(data => {
  console.log(data);
});

Amazon CloudFront

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

amazonaws_cloudfront.ListDistributions({}, context)

• input object
  • MaxItems string
  • Marker string

• output ListDistributionsResult

amazonaws_cloudfront.ListInvalidations({
  "DistributionId": ""
}, context)

• input object
  • MaxItems string
  • Marker string
  • DistributionId required string

• output ListInvalidationsResult

amazonaws_cloudfront.GetInvalidation({
  "DistributionId": "",
  "Id": ""
}, context)

• input object
  • DistributionId required string
  • Id required string

• output GetInvalidationResult

amazonaws_cloudfront.GetDistribution({
  "Id": ""
}, context)

• input object
  • Id required string

• output GetDistributionResult

amazonaws_cloudfront.UpdateDistribution({
  "Id": "",
  "DistributionConfig": {
    "CallerReference": "",
    "Origins": {
      "Quantity": 0
    },
    "DefaultCacheBehavior": {
      "TargetOriginId": "",
      "ForwardedValues": {
        "QueryString": true,
        "Cookies": {
          "Forward": ""
        }
      },
      "TrustedSigners": {
        "Enabled": true,
        "Quantity": 0
      },
      "ViewerProtocolPolicy": "",
      "MinTTL": 0
    },
    "Comment": "",
    "Enabled": true
  }
}, context)

• input object
  • Id required string
  • DistributionConfig required DistributionConfig

• output UpdateDistributionResult

amazonaws_cloudfront.CreateDistributionWithTags({
  "DistributionConfigWithTags": {
    "DistributionConfig": {
      "CallerReference": "",
      "Origins": {
        "Quantity": 0
      },
      "DefaultCacheBehavior": {
        "TargetOriginId": "",
        "ForwardedValues": {
          "QueryString": true,
          "Cookies": {
            "Forward": ""
          }
        },
        "TrustedSigners": {
          "Enabled": true,
          "Quantity": 0
        },
        "ViewerProtocolPolicy": "",
        "MinTTL": 0
      },
      "Comment": "",
      "Enabled": true
    },
    "Tags": {}
  }
}, context)

• input object
  • DistributionConfigWithTags required DistributionConfigWithTags

Output schema unknown

amazonaws_cloudfront.ListDistributionsByWebACLId({
  "WebACLId": ""
}, context)

• input object
  • WebACLId required string

• output ListDistributionsByWebACLIdResult

amazonaws_cloudfront.ListCloudFrontOriginAccessIdentities({}, context)

• input object
  • MaxItems string
  • Marker string

• output ListCloudFrontOriginAccessIdentitiesResult

amazonaws_cloudfront.GetCloudFrontOriginAccessIdentity({
  "Id": ""
}, context)

• input object
  • Id required string

• output GetCloudFrontOriginAccessIdentityResult

amazonaws_cloudfront.UpdateCloudFrontOriginAccessIdentity({
  "Id": "",
  "CloudFrontOriginAccessIdentityConfig": {
    "CallerReference": "",
    "Comment": ""
  }
}, context)

• input object
  • Id required string
  • CloudFrontOriginAccessIdentityConfig required CloudFrontOriginAccessIdentityConfig

• output UpdateCloudFrontOriginAccessIdentityResult

amazonaws_cloudfront.DeleteServiceLinkedRole({
  "RoleName": ""
}, context)

• input object
  • RoleName required string

Output schema unknown

amazonaws_cloudfront.ListStreamingDistributions({}, context)

• input object
  • MaxItems string
  • Marker string

• output ListStreamingDistributionsResult

amazonaws_cloudfront.GetStreamingDistribution({
  "Id": ""
}, context)

• input object
  • Id required string

• output GetStreamingDistributionResult

amazonaws_cloudfront.UpdateStreamingDistribution({
  "Id": "",
  "StreamingDistributionConfig": {
    "CallerReference": "",
    "S3Origin": {
      "DomainName": "",
      "OriginAccessIdentity": ""
    },
    "Comment": "",
    "TrustedSigners": {
      "Enabled": true,
      "Quantity": 0
    },
    "Enabled": true
  }
}, context)

• input object
  • Id required string
  • StreamingDistributionConfig required StreamingDistributionConfig

• output UpdateStreamingDistributionResult

amazonaws_cloudfront.CreateStreamingDistributionWithTags({
  "StreamingDistributionConfigWithTags": {
    "StreamingDistributionConfig": {
      "CallerReference": "",
      "S3Origin": {
        "DomainName": "",
        "OriginAccessIdentity": ""
      },
      "Comment": "",
      "TrustedSigners": {
        "Enabled": true,
        "Quantity": 0
      },
      "Enabled": true
    },
    "Tags": {}
  }
}, context)

• input object
  • StreamingDistributionConfigWithTags required StreamingDistributionConfigWithTags

Output schema unknown

amazonaws_cloudfront.ListTagsForResource({}, context)

• input object

• output ListTagsForResourceResult

amazonaws_cloudfront.TagResource({
  "Tags": {}
}, context)

• input object
  • Tags required Tags

Output schema unknown

amazonaws_cloudfront.UntagResource({
  "TagKeys": {}
}, context)

• input object
  • TagKeys required TagKeys

Output schema unknown

• AccessDenied object: Access denied.
  • Message string

• ActiveTrustedSigners object:

  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
  • Items SignerList
  • Quantity required integer

• AliasList array
  • items string

• Aliases object: A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
  • Items AliasList
  • Quantity required integer

• AllowedMethods object:

  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.

  • CachedMethods CachedMethods
  • Items required MethodsList
  • Quantity required integer

• AwsAccountNumberList array
  • items string

• BatchTooLarge object
  • Message string

• CNAMEAlreadyExists object
  • Message string

• CacheBehavior object:

  A complex type that describes how CloudFront processes requests.

  You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used.

  For the current limit on the number of cache behaviors that you can add to a distribution, see Amazon CloudFront Limits in the AWS General Reference.

  If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error.

  To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element.

  To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.

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

  • AllowedMethods AllowedMethods
  • Compress boolean
  • DefaultTTL long
  • ForwardedValues required ForwardedValues
  • LambdaFunctionAssociations LambdaFunctionAssociations
  • MaxTTL long
  • MinTTL required long
  • PathPattern required string
  • SmoothStreaming boolean
  • TargetOriginId required string
  • TrustedSigners required TrustedSigners
  • ViewerProtocolPolicy required ViewerProtocolPolicy

• CacheBehaviorList array
  • items CacheBehavior

• CacheBehaviors object: A complex type that contains zero or more CacheBehavior elements.
  • Items CacheBehaviorList
  • Quantity required integer

• CachedMethods object:

  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.

  • Items required MethodsList
  • Quantity required integer

• CertificateSource string (values: cloudfront, iam, acm)

• CloudFrontOriginAccessIdentity object: CloudFront origin access identity.
  • CloudFrontOriginAccessIdentityConfig CloudFrontOriginAccessIdentityConfig
  • Id required string
  • S3CanonicalUserId required string

• CloudFrontOriginAccessIdentityAlreadyExists object: 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.
  • Message string

• CloudFrontOriginAccessIdentityConfig object: Origin access identity configuration. Send a GET request to the /CloudFront API version/CloudFront/identity ID/config resource.
  • CallerReference required string
  • Comment required string

• CloudFrontOriginAccessIdentityInUse object
  • Message string

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

• CloudFrontOriginAccessIdentitySummary object: Summary of the information about a CloudFront origin access identity.
  • Comment required string
  • Id required string
  • S3CanonicalUserId required string

• CloudFrontOriginAccessIdentitySummaryList array
  • items CloudFrontOriginAccessIdentitySummary

• CookieNameList array
  • items string

• CookieNames object: 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.
  • Items CookieNameList
  • Quantity required integer

• CookiePreference object: 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 ItemSelection
  • WhitelistedNames CookieNames

• CreateCloudFrontOriginAccessIdentityRequest object: The request to create a new origin access identity.
  • CloudFrontOriginAccessIdentityConfig required CloudFrontOriginAccessIdentityConfig

• CreateCloudFrontOriginAccessIdentityResult object: The returned result of the corresponding request.
  • CloudFrontOriginAccessIdentity CloudFrontOriginAccessIdentity

• CreateDistributionRequest object: The request to create a new distribution.
  • DistributionConfig required DistributionConfig

• CreateDistributionResult object: The returned result of the corresponding request.
  • Distribution Distribution

• CreateDistributionWithTagsRequest object: The request to create a new distribution with tags.
  • DistributionConfigWithTags required DistributionConfigWithTags

• CreateDistributionWithTagsResult object: The returned result of the corresponding request.
  • Distribution Distribution

• CreateInvalidationRequest object: The request to create an invalidation.
  • InvalidationBatch required InvalidationBatch

• CreateInvalidationResult object: The returned result of the corresponding request.
  • Invalidation Invalidation

• CreateStreamingDistributionRequest object: The request to create a new streaming distribution.
  • StreamingDistributionConfig required StreamingDistributionConfig

• CreateStreamingDistributionResult object: The returned result of the corresponding request.
  • StreamingDistribution StreamingDistribution

• CreateStreamingDistributionWithTagsRequest object: The request to create a new streaming distribution with tags.
  • StreamingDistributionConfigWithTags required StreamingDistributionConfigWithTags

• CreateStreamingDistributionWithTagsResult object: The returned result of the corresponding request.
  • StreamingDistribution StreamingDistribution

• CustomErrorResponse object:

  A complex type that controls:

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

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

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

  • ErrorCachingMinTTL long
  • ErrorCode required integer
  • ResponseCode string
  • ResponsePagePath string

• CustomErrorResponseList array
  • items CustomErrorResponse

• CustomErrorResponses object:

  A complex type that controls:

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

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

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

  • Items CustomErrorResponseList
  • Quantity required integer

• CustomHeaders object: A complex type that contains the list of Custom Headers for each origin.
  • Items OriginCustomHeadersList
  • Quantity required integer

• CustomOriginConfig object: A customer origin.
  • HTTPPort required integer
  • HTTPSPort required integer
  • OriginKeepaliveTimeout integer
  • OriginProtocolPolicy required OriginProtocolPolicy
  • OriginReadTimeout integer
  • OriginSslProtocols OriginSslProtocols

• DefaultCacheBehavior object: 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.
  • AllowedMethods AllowedMethods
  • Compress boolean
  • DefaultTTL long
  • ForwardedValues required ForwardedValues
  • LambdaFunctionAssociations LambdaFunctionAssociations
  • MaxTTL long
  • MinTTL required long
  • SmoothStreaming boolean
  • TargetOriginId required string
  • TrustedSigners required TrustedSigners
  • ViewerProtocolPolicy required ViewerProtocolPolicy

• DeleteCloudFrontOriginAccessIdentityRequest object: Deletes a origin access identity.

• DeleteDistributionRequest object:

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

  To delete a web distribution using the CloudFront API:

  1. Disable the web distribution

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

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

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

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

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

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

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

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

• DeleteServiceLinkedRoleRequest object

• DeleteStreamingDistributionRequest object: The request to delete a streaming distribution.

• Distribution object: The distribution's information.
  • ARN required string
  • ActiveTrustedSigners required ActiveTrustedSigners
  • DistributionConfig required DistributionConfig
  • DomainName required string
  • Id required string
  • InProgressInvalidationBatches required integer
  • LastModifiedTime required timestamp
  • Status required string

• DistributionAlreadyExists object: The caller reference you attempted to create the distribution with is associated with another distribution.
  • Message string

• DistributionConfig object: A distribution configuration.
  • Aliases Aliases
  • CacheBehaviors CacheBehaviors
  • CallerReference required string
  • Comment required string
  • CustomErrorResponses CustomErrorResponses
  • DefaultCacheBehavior required DefaultCacheBehavior
  • DefaultRootObject string
  • Enabled required boolean
  • HttpVersion HttpVersion
  • IsIPV6Enabled boolean
  • Logging LoggingConfig
  • Origins required Origins
  • PriceClass PriceClass
  • Restrictions Restrictions
  • ViewerCertificate ViewerCertificate
  • WebACLId string

• DistributionConfigWithTags object: A distribution Configuration and a list of tags to be associated with the distribution.
  • DistributionConfig required DistributionConfig
  • Tags required Tags

• DistributionList object: A distribution list.
  • IsTruncated required boolean
  • Items DistributionSummaryList
  • Marker required string
  • MaxItems required integer
  • NextMarker string
  • Quantity required integer

• DistributionNotDisabled object
  • Message string

• DistributionSummary object: A summary of the information about a CloudFront distribution.
  • ARN required string
  • Aliases required Aliases
  • CacheBehaviors required CacheBehaviors
  • Comment required string
  • CustomErrorResponses required CustomErrorResponses
  • DefaultCacheBehavior required DefaultCacheBehavior
  • DomainName required string
  • Enabled required boolean
  • HttpVersion required HttpVersion
  • Id required string
  • IsIPV6Enabled required boolean
  • LastModifiedTime required timestamp
  • Origins required Origins
  • PriceClass required PriceClass
  • Restrictions required Restrictions
  • Status required string
  • ViewerCertificate required ViewerCertificate
  • WebACLId required string

• DistributionSummaryList array
  • items DistributionSummary

• EventType string (values: viewer-request, viewer-response, origin-request, origin-response)

• ForwardedValues object: A complex type that specifies how CloudFront handles query strings and cookies.
  • Cookies required CookiePreference
  • Headers Headers
  • QueryString required boolean
  • QueryStringCacheKeys QueryStringCacheKeys

• GeoRestriction object: A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.
  • Items LocationList
  • Quantity required integer
  • RestrictionType required GeoRestrictionType

• GeoRestrictionType string (values: blacklist, whitelist, none)

• GetCloudFrontOriginAccessIdentityConfigRequest object: The origin access identity's configuration information. For more information, see CloudFrontOriginAccessIdentityConfigComplexType.

• GetCloudFrontOriginAccessIdentityConfigResult object: The returned result of the corresponding request.
  • CloudFrontOriginAccessIdentityConfig CloudFrontOriginAccessIdentityConfig

• GetCloudFrontOriginAccessIdentityRequest object: The request to get an origin access identity's information.

• GetCloudFrontOriginAccessIdentityResult object: The returned result of the corresponding request.
  • CloudFrontOriginAccessIdentity CloudFrontOriginAccessIdentity

• GetDistributionConfigRequest object: The request to get a distribution configuration.

• GetDistributionConfigResult object: The returned result of the corresponding request.
  • DistributionConfig DistributionConfig

• GetDistributionRequest object: The request to get a distribution's information.

• GetDistributionResult object: The returned result of the corresponding request.
  • Distribution Distribution

• GetInvalidationRequest object: The request to get an invalidation's information.

• GetInvalidationResult object: The returned result of the corresponding request.
  • Invalidation Invalidation

• GetStreamingDistributionConfigRequest object: To request to get a streaming distribution configuration.

• GetStreamingDistributionConfigResult object: The returned result of the corresponding request.
  • StreamingDistributionConfig StreamingDistributionConfig

• GetStreamingDistributionRequest object: The request to get a streaming distribution's information.

• GetStreamingDistributionResult object: The returned result of the corresponding request.
  • StreamingDistribution StreamingDistribution

• HeaderList array
  • items string

• Headers object:

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

  For the headers that you specify, CloudFront caches separate versions of a specified object based on the header values in viewer requests. For example, suppose viewer requests for logo.jpg contain a custom product header that has a value of either acme or apex, and you configure CloudFront to cache your content based on values in the product header. CloudFront forwards the product header to the origin and caches the response from the origin once for each header value. For more information about caching based on header values, see How CloudFront Forwards and Caches Headers in the Amazon CloudFront Developer Guide.

  • Items HeaderList
  • Quantity required integer

• HttpVersion string (values: http1.1, http2)

• IllegalUpdate object: Origin and CallerReference cannot be updated.
  • Message string

• InconsistentQuantities object: The value of Quantity and the size of Items don't match.
  • Message string

• InvalidArgument object: The argument is invalid.
  • Message string

• InvalidDefaultRootObject object: The default root object file name is too big or contains an invalid character.
  • Message string

• InvalidErrorCode object
  • Message string

• InvalidForwardCookies object: Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.
  • Message string

• InvalidGeoRestrictionParameter object
  • Message string

• InvalidHeadersForS3Origin object
  • Message string

• InvalidIfMatchVersion object: The If-Match version is missing or not valid for the distribution.
  • Message string

• InvalidLambdaFunctionAssociation object: The specified Lambda function association is invalid.
  • Message string

• InvalidLocationCode object
  • Message string

• InvalidMinimumProtocolVersion object
  • Message string

• InvalidOrigin object: The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.
  • Message string

• InvalidOriginAccessIdentity object: The origin access identity is not valid or doesn't exist.
  • Message string

• InvalidOriginKeepaliveTimeout object
  • Message string

• InvalidOriginReadTimeout object
  • Message string

• InvalidProtocolSettings object: You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that support Server Name Indication (SNI).
  • Message string

• InvalidQueryStringParameters object
  • Message string

• InvalidRelativePath object: The relative path is too big, is not URL-encoded, or does not begin with a slash (/).
  • Message string

• InvalidRequiredProtocol object: This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration.
  • Message string

• InvalidResponseCode object
  • Message string

• InvalidTTLOrder object
  • Message string

• InvalidTagging object
  • Message string

• InvalidViewerCertificate object
  • Message string

• InvalidWebACLId object
  • Message string

• Invalidation object: An invalidation.
  • CreateTime required timestamp
  • Id required string
  • InvalidationBatch required InvalidationBatch
  • Status required string

• InvalidationBatch object: An invalidation batch.
  • CallerReference required string
  • Paths required Paths

• InvalidationList object: The InvalidationList complex type describes the list of invalidation objects. For more information about invalidation, see Invalidating Objects (Web Distributions Only) in the Amazon CloudFront Developer Guide.
  • IsTruncated required boolean
  • Items InvalidationSummaryList
  • Marker required string
  • MaxItems required integer
  • NextMarker string
  • Quantity required integer

• InvalidationSummary object: A summary of an invalidation request.
  • CreateTime required timestamp
  • Id required string
  • Status required string

• InvalidationSummaryList array
  • items InvalidationSummary

• ItemSelection string (values: none, whitelist, all)

• KeyPairIdList array
  • items string

• KeyPairIds object:

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

  For more information, see ActiveTrustedSigners.

  • Items KeyPairIdList
  • Quantity required integer

• LambdaFunctionAssociation object: A complex type that contains a Lambda function association.
  • EventType EventType
  • LambdaFunctionARN string

• LambdaFunctionAssociationList array
  • items LambdaFunctionAssociation

• LambdaFunctionAssociations object:

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

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

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

  • Items LambdaFunctionAssociationList
  • Quantity required integer

• ListCloudFrontOriginAccessIdentitiesRequest object: The request to list origin access identities.

• ListCloudFrontOriginAccessIdentitiesResult object: The returned result of the corresponding request.
  • CloudFrontOriginAccessIdentityList CloudFrontOriginAccessIdentityList

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

• ListDistributionsByWebACLIdResult object: The response to a request to list the distributions that are associated with a specified AWS WAF web ACL.
  • DistributionList DistributionList

• ListDistributionsRequest object: The request to list your distributions.

• ListDistributionsResult object: The returned result of the corresponding request.
  • DistributionList DistributionList

• ListInvalidationsRequest object: The request to list invalidations.

• ListInvalidationsResult object: The returned result of the corresponding request.
  • InvalidationList InvalidationList

• ListStreamingDistributionsRequest object: The request to list your streaming distributions.

• ListStreamingDistributionsResult object: The returned result of the corresponding request.
  • StreamingDistributionList StreamingDistributionList

• ListTagsForResourceRequest object: The request to list tags for a CloudFront resource.

• ListTagsForResourceResult object: The returned result of the corresponding request.
  • Tags required Tags

• LocationList array
  • items string

• LoggingConfig object: A complex type that controls whether access logs are written for the distribution.
  • Bucket required string
  • Enabled required boolean
  • IncludeCookies required boolean
  • Prefix required string

• Method string (values: GET, HEAD, POST, PUT, PATCH, OPTIONS, DELETE)

• MethodsList array
  • items Method

• MinimumProtocolVersion string (values: SSLv3, TLSv1, TLSv1_2016, TLSv1.1_2016, TLSv1.2_2018)

• MissingBody object: This operation requires a body. Ensure that the body is present and the Content-Type header is set.
  • Message string

• NoSuchCloudFrontOriginAccessIdentity object: The specified origin access identity does not exist.
  • Message string

• NoSuchDistribution object: The specified distribution does not exist.
  • Message string

• NoSuchInvalidation object: The specified invalidation does not exist.
  • Message string

• NoSuchOrigin object: No origin exists with the specified Origin Id.
  • Message string

• NoSuchResource object
  • Message string

• NoSuchStreamingDistribution object: The specified streaming distribution does not exist.
  • Message string

• Origin object:

  A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files. You must create at least one origin.

  For the current limit on the number of origins that you can create for a distribution, see Amazon CloudFront Limits in the AWS General Reference.

  • CustomHeaders CustomHeaders
  • CustomOriginConfig CustomOriginConfig
  • DomainName required string
  • Id required string
  • OriginPath string
  • S3OriginConfig S3OriginConfig

• OriginCustomHeader object: A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution.
  • HeaderName required string
  • HeaderValue required string

• OriginCustomHeadersList array
  • items OriginCustomHeader

• OriginList array
  • items Origin

• OriginProtocolPolicy string (values: http-only, match-viewer, https-only)

• OriginSslProtocols object: A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin.
  • Items required SslProtocolsList
  • Quantity required integer

• Origins object: A complex type that contains information about origins for this distribution.
  • Items OriginList
  • Quantity required integer

• PathList array
  • items string

• Paths object: 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.
  • Items PathList
  • Quantity required integer

• PreconditionFailed object: The precondition given in one or more of the request-header fields evaluated to false.
  • Message string

• PriceClass string (values: PriceClass_100, PriceClass_200, PriceClass_All)

• QueryStringCacheKeys object
  • Items QueryStringCacheKeysList
  • Quantity required integer

• QueryStringCacheKeysList array
  • items string

• ResourceARN string

• ResourceInUse object
  • Message string

• Restrictions object: A complex type that identifies ways in which you want to restrict distribution of your content.
  • GeoRestriction required GeoRestriction

• S3Origin object: 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
  • OriginAccessIdentity required string

• S3OriginConfig object: 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

• SSLSupportMethod string (values: sni-only, vip)

• Signer object: A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any.
  • AwsAccountNumber string
  • KeyPairIds KeyPairIds

• SignerList array
  • items Signer

• SslProtocol string (values: SSLv3, TLSv1, TLSv1.1, TLSv1.2)

• SslProtocolsList array
  • items SslProtocol

• StreamingDistribution object: A streaming distribution.
  • ARN required string
  • ActiveTrustedSigners required ActiveTrustedSigners
  • DomainName required string
  • Id required string
  • LastModifiedTime timestamp
  • Status required string
  • StreamingDistributionConfig required StreamingDistributionConfig

• StreamingDistributionAlreadyExists object
  • Message string

• StreamingDistributionConfig object: The RTMP distribution's configuration information.
  • Aliases Aliases
  • CallerReference required string
  • Comment required string
  • Enabled required boolean
  • Logging StreamingLoggingConfig
  • PriceClass PriceClass
  • S3Origin required S3Origin
  • TrustedSigners required TrustedSigners

• StreamingDistributionConfigWithTags object: A streaming distribution Configuration and a list of tags to be associated with the streaming distribution.
  • StreamingDistributionConfig required StreamingDistributionConfig
  • Tags required Tags

• StreamingDistributionList object: A streaming distribution list.
  • IsTruncated required boolean
  • Items StreamingDistributionSummaryList
  • Marker required string
  • MaxItems required integer
  • NextMarker string
  • Quantity required integer

• StreamingDistributionNotDisabled object
  • Message string

• StreamingDistributionSummary object: A summary of the information for an Amazon CloudFront streaming distribution.
  • ARN required string
  • Aliases required Aliases
  • Comment required string
  • DomainName required string
  • Enabled required boolean
  • Id required string
  • LastModifiedTime required timestamp
  • PriceClass required PriceClass
  • S3Origin required S3Origin
  • Status required string
  • TrustedSigners required TrustedSigners

• StreamingDistributionSummaryList array
  • items StreamingDistributionSummary

• StreamingLoggingConfig object: A complex type that controls whether access logs are written for this streaming distribution.
  • Bucket required string
  • Enabled required boolean
  • Prefix required string

• Tag object: A complex type that contains Tag key and Tag value.
  • Key required TagKey
  • Value TagValue

• TagKey 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 _ - . : / = + @.

• TagKeyList array
  • items TagKey

• TagKeys object: A complex type that contains zero or more Tag elements.
  • Items TagKeyList

• TagList array
  • items Tag

• TagResourceRequest object: The request to add tags to a CloudFront resource.
  • Tags required Tags

• TagValue string

• Tags object: A complex type that contains zero or more Tag elements.
  • Items TagList

• TooManyCacheBehaviors object: You cannot create more cache behaviors for the distribution.
  • Message string

• TooManyCertificates object: You cannot create anymore custom SSL/TLS certificates.
  • Message string

• TooManyCloudFrontOriginAccessIdentities object: Processing your request would cause you to exceed the maximum number of origin access identities allowed.
  • Message string

• TooManyCookieNamesInWhiteList object: Your request contains more cookie names in the whitelist than are allowed per cache behavior.
  • Message string

• TooManyDistributionCNAMEs object: Your request contains more CNAMEs than are allowed per distribution.
  • Message string

• TooManyDistributions object: Processing your request would cause you to exceed the maximum number of distributions allowed.
  • Message string

• TooManyDistributionsWithLambdaAssociations object: Processing your request would cause the maximum number of distributions with Lambda function associations per owner to be exceeded.
  • Message string

• TooManyHeadersInForwardedValues object
  • Message string

• TooManyInvalidationsInProgress object: You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.
  • Message string

• TooManyLambdaFunctionAssociations object: Your request contains more Lambda function associations than are allowed per distribution.
  • Message string

• TooManyOriginCustomHeaders object
  • Message string

• TooManyOrigins object: You cannot create more origins for the distribution.
  • Message string

• TooManyQueryStringParameters object
  • Message string

• TooManyStreamingDistributionCNAMEs object
  • Message string

• TooManyStreamingDistributions object: Processing your request would cause you to exceed the maximum number of streaming distributions allowed.
  • Message string

• TooManyTrustedSigners object: Your request contains more trusted signers than are allowed per distribution.
  • Message string

• TrustedSignerDoesNotExist object: One or more of your trusted signers don't exist.
  • Message string

• TrustedSigners object:

  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.

  For more information about updating the distribution configuration, see DistributionConfig .

  • Enabled required boolean
  • Items AwsAccountNumberList
  • Quantity required integer

• UntagResourceRequest object: The request to remove tags from a CloudFront resource.
  • TagKeys required TagKeys

• UpdateCloudFrontOriginAccessIdentityRequest object: The request to update an origin access identity.
  • CloudFrontOriginAccessIdentityConfig required CloudFrontOriginAccessIdentityConfig

• UpdateCloudFrontOriginAccessIdentityResult object: The returned result of the corresponding request.
  • CloudFrontOriginAccessIdentity CloudFrontOriginAccessIdentity

• UpdateDistributionRequest object: The request to update a distribution.
  • DistributionConfig required DistributionConfig

• UpdateDistributionResult object: The returned result of the corresponding request.
  • Distribution Distribution

• UpdateStreamingDistributionRequest object: The request to update a streaming distribution.
  • StreamingDistributionConfig required StreamingDistributionConfig

• UpdateStreamingDistributionResult object: The returned result of the corresponding request.
  • StreamingDistribution StreamingDistribution

• ViewerCertificate object:

  A complex type that specifies the following:

  • Whether you want viewers to use HTTP or HTTPS to request your objects.

  • If you want viewers to use HTTPS, whether you're using an alternate domain name such as example.com or the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net.

  • If you're using an alternate domain name, whether AWS Certificate Manager (ACM) provided the certificate, or you purchased a certificate from a third-party certificate authority and imported it into ACM or uploaded it to the IAM certificate store.

  You must specify only one of the following values:

  • ViewerCertificate$ACMCertificateArn

  • ViewerCertificate$IAMCertificateId

  • ViewerCertificate$CloudFrontDefaultCertificate

  Don't specify false for CloudFrontDefaultCertificate.

  If you want viewers to use HTTP instead of HTTPS to request your objects: Specify the following value:

  <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>

  In addition, specify allow-all for ViewerProtocolPolicy for all of your cache behaviors.

  If you want viewers to use HTTPS to request your objects: Choose the type of certificate that you want to use based on whether you're using an alternate domain name for your objects or the CloudFront domain name:

  • If you're using an alternate domain name, such as example.com: Specify one of the following values, depending on whether ACM provided your certificate or you purchased your certificate from third-party certificate authority:

    • <ACMCertificateArn>ARN for ACM SSL/TLS certificate<ACMCertificateArn> where ARN for ACM SSL/TLS certificate is the ARN for the ACM SSL/TLS certificate that you want to use for this distribution.

    • <IAMCertificateId>IAM certificate ID<IAMCertificateId> where IAM certificate ID is the ID that IAM returned when you added the certificate to the IAM certificate store.

    If you specify ACMCertificateArn or IAMCertificateId, you must also specify a value for SSLSupportMethod.

    If you choose to use an ACM certificate or a certificate in the IAM certificate store, we recommend that you use only an alternate domain name in your object URLs (https://example.com/logo.jpg). If you use the domain name that is associated with your CloudFront distribution (such as https://d111111abcdef8.cloudfront.net/logo.jpg) and the viewer supports SNI, then CloudFront behaves normally. However, if the browser does not support SNI, the user's experience depends on the value that you choose for SSLSupportMethod:

    • vip: The viewer displays a warning because there is a mismatch between the CloudFront domain name and the domain name in your SSL/TLS certificate.

    • sni-only: CloudFront drops the connection with the browser without returning the object.

  • If you're using the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net : Specify the following value:

    <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>

  If you want viewers to use HTTPS, you must also specify one of the following values in your cache behaviors:

  • <ViewerProtocolPolicy>https-only<ViewerProtocolPolicy>

  • <ViewerProtocolPolicy>redirect-to-https<ViewerProtocolPolicy>

  You can also optionally require that CloudFront use HTTPS to communicate with your origin by specifying one of the following values for the applicable origins:

  • <OriginProtocolPolicy>https-only<OriginProtocolPolicy>

  • <OriginProtocolPolicy>match-viewer<OriginProtocolPolicy>

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

  • ACMCertificateArn string
  • Certificate string
  • CertificateSource CertificateSource
  • CloudFrontDefaultCertificate boolean
  • IAMCertificateId string
  • MinimumProtocolVersion MinimumProtocolVersion
  • SSLSupportMethod SSLSupportMethod

• ViewerProtocolPolicy string (values: allow-all, https-only, redirect-to-https)

• boolean boolean

• integer integer

• long integer

• string string

• timestamp string