W3cubDocs

/Ansible

redshift_subnet_group - mange Redshift cluster subnet groups

New in version 2.2.

Synopsis

  • Create, modifies, and deletes Redshift cluster subnet groups.

Requirements (on host that executes module)

  • boto
  • python >= 2.6

Options

parameter required default choices comments
aws_access_key
 no
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.
aliases: ec2_access_key, access_key
aws_secret_key
 no
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.
aliases: ec2_secret_key, secret_key
ec2_url
 no
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.
group_description
 no
Database subnet group description.
aliases: description
group_name
 yes
Cluster subnet group name.
aliases: name
group_subnets
 no
List of subnet IDs that make up the cluster subnet group.
aliases: subnets
profile
(added in 1.6)
 no
Uses a boto profile. Only works with boto >= 2.24.0.
security_token
(added in 1.6)
 no
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
aliases: access_token
state
 no present
  • present
  • absent
Specifies whether the subnet should be present or absent.
validate_certs
(added in 1.5)
 no yes
  • yes
  • no
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Examples

# Create a Redshift subnet group
- local_action:
    module: redshift_subnet_group
    state: present
    group_name: redshift-subnet
    group_description: Redshift subnet
    group_subnets:
        - 'subnet-aaaaa'
        - 'subnet-bbbbb'

# Remove subnet group
- redshift_subnet_group:
    state: absent
    group_name: redshift-subnet

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
group
dictionary containing all Redshift subnet group information
 success complex
contains:
name description returned type sample
vpc_id
Id of the VPC where the subnet is located
 success string vpc-aabb1122
name
name of the Redshift subnet group
 success string redshift_subnet_group_name

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_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
  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/en/latest/boto_config_tut.html
  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/redshift_subnet_group_module.html