@Generated(value="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:
Disable the web distribution
Submit a GET Distribution Config
request to get the current configuration and the Etag
header for the distribution.
Update the XML document that was returned in the response to your GET Distribution Config
request to
change the value of Enabled
to false
.
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.
Review the response to the PUT Distribution Config
request to confirm that the distribution was
successfully disabled.
Submit a GET Distribution
request to confirm that your changes have propagated. When propagation is
complete, the value of Status
is Deployed
.
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.
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.
Modifier and Type | Class and Description |
---|---|
static interface |
DeleteDistributionRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static DeleteDistributionRequest.Builder |
builder() |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
id()
The distribution ID.
|
String |
ifMatch()
The value of the
ETag header that you received when you disabled the distribution. |
List<SdkField<?>> |
sdkFields() |
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() |
overrideConfiguration
copy
public String id()
The distribution ID.
public String ifMatch()
The value of the ETag
header that you received when you disabled the distribution. For example:
E2QWRUHAPOMQZL
.
ETag
header that you received when you disabled the distribution. For
example: E2QWRUHAPOMQZL
.public DeleteDistributionRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DeleteDistributionRequest.Builder,DeleteDistributionRequest>
toBuilder
in class CloudFrontRequest
public static DeleteDistributionRequest.Builder builder()
public static Class<? extends DeleteDistributionRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.