Try Spottermanage ElastiCache subnet groups
| "added in version" 1.0.0 of community.aws"
Authors: Tim Mahoney (@timmahoney)
Install with ansible-galaxy collection install community.aws:==3.4.0
collections:
- name: community.aws
version: 3.4.0Creates, modifies, and deletes ElastiCache subnet groups.
- name: Add or change a subnet group
community.aws.elasticache_subnet_group:
state: present
name: norwegian-blue
description: My Fancy Ex Parrot Subnet Group
subnets:
- subnet-aaaaaaaa
- subnet-bbbbbbbb
- name: Remove a subnet group
community.aws.elasticache_subnet_group:
state: absent
name: norwegian-blue
name:
description:
- Database subnet group identifier.
- This value is automatically converted to lowercase.
required: true
type: str
state:
choices:
- present
- absent
default: present
description:
- Specifies whether the subnet should be present or absent.
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:
- 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
subnets:
description:
- List of subnet IDs that make up the ElastiCache subnet group.
- At least one subnet must be provided when creating an ElastiCache subnet group.
elements: str
type: list
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
description:
description:
- ElastiCache subnet group description.
- When not provided defaults to I(name) on subnet group creation.
type: str
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- Not used by boto 2 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:
- C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY)
or C(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:
- C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY),
or C(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:
- C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN)
or C(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 communication with
the AWS APIs.
type: bool
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
cache_subnet_group:
contains:
arn:
description: The Amazon Resource Name (ARN) of the cache subnet group.
returned: when the subnet group exists
sample: arn:aws:elasticache:us-east-1:012345678901:subnetgroup:norwegian-blue
type: str
description:
description: The description of the cache subnet group.
returned: when the cache subnet group exists
sample: My Fancy Ex Parrot Subnet Group
type: str
name:
description: The name of the cache subnet group.
returned: when the cache subnet group exists
sample: norwegian-blue
type: str
subnet_ids:
description: The IDs of the subnets beloging to the cache subnet group.
elements: str
returned: when the cache subnet group exists
sample:
- subnet-aaaaaaaa
- subnet-bbbbbbbb
type: list
vpc_id:
description: The VPC ID of the cache subnet group.
returned: when the cache subnet group exists
sample: norwegian-blue
type: str
description: Description of the Elasticache Subnet Group.
returned: always
type: dict