Try Spottercreate, delete, or modify an Amazon Redshift instance
| "added in version" 1.0.0 of community.aws"
Authors: Jens Carl (@j-carl), Hothead Games Inc., Rafael Driutti (@rafaeldriutti)
Install with ansible-galaxy collection install community.aws:==1.1.0
collections:
- name: community.aws
version: 1.1.0Creates, deletes, or modifies Amazon Redshift cluster instances.
- 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
port:
description:
- Which port the cluster is listening on.
type: int
wait:
default: false
description:
- When I(command=create), I(command=modify) or I(command=restore) then wait for the
database to enter the 'available' state.
- When I(command=delete) wait for the database to be terminated.
type: bool
region:
aliases:
- aws_region
- ec2_region
description:
- The AWS region to use.
- For global services such as IAM, Route53 and CloudFront, I(region) is ignored.
- The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used.
- See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region).
- The C(ec2_region) alias has been deprecated and will be removed in a release after
2024-12-01
- Support for the C(EC2_REGION) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
command:
choices:
- create
- facts
- delete
- modify
description:
- Specifies the action to take.
required: true
type: str
db_name:
description:
- Name of the database.
type: str
profile:
aliases:
- aws_profile
description:
- A named AWS profile to use for authentication.
- See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
- The C(AWS_PROFILE) environment variable may also be used.
- The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
and I(security_token) options.
type: str
password:
description:
- Master database password.
- Used only when I(command=create).
type: str
username:
description:
- Master database username.
- Used only when I(command=create).
type: str
encrypted:
default: false
description:
- If the cluster is encrypted or not.
type: bool
node_type:
choices:
- ds1.xlarge
- ds1.8xlarge
- ds2.xlarge
- ds2.8xlarge
- dc1.large
- dc2.large
- dc1.8xlarge
- dw1.xlarge
- dw1.8xlarge
- dw2.large
- dw2.8xlarge
description:
- The node type of the cluster.
- Require when I(command=create).
type: str
access_key:
aliases:
- aws_access_key_id
- aws_access_key
- ec2_access_key
description:
- AWS access key ID.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables
may also be used in decreasing order of preference.
- The I(aws_access_key) and I(profile) options are mutually exclusive.
- The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the
AWS botocore SDK.
- The I(ec2_access_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
type: dict
elastic_ip:
description:
- An Elastic IP to use for the cluster.
type: str
identifier:
description:
- Redshift cluster identifier.
required: true
type: str
secret_key:
aliases:
- aws_secret_access_key
- aws_secret_key
- ec2_secret_key
description:
- AWS secret access key.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment
variables may also be used in decreasing order of preference.
- The I(secret_key) and I(profile) options are mutually exclusive.
- The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with
the AWS botocore SDK.
- The I(ec2_secret_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
cluster_type:
choices:
- multi-node
- single-node
default: single-node
description:
- The type of cluster.
type: str
endpoint_url:
aliases:
- ec2_url
- aws_endpoint_url
- s3_url
description:
- URL to connect to instead of the default AWS endpoints. While this can be used
to connection to other AWS-compatible services the amazon.aws and community.aws
collections are only tested against AWS.
- The C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing
order of preference.
- The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in
a release after 2024-12-01.
- Support for the C(EC2_URL) environment variable has been deprecated and will be
removed in a release after 2024-12-01.
type: str
wait_timeout:
default: 300
description:
- When I(wait=true) defines how long in seconds before giving up.
type: int
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- The C(AWS_CA_BUNDLE) environment variable may also be used.
type: path
session_token:
aliases:
- aws_session_token
- security_token
- aws_security_token
- access_token
description:
- AWS STS session token for use with temporary credentials.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment
variables may also be used in decreasing order of preference.
- The I(security_token) and I(profile) options are mutually exclusive.
- Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with
the parameter being renamed from I(security_token) to I(session_token) in release
6.0.0.
- The I(security_token), I(aws_security_token), and I(access_token) aliases have been
deprecated and will be removed in a release after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables
has been deprecated and will be removed in a release after 2024-12-01.
type: str
validate_certs:
default: true
description:
- When set to C(false), SSL certificates will not be validated for communication with
the AWS APIs.
- Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider
setting I(aws_ca_bundle) instead.
type: bool
cluster_version:
aliases:
- version
choices:
- '1.0'
description:
- Which version the cluster should have.
type: str
number_of_nodes:
description:
- Number of nodes.
- Only used when I(cluster_type=multi-node).
type: int
availability_zone:
aliases:
- zone
- aws_zone
description:
- Availability zone in which to launch cluster.
type: str
publicly_accessible:
default: false
description:
- If the cluster is accessible publicly or not.
type: bool
enhanced_vpc_routing:
default: false
description:
- Whether the cluster should have enhanced VPC routing enabled.
type: bool
allow_version_upgrade:
aliases:
- version_upgrade
default: true
description:
- When I(allow_version_upgrade=true) the cluster may be automatically upgraded during
the maintenance window.
type: bool
new_cluster_identifier:
aliases:
- new_identifier
description:
- Only used when command=modify.
type: str
vpc_security_group_ids:
aliases:
- vpc_security_groups
description:
- VPC security group
elements: str
type: list
cluster_security_groups:
aliases:
- security_groups
description:
- In which security group the cluster belongs.
elements: str
type: list
cluster_subnet_group_name:
aliases:
- subnet
description:
- Which subnet to place the cluster.
type: str
skip_final_cluster_snapshot:
aliases:
- skip_final_snapshot
default: false
description:
- Skip a final snapshot before deleting the cluster.
- Used only when I(command=delete).
type: bool
cluster_parameter_group_name:
aliases:
- param_group_name
description:
- Name of the cluster parameter group.
type: str
debug_botocore_endpoint_logs:
default: false
description:
- Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action")
API calls made during a task, outputing the set to the resource_actions key in the
task results. Use the C(aws_resource_action) callback to output to total list made
during a playbook.
- The C(ANSIBLE_DEBUG_BOTOCORE_LOGS) environment variable may also be used.
type: bool
preferred_maintenance_window:
aliases:
- maintance_window
- maint_window
description:
- 'Maintenance window in format of C(ddd:hh24:mi-ddd:hh24:mi). (Example: C(Mon:22:00-Mon:23:15))'
- Times are specified in UTC.
- If not specified then a random 30 minute maintenance window is assigned.
type: str
final_cluster_snapshot_identifier:
aliases:
- final_snapshot_id
description:
- Identifier of the final snapshot to be created before deleting the cluster.
- If this parameter is provided, I(skip_final_cluster_snapshot) must be C(false).
- Used only when I(command=delete).
type: str
automated_snapshot_retention_period:
aliases:
- retention_period
description:
- The number of days that automated snapshots are retained.
type: int
cluster:
contains:
availability_zone:
description: Amazon availability zone where the cluster is located. "None" until
cluster is available.
returned: success
sample: us-east-1b
type: str
create_time:
description: Time of the cluster creation as timestamp.
returned: success
sample: 1430158536.308
type: float
db_name:
description: Name of the database.
returned: success
sample: new_db_name
type: str
enhanced_vpc_routing:
description: status of the enhanced vpc routing feature.
returned: success
type: bool
identifier:
description: Id of the cluster.
returned: success
sample: new_redshift_cluster
type: str
maintenance_window:
description: Time frame when maintenance/upgrade are done.
returned: success
sample: sun:09:30-sun:10:00
type: str
port:
description: Port of the cluster. "None" until cluster is available.
returned: success
sample: 5439
type: int
private_ip_address:
description: Private IP address of the main node.
returned: success
sample: 10.10.10.10
type: str
public_ip_address:
description: Public IP address of the main node. "None" when enhanced_vpc_routing
is enabled.
returned: success
sample: 0.0.0.0
type: str
status:
description: Status of the cluster.
returned: success
sample: available
type: str
url:
description: FQDN of the main cluster node. "None" until cluster is available.
returned: success
sample: new-redshift_cluster.jfkdjfdkj.us-east-1.redshift.amazonaws.com
type: str
description: dictionary containing all the cluster information
returned: success
type: complex