AWS.CloudFront (2018-11-05) — AWS SDK for JavaScript (original) (raw)

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

Property Details

endpoint ⇒ AWS.Endpoint

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

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.

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

Create a new distribution with tags.

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

Create a new field-level encryption configuration.

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

Create a field-level encryption profile.

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

Create a new invalidation.

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.

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.

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

Create a new streaming distribution with tags.

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

Delete an origin access identity.

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

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

Remove a field-level encryption configuration.

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

Remove a field-level encryption profile.

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

Remove a public key you previously added to CloudFront.

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.

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

Get the information about an origin access identity.

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

Get the configuration information about an origin access identity.

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

Get the information about a distribution.

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

Get the configuration information about a distribution.

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

Get the field-level encryption configuration information.

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

Get the field-level encryption configuration information.

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

Get the field-level encryption profile information.

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

Get the field-level encryption profile configuration information.

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

Get the information about an invalidation.

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

Get the public key information.

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

Return public key configuration informaation

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

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

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

Get the configuration information about a streaming distribution.

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

Lists origin access identities.

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

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

List the distributions that are associated with a specified AWS WAF web ACL.

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

List all field-level encryption configurations that have been created in CloudFront for this account.

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

Request a list of field-level encryption profiles that have been created in CloudFront for this account.

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

Lists invalidation batches.

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

List all public keys that have been added to CloudFront for this account.

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

List streaming distributions.

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

List tags for a CloudFront resource.

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

Add tags to a CloudFront resource.

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

Remove tags from a CloudFront resource.

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

Update an origin access identity.

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.

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

Update a field-level encryption configuration.

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

Update a field-level encryption profile.

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

Update public key information. Note that the only value you can change is the comment.

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

Update a streaming distribution.

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

Waits for a given CloudFront_20181105 resource. The final callback or'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.