Struct aws_sdk_firehose::client::fluent_builders::DeleteDeliveryStream

pub struct DeleteDeliveryStream { /* private fields */ }

Fluent builder constructing a request to DeleteDeliveryStream.

Deletes a delivery stream and its data.

To check the state of a delivery stream, use DescribeDeliveryStream. You can delete a delivery stream only if it is in one of the following states: ACTIVE, DELETING, CREATING_FAILED, or DELETING_FAILED. You can't delete a delivery stream that is in the CREATING state. While the deletion request is in process, the delivery stream is in the DELETING state.

While the delivery stream is in the DELETING state, the service might continue to accept records, but it doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, first stop any applications that are sending records before you delete a delivery stream.

Implementations

impl DeleteDeliveryStream

pub async fn send(
    self
) -> Result<DeleteDeliveryStreamOutput, SdkError<DeleteDeliveryStreamError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn delivery_stream_name(self, input: impl Into<String>) -> Self

The name of the delivery stream.

pub fn set_delivery_stream_name(self, input: Option<String>) -> Self

The name of the delivery stream.

pub fn allow_force_delete(self, input: bool) -> Self

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.

pub fn set_allow_force_delete(self, input: Option<bool>) -> Self

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.

Trait Implementations

impl Clone for DeleteDeliveryStream

fn clone(&self) -> DeleteDeliveryStream

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DeleteDeliveryStream

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.