community.aws.redshift – create, delete, or modify an Amazon Redshift instance

From Get docs
Ansible/docs/2.10/collections/community/aws/redshift module


community.aws.redshift – create, delete, or modify an Amazon Redshift instance

Note

This plugin is part of the community.aws collection (version 1.3.0).

To install it use: ansible-galaxy collection install community.aws.

To use it in a playbook, specify: community.aws.redshift.


New in version 1.0.0: of community.aws


Synopsis

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

Requirements

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

  • boto
  • boto3
  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments

allow_version_upgrade

boolean

  • no
  • yes

When allow_version_upgrade=true the cluster may be automatically upgraded during the maintenance window.


aliases: version_upgrade

automated_snapshot_retention_period

integer

The number of days that automated snapshots are retained.


aliases: retention_period

availability_zone

string

Availability zone in which to launch cluster.


aliases: zone, aws_zone

aws_access_key

string

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.

If profile is set this parameter is ignored.

Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.


aliases: ec2_access_key, access_key

aws_ca_bundle

path

The location of a CA Bundle to use when validating SSL certificates.

Only used for boto3 based modules.

Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.

aws_config

dictionary

A dictionary to modify the botocore configuration.

Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.

aws_secret_key

string

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.

If profile is set this parameter is ignored.

Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.


aliases: ec2_secret_key, secret_key

cluster_parameter_group_name

string

Name of the cluster parameter group.


aliases: param_group_name

cluster_security_groups

list / elements=string

In which security group the cluster belongs.


aliases: security_groups

cluster_subnet_group_name

string

Which subnet to place the cluster.


aliases: subnet

cluster_type

string

  • multi-node
  • single-node

The type of cluster.

cluster_version

string

  • 1.0

Which version the cluster should have.


aliases: version

command

string / required

  • create
  • facts
  • delete
  • modify

Specifies the action to take.

db_name

string

Name of the database.

debug_botocore_endpoint_logs

boolean

  • no

  • yes

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.

ec2_url

string

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.


aliases: aws_endpoint_url, endpoint_url

elastic_ip

string

An Elastic IP to use for the cluster.

encrypted

boolean

  • no

  • yes

If the cluster is encrypted or not.

enhanced_vpc_routing

boolean

  • no

  • yes

Whether the cluster should have enhanced VPC routing enabled.

final_cluster_snapshot_identifier

string

Identifier of the final snapshot to be created before deleting the cluster.

If this parameter is provided, skip_final_cluster_snapshot must be false.

Used only when command=delete.


aliases: final_snapshot_id

identifier

string / required

Redshift cluster identifier.

new_cluster_identifier

string

Only used when command=modify.


aliases: new_identifier

node_type

string

  • ds1.xlarge
  • ds1.8xlarge
  • ds2.xlarge
  • ds2.8xlarge
  • dc1.large
  • dc2.large
  • dc1.8xlarge
  • dw1.xlarge
  • dw1.8xlarge
  • dw2.large
  • dw2.8xlarge

The node type of the cluster.

Require when command=create.

number_of_nodes

integer

Number of nodes.

Only used when cluster_type=multi-node.

password

string

Master database password.

Used only when command=create.

port

integer

Which port the cluster is listening on.

preferred_maintenance_window

string

Maintenance window in format of ddd:hh24:mi-ddd:hh24:mi. (Example: Mon:22:00-Mon:23:15)

Times are specified in UTC.

If not specified then a random 30 minute maintenance window is assigned.


aliases: maintance_window, maint_window

profile

string

Uses a boto profile. Only works with boto >= 2.24.0.

Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.

aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.


aliases: aws_profile

publicly_accessible

boolean

  • no

  • yes

If the cluster is accessible publicly or not.

purge_tags

boolean

added in 1.3.0 of community.aws

  • no
  • yes

Purge existing tags that are not found in the cluster

region

string

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

string

AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.

If profile is set this parameter is ignored.

Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.


aliases: aws_security_token, access_token

skip_final_cluster_snapshot

boolean

  • no

  • yes

Skip a final snapshot before deleting the cluster.

Used only when command=delete.


aliases: skip_final_snapshot

tags

dictionary

added in 1.3.0 of community.aws

A dictionary of resource tags.


aliases: resource_tags

username

string

Master database username.

Used only when command=create.

validate_certs

boolean

  • no
  • yes

When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

vpc_security_group_ids

list / elements=string

VPC security group


aliases: vpc_security_groups

wait

boolean

  • no

  • yes

When command=create, command=modify or command=restore then wait for the database to enter the 'available' state.

When command=delete wait for the database to be terminated.

wait_timeout

integer

Default:

300

When wait=true defines how long in seconds before giving up.



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_PROFILE or AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE
  • 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

- name: Basic cluster provisioning example
  community.aws.redshift:
    command: create
    node_type: ds1.xlarge
    identifier: new_cluster
    username: cluster_admin
    password: 1nsecure

- name: Cluster delete example
  community.aws.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


availability_zone

string

success

Amazon availability zone where the cluster is located. "None" until cluster is available.


Sample:

us-east-1b

create_time

float

success

Time of the cluster creation as timestamp.


Sample:

1430158536.308

db_name

string

success

Name of the database.


Sample:

new_db_name

enhanced_vpc_routing

boolean

success

status of the enhanced vpc routing feature.


identifier

string

success

Id of the cluster.


Sample:

new_redshift_cluster

maintenance_window

string

success

Time frame when maintenance/upgrade are done.


Sample:

sun:09:30-sun:10:00

port

integer

success

Port of the cluster. "None" until cluster is available.


Sample:

5439

private_ip_address

string

success

Private IP address of the main node.


Sample:

10.10.10.10

public_ip_address

string

success

Public IP address of the main node. "None" when enhanced_vpc_routing is enabled.


Sample:

0.0.0.0

status

string

success

Status of the cluster.


Sample:

available

tags

dictionary

success

aws tags for cluster.


url

string

success

FQDN of the main cluster node. "None" until cluster is available.


Sample:

new-redshift_cluster.jfkdjfdkj.us-east-1.redshift.amazonaws.com




Authors

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/aws/redshift_module.html