amazonka-cloudfront-2.0: Amazon CloudFront SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CloudFront.DeleteDistribution

Description

Delete a distribution.

Synopsis

Creating a Request

data DeleteDistribution Source #

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: newDeleteDistribution smart constructor.

Constructors

DeleteDistribution' 

Fields

  • ifMatch :: Maybe Text

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

  • id :: Text

    The distribution ID.

Instances

Instances details
ToHeaders DeleteDistribution Source # 
Instance details

Defined in Amazonka.CloudFront.DeleteDistribution

Methods

toHeaders :: DeleteDistribution -> [Header] #

ToPath DeleteDistribution Source # 
Instance details

Defined in Amazonka.CloudFront.DeleteDistribution

Methods

toPath :: DeleteDistribution -> ByteString #

ToQuery DeleteDistribution Source # 
Instance details

Defined in Amazonka.CloudFront.DeleteDistribution

Methods

toQuery :: DeleteDistribution -> QueryString #

AWSRequest DeleteDistribution Source # 
Instance details

Defined in Amazonka.CloudFront.DeleteDistribution

Associated Types

type AWSResponse DeleteDistribution #

Methods

request :: (Service -> Service) -> DeleteDistribution -> Request DeleteDistribution #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteDistribution -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteDistribution))) #

Generic DeleteDistribution Source # 
Instance details

Defined in Amazonka.CloudFront.DeleteDistribution

Associated Types

type Rep DeleteDistribution :: Type -> Type #

Methods

from :: DeleteDistribution -> Rep DeleteDistribution x #

to :: Rep DeleteDistribution x -> DeleteDistribution #

Read DeleteDistribution Source # 
Instance details

Defined in Amazonka.CloudFront.DeleteDistribution

Methods

readsPrec :: Int -> ReadS DeleteDistribution #

readList :: ReadS [DeleteDistribution] #

readPrec :: ReadPrec DeleteDistribution #

readListPrec :: ReadPrec [DeleteDistribution] #

Show DeleteDistribution Source # 
Instance details

Defined in Amazonka.CloudFront.DeleteDistribution

Methods

showsPrec :: Int -> DeleteDistribution -> ShowS #

show :: DeleteDistribution -> String #

showList :: [DeleteDistribution] -> ShowS #

NFData DeleteDistribution Source # 
Instance details

Defined in Amazonka.CloudFront.DeleteDistribution

Methods

rnf :: DeleteDistribution -> () #

Eq DeleteDistribution Source # 
Instance details

Defined in Amazonka.CloudFront.DeleteDistribution

Methods

(==) :: DeleteDistribution -> DeleteDistribution -> Bool #

(/=) :: DeleteDistribution -> DeleteDistribution -> Bool #

Hashable DeleteDistribution Source # 
Instance details

Defined in Amazonka.CloudFront.DeleteDistribution

Methods

hashWithSalt :: Int -> DeleteDistribution -> Int #

hash :: DeleteDistribution -> Int #

type AWSResponse DeleteDistribution Source # 
Instance details

Defined in Amazonka.CloudFront.DeleteDistribution

type AWSResponse DeleteDistribution = DeleteDistributionResponse
type Rep DeleteDistribution Source # 
Instance details

Defined in Amazonka.CloudFront.DeleteDistribution

type Rep DeleteDistribution = D1 ('MetaData "DeleteDistribution" "Amazonka.CloudFront.DeleteDistribution" "amazonka-cloudfront-2.0-8Jb7luniAuUfLdUxCxW4K" 'False) (C1 ('MetaCons "DeleteDistribution'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ifMatch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteDistribution Source #

Arguments

:: Text

DeleteDistribution

-> DeleteDistribution 

Create a value of DeleteDistribution with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:ifMatch:DeleteDistribution', deleteDistribution_ifMatch - The value of the ETag header that you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.

DeleteDistribution, deleteDistribution_id - The distribution ID.

Request Lenses

deleteDistribution_ifMatch :: Lens' DeleteDistribution (Maybe Text) Source #

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

deleteDistribution_id :: Lens' DeleteDistribution Text Source #

The distribution ID.

Destructuring the Response

data DeleteDistributionResponse Source #

See: newDeleteDistributionResponse smart constructor.

Constructors

DeleteDistributionResponse' 

Instances

Instances details
Generic DeleteDistributionResponse Source # 
Instance details

Defined in Amazonka.CloudFront.DeleteDistribution

Associated Types

type Rep DeleteDistributionResponse :: Type -> Type #

Methods

from :: DeleteDistributionResponse -> Rep DeleteDistributionResponse x #

to :: Rep DeleteDistributionResponse x -> DeleteDistributionResponse #

Read DeleteDistributionResponse Source # 
Instance details

Defined in Amazonka.CloudFront.DeleteDistribution

Methods

readsPrec :: Int -> ReadS DeleteDistributionResponse #

readList :: ReadS [DeleteDistributionResponse] #

readPrec :: ReadPrec DeleteDistributionResponse #

readListPrec :: ReadPrec [DeleteDistributionResponse] #

Show DeleteDistributionResponse Source # 
Instance details

Defined in Amazonka.CloudFront.DeleteDistribution

Methods

showsPrec :: Int -> DeleteDistributionResponse -> ShowS #

show :: DeleteDistributionResponse -> String #

showList :: [DeleteDistributionResponse] -> ShowS #

NFData DeleteDistributionResponse Source # 
Instance details

Defined in Amazonka.CloudFront.DeleteDistribution

Methods

rnf :: DeleteDistributionResponse -> () #

Eq DeleteDistributionResponse Source # 
Instance details

Defined in Amazonka.CloudFront.DeleteDistribution

Methods

(==) :: DeleteDistributionResponse -> DeleteDistributionResponse -> Bool #

(/=) :: DeleteDistributionResponse -> DeleteDistributionResponse -> Bool #

type Rep DeleteDistributionResponse Source # 
Instance details

Defined in Amazonka.CloudFront.DeleteDistribution

type Rep DeleteDistributionResponse = D1 ('MetaData "DeleteDistributionResponse" "Amazonka.CloudFront.DeleteDistribution" "amazonka-cloudfront-2.0-8Jb7luniAuUfLdUxCxW4K" 'False) (C1 ('MetaCons "DeleteDistributionResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteDistributionResponse :: DeleteDistributionResponse Source #

Create a value of DeleteDistributionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.