ansible / ansible.builtin / v2.6.20 / module / rds_param_group manage RDS parameter groups | "added in version" 1.5 of ansible.builtin" Authors: Scott Anderson (@tastychutney), Will Thames (@willthames) stableinterface | supported by communityansible.builtin.rds_param_group (v2.6.20) — module
pip
Install with pip install ansible==2.6.20
Creates, modifies, and deletes RDS parameter groups. This module has a dependency on python-boto >= 2.5.
# Add or change a parameter group, in this case setting auto_increment_increment to 42 * 1024 - rds_param_group: state: present name: norwegian_blue description: 'My Fancy Ex Parrot Group' engine: 'mysql5.6' params: auto_increment_increment: "42K" tags: Environment: production Application: parrot
# Remove a parameter group - rds_param_group: state: absent name: norwegian_blue
name: description: - Database parameter group identifier. required: true tags: description: - Dictionary of tags to attach to the parameter group version_added: '2.4' version_added_collection: ansible.builtin state: choices: - present - absent default: present description: - Specifies whether the group should be present or absent. required: true engine: choices: - aurora5.6 - mariadb10.0 - mariadb10.1 - mysql5.1 - mysql5.5 - mysql5.6 - mysql5.7 - oracle-ee-11.2 - oracle-ee-12.1 - oracle-se-11.2 - oracle-se-12.1 - oracle-se1-11.2 - oracle-se1-12.1 - postgres9.3 - postgres9.4 - postgres9.5 - postgres9.6 - sqlserver-ee-10.5 - sqlserver-ee-11.0 - sqlserver-ex-10.5 - sqlserver-ex-11.0 - sqlserver-ex-12.0 - sqlserver-se-10.5 - sqlserver-se-11.0 - sqlserver-se-12.0 - sqlserver-web-10.5 - sqlserver-web-11.0 - sqlserver-web-12.0 description: - The type of database for this group. Required for state=present. params: aliases: - parameters description: - Map of parameter names and values. Numeric values may be represented as K for kilo (1024), M for mega (1024^2), G for giga (1024^3), or T for tera (1024^4), and these values will be expanded into the appropriate number before being set in the parameter group. 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 immediate: aliases: - apply_immediately description: - Whether to apply the changes immediately, or after the next reboot of any associated instances. 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: description: - Whether or not to remove tags that do not appear in the I(tags) list. Defaults to false. version_added: '2.4' version_added_collection: ansible.builtin description: description: - Database parameter group description. Only set when a new group is added. 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
db_parameter_group_arn: description: ARN of the DB parameter group returned: when state is present type: string db_parameter_group_family: description: DB parameter group family that this DB parameter group is compatible with. returned: when state is present type: string db_parameter_group_name: description: Name of DB parameter group returned: when state is present type: string description: description: description of the DB parameter group returned: when state is present type: string errors: description: list of errors from attempting to modify parameters that are not modifiable returned: when state is present type: list tags: description: dictionary of tags returned: when state is present type: dict