Try SpotterCreates and manages a MemoryDB cluster
| "added in version" 0.4.0 of amazon.cloud"
Authors: Ansible Cloud Team (@ansible-collections)
Install with ansible-galaxy collection install amazon.cloud:==0.4.0
collections:
- name: amazon.cloud
version: 0.4.0Creates or manages a MemoryDB for Redis cluster. For more information, see U(https://docs.aws.amazon.com/cli/latest/reference/memorydb/create-cluster.html)
tags:
aliases:
- resource_tags
description:
- A dict of tags to apply to the resource.
- To remove all tags set I(tags={}) and I(purge_tags=true).
type: dict
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
acl_name:
description:
- The name of the Access Control List to associate with the cluster.
type: str
node_type:
description:
- The compute and memory capacity of the nodes in the cluster.
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.
- 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
kms_key_id:
description:
- The ID of the KMS key used to encrypt the cluster.
type: str
num_shards:
description:
- The number of shards the cluster will contain.
type: int
purge_tags:
default: true
description:
- Remove tags not listed in I(tags).
type: bool
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
description:
description:
- An optional description of the cluster.
type: str
tls_enabled:
description:
- A flag that enables in-transit encryption when set to true.
- You cannot modify the value of TransitEncryptionEnabled after the cluster is created.
- To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled
to true when you create a cluster.
type: bool
cluster_name:
description:
- The name of the cluster.
- This value must be unique as it also serves as the cluster identifier.
type: str
data_tiering:
choices:
- 'false'
- 'true'
description:
- Enables data tiering.
- Data tiering is only supported for clusters using the r6gd node type.
- This parameter must be set when using r6gd nodes.
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
snapshot_arns:
description:
- A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files
stored in Amazon S3. The snapshot files are used to populate the new cluster.
- The Amazon S3 object name in the ARN cannot contain any commas.
elements: str
type: list
snapshot_name:
description:
- The name of a snapshot from which to restore data into the new cluster.
- The snapshot status changes to restoring while the new cluster is being created.
type: str
sns_topic_arn:
description:
- The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic
to which notifications are sent.
type: str
engine_version:
description:
- The Redis engine version used by the cluster.
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
snapshot_window:
description:
- The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot
of your cluster.
type: str
cluster_endpoint:
description:
- The cluster endpoint.
suboptions: {}
type: dict
sns_topic_status:
description:
- The status of the Amazon SNS notification topic.
- Notifications are sent only if the status is enabled.
type: str
subnet_group_name:
description:
- The name of the subnet group to be used for the cluster.
type: str
maintenance_window:
description:
- Specifies the weekly time range during which maintenance on the cluster is performed.
- It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC).
The minimum maintenance window is a 60 minute period.
type: str
security_group_ids:
description:
- One or more Amazon VPC security groups associated with this cluster.
elements: str
type: list
final_snapshot_name:
description:
- The user-supplied name of a final cluster snapshot.
- This is the unique name that identifies the snapshot.
- MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.
type: str
parameter_group_name:
description:
- The name of the parameter group associated with the cluster.
type: str
num_replicas_per_shard:
description:
- The number of replicas to apply to each shard.
- The limit is 5.
type: int
snapshot_retention_limit:
description:
- The number of days for which MemoryDB retains automatic snapshots before deleting
them.
- For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today
is retained for 5 days before being deleted.
type: int
auto_minor_version_upgrade:
description:
- A flag that enables automatic minor version upgrade when set to true.
- You cannot modify the value of AutoMinorVersionUpgrade after the cluster is created.
- To enable AutoMinorVersionUpgrade on a cluster you must set AutoMinorVersionUpgrade
to true when you create a cluster.
type: bool
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
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