You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.aws.dynamodb_table module – Create, update or delete AWS Dynamo DB tables

Note

This module is part of the community.aws collection (version 2.6.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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
Requirements
Parameters
Notes
Examples
Return Values

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.

python >= 3.6
boto3 >= 1.15.0
botocore >= 1.18.0

Parameters 

Parameter	Comments
aws_access_key aliases: ec2_access_key, 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.
aws_ca_bundle path	The location of a CA Bundle to use when validating SSL certificates. Not used by boto 2 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 aliases: ec2_secret_key, 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.
billing_mode string	Controls whether provisoned pr on-demand tables are created. Choices: PROVISIONED PAY_PER_REQUEST
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. Choices: no ← (default) yes
ec2_url aliases: aws_endpoint_url, endpoint_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.
hash_key_name string	Name of the hash key. Required when state=present and table doesn’t exist.
hash_key_type string	Type of the hash key. Defaults to `'STRING'` when creating a new table. Choices: STRING NUMBER BINARY
indexes list / elements=dictionary	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’] Default: []
hash_key_name string	The name of the hash-based key. Required if index doesn’t already exist. Can not be modified once the index has been created.
hash_key_type string	The type of the hash-based key. Defaults to `'STRING'` when creating a new index. Can not be modified once the index has been created. Choices: STRING NUMBER BINARY
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. Can not be modified once the index has been created.
range_key_type string	The type of the range-based key. Defaults to `'STRING'` when creating a new index. Can not be modified once the index has been created. Choices: STRING NUMBER BINARY
read_capacity integer	Read throughput capacity (units) to provision for the index.
type string / required	The type of index. Choices: 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 aliases: aws_profile string	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.
purge_tags boolean	Remove tags not listed in tags. Choices: no yes ← (default)
range_key_name string	Name of the range key.
range_key_type string	Type of the range key. Defaults to `'STRING'` when creating a new range key. Choices: STRING NUMBER BINARY
read_capacity integer	Read throughput capacity (units) to provision. Defaults to `1` when creating a new table.
region aliases: aws_region, ec2_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
security_token aliases: aws_security_token, access_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.
state string	Create or delete the table. Choices: present ← (default) absent
tags dictionary	A hash/dictionary of tags to add to the new instance or for starting/stopping instance by tag. For example: `{"key":"value"}` or `{"key":"value","key2":"value2"}`
validate_certs boolean	When set to “no”, SSL certificates will not be validated for communication with the AWS APIs. Choices: no yes ← (default)
wait boolean	When wait=True the module will wait for up to wait_timeout seconds for table creation or deletion to complete before returning. Choices: no yes ← (default)
wait_timeout aliases: wait_for_active_timeout integer	How long (in seconds) to wait for creation / update / deletion to complete. Default: 300
write_capacity integer	Write throughput capacity (units) to provision. Defaults to `1` when creating a new table.

Notes 

Note

If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION, AWS_CA_BUNDLE
When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.

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: Create pay-per-request table
  community.aws.dynamodb_table:
    name: my-table
    region: us-east-1
    hash_key_name: id
    hash_key_type: STRING
    billing_mode: PAY_PER_REQUEST

- 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	Description
table_status string	The current status of the table. Returned: success Sample: “ACTIVE”

Authors

Alan Loi (@loia)

Collection links

Issue Tracker Repository (Sources)

community.aws.dynamodb_table module – Create, update or delete AWS Dynamo DB tables

Synopsis

Requirements

Parameters

Notes

Examples

Return Values