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:
-
Disable the web distribution
-
Submit a
GET Distribution Configrequest to get the current configuration and theEtagheader for the distribution. -
Update the XML document that was returned in the response to your
GET Distribution Configrequest to change the value ofEnabledtofalse. -
Submit a
PUT Distribution Configrequest 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 HTTPIf-Matchheader to the value of theETagheader that CloudFront returned when you submitted theGET Distribution Configrequest in Step 2. -
Review the response to the
PUT Distribution Configrequest to confirm that the distribution was successfully disabled. -
Submit a
GET Distributionrequest to confirm that your changes have propagated. When propagation is complete, the value ofStatusisDeployed. -
Submit a
DELETE Distributionrequest. Set the value of the HTTPIf-Matchheader to the value of theETagheader that CloudFront returned when you submitted theGET Distribution Configrequest in Step 6. -
Review the response to your
DELETE Distributionrequest 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 interfaceDeleteDistributionRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DeleteDistributionRequest.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Stringid()The distribution ID.StringifMatch()The value of theETagheader that you received when you disabled the distribution.List<SdkField<?>>sdkFields()static Class<? extends DeleteDistributionRequest.Builder>serializableBuilderClass()DeleteDistributionRequest.BuildertoBuilder()StringtoString()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 Detail
-
id
public final String id()
The distribution ID.
- Returns:
- The distribution ID.
-
ifMatch
public final String ifMatch()
The value of the
ETagheader that you received when you disabled the distribution. For example:E2QWRUHAPOMQZL.- Returns:
- The value of the
ETagheader that you received when you disabled the distribution. For example:E2QWRUHAPOMQZL.
-
toBuilder
public DeleteDistributionRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DeleteDistributionRequest.Builder,DeleteDistributionRequest>- Specified by:
toBuilderin classCloudFrontRequest
-
builder
public static DeleteDistributionRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends DeleteDistributionRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-