amazon.cloud.dynamodb_global_table (0.4.0) — module

Creates and manages a Version 2019.11.21 global table

| "added in version" 0.2.0 of amazon.cloud"

Authors: Ansible Cloud Team (@ansible-collections)

Install collection

Install with ansible-galaxy collection install amazon.cloud:==0.4.0


Add to requirements.yml

  collections:
    - name: amazon.cloud
      version: 0.4.0

Description

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

Inputs

    
wait:
    default: false
    description:
    - Wait for operation to complete before returning.
    type: bool

force:
    default: false
    description:
    - 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.
    type: bool

state:
    choices:
    - present
    - absent
    - list
    - describe
    - get
    default: present
    description:
    - Goal state for resource.
    - I(state=present) creates the resource if it doesn't exist, or updates to the provided
      state if the resource already exists.
    - I(state=absent) ensures an existing instance is deleted.
    - I(state=list) get all the existing resources.
    - I(state=describe) or I(state=get) retrieves information on an existing resource.
    type: str

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

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.
    - The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
      and I(security_token) options.
    type: str

replicas:
    description:
    - Not Provived.
    elements: dict
    suboptions:
      contributor_insights_specification:
        description:
        - Not Provived.
        suboptions:
          enabled:
            description:
            - Not Provived.
            type: bool
        type: dict
      global_secondary_indexes:
        description:
        - Not Provived.
        elements: dict
        suboptions:
          contributor_insights_specification:
            description:
            - Not Provived.
            suboptions:
              enabled:
                description:
                - Not Provived.
                type: bool
            type: dict
          index_name:
            description:
            - Not Provived.
            type: str
          read_provisioned_throughput_settings:
            description:
            - Not Provived.
            suboptions:
              read_capacity_auto_scaling_settings:
                description:
                - Not Provived.
                suboptions:
                  max_capacity:
                    description:
                    - Not Provived.
                    type: int
                  min_capacity:
                    description:
                    - Not Provived.
                    type: int
                  seed_capacity:
                    description:
                    - Not Provived.
                    type: int
                  target_tracking_scaling_policy_configuration:
                    description:
                    - Not Provived.
                    suboptions:
                      disable_scale_in:
                        description:
                        - Not Provived.
                        type: bool
                      scale_in_cooldown:
                        description:
                        - Not Provived.
                        type: int
                      scale_out_cooldown:
                        description:
                        - Not Provived.
                        type: int
                      target_value:
                        description:
                        - Not Provived.
                        type: int
                    type: dict
                type: dict
              read_capacity_units:
                description:
                - Not Provived.
                type: int
            type: dict
        type: list
      point_in_time_recovery_specification:
        description:
        - Not Provived.
        suboptions:
          point_in_time_recovery_enabled:
            description:
            - Not Provived.
            type: bool
        type: dict
      read_provisioned_throughput_settings:
        description:
        - Not Provived.
        suboptions:
          read_capacity_auto_scaling_settings:
            description:
            - Not Provived.
            suboptions:
              max_capacity:
                description:
                - Not Provived.
                type: int
              min_capacity:
                description:
                - Not Provived.
                type: int
              seed_capacity:
                description:
                - Not Provived.
                type: int
              target_tracking_scaling_policy_configuration:
                description:
                - Not Provived.
                suboptions:
                  disable_scale_in:
                    description:
                    - Not Provived.
                    type: bool
                  scale_in_cooldown:
                    description:
                    - Not Provived.
                    type: int
                  scale_out_cooldown:
                    description:
                    - Not Provived.
                    type: int
                  target_value:
                    description:
                    - Not Provived.
                    type: int
                type: dict
            type: dict
          read_capacity_units:
            description:
            - Not Provived.
            type: int
        type: dict
      region:
        description:
        - Not Provived.
        type: str
      sse_specification:
        description:
        - Not Provived.
        suboptions:
          kms_master_key_id:
            description:
            - Not Provived.
            type: str
        type: dict
      table_class:
        description:
        - Not Provived.
        type: str
      tags:
        description:
        - Not Provived.
        elements: dict
        suboptions:
          key:
            description:
            - Not Provived.
            type: str
          value:
            description:
            - Not Provived.
            type: str
        type: list
    type: list

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.
    - 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

key_schema:
    description:
    - Not Provived.
    elements: dict
    suboptions:
      attribute_name:
        description:
        - Not Provived.
        type: str
      key_type:
        description:
        - Not Provived.
        type: str
    type: list

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.
    - 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

table_name:
    description:
    - Not Provived.
    type: str

billing_mode:
    description:
    - Not Provived.
    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

wait_timeout:
    default: 320
    description:
    - How many seconds to wait for an operation to complete before timing out.
    type: int

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

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.
    - 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

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

sse_specification:
    description:
    - Not Provived.
    suboptions:
      sse_enabled:
        description:
        - Not Provived.
        type: bool
      sse_type:
        description:
        - Not Provived.
        type: str
    type: dict

stream_specification:
    description:
    - Not Provived.
    suboptions:
      stream_view_type:
        description:
        - Not Provived.
        type: str
    type: dict

attribute_definitions:
    description:
    - Not Provived.
    elements: dict
    suboptions:
      attribute_name:
        description:
        - Not Provived.
        type: str
      attribute_type:
        description:
        - Not Provived.
        type: str
    type: list

local_secondary_indexes:
    description:
    - Not Provived.
    elements: dict
    suboptions:
      index_name:
        description:
        - Not Provived.
        type: str
      key_schema:
        description:
        - Not Provived.
        elements: dict
        suboptions:
          attribute_name:
            description:
            - Not Provived.
            type: str
          key_type:
            description:
            - Not Provived.
            type: str
        type: list
      projection:
        description:
        - Not Provived.
        suboptions:
          non_key_attributes:
            description:
            - Not Provived.
            elements: str
            type: list
          projection_type:
            description:
            - Not Provived.
            type: str
        type: dict
    type: list

global_secondary_indexes:
    description:
    - Not Provived.
    elements: dict
    suboptions:
      index_name:
        description:
        - Not Provived.
        type: str
      key_schema:
        description:
        - Not Provived.
        elements: dict
        suboptions:
          attribute_name:
            description:
            - Not Provived.
            type: str
          key_type:
            description:
            - Not Provived.
            type: str
        type: list
      projection:
        description:
        - Not Provived.
        suboptions:
          non_key_attributes:
            description:
            - Not Provived.
            elements: str
            type: list
          projection_type:
            description:
            - Not Provived.
            type: str
        type: dict
      write_provisioned_throughput_settings:
        description:
        - Not Provived.
        suboptions:
          write_capacity_auto_scaling_settings:
            description:
            - Not Provived.
            suboptions:
              max_capacity:
                description:
                - Not Provived.
                type: int
              min_capacity:
                description:
                - Not Provived.
                type: int
              seed_capacity:
                description:
                - Not Provived.
                type: int
              target_tracking_scaling_policy_configuration:
                description:
                - Not Provived.
                suboptions:
                  disable_scale_in:
                    description:
                    - Not Provived.
                    type: bool
                  scale_in_cooldown:
                    description:
                    - Not Provived.
                    type: int
                  scale_out_cooldown:
                    description:
                    - Not Provived.
                    type: int
                  target_value:
                    description:
                    - Not Provived.
                    type: int
                type: dict
            type: dict
        type: dict
    type: list

time_to_live_specification:
    description:
    - Not Provived.
    suboptions:
      attribute_name:
        description:
        - Not Provived.
        type: str
      enabled:
        description:
        - Not Provived.
        type: bool
    type: dict

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

write_provisioned_throughput_settings:
    description:
    - Not Provived.
    suboptions:
      write_capacity_auto_scaling_settings:
        description:
        - Not Provived.
        suboptions:
          max_capacity:
            description:
            - Not Provived.
            type: int
          min_capacity:
            description:
            - Not Provived.
            type: int
          seed_capacity:
            description:
            - Not Provived.
            type: int
          target_tracking_scaling_policy_configuration:
            description:
            - Not Provived.
            suboptions:
              disable_scale_in:
                description:
                - Not Provived.
                type: bool
              scale_in_cooldown:
                description:
                - Not Provived.
                type: int
              scale_out_cooldown:
                description:
                - Not Provived.
                type: int
              target_value:
                description:
                - Not Provived.
                type: int
            type: dict
        type: dict
    type: dict

Outputs

result:
  contains:
    identifier:
      description: The unique identifier of the resource.
      type: str
    properties:
      description: The resource properties.
      type: dict
  description:
  - When I(state=list), it is a list containing dictionaries of resource information.
  - Otherwise, it is a dictionary of resource information.
  - When I(state=absent), it is an empty dictionary.
  returned: always
  type: complex