Try Spottermanage RDS parameter groups
| "added in version" 1.5 of ansible.builtin"
Authors: Scott Anderson (@tastychutney), Will Thames (@willthames)
stableinterface | supported by community
pipInstall with pip install ansible==2.5.12
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.
- 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.
- 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.
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.
- 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
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
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.
- 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
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 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.
- 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
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
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