Documentation

redshift - create, delete, or modify an Amazon Redshift instance

New in version 2.2.

Synopsis

  • Creates, deletes, or modifies amazon Redshift cluster instances.

Requirements

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

  • boto
  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
allow_version_upgrade Default:
yes
flag to determinate if upgrade of version is possible

aliases: version_upgrade
automated_snapshot_retention_period
period when the snapshot take place

aliases: retention_period
availability_zone
availability zone in which to launch cluster

aliases: zone, aws_zone
aws_access_key
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
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
name of the cluster parameter group

aliases: param_group_name
cluster_security_groups
in which security group the cluster belongs

aliases: security_groups
cluster_subnet_group_name
which subnet to place the cluster

aliases: subnet
cluster_type
    Choices:
  • multi-node
  • single-node ←
The type of cluster.
cluster_version
    Choices:
  • 1.0
which version the cluster should have

aliases: version
command
required
    Choices:
  • create
  • facts
  • delete
  • modify
Specifies the action to take.
db_name
Name of the database.
ec2_url
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
if the cluster has an elastic IP or not
encrypted Default:
no
if the cluster is encrypted or not
final_cluster_snapshot_identifier
(added in 2.4)
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
required
Redshift cluster identifier.
new_cluster_identifier
Only used when command=modify.

aliases: new_identifier
node_type
    Choices:
  • ds1.xlarge
  • ds1.8xlarge
  • ds2.xlarge
  • ds2.8xlarge
  • dc1.large
  • dc1.8xlarge
  • dc2.large
  • dc2.8xlarge
  • dw1.xlarge
  • dw1.8xlarge
  • dw2.large
  • dw2.8xlarge
The node type of the cluster. Must be specified when command=create.
number_of_nodes
Number of nodes. Only used when cluster_type=multi-node.
password
Master database password. Used only when command=create.
port
which port the cluster is listining
preferred_maintenance_window
maintenance window

aliases: maintance_window, maint_window
profile
(added in 1.6)
Uses a boto profile. Only works with boto >= 2.24.0.
publicly_accessible Default:
no
if the cluster is accessible publicly or not
region
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
(added in 1.6)
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)
Default:
no
skip a final snapshot before deleting the cluster. Used only when command=delete.

aliases: skip_final_snapshot
username
Master database username. Used only when command=create.
validate_certs
bool

(added in 1.5)
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
vpc_security_group_ids
VPC security group

aliases: vpc_security_groups
wait
bool
    Choices:
  • no ←
  • yes
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 Default:
300
how long before wait gives up, in seconds

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 https://boto.readthedocs.io/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

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, the following are the fields unique to this module:

Key Returned Description
cluster
complex
success
dictionary containing all the cluster information

  status
string
success
Stutus of the cluster.

Sample:
available
  public_ip_address
string
success
Public IP address of the main node.

Sample:
0.0.0.0
  availability_zone
string
success
Amazon availability zone where the cluster is located.

Sample:
us-east-1b
  url
string
success
FQDN of the main cluster node.

Sample:
new-redshift_cluster.jfkdjfdkj.us-east-1.redshift.amazonaws.com
  db_name
string
success
Name of the database.

Sample:
new_db_name
  create_time
float
success
Time of the cluster creation as timestamp.

Sample:
1430158536.31
  private_ip_address
string
success
Private IP address of the main node.

Sample:
10.10.10.10
  identifier
string
success
Id of the cluster.

Sample:
new_redshift_cluster
  port
int
success
Port of the cluster.

Sample:
5439
  maintenance_window
string
success
Time frame when maintenance/upgrade are done.

Sample:
sun:09:30-sun:10:00


Status

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

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Jens Carl (@j-carl), Hothead Games Inc.

Hint

If you notice any issues in this documentation you can edit this document to improve it.