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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kinesis/types.rb

Overview

Note:

When making an API call, you may pass DeleteStreamInput data as a hash:

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

Represents the input for DeleteStream.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#enforce_consumer_deletionBoolean

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)

225
226
227
228
229
230
# File 'lib/aws-sdk-kinesis/types.rb', line 225

class DeleteStreamInput < Struct.new(
  :stream_name,
  :enforce_consumer_deletion)
  SENSITIVE = []
  include Aws::Structure
end

#stream_nameString

The name of the stream to delete.

Returns:

  • (String)

225
226
227
228
229
230
# File 'lib/aws-sdk-kinesis/types.rb', line 225

class DeleteStreamInput < Struct.new(
  :stream_name,
  :enforce_consumer_deletion)
  SENSITIVE = []
  include Aws::Structure
end