community.aws.dynamodb_table module – Create, update or delete AWS Dynamo DB tables
Note
This module is part of the community.aws collection (version 9.0.0).
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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.aws.dynamodb_table.
New in community.aws 1.0.0
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.28.0
botocore >= 1.31.0
Parameters
Parameter |
Comments |
|---|---|
AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
|
Controls whether provisoned pr on-demand tables are created. Choices:
|
|
Use a The Choices:
|
|
URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. The The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Name of the hash key. Required when state=present and table doesn’t exist. |
|
Type of the hash key. Defaults to Choices:
|
|
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: |
|
The name of the hash-based key. Required if index doesn’t already exist. Can not be modified once the index has been created. |
|
The type of the hash-based key. Defaults to Can not be modified once the index has been created. Choices:
|
|
A list of fields to include when using |
|
The name of the index. |
|
The name of the range-based key. Can not be modified once the index has been created. |
|
The type of the range-based key. Defaults to Can not be modified once the index has been created. Choices:
|
|
Read throughput capacity (units) to provision for the index. |
|
The type of index. Choices:
|
|
Write throughput capacity (units) to provision for the index. |
|
Name of the table. |
|
A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
If If the Tag keys beginning with Choices:
|
|
Name of the range key. |
|
Type of the range key. Defaults to Choices:
|
|
Read throughput capacity (units) to provision. Defaults to |
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Create or delete the table. Choices:
|
|
The class of the table. Choices:
|
|
A dictionary representing the tags to be applied to the resource. If the |
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
|
When wait=True the module will wait for up to wait_timeout seconds for index updates, table creation or deletion to complete before returning. Choices:
|
|
How long (in seconds) to wait for creation / update / deletion to complete. AWS only allows secondary indexies to be updated one at a time, this module will automatically update them in serial, and the timeout will be separately applied for each index. Default: |
|
Write throughput capacity (units) to provision. Defaults to |
Notes
Note
Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically
~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
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 |
|---|---|
The returned table params from the describe API call. Returned: success Sample: |
|
The current status of the table. Returned: success Sample: |