Class: Ansible::Ruby::Modules::Dynamodb_table

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/amazon/dynamodb_table.rb

Overview

Create or delete AWS Dynamo DB tables. Can update the provisioned throughput on existing tables. Returns the status of the specified table.

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

#hash_key_name ⇒ String?

Returns Name of the hash key.,Required when C(state=present).

Returns:

  • (String, nil) —

    Name of the hash key.,Required when C(state=present).



22
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/dynamodb_table.rb', line 22

attribute :hash_key_name

#hash_key_type ⇒ :STRING, ...

Returns Type of the hash key.

Returns:

  • (:STRING, :NUMBER, :BINARY, nil) —

    Type of the hash key.



26
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/dynamodb_table.rb', line 26

attribute :hash_key_type

#indexes ⇒ Object?

Returns list of dictionaries describing indexes to add to the table. global indexes can be updated. local indexes don’t support updates or have throughput.,required options: [‘name’, ‘type’, ‘hash_key_name’],valid types: [‘all’, ‘global_all’, ‘global_include’, ‘global_keys_only’, ‘include’, ‘keys_only’],other options: [‘hash_key_type’, ‘range_key_name’, ‘range_key_type’, ‘includes’, ‘read_capacity’, ‘write_capacity’].

Returns:

  • (Object, nil) —

    list of dictionaries describing indexes to add to the table. global indexes can be updated. local indexes don’t support updates or have throughput.,required options: [‘name’, ‘type’, ‘hash_key_name’],valid types: [‘all’, ‘global_all’, ‘global_include’, ‘global_keys_only’, ‘include’, ‘keys_only’],other options: [‘hash_key_type’, ‘range_key_name’, ‘range_key_type’, ‘includes’, ‘read_capacity’, ‘write_capacity’]



46
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/dynamodb_table.rb', line 46

attribute :indexes

#name ⇒ String

Returns Name of the table.

Returns:

  • (String) —

    Name of the table.



18
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/dynamodb_table.rb', line 18

attribute :name

#range_key_name ⇒ String?

Returns Name of the range key.

Returns:

  • (String, nil) —

    Name of the range key.



30
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/dynamodb_table.rb', line 30

attribute :range_key_name

#range_key_type ⇒ :STRING, ...

Returns Type of the range key.

Returns:

  • (:STRING, :NUMBER, :BINARY, nil) —

    Type of the range key.



34
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/dynamodb_table.rb', line 34

attribute :range_key_type

#read_capacity ⇒ Integer?

Returns Read throughput capacity (units) to provision.

Returns:

  • (Integer, nil) —

    Read throughput capacity (units) to provision.



38
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/dynamodb_table.rb', line 38

attribute :read_capacity

#state ⇒ :present, ...

Returns Create or delete the table.

Returns:

  • (:present, :absent, nil) —

    Create or delete the table



14
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/dynamodb_table.rb', line 14

attribute :state

#tags ⇒ Hash?

Returns a hash/dictionary of tags to add to the new instance or for starting/stopping instance by tag; ‘“key”:“value”’ and ‘“key”:“value”,“key”:“value”’.

Returns:

  • (Hash, nil) —

    a hash/dictionary of tags to add to the new instance or for starting/stopping instance by tag; ‘“key”:“value”’ and ‘“key”:“value”,“key”:“value”’



49
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/dynamodb_table.rb', line 49

attribute :tags

#wait_for_active_timeout ⇒ Integer?

Returns how long before wait gives up, in seconds. only used when tags is set.

Returns:

  • (Integer, nil) —

    how long before wait gives up, in seconds. only used when tags is set



53
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/dynamodb_table.rb', line 53

attribute :wait_for_active_timeout

#write_capacity ⇒ Integer?

Returns Write throughput capacity (units) to provision.

Returns:

  • (Integer, nil) —

    Write throughput capacity (units) to provision.



42
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/dynamodb_table.rb', line 42

attribute :write_capacity