Class: Ansible::Ruby::Modules::Kinesis_stream

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Kinesis_stream

Defined in:

lib/ansible/ruby/modules/generated/cloud/amazon/kinesis_stream.rb

Overview

Create or Delete a Kinesis Stream. Update the retention period of a Kinesis Stream. Update Tags on a Kinesis Stream. Enable/disable server side encryption on a Kinesis Stream.

Instance Method Summary

• #encryption_state ⇒ :enabled, ...

  Enable or Disable encryption on the Kinesis Stream.

• #encryption_type ⇒ String^?

  The type of encryption.

• #key_id ⇒ String^?

  The GUID or alias for the KMS key.

• #name ⇒ String

  The name of the Kinesis Stream you are managing.

• #retention_period ⇒ Integer^?

  The default retention period is 24 hours and can not be less than 24 hours.,The retention period can be modified during any point in time.

• #shards ⇒ Integer^?

  The number of shards you want to have with this stream.,This is required when state == present.

• #state ⇒ :present, ...

  Create or Delete the Kinesis Stream.

• #tags ⇒ Hash^?

  A dictionary of resource tags of the form: { tag1: value1, tag2: value2 }.

• #wait ⇒ Boolean^?

  Wait for operation to complete before returning.

• #wait_timeout ⇒ Integer^?

  How many seconds to wait for an operation to complete before timing out.

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#encryption_state ⇒ :enabled, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/kinesis_stream.rb', line 43

attribute :encryption_state

#encryption_type ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/kinesis_stream.rb', line 47

attribute :encryption_type

#key_id ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/kinesis_stream.rb', line 51

attribute :key_id

#name ⇒ String

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/kinesis_stream.rb', line 15

attribute :name

#retention_period ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/kinesis_stream.rb', line 23

attribute :retention_period

#shards ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/kinesis_stream.rb', line 19

attribute :shards

#state ⇒ :present, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/kinesis_stream.rb', line 27

attribute :state

#tags ⇒ Hash^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/kinesis_stream.rb', line 39

attribute :tags

#wait ⇒ Boolean^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/kinesis_stream.rb', line 31

attribute :wait

#wait_timeout ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/kinesis_stream.rb', line 35

attribute :wait_timeout