Package software.amazon.awssdk.services.cloudfront.model

Class DeleteDistributionRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.cloudfront.model.DeleteDistributionRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<DeleteDistributionRequest.Builder,DeleteDistributionRequest>

@Generated("software.amazon.awssdk:codegen")
public class DeleteDistributionRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<DeleteDistributionRequest.Builder,DeleteDistributionRequest>

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeleteDistributionRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static DeleteDistributionRequest.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
String	id()	The distribution ID.
String	ifMatch()	The value of the ETag header that you received when you disabled the distribution.
static Class<? extends DeleteDistributionRequest.Builder>	serializableBuilderClass()
DeleteDistributionRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

id

public String id()

The distribution ID.

Returns:

The distribution ID.

ifMatch

public String ifMatch()

The value of the ETag header that you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.

Returns:

The value of the ETag header that you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.

toBuilder

public DeleteDistributionRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DeleteDistributionRequest.Builder,DeleteDistributionRequest>

Returns:

a builder for type T

builder

public static DeleteDistributionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DeleteDistributionRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object