Try Spotterrds_option_group module
| "added in version" 2.1.0 of community.aws"
Authors: Nick Aslanidis (@naslanidis), Will Thames (@willthames), Alina Buzachis (@alinabuzachis)
Install with ansible-galaxy collection install community.aws:==3.4.0
collections:
- name: community.aws
version: 3.4.0Manages the creation, modification, deletion of RDS option groups.
# 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
tags:
description:
- A dictionary of key value pairs to assign the option group.
- To remove all tags set I(tags={}) and I(purge_tags=true).
type: dict
wait:
default: true
description: Whether to wait for the cluster to be available or deleted.
type: bool
state:
choices:
- present
- absent
description:
- Specifies whether the option group should be C(present) or C(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
ec2_url:
aliases:
- aws_endpoint_url
- endpoint_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
options:
description:
- 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.
elements: dict
suboptions:
db_security_group_memberships:
description: A list of C(DBSecurityGroupMembership) name strings used for this
option.
elements: str
required: false
type: list
option_name:
description: The configuration of options to include in a group.
required: false
type: str
option_settings:
description: The option settings to include in an option group.
elements: dict
required: false
suboptions:
allowed_values:
description: The allowed values of the option setting.
required: false
type: str
apply_type:
description: The DB engine specific parameter type.
required: false
type: str
data_type:
description: The data type of the option setting.
required: false
type: str
default_value:
description: The default value of the option setting.
required: false
type: str
description:
description: The description of the option setting.
required: false
type: str
is_collection:
description: Indicates if the option setting is part of a collection.
required: false
type: bool
is_modifiable:
description: A Boolean value that, when C(true), indicates the option setting
can be modified from the default.
required: false
type: bool
name:
description: The name of the option that has settings that you can set.
required: false
type: str
value:
description: The current value of the option setting.
required: false
type: str
type: list
option_version:
description: The version for the option.
required: false
type: str
port:
description: The optional port for the option.
required: false
type: int
vpc_security_group_memberships:
description: A list of C(VpcSecurityGroupMembership) name strings used for this
option.
elements: str
required: false
type: list
type: list
profile:
aliases:
- aws_profile
description:
- Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token)
and support for passing them at the same time as I(profile) has been deprecated.
- I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually
exclusive with I(profile) after 2022-06-01.
type: str
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).
- Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto)
for more boto configuration.
type: dict
purge_tags:
default: true
description:
- Remove tags not listed in I(tags).
type: bool
engine_name:
description:
- Specifies the name of the engine that this option group should be associated with.
type: str
aws_ca_bundle:
description:
- 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.'
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.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
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.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
security_token:
aliases:
- 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.
- If I(profile) is set this parameter is ignored.
- Passing the I(security_token) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
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
apply_immediately:
default: false
description:
- Indicates whether the changes should be applied immediately, or during the next
maintenance window.
required: false
type: bool
option_group_name:
description:
- Specifies the name of the option group to be created.
required: true
type: str
major_engine_version:
description:
- Specifies the major version of the engine that this option group should be associated
with.
type: str
option_group_description:
description:
- The description of the option group.
type: str
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
allows_vpc_and_non_vpc_instance_memberships:
description: Indicates whether this option group can be applied to both VPC and
non-VPC instances.
returned: always
sample: false
type: bool
changed:
description: If the Option Group has changed.
returned: always
sample: true
type: bool
engine_name:
description: Indicates the name of the engine that this option group can be applied
to.
returned: always
sample: mysql
type: str
major_engine_version:
description: Indicates the major engine version associated with this option group.
returned: always
sample: '5.6'
type: str
option_group_arn:
description: The Amazon Resource Name (ARN) for the option group.
returned: always
sample: arn:aws:rds:ap-southeast-2:721066863947:og:ansible-test-option-group
type: str
option_group_description:
description: Provides a description of the option group.
returned: always
sample: test mysql option group
type: str
option_group_name:
description: Specifies the name of the option group.
returned: always
sample: test-mysql-option-group
type: str
options:
contains:
db_security_group_memberships:
contains:
db_security_group_name:
description: The name of the DB security group.
returned: always
sample: mydbsecuritygroup
type: str
status:
description: The status of the DB security group.
returned: always
sample: available
type: str
description: If the option requires access to a port, then this DB security
group allows access to the port.
elements: dict
returned: always
type: list
option_description:
description: The description of the option.
returned: always
sample: Innodb Memcached for MySQL
type: str
option_name:
description: The name of the option.
returned: always
sample: MEMCACHED
type: str
option_settings:
contains:
allowed_values:
description: The allowed values of the option setting.
returned: always
sample: 1-2048
type: str
apply_type:
description: The DB engine specific parameter type.
returned: always
sample: STATIC
type: str
data_type:
description: The data type of the option setting.
returned: always
sample: INTEGER
type: str
default_value:
description: The default value of the option setting.
returned: always
sample: '1024'
type: str
description:
description: The description of the option setting.
returned: always
sample: Verbose level for memcached.
type: str
is_collection:
description: Indicates if the option setting is part of a collection.
returned: always
sample: true
type: bool
is_modifiable:
description: A Boolean value that, when true, indicates the option setting
can be modified from the default.
returned: always
sample: true
type: bool
name:
description: The name of the option that has settings that you can set.
returned: always
sample: INNODB_API_ENABLE_MDL
type: str
value:
description: The current value of the option setting.
returned: always
sample: '0'
type: str
description: The name of the option.
returned: always
type: list
permanent:
description: Indicate if this option is permanent.
returned: always
sample: true
type: bool
persistent:
description: Indicate if this option is persistent.
returned: always
sample: true
type: bool
port:
description: If required, the port configured for this option to use.
returned: always
sample: 11211
type: int
vpc_security_group_memberships:
contains:
status:
description: The status of the VPC security group.
returned: always
sample: available
type: str
vpc_security_group_id:
description: The name of the VPC security group.
returned: always
sample: sg-0cd636a23ae76e9a4
type: str
description: If the option requires access to a port, then this VPC security
group allows access to the port.
elements: dict
returned: always
type: list
description: Indicates what options are available in the option group.
elements: dict
returned: always
type: list
tags:
description: The tags associated the Internet Gateway.
returned: always
sample:
Ansible: Test
type: dict
vpc_id:
description: If present, this option group can only be applied to instances that
are in the VPC indicated by this field.
returned: always
sample: vpc-bf07e9d6
type: str