Class: Aws::CloudFront::Types::DeleteDistributionRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudfront/types.rb

Overview

Note:

When making an API call, you may pass DeleteDistributionRequest data as a hash:

{
  id: "string", # required
  if_match: "string",
}

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*.

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/HowToDeleteDistribution.html

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#idString

The distribution ID.

Returns:

  • (String)

3961
3962
3963
3964
3965
3966
# File 'lib/aws-sdk-cloudfront/types.rb', line 3961

class DeleteDistributionRequest < Struct.new(
  :id,
  :if_match)
  SENSITIVE = []
  include Aws::Structure
end

#if_matchString

The value of the `ETag` header that you received when you disabled the distribution. For example: `E2QWRUHAPOMQZL`.

Returns:

  • (String)

3961
3962
3963
3964
3965
3966
# File 'lib/aws-sdk-cloudfront/types.rb', line 3961

class DeleteDistributionRequest < Struct.new(
  :id,
  :if_match)
  SENSITIVE = []
  include Aws::Structure
end