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

Class DeleteDistributionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudfront.model.CloudFrontRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DeleteDistributionRequest.Builder,DeleteDistributionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DeleteDistributionRequest
extends CloudFrontRequest
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

Method Summary

Modifier and Type	Method	Description
static DeleteDistributionRequest.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final String	id()	The distribution ID.
final String	ifMatch()	The value of the ETag header that you received when you disabled the distribution.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends DeleteDistributionRequest.Builder>	serializableBuilderClass()
DeleteDistributionRequest.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

id

public final String id()

The distribution ID.

Returns:

The distribution ID.

ifMatch

public final 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()

Specified by:

toBuilder in interface ToCopyableBuilder<DeleteDistributionRequest.Builder,DeleteDistributionRequest>

Specified by:

toBuilder in class CloudFrontRequest

builder

public static DeleteDistributionRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
 Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo