community.aws.rds_option_group – rds_option_group module

Note

This plugin is part of the community.aws collection (version 2.1.0).

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 community.aws.

To use it in a playbook, specify: community.aws.rds_option_group.

New in version 2.1.0: of community.aws

Synopsis

  • Manages the creation, modification, deletion of RDS option groups.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.6

  • boto3 >= 1.15.0

  • botocore >= 1.18.0

Parameters

Parameter Choices/Defaults Comments
apply_immediately
boolean
    Choices:
  • no ←
  • yes
Indicates whether the changes should be applied immediately, or during the next maintenance window.
aws_access_key
string
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
If profile is set this parameter is ignored.
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_access_key, access_key
aws_ca_bundle
path
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.
aws_config
dictionary
A dictionary to modify the botocore configuration.
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
aws_secret_key
string
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
If profile is set this parameter is ignored.
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_secret_key, secret_key
debug_botocore_endpoint_logs
boolean
    Choices:
  • no ←
  • yes
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.
ec2_url
string
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.

aliases: aws_endpoint_url, endpoint_url
engine_name
string
Specifies the name of the engine that this option group should be associated with.
major_engine_version
string
Specifies the major version of the engine that this option group should be associated with.
option_group_description
string
The description of the option group.
option_group_name
string / required
Specifies the name of the option group to be created.
options
list / elements=dictionary
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.
db_security_group_memberships
list / elements=string
A list of DBSecurityGroupMembership name strings used for this option.
option_name
string
The configuration of options to include in a group.
option_settings
list / elements=string
The option settings to include in an option group.
allowed_values
string
The allowed values of the option setting.
apply_type
string
The DB engine specific parameter type.
data_type
string
The data type of the option setting.
default_value
string
The default value of the option setting.
description
string
The description of the option setting.
is_collection
boolean
    Choices:
  • no
  • yes
Indicates if the option setting is part of a collection.
is_modifiable
boolean
    Choices:
  • no
  • yes
A Boolean value that, when true, indicates the option setting can be modified from the default.
name
string
The name of the option that has settings that you can set.
value
string
The current value of the option setting.
option_version
string
The version for the option.
port
integer
The optional port for the option.
vpc_security_group_memberships
list / elements=string
A list of VpcSecurityGroupMembership name strings used for this option.
profile
string
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

aliases: aws_profile
purge_tags
boolean
    Choices:
  • no
  • yes ←
Remove tags not listed in tags.
region
string
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 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

aliases: aws_region, ec2_region
security_token
string
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
If profile is set this parameter is ignored.
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: aws_security_token, access_token
state
string / required
    Choices:
  • present
  • absent
Specifies whether the option group should be present or absent.
tags
dictionary
A dictionary of key value pairs to assign the option group.
To remove all tags set tags={} and purge_tags=true.
validate_certs
boolean
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for the cluster to be available or deleted.

Notes

Note

  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION, AWS_CA_BUNDLE

  • When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.

  • Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.

  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.

Examples

# Create an RDS Mysql Option group
- name: Create an RDS Mysql option group
  community.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
  community.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
  community.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
  community.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 Returned Description
allows_vpc_and_non_vpc_instance_memberships
boolean
always
Indicates whether this option group can be applied to both VPC and non-VPC instances.

changed
boolean
always
If the Option Group has changed.

Sample:
True
engine_name
string
always
Indicates the name of the engine that this option group can be applied to.

Sample:
mysql
major_engine_version
string
always
Indicates the major engine version associated with this option group.

Sample:
5.6
option_group_arn
string
always
The Amazon Resource Name (ARN) for the option group.

Sample:
arn:aws:rds:ap-southeast-2:721066863947:og:ansible-test-option-group
option_group_description
string
always
Provides a description of the option group.

Sample:
test mysql option group
option_group_name
string
always
Specifies the name of the option group.

Sample:
test-mysql-option-group
options
list / elements=dictionary
always
Indicates what options are available in the option group.

 
db_security_group_memberships
list / elements=dictionary
always
If the option requires access to a port, then this DB security group allows access to the port.

   
db_security_group_name
string
always
The name of the DB security group.

Sample:
mydbsecuritygroup
   
status
string
always
The status of the DB security group.

Sample:
available
 
option_description
string
always
The description of the option.

Sample:
Innodb Memcached for MySQL
 
option_name
string
always
The name of the option.

Sample:
MEMCACHED
 
option_settings
list / elements=string
always
The name of the option.

   
allowed_values
string
always
The allowed values of the option setting.

Sample:
1-2048
   
apply_type
string
always
The DB engine specific parameter type.

Sample:
STATIC
   
data_type
string
always
The data type of the option setting.

Sample:
INTEGER
   
default_value
string
always
The default value of the option setting.

Sample:
1024
   
description
string
always
The description of the option setting.

Sample:
Verbose level for memcached.
   
is_collection
boolean
always
Indicates if the option setting is part of a collection.

Sample:
True
   
is_modifiable
boolean
always
A Boolean value that, when true, indicates the option setting can be modified from the default.

Sample:
True
   
name
string
always
The name of the option that has settings that you can set.

Sample:
INNODB_API_ENABLE_MDL
   
value
string
always
The current value of the option setting.

Sample:
0
 
permanent
boolean
always
Indicate if this option is permanent.

Sample:
True
 
persistent
boolean
always
Indicate if this option is persistent.

Sample:
True
 
port
integer
always
If required, the port configured for this option to use.

Sample:
11211
 
vpc_security_group_memberships
list / elements=dictionary
always
If the option requires access to a port, then this VPC security group allows access to the port.

   
status
string
always
The status of the VPC security group.

Sample:
available
   
vpc_security_group_id
string
always
The name of the VPC security group.

Sample:
sg-0cd636a23ae76e9a4
tags
dictionary
always
The tags associated the Internet Gateway.

Sample:
{'Ansible': 'Test'}
vpc_id
string
always
If present, this option group can only be applied to instances that are in the VPC indicated by this field.

Sample:
vpc-bf07e9d6


Authors

  • Nick Aslanidis (@naslanidis)

  • Will Thames (@willthames)

  • Alina Buzachis (@alinabuzachis)