You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Kinesis::Types::DeleteStreamInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DeleteStreamInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  stream_name: "StreamName", # required
  enforce_consumer_deletion: false,
}

Represents the input for DeleteStream.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#enforce_consumer_deletion ⇒ Boolean

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.

Returns:

  • (Boolean) —

    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.

#stream_name ⇒ String

The name of the stream to delete.

Returns:

  • (String) —

    The name of the stream to delete.