community / community.aws / 4.3.0 / module / elasticache Manage cache clusters in Amazon ElastiCache | "added in version" 1.0.0 of community.aws" Authors: Jim Dalton (@jsdalton)community.aws.elasticache (4.3.0) — module
Install with ansible-galaxy collection install community.aws:==4.3.0
collections: - name: community.aws version: 4.3.0
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. - name: Basic example community.aws.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
- name: Ensure cache cluster is gone community.aws.elasticache: name: "test-please-delete" state: absent
- name: Reboot cache cluster community.aws.elasticache: name: "test-please-delete" state: rebooted
name: description: - The cache cluster identifier. required: true type: str wait: default: true description: - Wait for cache cluster result before returning. type: bool zone: description: - The EC2 Availability Zone in which the cache cluster will be created. type: str 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 type: str engine: default: memcached description: - Name of the cache engine to be used. - Supported values are C(redis) and C(memcached). type: str region: aliases: - aws_region - ec2_region description: - The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) type: str ec2_url: aliases: - aws_endpoint_url - endpoint_url description: - Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. type: str profile: aliases: - aws_profile description: - Uses a boto profile. Only works with boto >= 2.24.0. - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token) and support for passing them at the same time as I(profile) has been deprecated. - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually exclusive with I(profile) after 2022-06-01. type: str node_type: default: cache.t2.small description: - The compute and memory capacity of the nodes in the cache cluster. type: str num_nodes: default: 1 description: - The initial number of cache nodes that the cache cluster will have. - Required when I(state=present). type: int aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). - Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto) for more boto configuration. type: dict cache_port: description: - The port number on which each of the cache nodes will accept connections. type: int hard_modify: description: - Whether to destroy and recreate an existing cache cluster if necessary in order to modify its state. - Defaults to C(false). type: bool aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - Only used for boto3 based modules. - 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied from the controller if not run locally.' type: path aws_access_key: aliases: - ec2_access_key - access_key description: - AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str aws_secret_key: aliases: - ec2_secret_key - secret_key description: - AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str security_token: aliases: - aws_security_token - access_token description: - AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(security_token) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. type: bool cache_subnet_group: description: - The subnet group name to associate with. Only use if inside a VPC. - Required if inside a VPC. type: str security_group_ids: description: - A list of VPC security group IDs to associate with this cache cluster. Only use if inside a VPC. elements: str type: list cache_engine_version: description: - The version number of the cache engine. type: str 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. type: str cache_security_groups: description: - A list of cache security group names to associate with this cache cluster. - Don't use if your Cache is inside a VPC. In that case use I(security_group_ids) instead! elements: str type: list debug_botocore_endpoint_logs: default: 'no' description: - 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. type: bool