community.aws.dynamodb_table – Create, update or delete AWS Dynamo DB tables
Note
This plugin is part of the community.aws collection (version 1.3.0).
To install it use: ansible-galaxy collection install community.aws.
To use it in a playbook, specify: community.aws.dynamodb_table.
New in version 1.0.0: of community.aws
Synopsis
- Create or delete AWS Dynamo DB tables.
 - Can update the provisioned throughput on existing tables.
 - Returns the status of the specified table.
 
Requirements
The below requirements are needed on the host that executes this module.
- boto
 - boto >= 2.37.0
 - boto3 >= 1.4.4 (for tagging)
 - python >= 2.6
 
Parameters
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
|   aws_access_key    string    |    AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.  If profile is set this parameter is ignored.  Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.  aliases: ec2_access_key, access_key  |  ||
|   aws_ca_bundle    path    |    The location of a CA Bundle to use when validating SSL certificates.  Only used for boto3 based modules.  Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.   |  ||
|   aws_config    dictionary    |    A dictionary to modify the botocore configuration.  Parameters can be found at https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.  Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.   |  ||
|   aws_secret_key    string    |    AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.  If profile is set this parameter is ignored.  Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.  aliases: ec2_secret_key, secret_key  |  ||
|   debug_botocore_endpoint_logs    boolean    |   
  |    Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.   |  |
|   ec2_url    string    |    Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.  aliases: aws_endpoint_url, endpoint_url  |  ||
|   hash_key_name    string    |    Name of the hash key.  Required when   state=present. |  ||
|   hash_key_type    string    |   
  |    Type of the hash key.   |  |
|   indexes    list / elements=dictionary    |   Default: []   |    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']  other options: ['hash_key_type', 'range_key_name', 'range_key_type', 'includes', 'read_capacity', 'write_capacity']   |  |
|   hash_key_name    string / required    |    The name of the hash-based key.   |  ||
|   hash_key_type    string    |    The type of the hash-based key.   |  ||
|   includes    list / elements=string    |    A list of fields to include when using   global_include or include indexes. |  ||
|   name    string / required    |    The name of the index.   |  ||
|   range_key_name    string    |    The name of the range-based key.   |  ||
|   range_key_type    string    |    The type of the range-based key.   |  ||
|   read_capacity    integer    |    Read throughput capacity (units) to provision for the index.   |  ||
|   type    string / required    |    The type of index.  Valid types:   all, global_all, global_include, global_keys_only, include, keys_only
 |  ||
|   write_capacity    integer    |    Write throughput capacity (units) to provision for the index.   |  ||
|   name    string / required    |    Name of the table.   |  ||
|   profile    string    |    Uses a boto profile. Only works with boto >= 2.24.0.  Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.  
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.  aliases: aws_profile  |  ||
|   range_key_name    string    |    Name of the range key.   |  ||
|   range_key_type    string    |   
  |    Type of the range key.   |  |
|   read_capacity    integer    |   Default: 1   |    Read throughput capacity (units) to provision.   |  |
|   region    string    |    The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
  aliases: aws_region, ec2_region  |  ||
|   security_token    string    |    AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.  If profile is set this parameter is ignored.  Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.  aliases: aws_security_token, access_token  |  ||
|   state    string    |   
  |    Create or delete the table.   |  |
|   tags    dictionary    |    A hash/dictionary of tags to add to the new instance or for starting/stopping instance by tag.  For example:   {"key":"value"} and {"key":"value","key2":"value2"}
 |  ||
|   validate_certs    boolean    |   
  |    When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.   |  |
|   wait_for_active_timeout    integer    |   Default: 60   |    how long before wait gives up, in seconds. only used when tags is set   |  |
|   write_capacity    integer    |   Default: 1   |    Write throughput capacity (units) to provision.   |  |
Notes
Note
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence 
AWS_URLorEC2_URL,AWS_PROFILEorAWS_DEFAULT_PROFILE,AWS_ACCESS_KEY_IDorAWS_ACCESS_KEYorEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYorAWS_SECRET_KEYorEC2_SECRET_KEY,AWS_SECURITY_TOKENorEC2_SECURITY_TOKEN,AWS_REGIONorEC2_REGION,AWS_CA_BUNDLE - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
 - 
AWS_REGIONorEC2_REGIONcan be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file 
Examples
- name: Create dynamo table with hash and range primary key
  community.aws.dynamodb_table:
    name: my-table
    region: us-east-1
    hash_key_name: id
    hash_key_type: STRING
    range_key_name: create_time
    range_key_type: NUMBER
    read_capacity: 2
    write_capacity: 2
    tags:
      tag_name: tag_value
- name: Update capacity on existing dynamo table
  community.aws.dynamodb_table:
    name: my-table
    region: us-east-1
    read_capacity: 10
    write_capacity: 10
- name: set index on existing dynamo table
  community.aws.dynamodb_table:
    name: my-table
    region: us-east-1
    indexes:
      - name: NamedIndex
        type: global_include
        hash_key_name: id
        range_key_name: create_time
        includes:
          - other_field
          - other_field2
        read_capacity: 10
        write_capacity: 10
- name: Delete dynamo table
  community.aws.dynamodb_table:
    name: my-table
    region: us-east-1
    state: absent
   Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | 
|---|---|---|
|   table_status    string    |  success |   The current status of the table.  Sample:  ACTIVE   |  
Authors
- Alan Loi (@loia)
 
    © 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
    https://docs.ansible.com/ansible/2.10/collections/community/aws/dynamodb_table_module.html