redshift - create, delete, or modify an Amazon Redshift instance
New in version 2.2.
Synopsis
- Creates, deletes, or modifies amazon Redshift cluster instances.
Requirements (on host that executes module)
- boto
- python >= 2.6
Options
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| allow_version_upgrade | no | True | flag to determinate if upgrade of version is possible aliases: version_upgrade | |
| automated_snapshot_retention_period | no | period when the snapshot take place aliases: retention_period | ||
| availability_zone | no | availability zone in which to launch cluster aliases: zone, aws_zone | ||
| 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 | ||
| cluster_parameter_group_name | no | name of the cluster parameter group aliases: param_group_name | ||
| cluster_security_groups | no | in which security group the cluster belongs aliases: security_groups | ||
| cluster_subnet_group_name | no | which subnet to place the cluster aliases: subnet | ||
| cluster_type | no | single-node |
| The type of cluster. |
| cluster_version | no |
| which version the cluster should have aliases: version | |
| command | yes |
| Specifies the action to take. | |
| db_name | no | Name of the database. | ||
| 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. | ||
| elastic_ip | no | if the cluster has an elastic IP or not | ||
| encrypted | no | if the cluster is encrypted or not | ||
| final_cluster_snapshot_identifier (added in 2.4)
| no | identifier of the final snapshot to be created before deleting the cluster. If this parameter is provided, final_cluster_snapshot_identifier must be false. Used only when command=delete. aliases: final_snapshot_id | ||
| identifier | yes | Redshift cluster identifier. | ||
| new_cluster_identifier | no | Only used when command=modify. aliases: new_identifier | ||
| node_type | no |
| The node type of the cluster. Must be specified when command=create. | |
| number_of_nodes | no | Number of nodes. Only used when cluster_type=multi-node. | ||
| password | no | Master database password. Used only when command=create. | ||
| port | no | which port the cluster is listining | ||
| preferred_maintenance_window | no | maintenance window aliases: maintance_window, maint_window | ||
| profile (added in 1.6)
| no | Uses a boto profile. Only works with boto >= 2.24.0. | ||
| publicly_accessible | no | if the cluster is accessible publicly or not | ||
| 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 | ||
| skip_final_cluster_snapshot (added in 2.4)
| no | skip a final snapshot before deleting the cluster. Used only when command=delete. aliases: skip_final_snapshot | ||
| username | no | Master database username. Used only when command=create. | ||
| validate_certs (added in 1.5)
| no | yes |
| When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. |
| vpc_security_group_ids | no | VPC security group aliases: vpc_security_groups | ||
| wait | no | no |
| When command=create, modify or restore then wait for the database to enter the 'available' state. When command=delete wait for the database to be terminated. |
| wait_timeout | no | 300 | how long before wait gives up, in seconds |
Examples
# Basic cluster provisioning example
- redshift: >
command=create
node_type=ds1.xlarge
identifier=new_cluster
username=cluster_admin
password=1nsecure
# Cluster delete example
- redshift:
command: delete
identifier: new_cluster
skip_final_cluster_snapshot: true
wait: true
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| cluster | dictionary containing all the cluster information | success | complex | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| contains: |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Notes
Note
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence
AWS_URLorEC2_URL,AWS_ACCESS_KEY_IDorAWS_ACCESS_KEYorEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYorAWS_SECRET_KEYorEC2_SECRET_KEY,AWS_SECURITY_TOKENorEC2_SECURITY_TOKEN,AWS_REGIONorEC2_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_REGIONorEC2_REGIONcan 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–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/redshift_module.html