amazon.cloud.redshift_cluster module – Create and manage clusters

Note

This module is part of the amazon.cloud collection (version 0.4.0).

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 amazon.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: amazon.cloud.redshift_cluster.

New in amazon.cloud 0.1.0

Synopsis

  • Creates and manage clusters.

Requirements

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

  • python >= 3.9

  • boto3 >= 1.25.0

  • botocore >= 1.28.0

  • jsonpatch

Parameters

Parameter

Comments

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

AWS access key ID.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variables may also be used in decreasing order of preference.

The aws_access_key and profile options are mutually exclusive.

The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK.

The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_ACCESS_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

allow_version_upgrade

boolean

Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

Default value is True.

Choices:

  • false

  • true

aqua_configuration_status

string

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored.

Possible values include the following.

enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type.

disabled - Dont use AQUA.

auto - Amazon Redshift determines whether to use AQUA.

automated_snapshot_retention_period

integer

The number of days that automated snapshots are retained.

If the value is 0, automated snapshots are disabled.

Default value is 1.

availability_zone

string

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster.

Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.

availability_zone_relocation

boolean

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.

Choices:

  • false

  • true

availability_zone_relocation_status

string

The availability zone relocation status of the cluster.

aws_ca_bundle

path

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

The AWS_CA_BUNDLE environment variable may also be used.

aws_config

dictionary

A dictionary to modify the botocore configuration.

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

classic

boolean

A boolean value indicating whether the resize operation is using the classic resize process.

If you dont provide this parameter or set the value to false , the resize type is elastic.

Choices:

  • false

  • true

cluster_identifier

string

A unique identifier for the cluster.

You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying.

All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens.

Cluster name should be unique for all clusters within an AWS account.

cluster_parameter_group_name

string

The name of the parameter group to be associated with this cluster.

cluster_security_groups

list / elements=string

A list of security groups to be associated with this cluster.

cluster_subnet_group_name

string

The name of a cluster subnet group to be associated with this cluster.

cluster_type

string

The type of the cluster.

When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required.

cluster_version

string

The version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster.

db_name

string

The name of the first database to be created when the cluster is created.

To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a 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

defer_maintenance

boolean

A boolean indicating whether to enable the deferred maintenance window.

Choices:

  • false

  • true

defer_maintenance_duration

integer

An integer indicating the duration of the maintenance window in days.

If you specify a duration, you cant specify an end time.

The duration must be 45 days or less.

defer_maintenance_end_time

string

A timestamp indicating end time for the deferred maintenance window.

If you specify an end time, you cant specify a duration.

defer_maintenance_start_time

string

A timestamp indicating the start time for the deferred maintenance window.

destination_region

string

The destination AWS Region that you want to copy snapshots to.

Constraints: Must be the name of a valid AWS Region.

For more information, see Regions and Endpoints in the Amazon Web Services ) General Reference.

elastic_ip

string

The Elastic IP (EIP) address for the cluster.

encrypted

boolean

If true, the data in the cluster is encrypted at rest.

Choices:

  • false

  • true

endpoint

dictionary

Not Provived.

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

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 AWS_URL or EC2_URL environment variables may also be used, in decreasing order of preference.

The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_URL environment variable has been deprecated and will be removed in a release after 2024-12-01.

enhanced_vpc_routing

boolean

An option that specifies whether to create the cluster with enhanced VPC routing enabled.

To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

If this option is true , enhanced VPC routing is enabled.

Default: false.

Choices:

  • false

  • true

force

boolean

Cancel IN_PROGRESS and PENDING resource requestes.

Because you can only perform a single operation on a given resource at a time, there might be cases where you need to cancel the current resource operation to make the resource available so that another operation may be performed on it.

Choices:

  • false ← (default)

  • true

hsm_client_certificate_identifier

string

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

hsm_configuration_identifier

string

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.

iam_roles

list / elements=string

A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.

You must supply the IAM roles in their Amazon Resource Name (ARN) format.

You can supply up to 50 IAM roles in a single request.

kms_key_id

string

The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

logging_properties

dictionary

Not Provived.

bucket_name

string

Not Provived.

s3_key_prefix

string

Not Provived.

maintenance_track_name

string

The name for the maintenance track that you want to assign for the cluster.

This name change is asynchronous.

The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window.

When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track.

At this point, the maintenance track name is applied.

manual_snapshot_retention_period

integer

The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region.

If the value is -1, the manual snapshot is retained indefinitely.

The value must be either -1 or an integer between 1 and 3,653.

master_user_password

string

The password associated with the master user account for the cluster that is being created.

Password must be between 8 and 64 characters in length, should have at least one uppercase letter.Must contain at least one lowercase letter.Must contain one number.Can be any printable ASCII character.

master_username

string

The user name associated with the master user account for the cluster that is being created.

The user name cant be PUBLIC and first character must be a letter.

node_type

string

The node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge.

number_of_nodes

integer

The number of compute nodes in the cluster.

This parameter is required when the ClusterType parameter is specified as multi-node.

owner_account

string

Not Provived.

preferred_maintenance_window

string

The weekly time range (in UTC) during which automated cluster maintenance can occur.

profile

aliases: aws_profile

string

A named AWS profile to use for authentication.

See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

The AWS_PROFILE environment variable may also be used.

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

publicly_accessible

boolean

If true, the cluster can be accessed from a public network.

Choices:

  • false

  • true

purge_tags

boolean

Remove tags not listed in tags.

Choices:

  • false

  • true ← (default)

region

aliases: aws_region, ec2_region

string

The AWS region to use.

For global services such as IAM, Route53 and CloudFront, region is ignored.

The AWS_REGION or EC2_REGION environment variables may also be used.

See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

The ec2_region alias has been deprecated and will be removed in a release after 2024-12-01

Support for the EC2_REGION environment variable has been deprecated and will be removed in a release after 2024-12-01.

resource_action

string

The Redshift operation to be performed.

Resource Action supports pause-cluster, resume-cluster APIs.

revision_target

string

The identifier of the database revision.

You can retrieve this value from the response to the DescribeClusterDbRevisions request.

rotate_encryption_key

boolean

A boolean indicating if we want to rotate Encryption Keys.

Choices:

  • false

  • true

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

string

AWS secret access key.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variables may also be used in decreasing order of preference.

The secret_key and profile options are mutually exclusive.

The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK.

The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_SECRET_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

AWS STS session token for use with temporary credentials.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variables may also be used in decreasing order of preference.

The security_token and profile options are mutually exclusive.

Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0.

The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_SECRET_KEY and AWS_SECURITY_TOKEN environment variables has been deprecated and will be removed in a release after 2024-12-01.

snapshot_cluster_identifier

string

The name of the cluster the source snapshot was created from.

This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

snapshot_copy_grant_name

string

The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.

snapshot_copy_manual

boolean

Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

Choices:

  • false

  • true

snapshot_copy_retention_period

integer

The number of days to retain automated snapshots in the destination region after they are copied from the source region.

Default is 7.

Constraints: Must be at least 1 and no more than 35.

snapshot_identifier

string

The name of the snapshot from which to create the new cluster.

This parameter isnt case sensitive.

state

string

Goal state for resource.

state=present creates the resource if it doesn’t exist, or updates to the provided state if the resource already exists.

state=absent ensures an existing instance is deleted.

state=list get all the existing resources.

state=describe or state=get retrieves information on an existing resource.

Choices:

  • "present" ← (default)

  • "absent"

  • "list"

  • "describe"

  • "get"

tags

aliases: resource_tags

dictionary

A dict of tags to apply to the resource.

To remove all tags set tags={} and purge_tags=true.

validate_certs

boolean

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

Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead.

Choices:

  • false

  • true ← (default)

vpc_security_group_ids

list / elements=string

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

wait

boolean

Wait for operation to complete before returning.

Choices:

  • false ← (default)

  • true

wait_timeout

integer

How many seconds to wait for an operation to complete before timing out.

Default: 320

Notes

Note

  • Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.

  • The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.

Examples

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

result

complex

When state=list, it is a list containing dictionaries of resource information.

Otherwise, it is a dictionary of resource information.

When state=absent, it is an empty dictionary.

Returned: always

identifier

string

The unique identifier of the resource.

Returned: success

properties

dictionary

The resource properties.

Returned: success

Authors

  • Ansible Cloud Team (@ansible-collections)