ansible.builtin.rds_param_group (v2.9.17) — module

Install Ansible via pip

Install with pip install ansible==2.9.17

Description

Creates, modifies, and deletes RDS parameter groups. This module has a dependency on python-boto >= 2.5.

Requirements

• boto3
• boto3 >= 1.15.0
• botocore >= 1.18.0
• python >= 3.6

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Remove a parameter group
- rds_param_group:
      state: absent
      name: norwegian-blue

Inputs

    
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:
    description:
    - The type of database for this group. Required for state=present.
    - Please use following command to get list of all supported db engines and their respective
      versions.
    - '# aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"'

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

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

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

immediate:
    aliases:
    - apply_immediately
    description:
    - Whether to apply the changes immediately, or after the next reboot of any associated
      instances.
    type: bool

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: false
    description:
    - Whether or not to remove tags that do not appear in the I(tags) list.
    type: bool
    version_added: '2.4'
    version_added_collection: ansible.builtin

description:
    description:
    - Database parameter group description. Only set when a new group is added.

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

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

Outputs

db_parameter_group_arn:
  description: ARN of the DB parameter group
  returned: when state is present
  type: str
db_parameter_group_family:
  description: DB parameter group family that this DB parameter group is compatible
    with.
  returned: when state is present
  type: str
db_parameter_group_name:
  description: Name of DB parameter group
  returned: when state is present
  type: str
description:
  description: description of the DB parameter group
  returned: when state is present
  type: str
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