Struct aws_sdk_cloudfront::client::fluent_builders::UpdateDistribution

pub struct UpdateDistribution { /* private fields */ }

Fluent builder constructing a request to UpdateDistribution.

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.

   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.

Implementations

impl UpdateDistribution

pub async fn send(
    self
) -> Result<UpdateDistributionOutput, SdkError<UpdateDistributionError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn distribution_config(self, input: DistributionConfig) -> Self

The distribution's configuration information.

pub fn set_distribution_config(self, input: Option<DistributionConfig>) -> Self

The distribution's configuration information.

pub fn id(self, input: impl Into<String>) -> Self

The distribution's id.

pub fn set_id(self, input: Option<String>) -> Self

The distribution's id.

pub fn if_match(self, input: impl Into<String>) -> Self

The value of the ETag header that you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.

pub fn set_if_match(self, input: Option<String>) -> Self

The value of the ETag header that you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.

Trait Implementations

impl Clone for UpdateDistribution

fn clone(&self) -> UpdateDistribution

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateDistribution

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.