@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:
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.
NOOP
Constructor and Description |
---|
DeleteDistributionRequest()
Default constructor for DeleteDistributionRequest object.
|
DeleteDistributionRequest(String id,
String ifMatch)
Constructs a new DeleteDistributionRequest object.
|
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. |
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
public DeleteDistributionRequest()
public DeleteDistributionRequest(String id, String ifMatch)
id
- The distribution ID.ifMatch
- The value of the ETag
header that you received when you disabled the distribution. For
example: E2QWRUHAPOMQZL
.public void setId(String id)
The distribution ID.
id
- The distribution ID.public String getId()
The distribution ID.
public DeleteDistributionRequest withId(String id)
The distribution ID.
id
- The distribution ID.public void setIfMatch(String ifMatch)
The value of the ETag
header that you received when you disabled the distribution. For example:
E2QWRUHAPOMQZL
.
ifMatch
- The value of the ETag
header that you received when you disabled the distribution. For
example: E2QWRUHAPOMQZL
.public String getIfMatch()
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 withIfMatch(String ifMatch)
The value of the ETag
header that you received when you disabled the distribution. For example:
E2QWRUHAPOMQZL
.
ifMatch
- The value of the ETag
header that you received when you disabled the distribution. For
example: E2QWRUHAPOMQZL
.public String toString()
toString
in class Object
Object.toString()
public DeleteDistributionRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()