Try SpotterCreate, update or delete AWS Dynamo DB tables.
| "added in version" 2.0 of ansible.builtin"
Authors: Alan Loi (@loia)
preview | supported by community
pipInstall with pip install ansible==2.9.17
Create or delete AWS Dynamo DB tables.
Can update the provisioned throughput on existing tables.
Returns the status of the specified table.
# Create dynamo table with hash and range primary key
- 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
# Update capacity on existing dynamo table
- dynamodb_table:
name: my-table
region: us-east-1
read_capacity: 10
write_capacity: 10
# set index on existing dynamo table
- 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
# Delete dynamo table
- dynamodb_table:
name: my-table
region: us-east-1
state: absent
name:
description:
- Name of the table.
required: true
tags:
description:
- 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"}'
version_added: '2.4'
version_added_collection: ansible.builtin
state:
choices:
- present
- absent
default: present
description:
- Create or delete the table
region:
aliases:
- aws_region
- ec2_region
description:
- 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
type: str
ec2_url:
aliases:
- aws_endpoint_url
- endpoint_url
description:
- 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.
type: str
indexes:
default: []
description:
- 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'']'
version_added: '2.1'
version_added_collection: ansible.builtin
profile:
aliases:
- aws_profile
description:
- Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token)
and support for passing them at the same time as I(profile) has been deprecated.
- I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually
exclusive with I(profile) after 2022-06-01.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found at U(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 U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto)
for more boto configuration.
type: dict
aws_ca_bundle:
description:
- 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.'
type: path
hash_key_name:
description:
- Name of the hash key.
- Required when C(state=present).
hash_key_type:
choices:
- STRING
- NUMBER
- BINARY
default: STRING
description:
- Type of the hash key.
read_capacity:
default: 1
description:
- Read throughput capacity (units) to provision.
aws_access_key:
aliases:
- ec2_access_key
- access_key
description:
- C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY)
or C(EC2_ACCESS_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
aws_secret_key:
aliases:
- ec2_secret_key
- secret_key
description:
- C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY),
or C(EC2_SECRET_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
range_key_name:
description:
- Name of the range key.
range_key_type:
choices:
- STRING
- NUMBER
- BINARY
default: STRING
description:
- Type of the range key.
security_token:
aliases:
- aws_security_token
- access_token
description:
- C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN)
or C(EC2_SECURITY_TOKEN) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(security_token) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for communication with
the AWS APIs.
type: bool
write_capacity:
default: 1
description:
- Write throughput capacity (units) to provision.
wait_for_active_timeout:
default: 60
description:
- how long before wait gives up, in seconds. only used when tags is set
version_added: '2.4'
version_added_collection: ansible.builtin
debug_botocore_endpoint_logs:
default: 'no'
description:
- 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.
type: bool
table_status: description: The current status of the table. returned: success sample: ACTIVE type: str