amazon.aws.rds_option_group module – Manages the creation, modification, deletion of RDS option groups
Note
This module is part of the amazon.aws collection (version 8.2.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install amazon.aws
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: amazon.aws.rds_option_group
.
New in amazon.aws 5.0.0
Synopsis
Manages the creation, modification, deletion of RDS option groups.
This module was originally added to
community.aws
in release 2.1.0.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0
Parameters
Parameter |
Comments |
---|---|
AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Indicates whether the changes should be applied immediately, or during the next maintenance window. Choices:
|
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
|
Use a The Choices:
|
|
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 The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Specifies the name of the engine that this option group should be associated with. |
|
Specifies the major version of the engine that this option group should be associated with. |
|
The description of the option group. |
|
Specifies the name of the option group to be created. |
|
Options in this list are added to the option group. If already present, the specified configuration is used to update the existing configuration. If none are supplied, any existing options are removed. |
|
A list of |
|
The configuration of options to include in a group. |
|
The option settings to include in an option group. |
|
The allowed values of the option setting. |
|
The DB engine specific parameter type. |
|
The data type of the option setting. |
|
The default value of the option setting. |
|
The description of the option setting. |
|
Indicates if the option setting is part of a collection. Choices:
|
|
A Boolean value that, when Choices:
|
|
The name of the option that has settings that you can set. |
|
The current value of the option setting. |
|
The version for the option. |
|
The optional port for the option. |
|
A list of |
|
A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
If purge_tags=true and tags is set, existing tags will be purged from the resource to match exactly what is defined by tags parameter. If the tags parameter is not set then tags will not be modified, even if purge_tags=True. Tag keys beginning with Choices:
|
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Specifies whether the option group should be Choices:
|
|
A dictionary representing the tags to be applied to the resource. If the tags parameter is not set then tags will not be modified. |
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
|
Whether to wait for the cluster to be available or deleted. Choices:
|
Notes
Note
Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically
~/.aws/credentials
). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
Examples
# Create an RDS Mysql Option group
- name: Create an RDS Mysql option group
amazon.aws.rds_option_group:
state: present
option_group_name: test-mysql-option-group
engine_name: mysql
major_engine_version: 5.6
option_group_description: test mysql option group
apply_immediately: true
options:
- option_name: MEMCACHED
port: 11211
vpc_security_group_memberships:
- "sg-d188c123"
option_settings:
- name: MAX_SIMULTANEOUS_CONNECTIONS
value: "20"
- name: CHUNK_SIZE_GROWTH_FACTOR
value: "1.25"
register: new_rds_mysql_option_group
# Remove currently configured options for an option group by removing options argument
- name: Create an RDS Mysql option group
amazon.aws.rds_option_group:
state: present
option_group_name: test-mysql-option-group
engine_name: mysql
major_engine_version: 5.6
option_group_description: test mysql option group
apply_immediately: true
register: rds_mysql_option_group
- name: Create an RDS Mysql option group using tags
amazon.aws.rds_option_group:
state: present
option_group_name: test-mysql-option-group
engine_name: mysql
major_engine_version: 5.6
option_group_description: test mysql option group
apply_immediately: true
tags:
Tag1: tag1
Tag2: tag2
register: rds_mysql_option_group
# Delete an RDS Mysql Option group
- name: Delete an RDS Mysql option group
amazon.aws.rds_option_group:
state: absent
option_group_name: test-mysql-option-group
register: deleted_rds_mysql_option_group
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Indicates whether this option group can be applied to both VPC and non-VPC instances. Returned: always Sample: |
|
If the Option Group has changed. Returned: always Sample: |
|
Indicates the name of the engine that this option group can be applied to. Returned: always Sample: |
|
Indicates the major engine version associated with this option group. Returned: always Sample: |
|
The Amazon Resource Name (ARN) for the option group. Returned: always Sample: |
|
Provides a description of the option group. Returned: always Sample: |
|
Specifies the name of the option group. Returned: always Sample: |
|
Indicates what options are available in the option group. Returned: always |
|
If the option requires access to a port, then this DB security group allows access to the port. Returned: always |
|
The name of the DB security group. Returned: always Sample: |
|
The status of the DB security group. Returned: always Sample: |
|
The description of the option. Returned: always Sample: |
|
The name of the option. Returned: always Sample: |
|
The name of the option. Returned: always |
|
The allowed values of the option setting. Returned: always Sample: |
|
The DB engine specific parameter type. Returned: always Sample: |
|
The data type of the option setting. Returned: always Sample: |
|
The default value of the option setting. Returned: always Sample: |
|
The description of the option setting. Returned: always Sample: |
|
Indicates if the option setting is part of a collection. Returned: always Sample: |
|
A Boolean value that, when true, indicates the option setting can be modified from the default. Returned: always Sample: |
|
The name of the option that has settings that you can set. Returned: always Sample: |
|
The current value of the option setting. Returned: always Sample: |
|
Indicate if this option is permanent. Returned: always Sample: |
|
Indicate if this option is persistent. Returned: always Sample: |
|
If required, the port configured for this option to use. Returned: always Sample: |
|
If the option requires access to a port, then this VPC security group allows access to the port. Returned: always |
|
The status of the VPC security group. Returned: always Sample: |
|
The name of the VPC security group. Returned: always Sample: |
|
The tags associated the RDS option group. Returned: always Sample: |
|
If present, this option group can only be applied to instances that are in the VPC indicated by this field. Returned: always Sample: |