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

Inherits:
Base show all
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 collapse

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, ...

Returns Enable or Disable encryption on the Kinesis Stream.

Returns:

  • (:enabled, :disabled, nil) —

    Enable or Disable encryption on the Kinesis Stream.



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

attribute :encryption_state

#encryption_type ⇒ String?

Returns The type of encryption.

Returns:

  • (String, nil) —

    The type of encryption.



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

attribute :encryption_type

#key_id ⇒ String?

Returns The GUID or alias for the KMS key.

Returns:

  • (String, nil) —

    The GUID or alias for the KMS key.



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

attribute :key_id

#name ⇒ String

Returns The name of the Kinesis Stream you are managing.

Returns:

  • (String) —

    The name of the Kinesis Stream you are managing.



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

attribute :name

#retention_period ⇒ Integer?

Returns 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.

Returns:

  • (Integer, nil) —

    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.



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

attribute :retention_period

#shards ⇒ Integer?

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

Returns:

  • (Integer, nil) —

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



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

attribute :shards

#state ⇒ :present, ...

Returns Create or Delete the Kinesis Stream.

Returns:

  • (:present, :absent, nil) —

    Create or Delete the Kinesis Stream.



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

attribute :state

#tags ⇒ Hash?

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

Returns:

  • (Hash, nil) —

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



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

attribute :tags

#wait ⇒ Boolean?

Returns Wait for operation to complete before returning.

Returns:

  • (Boolean, nil) —

    Wait for operation to complete before returning.



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

attribute :wait

#wait_timeout ⇒ Integer?

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

Returns:

  • (Integer, nil) —

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



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

attribute :wait_timeout