AWS SDK for C++  1.9.102
AWS SDK for C++
Public Member Functions | List of all members
Aws::Lightsail::Model::DeleteBucketRequest Class Reference

#include <DeleteBucketRequest.h>

+ Inheritance diagram for Aws::Lightsail::Model::DeleteBucketRequest:

Public Member Functions

 DeleteBucketRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetBucketName () const
 
bool BucketNameHasBeenSet () const
 
void SetBucketName (const Aws::String &value)
 
void SetBucketName (Aws::String &&value)
 
void SetBucketName (const char *value)
 
DeleteBucketRequestWithBucketName (const Aws::String &value)
 
DeleteBucketRequestWithBucketName (Aws::String &&value)
 
DeleteBucketRequestWithBucketName (const char *value)
 
bool GetForceDelete () const
 
bool ForceDeleteHasBeenSet () const
 
void SetForceDelete (bool value)
 
DeleteBucketRequestWithForceDelete (bool value)
 
- Public Member Functions inherited from Aws::Lightsail::LightsailRequest
virtual ~LightsailRequest ()
 
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

Definition at line 21 of file DeleteBucketRequest.h.

Constructor & Destructor Documentation

◆ DeleteBucketRequest()

Aws::Lightsail::Model::DeleteBucketRequest::DeleteBucketRequest ( )

Member Function Documentation

◆ BucketNameHasBeenSet()

bool Aws::Lightsail::Model::DeleteBucketRequest::BucketNameHasBeenSet ( ) const
inline

The name of the bucket to delete.

Use the GetBuckets action to get a list of bucket names that you can specify.

Definition at line 47 of file DeleteBucketRequest.h.

◆ ForceDeleteHasBeenSet()

bool Aws::Lightsail::Model::DeleteBucketRequest::ForceDeleteHasBeenSet ( ) const
inline

A Boolean value that indicates whether to force delete the bucket.

You must force delete the bucket if it has one of the following conditions:

  • The bucket is the origin of a distribution.

  • The bucket has instances that were granted access to it using the SetResourceAccessForBucket action.

  • The bucket has objects.

  • The bucket has access keys.

Force deleting a bucket might impact other resources that rely on the bucket, such as instances, distributions, or software that use the issued access keys.

Definition at line 110 of file DeleteBucketRequest.h.

◆ GetBucketName()

const Aws::String& Aws::Lightsail::Model::DeleteBucketRequest::GetBucketName ( ) const
inline

The name of the bucket to delete.

Use the GetBuckets action to get a list of bucket names that you can specify.

Definition at line 41 of file DeleteBucketRequest.h.

◆ GetForceDelete()

bool Aws::Lightsail::Model::DeleteBucketRequest::GetForceDelete ( ) const
inline

A Boolean value that indicates whether to force delete the bucket.

You must force delete the bucket if it has one of the following conditions:

  • The bucket is the origin of a distribution.

  • The bucket has instances that were granted access to it using the SetResourceAccessForBucket action.

  • The bucket has objects.

  • The bucket has access keys.

Force deleting a bucket might impact other resources that rely on the bucket, such as instances, distributions, or software that use the issued access keys.

Definition at line 97 of file DeleteBucketRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Lightsail::Model::DeleteBucketRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::Lightsail::LightsailRequest.

◆ GetServiceRequestName()

virtual const char* Aws::Lightsail::Model::DeleteBucketRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file DeleteBucketRequest.h.

◆ SerializePayload()

Aws::String Aws::Lightsail::Model::DeleteBucketRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBucketName() [1/3]

void Aws::Lightsail::Model::DeleteBucketRequest::SetBucketName ( Aws::String &&  value)
inline

The name of the bucket to delete.

Use the GetBuckets action to get a list of bucket names that you can specify.

Definition at line 59 of file DeleteBucketRequest.h.

◆ SetBucketName() [2/3]

void Aws::Lightsail::Model::DeleteBucketRequest::SetBucketName ( const Aws::String value)
inline

The name of the bucket to delete.

Use the GetBuckets action to get a list of bucket names that you can specify.

Definition at line 53 of file DeleteBucketRequest.h.

◆ SetBucketName() [3/3]

void Aws::Lightsail::Model::DeleteBucketRequest::SetBucketName ( const char *  value)
inline

The name of the bucket to delete.

Use the GetBuckets action to get a list of bucket names that you can specify.

Definition at line 65 of file DeleteBucketRequest.h.

◆ SetForceDelete()

void Aws::Lightsail::Model::DeleteBucketRequest::SetForceDelete ( bool  value)
inline

A Boolean value that indicates whether to force delete the bucket.

You must force delete the bucket if it has one of the following conditions:

  • The bucket is the origin of a distribution.

  • The bucket has instances that were granted access to it using the SetResourceAccessForBucket action.

  • The bucket has objects.

  • The bucket has access keys.

Force deleting a bucket might impact other resources that rely on the bucket, such as instances, distributions, or software that use the issued access keys.

Definition at line 123 of file DeleteBucketRequest.h.

◆ WithBucketName() [1/3]

DeleteBucketRequest& Aws::Lightsail::Model::DeleteBucketRequest::WithBucketName ( Aws::String &&  value)
inline

The name of the bucket to delete.

Use the GetBuckets action to get a list of bucket names that you can specify.

Definition at line 77 of file DeleteBucketRequest.h.

◆ WithBucketName() [2/3]

DeleteBucketRequest& Aws::Lightsail::Model::DeleteBucketRequest::WithBucketName ( const Aws::String value)
inline

The name of the bucket to delete.

Use the GetBuckets action to get a list of bucket names that you can specify.

Definition at line 71 of file DeleteBucketRequest.h.

◆ WithBucketName() [3/3]

DeleteBucketRequest& Aws::Lightsail::Model::DeleteBucketRequest::WithBucketName ( const char *  value)
inline

The name of the bucket to delete.

Use the GetBuckets action to get a list of bucket names that you can specify.

Definition at line 83 of file DeleteBucketRequest.h.

◆ WithForceDelete()

DeleteBucketRequest& Aws::Lightsail::Model::DeleteBucketRequest::WithForceDelete ( bool  value)
inline

A Boolean value that indicates whether to force delete the bucket.

You must force delete the bucket if it has one of the following conditions:

  • The bucket is the origin of a distribution.

  • The bucket has instances that were granted access to it using the SetResourceAccessForBucket action.

  • The bucket has objects.

  • The bucket has access keys.

Force deleting a bucket might impact other resources that rely on the bucket, such as instances, distributions, or software that use the issued access keys.

Definition at line 136 of file DeleteBucketRequest.h.


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