community.aws.redshift module – create, delete, or modify an Amazon Redshift instance
Note
This module is part of the community.aws collection (version 3.6.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
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.16.0
botocore >= 1.19.0
Parameters
Parameter |
Comments |
---|---|
When allow_version_upgrade=true the cluster may be automatically upgraded during the maintenance window. Choices:
|
|
The number of days that automated snapshots are retained. |
|
Availability zone in which to launch cluster. |
|
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. |
|
The location of a CA Bundle to use when validating SSL certificates. Not used by boto 2 based modules. Note: The CA Bundle is read ‘module’ side and may need to be explicitly copied from the controller if not run locally. |
|
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. 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. |
|
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. |
|
Name of the cluster parameter group. |
|
In which security group the cluster belongs. |
|
Which subnet to place the cluster. |
|
The type of cluster. Choices:
|
|
Which version the cluster should have. Choices:
|
|
Specifies the action to take. Choices:
|
|
Name of the database. |
|
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:
|
|
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. |
|
An Elastic IP to use for the cluster. |
|
If the cluster is encrypted or not. Choices:
|
|
Whether the cluster should have enhanced VPC routing enabled. Choices:
|
|
Identifier of the final snapshot to be created before deleting the cluster. If this parameter is provided, skip_final_cluster_snapshot must be Used only when command=delete. |
|
Redshift cluster identifier. |
|
Only used when command=modify. |
|
The node type of the cluster. Require when command=create. Choices:
|
|
Number of nodes. Only used when cluster_type=multi-node. |
|
Master database password. Used only when command=create. |
|
Which port the cluster is listening on. |
|
Maintenance window in format of Times are specified in UTC. If not specified then a random 30 minute maintenance window is assigned. |
|
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. |
|
If the cluster is accessible publicly or not. Choices:
|
|
Purge existing tags that are not found in the cluster Choices:
|
|
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 |
|
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_session_token and session_token have been added in version 3.2.0. |
|
Skip a final snapshot before deleting the cluster. Used only when command=delete. Choices:
|
|
A dictionary of resource tags. |
|
Master database username. Used only when command=create. |
|
When set to “no”, SSL certificates will not be validated for communication with the AWS APIs. Choices:
|
|
VPC security group |
|
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:
|
|
When wait=true defines how long in seconds before giving up. Default: |
Notes
Note
If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence
AWS_URL
orEC2_URL
,AWS_PROFILE
orAWS_DEFAULT_PROFILE
,AWS_ACCESS_KEY_ID
orAWS_ACCESS_KEY
orEC2_ACCESS_KEY
,AWS_SECRET_ACCESS_KEY
orAWS_SECRET_KEY
orEC2_SECRET_KEY
,AWS_SECURITY_TOKEN
orEC2_SECURITY_TOKEN
,AWS_REGION
orEC2_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.Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
AWS_REGION
orEC2_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 |
---|---|
dictionary containing all the cluster information Returned: success |
|
Amazon availability zone where the cluster is located. “None” until cluster is available. Returned: success Sample: |
|
Time of the cluster creation as timestamp. Returned: success Sample: |
|
Name of the database. Returned: success Sample: |
|
status of the enhanced vpc routing feature. Returned: success |
|
Id of the cluster. Returned: success Sample: |
|
Time frame when maintenance/upgrade are done. Returned: success Sample: |
|
Port of the cluster. “None” until cluster is available. Returned: success Sample: |
|
Private IP address of the main node. Returned: success Sample: |
|
Public IP address of the main node. “None” when enhanced_vpc_routing is enabled. Returned: success Sample: |
|
Status of the cluster. Returned: success Sample: |
|
aws tags for cluster. Returned: success |
|
FQDN of the main cluster node. “None” until cluster is available. Returned: success Sample: |