AWS SDK for C++  1.9.158
AWS SDK for C++
Public Member Functions | List of all members
Aws::CloudFront::Model::DeleteDistribution2020_05_31Request Class Reference

#include <DeleteDistribution2020_05_31Request.h>

+ Inheritance diagram for Aws::CloudFront::Model::DeleteDistribution2020_05_31Request:

Public Member Functions

 DeleteDistribution2020_05_31Request ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
DeleteDistribution2020_05_31RequestWithId (const Aws::String &value)
 
DeleteDistribution2020_05_31RequestWithId (Aws::String &&value)
 
DeleteDistribution2020_05_31RequestWithId (const char *value)
 
const Aws::StringGetIfMatch () const
 
bool IfMatchHasBeenSet () const
 
void SetIfMatch (const Aws::String &value)
 
void SetIfMatch (Aws::String &&value)
 
void SetIfMatch (const char *value)
 
DeleteDistribution2020_05_31RequestWithIfMatch (const Aws::String &value)
 
DeleteDistribution2020_05_31RequestWithIfMatch (Aws::String &&value)
 
DeleteDistribution2020_05_31RequestWithIfMatch (const char *value)
 
- Public Member Functions inherited from Aws::CloudFront::CloudFrontRequest
virtual ~CloudFrontRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

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 Reference

Definition at line 51 of file DeleteDistribution2020_05_31Request.h.

Constructor & Destructor Documentation

◆ DeleteDistribution2020_05_31Request()

Aws::CloudFront::Model::DeleteDistribution2020_05_31Request::DeleteDistribution2020_05_31Request ( )

Member Function Documentation

◆ GetId()

const Aws::String& Aws::CloudFront::Model::DeleteDistribution2020_05_31Request::GetId ( ) const
inline

The distribution ID.

Definition at line 70 of file DeleteDistribution2020_05_31Request.h.

◆ GetIfMatch()

const Aws::String& Aws::CloudFront::Model::DeleteDistribution2020_05_31Request::GetIfMatch ( ) const
inline

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

Definition at line 112 of file DeleteDistribution2020_05_31Request.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::CloudFront::Model::DeleteDistribution2020_05_31Request::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::CloudFront::Model::DeleteDistribution2020_05_31Request::GetServiceRequestName ( ) const
inlineoverridevirtual

◆ IdHasBeenSet()

bool Aws::CloudFront::Model::DeleteDistribution2020_05_31Request::IdHasBeenSet ( ) const
inline

The distribution ID.

Definition at line 75 of file DeleteDistribution2020_05_31Request.h.

◆ IfMatchHasBeenSet()

bool Aws::CloudFront::Model::DeleteDistribution2020_05_31Request::IfMatchHasBeenSet ( ) const
inline

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

Definition at line 118 of file DeleteDistribution2020_05_31Request.h.

◆ SerializePayload()

Aws::String Aws::CloudFront::Model::DeleteDistribution2020_05_31Request::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetId() [1/3]

void Aws::CloudFront::Model::DeleteDistribution2020_05_31Request::SetId ( Aws::String &&  value)
inline

The distribution ID.

Definition at line 85 of file DeleteDistribution2020_05_31Request.h.

◆ SetId() [2/3]

void Aws::CloudFront::Model::DeleteDistribution2020_05_31Request::SetId ( const Aws::String value)
inline

The distribution ID.

Definition at line 80 of file DeleteDistribution2020_05_31Request.h.

◆ SetId() [3/3]

void Aws::CloudFront::Model::DeleteDistribution2020_05_31Request::SetId ( const char *  value)
inline

The distribution ID.

Definition at line 90 of file DeleteDistribution2020_05_31Request.h.

◆ SetIfMatch() [1/3]

void Aws::CloudFront::Model::DeleteDistribution2020_05_31Request::SetIfMatch ( Aws::String &&  value)
inline

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

Definition at line 130 of file DeleteDistribution2020_05_31Request.h.

◆ SetIfMatch() [2/3]

void Aws::CloudFront::Model::DeleteDistribution2020_05_31Request::SetIfMatch ( const Aws::String value)
inline

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

Definition at line 124 of file DeleteDistribution2020_05_31Request.h.

◆ SetIfMatch() [3/3]

void Aws::CloudFront::Model::DeleteDistribution2020_05_31Request::SetIfMatch ( const char *  value)
inline

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

Definition at line 136 of file DeleteDistribution2020_05_31Request.h.

◆ WithId() [1/3]

DeleteDistribution2020_05_31Request& Aws::CloudFront::Model::DeleteDistribution2020_05_31Request::WithId ( Aws::String &&  value)
inline

The distribution ID.

Definition at line 100 of file DeleteDistribution2020_05_31Request.h.

◆ WithId() [2/3]

DeleteDistribution2020_05_31Request& Aws::CloudFront::Model::DeleteDistribution2020_05_31Request::WithId ( const Aws::String value)
inline

The distribution ID.

Definition at line 95 of file DeleteDistribution2020_05_31Request.h.

◆ WithId() [3/3]

DeleteDistribution2020_05_31Request& Aws::CloudFront::Model::DeleteDistribution2020_05_31Request::WithId ( const char *  value)
inline

The distribution ID.

Definition at line 105 of file DeleteDistribution2020_05_31Request.h.

◆ WithIfMatch() [1/3]

DeleteDistribution2020_05_31Request& Aws::CloudFront::Model::DeleteDistribution2020_05_31Request::WithIfMatch ( Aws::String &&  value)
inline

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

Definition at line 148 of file DeleteDistribution2020_05_31Request.h.

◆ WithIfMatch() [2/3]

DeleteDistribution2020_05_31Request& Aws::CloudFront::Model::DeleteDistribution2020_05_31Request::WithIfMatch ( const Aws::String value)
inline

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

Definition at line 142 of file DeleteDistribution2020_05_31Request.h.

◆ WithIfMatch() [3/3]

DeleteDistribution2020_05_31Request& Aws::CloudFront::Model::DeleteDistribution2020_05_31Request::WithIfMatch ( const char *  value)
inline

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

Definition at line 154 of file DeleteDistribution2020_05_31Request.h.


The documentation for this class was generated from the following file: