community / community.aws / 2.6.0 / module / rds_subnet_group manage RDS database subnet groups | "added in version" 1.0.0 of community.aws" Authors: Scott Anderson (@tastychutney), Alina Buzachis (@alinabuzachis)community.aws.rds_subnet_group (2.6.0) — module
Install with ansible-galaxy collection install community.aws:==2.6.0
collections: - name: community.aws version: 2.6.0
Creates, modifies, and deletes RDS database subnet groups.
- name: Add or change a subnet group community.aws.rds_subnet_group: state: present name: norwegian-blue description: My Fancy Ex Parrot Subnet Group subnets: - subnet-aaaaaaaa - subnet-bbbbbbbb
- name: Add or change a subnet group and associate tags community.aws.rds_subnet_group: state: present name: norwegian-blue description: My Fancy Ex Parrot Subnet Group subnets: - subnet-aaaaaaaa - subnet-bbbbbbbb tags: tag1: Tag1 tag2: Tag2
- name: Remove a subnet group community.aws.rds_subnet_group: state: absent name: norwegian-blue
name: description: - Database subnet group identifier. required: true type: str tags: aliases: - resource_tags description: - A dictionary representing the tags to be applied to the resource. - If the I(tags) parameter is not set then tags will not be modified. required: false type: dict state: choices: - present - absent description: - Specifies whether the subnet should be present or absent. required: true 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 profile: aliases: - aws_profile description: - The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key) and I(security_token) options. type: str subnets: description: - List of subnet IDs that make up the database subnet group. - Required when I(state=present). 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). type: dict purge_tags: default: true description: - If I(purge_tags=true) and I(tags) is set, existing tags will be purged from the resource to match exactly what is defined by I(tags) parameter. - If the I(tags) parameter is not set then tags will not be modified, even if I(purge_tags=True). - Tag keys beginning with C(aws:) are reserved by Amazon and can not be modified. As such they will be ignored for the purposes of the I(purge_tags) parameter. See the Amazon documentation for more information U(https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions). required: false type: bool description: description: - Database subnet group description. - Required when I(state=present). type: str endpoint_url: aliases: - ec2_url - aws_endpoint_url - s3_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 aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - '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. - The I(aws_access_key) and I(profile) options are mutually exclusive. 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. - The I(aws_secret_key) and I(profile) options are mutually exclusive. type: str security_token: aliases: - aws_session_token - session_token - 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. - The I(security_token) and I(profile) options are mutually exclusive. - Aliases I(aws_session_token) and I(session_token) have been added in version 3.2.0. 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
changed: description: True if listing the RDS subnet group succeeds. returned: always sample: 'false' type: bool subnet_group: contains: db_subnet_group_arn: description: The ARN of the DB subnet group returned: I(state=present) sample: arn:aws:rds:eu-north-1:721066863947:subgrp:ansible-test-13950442 type: str db_subnet_group_description: description: The description of the DB subnet group returned: I(state=present) sample: Simple description. type: str db_subnet_group_name: description: The name of the DB subnet group returned: I(state=present) sample: ansible-test-mbp-13950442 type: str description: description: The description of the DB subnet group (maintained for backward compatibility) returned: I(state=present) sample: Simple description. type: str name: description: The name of the DB subnet group (maintained for backward compatibility) returned: I(state=present) sample: ansible-test-mbp-13950442 type: str status: description: The status of the DB subnet group (maintained for backward compatibility) returned: I(state=present) sample: Complete type: str subnet_group_status: description: The status of the DB subnet group returned: I(state=present) sample: Complete type: str subnet_ids: description: Contains a list of Subnet IDs returned: I(state=present) sample: subnet-08c94870f4480797e type: list subnets: contains: subnet_availability_zone: description: Contains Availability Zone information. returned: I(state=present) sample: name: eu-north-1b type: dict version_added: 3.2.0 version_added_collection: community.aws subnet_identifier: description: The identifier of the subnet. returned: I(state=present) sample: subnet-08c94870f4480797e type: str version_added: 3.2.0 version_added_collection: community.aws subnet_outpost: description: This value specifies the Outpost. returned: I(state=present) sample: {} type: dict version_added: 3.2.0 version_added_collection: community.aws subnet_status: description: The status of the subnet. returned: I(state=present) sample: Active type: str version_added: 3.2.0 version_added_collection: community.aws description: Contains a list of Subnet elements (@see https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/rds.html#RDS.Client.describe_db_subnet_groups) returned: I(state=present) type: list tags: description: The tags associated with the subnet group returned: I(state=present) sample: tag1: Tag1 tag2: Tag2 type: dict version_added: 3.2.0 version_added_collection: community.aws vpc_id: description: The VpcId of the DB subnet group returned: I(state=present) sample: vpc-0acb0ba033ff2119c type: str description: Dictionary of DB subnet group values returned: I(state=present) type: complex