AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::Firehose::Model::DeleteDeliveryStreamRequest Class Reference

#include <DeleteDeliveryStreamRequest.h>

+ Inheritance diagram for Aws::Firehose::Model::DeleteDeliveryStreamRequest:

Public Member Functions

 DeleteDeliveryStreamRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetDeliveryStreamName () const
 
bool DeliveryStreamNameHasBeenSet () const
 
void SetDeliveryStreamName (const Aws::String &value)
 
void SetDeliveryStreamName (Aws::String &&value)
 
void SetDeliveryStreamName (const char *value)
 
DeleteDeliveryStreamRequestWithDeliveryStreamName (const Aws::String &value)
 
DeleteDeliveryStreamRequestWithDeliveryStreamName (Aws::String &&value)
 
DeleteDeliveryStreamRequestWithDeliveryStreamName (const char *value)
 
bool GetAllowForceDelete () const
 
bool AllowForceDeleteHasBeenSet () const
 
void SetAllowForceDelete (bool value)
 
DeleteDeliveryStreamRequestWithAllowForceDelete (bool value)
 
- Public Member Functions inherited from Aws::Firehose::FirehoseRequest
virtual ~FirehoseRequest ()
 
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 DeleteDeliveryStreamRequest.h.

Constructor & Destructor Documentation

◆ DeleteDeliveryStreamRequest()

Aws::Firehose::Model::DeleteDeliveryStreamRequest::DeleteDeliveryStreamRequest ( )

Member Function Documentation

◆ AllowForceDeleteHasBeenSet()

bool Aws::Firehose::Model::DeleteDeliveryStreamRequest::AllowForceDeleteHasBeenSet ( ) const
inline

Set this to true if you want to delete the delivery stream even if Kinesis Data Firehose is unable to retire the grant for the CMK. Kinesis Data Firehose might be unable to retire the grant due to a customer error, such as when the CMK or the grant are in an invalid state. If you force deletion, you can then use the RevokeGrant operation to revoke the grant you gave to Kinesis Data Firehose. If a failure to retire the grant happens due to an AWS KMS issue, Kinesis Data Firehose keeps retrying the delete operation.

The default value is false.

Definition at line 102 of file DeleteDeliveryStreamRequest.h.

◆ DeliveryStreamNameHasBeenSet()

bool Aws::Firehose::Model::DeleteDeliveryStreamRequest::DeliveryStreamNameHasBeenSet ( ) const
inline

The name of the delivery stream.

Definition at line 45 of file DeleteDeliveryStreamRequest.h.

◆ GetAllowForceDelete()

bool Aws::Firehose::Model::DeleteDeliveryStreamRequest::GetAllowForceDelete ( ) const
inline

Set this to true if you want to delete the delivery stream even if Kinesis Data Firehose is unable to retire the grant for the CMK. Kinesis Data Firehose might be unable to retire the grant due to a customer error, such as when the CMK or the grant are in an invalid state. If you force deletion, you can then use the RevokeGrant operation to revoke the grant you gave to Kinesis Data Firehose. If a failure to retire the grant happens due to an AWS KMS issue, Kinesis Data Firehose keeps retrying the delete operation.

The default value is false.

Definition at line 89 of file DeleteDeliveryStreamRequest.h.

◆ GetDeliveryStreamName()

const Aws::String& Aws::Firehose::Model::DeleteDeliveryStreamRequest::GetDeliveryStreamName ( ) const
inline

The name of the delivery stream.

Definition at line 40 of file DeleteDeliveryStreamRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Firehose::Model::DeleteDeliveryStreamRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::Firehose::FirehoseRequest.

◆ GetServiceRequestName()

virtual const char* Aws::Firehose::Model::DeleteDeliveryStreamRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file DeleteDeliveryStreamRequest.h.

◆ SerializePayload()

Aws::String Aws::Firehose::Model::DeleteDeliveryStreamRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAllowForceDelete()

void Aws::Firehose::Model::DeleteDeliveryStreamRequest::SetAllowForceDelete ( bool  value)
inline

Set this to true if you want to delete the delivery stream even if Kinesis Data Firehose is unable to retire the grant for the CMK. Kinesis Data Firehose might be unable to retire the grant due to a customer error, such as when the CMK or the grant are in an invalid state. If you force deletion, you can then use the RevokeGrant operation to revoke the grant you gave to Kinesis Data Firehose. If a failure to retire the grant happens due to an AWS KMS issue, Kinesis Data Firehose keeps retrying the delete operation.

The default value is false.

Definition at line 115 of file DeleteDeliveryStreamRequest.h.

◆ SetDeliveryStreamName() [1/3]

void Aws::Firehose::Model::DeleteDeliveryStreamRequest::SetDeliveryStreamName ( const Aws::String value)
inline

The name of the delivery stream.

Definition at line 50 of file DeleteDeliveryStreamRequest.h.

◆ SetDeliveryStreamName() [2/3]

void Aws::Firehose::Model::DeleteDeliveryStreamRequest::SetDeliveryStreamName ( Aws::String &&  value)
inline

The name of the delivery stream.

Definition at line 55 of file DeleteDeliveryStreamRequest.h.

◆ SetDeliveryStreamName() [3/3]

void Aws::Firehose::Model::DeleteDeliveryStreamRequest::SetDeliveryStreamName ( const char *  value)
inline

The name of the delivery stream.

Definition at line 60 of file DeleteDeliveryStreamRequest.h.

◆ WithAllowForceDelete()

DeleteDeliveryStreamRequest& Aws::Firehose::Model::DeleteDeliveryStreamRequest::WithAllowForceDelete ( bool  value)
inline

Set this to true if you want to delete the delivery stream even if Kinesis Data Firehose is unable to retire the grant for the CMK. Kinesis Data Firehose might be unable to retire the grant due to a customer error, such as when the CMK or the grant are in an invalid state. If you force deletion, you can then use the RevokeGrant operation to revoke the grant you gave to Kinesis Data Firehose. If a failure to retire the grant happens due to an AWS KMS issue, Kinesis Data Firehose keeps retrying the delete operation.

The default value is false.

Definition at line 128 of file DeleteDeliveryStreamRequest.h.

◆ WithDeliveryStreamName() [1/3]

DeleteDeliveryStreamRequest& Aws::Firehose::Model::DeleteDeliveryStreamRequest::WithDeliveryStreamName ( const Aws::String value)
inline

The name of the delivery stream.

Definition at line 65 of file DeleteDeliveryStreamRequest.h.

◆ WithDeliveryStreamName() [2/3]

DeleteDeliveryStreamRequest& Aws::Firehose::Model::DeleteDeliveryStreamRequest::WithDeliveryStreamName ( Aws::String &&  value)
inline

The name of the delivery stream.

Definition at line 70 of file DeleteDeliveryStreamRequest.h.

◆ WithDeliveryStreamName() [3/3]

DeleteDeliveryStreamRequest& Aws::Firehose::Model::DeleteDeliveryStreamRequest::WithDeliveryStreamName ( const char *  value)
inline

The name of the delivery stream.

Definition at line 75 of file DeleteDeliveryStreamRequest.h.


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