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.4.4.0.post1
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:
default: null
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"}'
required: false
version_added: '2.4'
version_added_collection: ansible.builtin
state:
choices:
- present
- absent
default: present
description:
- Create or delete the table
required: false
region:
aliases:
- aws_region
- ec2_region
description:
- The AWS region to use.
- For global services such as IAM, Route53 and CloudFront, I(region) is ignored.
- The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used.
- See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region).
- The C(ec2_region) alias has been deprecated and will be removed in a release after
2024-12-01
- Support for the C(EC2_REGION) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
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'']'
required: false
version_added: '2.1'
version_added_collection: ansible.builtin
profile:
aliases:
- aws_profile
description:
- A named AWS profile to use for authentication.
- See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
- The C(AWS_PROFILE) environment variable may also be used. Prior to release 6.0.0
the C(AWS_PROFILE) environment variable will be ignored if any of I(access_key),
I(secret_key), or I(session_token) are passed. After release 6.0.0 I(profile) will
always fall back to the C(AWS_PROFILE) environment variable if set.
- The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
and I(security_token) options.
type: str
access_key:
aliases:
- aws_access_key_id
- aws_access_key
- ec2_access_key
description:
- AWS access key ID.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables
may also be used in decreasing order of preference. Prior to release 6.0.0 these
environment variables will be ignored if the I(profile) parameter is passed. After
release 6.0.0 I(access_key) will always fall back to the environment variables if
set.
- The I(aws_access_key) and I(profile) options are mutually exclusive.
- The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the
AWS botocore SDK.
- The I(ec2_access_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
type: dict
secret_key:
aliases:
- aws_secret_access_key
- aws_secret_key
- ec2_secret_key
description:
- AWS secret access key.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment
variables may also be used in decreasing order of preference. Prior to release
6.0.0 these environment variables will be ignored if the I(profile) parameter is
passed. After release 6.0.0 I(secret_key) will always fall back to the environment
variables if set.
- The I(secret_key) and I(profile) options are mutually exclusive.
- The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with
the AWS botocore SDK.
- The I(ec2_secret_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
endpoint_url:
aliases:
- ec2_url
- aws_endpoint_url
- s3_url
description:
- 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 C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing
order of preference.
- The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in
a release after 2024-12-01.
- Support for the C(EC2_URL) environment variable has been deprecated and will be
removed in a release after 2024-12-01.
type: str
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- The C(AWS_CA_BUNDLE) environment variable may also be used.
type: path
hash_key_name:
default: null
description:
- Name of the hash key.
- Required when C(state=present).
required: false
hash_key_type:
choices:
- STRING
- NUMBER
- BINARY
default: STRING
description:
- Type of the hash key.
required: false
read_capacity:
default: 1
description:
- Read throughput capacity (units) to provision.
required: false
session_token:
aliases:
- aws_session_token
- security_token
- aws_security_token
- access_token
description:
- AWS STS session token for use with temporary credentials.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment
variables may also be used in decreasing order of preference. Prior to release 6.0.0
these environment variables will be ignored if the I(profile) parameter is passed. After
release 6.0.0 I(session_token) will always fall back to the environment variables
if set.
- The I(security_token) and I(profile) options are mutually exclusive.
- Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with
the parameter being renamed from I(security_token) to I(session_token) in release
6.0.0.
- The I(security_token), I(aws_security_token), and I(access_token) aliases have been
deprecated and will be removed in a release after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables
has been deprecated and will be removed in a release after 2024-12-01.
type: str
range_key_name:
default: null
description:
- Name of the range key.
required: false
range_key_type:
choices:
- STRING
- NUMBER
- BINARY
default: STRING
description:
- Type of the range key.
required: false
validate_certs:
default: true
description:
- When set to C(false), SSL certificates will not be validated for communication with
the AWS APIs.
- Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider
setting I(aws_ca_bundle) instead.
type: bool
write_capacity:
default: 1
description:
- Write throughput capacity (units) to provision.
required: false
wait_for_active_timeout:
default: 60
description:
- how long before wait gives up, in seconds. only used when tags is set
required: false
version_added: '2.4'
version_added_collection: ansible.builtin
debug_botocore_endpoint_logs:
default: false
description:
- Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action")
API calls made during a task, outputing the set to the resource_actions key in the
task results. Use the C(aws_resource_action) callback to output to total list made
during a playbook.
- The C(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: string