Class: Aws::Firehose::Types::DeleteDeliveryStreamInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb

Overview

Note:

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

{
  delivery_stream_name: "DeliveryStreamName", # required
  allow_force_delete: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allow_force_deleteBoolean

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.

Returns:

  • (Boolean)


808
809
810
811
812
813
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 808

class DeleteDeliveryStreamInput < Struct.new(
  :delivery_stream_name,
  :allow_force_delete)
  SENSITIVE = []
  include Aws::Structure
end

#delivery_stream_nameString

The name of the delivery stream.

Returns:

  • (String)


808
809
810
811
812
813
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 808

class DeleteDeliveryStreamInput < Struct.new(
  :delivery_stream_name,
  :allow_force_delete)
  SENSITIVE = []
  include Aws::Structure
end