class Aws::CloudFront::Types::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 thatCloudFront
returned when you submitted the `GETDistribution
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 `GETDistribution
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*.
[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/HowToDeleteDistribution.html
@note When making an API call, you may pass DeleteDistributionRequest
data as a hash: { id: "string", # required if_match: "string", }
@!attribute [rw] id
The distribution ID. @return [String]
@!attribute [rw] if_match
The value of the `ETag` header that you received when you disabled the distribution. For example: `E2QWRUHAPOMQZL`. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/cloudfront-2020-05-31/DeleteDistributionRequest AWS API Documentation
Constants
- SENSITIVE