ansible / ansible.builtin / v2.6.10 / module / elasticache Manage cache clusters in Amazon Elasticache. | "added in version" 1.4 of ansible.builtin" Authors: Jim Dalton (@jsdalton) preview | supported by communityansible.builtin.elasticache (v2.6.10) — module
pip
Install with pip install ansible==2.6.10
Manage cache clusters in Amazon Elasticache.
Returns information about the specified cache cluster.
# Note: None of these examples set aws_access_key, aws_secret_key, or region. # It is assumed that their matching environment variables are set. # Basic example - elasticache: name: "test-please-delete" state: present engine: memcached cache_engine_version: 1.4.14 node_type: cache.m1.small num_nodes: 1 cache_port: 11211 cache_security_groups: - default zone: us-east-1d
# Ensure cache cluster is gone - elasticache: name: "test-please-delete" state: absent
# Reboot cache cluster - elasticache: name: "test-please-delete" state: rebooted
name: description: - The cache cluster identifier required: true wait: default: 'yes' description: - Wait for cache cluster result before returning type: bool zone: description: - The EC2 Availability Zone in which the cache cluster will be created state: choices: - present - absent - rebooted description: - C(absent) or C(present) are idempotent actions that will create or destroy a cache cluster as needed. C(rebooted) will reboot the cluster, resulting in a momentary outage. required: true engine: choices: - redis - memcached default: memcached description: - Name of the cache engine to be used. 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. 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 node_type: default: cache.m1.small description: - The compute and memory capacity of the nodes in the cache cluster num_nodes: description: - The initial number of cache nodes that the cache cluster will have. Required when state=present. 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 cache_port: description: - The port number on which each of the cache nodes will accept connections 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 hard_modify: default: 'no' description: - Whether to destroy and recreate an existing cache cluster if necessary in order to modify its state type: bool 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 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 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 cache_subnet_group: description: - The subnet group name to associate with. Only use if inside a vpc. Required if inside a vpc version_added: '2.0' version_added_collection: ansible.builtin security_group_ids: description: - A list of vpc security group names to associate with this cache cluster. Only use if inside a vpc version_added: '1.6' version_added_collection: ansible.builtin cache_engine_version: description: - The version number of the cache engine cache_parameter_group: aliases: - parameter_group description: - The name of the cache parameter group to associate with this cache cluster. If this argument is omitted, the default cache parameter group for the specified engine will be used. version_added: '2.0' version_added_collection: ansible.builtin cache_security_groups: description: - A list of cache security group names to associate with this cache cluster. Must be an empty list if inside a vpc 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