pub struct DeleteStreamFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to DeleteStream
.
Deletes a Kinesis data stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it receives the exception ResourceNotFoundException
.
When invoking this API, you must use either the StreamARN
or the StreamName
parameter, or both. It is recommended that you use the StreamARN
input parameter when you invoke this API.
If the stream is in the ACTIVE
state, you can delete it. After a DeleteStream
request, the specified stream is in the DELETING
state until Kinesis Data Streams completes the deletion.
Note: Kinesis Data Streams might continue to accept data read and write operations, such as PutRecord
, PutRecords
, and GetRecords
, on a stream in the DELETING
state until the stream deletion is complete.
When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream.
You can use the DescribeStreamSummary
operation to check the state of the stream, which is returned in StreamStatus
.
DeleteStream
has a limit of five transactions per second per account.
Implementations§
source§impl DeleteStreamFluentBuilder
impl DeleteStreamFluentBuilder
sourcepub fn as_input(&self) -> &DeleteStreamInputBuilder
pub fn as_input(&self) -> &DeleteStreamInputBuilder
Access the DeleteStream as a reference.
sourcepub async fn send(
self
) -> Result<DeleteStreamOutput, SdkError<DeleteStreamError, HttpResponse>>
pub async fn send( self ) -> Result<DeleteStreamOutput, SdkError<DeleteStreamError, HttpResponse>>
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.
sourcepub fn customize(
self
) -> CustomizableOperation<DeleteStreamOutput, DeleteStreamError, Self>
pub fn customize( self ) -> CustomizableOperation<DeleteStreamOutput, DeleteStreamError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn stream_name(self, input: impl Into<String>) -> Self
pub fn stream_name(self, input: impl Into<String>) -> Self
The name of the stream to delete.
sourcepub fn set_stream_name(self, input: Option<String>) -> Self
pub fn set_stream_name(self, input: Option<String>) -> Self
The name of the stream to delete.
sourcepub fn get_stream_name(&self) -> &Option<String>
pub fn get_stream_name(&self) -> &Option<String>
The name of the stream to delete.
sourcepub fn enforce_consumer_deletion(self, input: bool) -> Self
pub fn enforce_consumer_deletion(self, input: bool) -> Self
If this parameter is unset (null
) or if you set it to false
, and the stream has registered consumers, the call to DeleteStream
fails with a ResourceInUseException
.
sourcepub fn set_enforce_consumer_deletion(self, input: Option<bool>) -> Self
pub fn set_enforce_consumer_deletion(self, input: Option<bool>) -> Self
If this parameter is unset (null
) or if you set it to false
, and the stream has registered consumers, the call to DeleteStream
fails with a ResourceInUseException
.
sourcepub fn get_enforce_consumer_deletion(&self) -> &Option<bool>
pub fn get_enforce_consumer_deletion(&self) -> &Option<bool>
If this parameter is unset (null
) or if you set it to false
, and the stream has registered consumers, the call to DeleteStream
fails with a ResourceInUseException
.
sourcepub fn stream_arn(self, input: impl Into<String>) -> Self
pub fn stream_arn(self, input: impl Into<String>) -> Self
The ARN of the stream.
sourcepub fn set_stream_arn(self, input: Option<String>) -> Self
pub fn set_stream_arn(self, input: Option<String>) -> Self
The ARN of the stream.
sourcepub fn get_stream_arn(&self) -> &Option<String>
pub fn get_stream_arn(&self) -> &Option<String>
The ARN of the stream.
Trait Implementations§
source§impl Clone for DeleteStreamFluentBuilder
impl Clone for DeleteStreamFluentBuilder
source§fn clone(&self) -> DeleteStreamFluentBuilder
fn clone(&self) -> DeleteStreamFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for DeleteStreamFluentBuilder
impl !RefUnwindSafe for DeleteStreamFluentBuilder
impl Send for DeleteStreamFluentBuilder
impl Sync for DeleteStreamFluentBuilder
impl Unpin for DeleteStreamFluentBuilder
impl !UnwindSafe for DeleteStreamFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more