DeleteDistributionRequest (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.cloudfront.model

Class DeleteDistributionRequest

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cloudfront.model.DeleteDistributionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DeleteDistributionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable 
```
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.
See Also:

AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description
`DeleteDistributionRequest ()` Default constructor for DeleteDistributionRequest object.
`DeleteDistributionRequest (String id, String ifMatch)` Constructs a new DeleteDistributionRequest object.

Method Summary

All Methods
Modifier and Type	Method and Description
`DeleteDistributionRequest`	`clone ()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals (Object obj)`
`String`	`getId ()` The distribution ID.
`String`	`getIfMatch ()` The value of the `ETag` header that you received when you disabled the distribution.
`int`	`hashCode ()`
`void`	`setId (String id)` The distribution ID.
`void`	`setIfMatch (String ifMatch)` The value of the `ETag` header that you received when you disabled the distribution.
`String`	`toString ()` Returns a string representation of this object.
`DeleteDistributionRequest`	`withId (String id)` The distribution ID.
`DeleteDistributionRequest`	`withIfMatch (String ifMatch)` The value of the `ETag` header that you received when you disabled the distribution.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DeleteDistributionRequest
```
public DeleteDistributionRequest()
```
    Default constructor for DeleteDistributionRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.
  - DeleteDistributionRequest
```
public DeleteDistributionRequest(String id,
 String ifMatch)
```
    Constructs a new DeleteDistributionRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
    
    Parameters:
    
    id - The distribution ID.
    
    ifMatch - The value of the ETag header that you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.
- Method Detail
  - setId
```
public void setId(String id)
```
    The distribution ID.
    
    Parameters:
    
    id - The distribution ID.
  - getId
```
public String getId()
```
    The distribution ID.
    
    Returns:
    
    The distribution ID.
  - withId
```
public DeleteDistributionRequest withId(String id)
```
    The distribution ID.
    
    Parameters:
    
    id - The distribution ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIfMatch
```
public void setIfMatch(String ifMatch)
```
    The value of the ETag header that you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.
    
    Parameters:
    
    ifMatch - The value of the ETag header that you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.
  - getIfMatch
```
public String getIfMatch()
```
    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.
  - withIfMatch
```
public DeleteDistributionRequest withIfMatch(String ifMatch)
```
    The value of the ETag header that you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.
    
    Parameters:
    
    ifMatch - The value of the ETag header that you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DeleteDistributionRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.793

Class DeleteDistributionRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

DeleteDistributionRequest

DeleteDistributionRequest

Method Detail

setId

getId

withId

setIfMatch

getIfMatch

withIfMatch

toString

equals

hashCode

clone