amazon.cloud.dynamodb_global_table module – Creates and manages a Version 2019.11.21 global table

Note

This module is part of the amazon.cloud collection (version 0.4.0).

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 amazon.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: amazon.cloud.dynamodb_global_table.

New in amazon.cloud 0.2.0

Synopsis

  • Creates and manages a Version 2019.11.21 global table.

  • This resource cannot be used to create or manage a Version 2017.11.29 global table.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.9

  • boto3 >= 1.25.0

  • botocore >= 1.28.0

  • jsonpatch

Parameters

Parameter

Comments

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

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 AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variables may also be used in decreasing order of preference.

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 EC2_ACCESS_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

attribute_definitions

list / elements=dictionary

Not Provived.

attribute_name

string

Not Provived.

attribute_type

string

Not Provived.

aws_ca_bundle

path

The location of a CA Bundle to use when validating SSL certificates.

The AWS_CA_BUNDLE environment variable may also be used.

aws_config

dictionary

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.

billing_mode

string

Not Provived.

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:

  • false ← (default)

  • true

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

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 AWS_URL or EC2_URL environment variables may also be used, in decreasing order of preference.

The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_URL environment variable has been deprecated and will be removed in a release after 2024-12-01.

force

boolean

Cancel IN_PROGRESS and PENDING resource requestes.

Because you can only perform a single operation on a given resource at a time, there might be cases where you need to cancel the current resource operation to make the resource available so that another operation may be performed on it.

Choices:

  • false ← (default)

  • true

global_secondary_indexes

list / elements=dictionary

Not Provived.

index_name

string

Not Provived.

key_schema

list / elements=dictionary

Not Provived.

attribute_name

string

Not Provived.

key_type

string

Not Provived.

projection

dictionary

Not Provived.

non_key_attributes

list / elements=string

Not Provived.

projection_type

string

Not Provived.

write_provisioned_throughput_settings

dictionary

Not Provived.

write_capacity_auto_scaling_settings

dictionary

Not Provived.

max_capacity

integer

Not Provived.

min_capacity

integer

Not Provived.

seed_capacity

integer

Not Provived.

target_tracking_scaling_policy_configuration

dictionary

Not Provived.

disable_scale_in

boolean

Not Provived.

Choices:

  • false

  • true

scale_in_cooldown

integer

Not Provived.

scale_out_cooldown

integer

Not Provived.

target_value

integer

Not Provived.

key_schema

list / elements=dictionary

Not Provived.

attribute_name

string

Not Provived.

key_type

string

Not Provived.

local_secondary_indexes

list / elements=dictionary

Not Provived.

index_name

string

Not Provived.

key_schema

list / elements=dictionary

Not Provived.

attribute_name

string

Not Provived.

key_type

string

Not Provived.

projection

dictionary

Not Provived.

non_key_attributes

list / elements=string

Not Provived.

projection_type

string

Not Provived.

profile

aliases: aws_profile

string

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 AWS_PROFILE environment variable may also be used.

The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.

region

aliases: aws_region, ec2_region

string

The AWS region to use.

For global services such as IAM, Route53 and CloudFront, region is ignored.

The AWS_REGION or EC2_REGION environment variables may also be used.

See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

The ec2_region alias has been deprecated and will be removed in a release after 2024-12-01

Support for the EC2_REGION environment variable has been deprecated and will be removed in a release after 2024-12-01.

replicas

list / elements=dictionary

Not Provived.

contributor_insights_specification

dictionary

Not Provived.

enabled

boolean

Not Provived.

Choices:

  • false

  • true

global_secondary_indexes

list / elements=dictionary

Not Provived.

contributor_insights_specification

dictionary

Not Provived.

enabled

boolean

Not Provived.

Choices:

  • false

  • true

index_name

string

Not Provived.

read_provisioned_throughput_settings

dictionary

Not Provived.

read_capacity_auto_scaling_settings

dictionary

Not Provived.

max_capacity

integer

Not Provived.

min_capacity

integer

Not Provived.

seed_capacity

integer

Not Provived.

target_tracking_scaling_policy_configuration

dictionary

Not Provived.

disable_scale_in

boolean

Not Provived.

Choices:

  • false

  • true

scale_in_cooldown

integer

Not Provived.

scale_out_cooldown

integer

Not Provived.

target_value

integer

Not Provived.

read_capacity_units

integer

Not Provived.

point_in_time_recovery_specification

dictionary

Not Provived.

point_in_time_recovery_enabled

boolean

Not Provived.

Choices:

  • false

  • true

read_provisioned_throughput_settings

dictionary

Not Provived.

read_capacity_auto_scaling_settings

dictionary

Not Provived.

max_capacity

integer

Not Provived.

min_capacity

integer

Not Provived.

seed_capacity

integer

Not Provived.

target_tracking_scaling_policy_configuration

dictionary

Not Provived.

disable_scale_in

boolean

Not Provived.

Choices:

  • false

  • true

scale_in_cooldown

integer

Not Provived.

scale_out_cooldown

integer

Not Provived.

target_value

integer

Not Provived.

read_capacity_units

integer

Not Provived.

region

string

Not Provived.

sse_specification

dictionary

Not Provived.

kms_master_key_id

string

Not Provived.

table_class

string

Not Provived.

tags

list / elements=dictionary

Not Provived.

key

string

Not Provived.

value

string

Not Provived.

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

string

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 AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variables may also be used in decreasing order of preference.

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 EC2_SECRET_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

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 AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variables may also be used in decreasing order of preference.

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 EC2_SECRET_KEY and AWS_SECURITY_TOKEN environment variables has been deprecated and will be removed in a release after 2024-12-01.

sse_specification

dictionary

Not Provived.

sse_enabled

boolean

Not Provived.

Choices:

  • false

  • true

sse_type

string

Not Provived.

state

string

Goal state for resource.

state=present creates the resource if it doesn’t exist, or updates to the provided state if the resource already exists.

state=absent ensures an existing instance is deleted.

state=list get all the existing resources.

state=describe or state=get retrieves information on an existing resource.

Choices:

  • "present" ← (default)

  • "absent"

  • "list"

  • "describe"

  • "get"

stream_specification

dictionary

Not Provived.

stream_view_type

string

Not Provived.

table_name

string

Not Provived.

time_to_live_specification

dictionary

Not Provived.

attribute_name

string

Not Provived.

enabled

boolean

Not Provived.

Choices:

  • false

  • true

validate_certs

boolean

When set to false, SSL certificates will not be validated for communication with the AWS APIs.

Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead.

Choices:

  • false

  • true ← (default)

wait

boolean

Wait for operation to complete before returning.

Choices:

  • false ← (default)

  • true

wait_timeout

integer

How many seconds to wait for an operation to complete before timing out.

Default: 320

write_provisioned_throughput_settings

dictionary

Not Provived.

write_capacity_auto_scaling_settings

dictionary

Not Provived.

max_capacity

integer

Not Provived.

min_capacity

integer

Not Provived.

seed_capacity

integer

Not Provived.

target_tracking_scaling_policy_configuration

dictionary

Not Provived.

disable_scale_in

boolean

Not Provived.

Choices:

  • false

  • true

scale_in_cooldown

integer

Not Provived.

scale_out_cooldown

integer

Not Provived.

target_value

integer

Not Provived.

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

result

complex

When state=list, it is a list containing dictionaries of resource information.

Otherwise, it is a dictionary of resource information.

When state=absent, it is an empty dictionary.

Returned: always

identifier

string

The unique identifier of the resource.

Returned: success

properties

dictionary

The resource properties.

Returned: success

Authors

  • Ansible Cloud Team (@ansible-collections)