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

Note

This module is part of the community.aws collection (version 5.0.0).

To install it, use: ansible-galaxy collection install community.aws. You need further requirements to be able to use this module, see Requirements for details.

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

New in community.aws 1.0.0

Synopsis

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

Requirements

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

  • python >= 3.6

  • boto3 >= 1.18.0

  • botocore >= 1.21.0

Parameters

Parameter

Comments

allow_version_upgrade

aliases: version_upgrade

boolean

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

Choices:

  • false

  • true ← (default)

automated_snapshot_retention_period

aliases: retention_period

integer

The number of days that automated snapshots are retained.

availability_zone

aliases: zone, aws_zone

string

Availability zone in which to launch cluster.

aws_access_key

aliases: ec2_access_key, 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.

The aws_access_key and profile options are mutually exclusive.

aws_ca_bundle

path

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

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.

Parameters can be found at https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

aws_secret_key

aliases: ec2_secret_key, 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.

The aws_secret_key and profile options are mutually exclusive.

cluster_parameter_group_name

aliases: param_group_name

string

Name of the cluster parameter group.

cluster_security_groups

aliases: security_groups

list / elements=string

In which security group the cluster belongs.

cluster_subnet_group_name

aliases: subnet

string

Which subnet to place the cluster.

cluster_type

string

The type of cluster.

Choices:

  • “multi-node”

  • “single-node” ← (default)

cluster_version

aliases: version

string

Which version the cluster should have.

Choices:

  • “1.0”

command

string / required

Specifies the action to take.

Choices:

  • “create”

  • “facts”

  • “delete”

  • “modify”

db_name

string

Name of the database.

debug_botocore_endpoint_logs

boolean

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.

Choices:

  • false ← (default)

  • true

elastic_ip

string

An Elastic IP to use for the cluster.

encrypted

boolean

If the cluster is encrypted or not.

Choices:

  • false ← (default)

  • true

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_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.

enhanced_vpc_routing

boolean

Whether the cluster should have enhanced VPC routing enabled.

Choices:

  • false ← (default)

  • true

final_cluster_snapshot_identifier

aliases: final_snapshot_id

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.

identifier

string / required

Redshift cluster identifier.

new_cluster_identifier

aliases: new_identifier

string

Only used when command=modify.

node_type

string

The node type of the cluster.

Require when command=create.

Choices:

  • “ds1.xlarge”

  • “ds1.8xlarge”

  • “ds2.xlarge”

  • “ds2.8xlarge”

  • “dc1.large”

  • “dc2.large”

  • “dc1.8xlarge”

  • “dw1.xlarge”

  • “dw1.8xlarge”

  • “dw2.large”

  • “dw2.8xlarge”

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

aliases: maintance_window, maint_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.

profile

aliases: aws_profile

string

The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.

publicly_accessible

boolean

If the cluster is accessible publicly or not.

Choices:

  • false ← (default)

  • true

purge_tags

boolean

If purge_tags=true and tags is set, existing tags will be purged from the resource to match exactly what is defined by tags parameter.

If the tags parameter is not set then tags will not be modified, even if purge_tags=True.

Tag keys beginning with aws: are reserved by Amazon and can not be modified. As such they will be ignored for the purposes of the purge_tags parameter. See the Amazon documentation for more information https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions.

Choices:

  • false

  • true ← (default)

region

aliases: aws_region, ec2_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

security_token

aliases: aws_session_token, session_token, aws_security_token, access_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.

The security_token and profile options are mutually exclusive.

Aliases aws_session_token and session_token have been added in version 3.2.0.

skip_final_cluster_snapshot

aliases: skip_final_snapshot

boolean

Skip a final snapshot before deleting the cluster.

Used only when command=delete.

Choices:

  • false ← (default)

  • true

tags

aliases: resource_tags

dictionary

A dictionary representing the tags to be applied to the resource.

If the tags parameter is not set then tags will not be modified.

username

string

Master database username.

Used only when command=create.

validate_certs

boolean

When set to “no”, SSL certificates will not be validated for communication with the AWS APIs.

Choices:

  • false

  • true ← (default)

vpc_security_group_ids

aliases: vpc_security_groups

list / elements=string

VPC security group

wait

boolean

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.

Choices:

  • false ← (default)

  • true

wait_timeout

integer

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

Default: 300

Notes

Note

  • Support for tags and purge_tags was added in release 1.3.0.

  • 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

  • When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.

  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.

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

Description

cluster

complex

dictionary containing all the cluster information

Returned: success

availability_zone

string

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

Returned: success

Sample: “us-east-1b”

create_time

float

Time of the cluster creation as timestamp.

Returned: success

Sample: 1430158536.308

db_name

string

Name of the database.

Returned: success

Sample: “new_db_name”

enhanced_vpc_routing

boolean

status of the enhanced vpc routing feature.

Returned: success

identifier

string

Id of the cluster.

Returned: success

Sample: “new_redshift_cluster”

maintenance_window

string

Time frame when maintenance/upgrade are done.

Returned: success

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

port

integer

Port of the cluster. “None” until cluster is available.

Returned: success

Sample: 5439

private_ip_address

string

Private IP address of the main node.

Returned: success

Sample: “10.10.10.10”

public_ip_address

string

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

Returned: success

Sample: “0.0.0.0”

status

string

Status of the cluster.

Returned: success

Sample: “available”

tags

dictionary

aws tags for cluster.

Returned: success

url

string

FQDN of the main cluster node. “None” until cluster is available.

Returned: success

Sample: “new-redshift_cluster.jfkdjfdkj.us-east-1.redshift.amazonaws.com”

Authors

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

  • Rafael Driutti (@rafaeldriutti)