community.aws.redshift_info module – Gather information about Redshift cluster(s)
Note
This module is part of the community.aws collection (version 8.0.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_info
.
New in community.aws 1.0.0
Synopsis
Gather information about Redshift cluster(s).
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0
Parameters
Parameter |
Comments |
---|---|
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 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 |
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
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. |
|
The prefix of cluster identifier of the Redshift cluster you are searching for. This is a regular expression match with implicit ‘^’. Append ‘$’ for a complete match. |
|
Use a The Choices:
|
|
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 The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
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 The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
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 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 |
|
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 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 |
|
A dictionary/hash of tags in the format { tag1_name: ‘tag1_value’, tag2_name: ‘tag2_value’ } to match against the security group(s) you are searching for. |
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
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
# Note: These examples do net set authentication details, see the AWS guide for details.
- name: Find all clusters
community.aws.redshift_info:
register: redshift
- name: Find cluster(s) with matching tags
community.aws.redshift_info:
tags:
env: prd
stack: monitoring
register: redshift_tags
- name: Find cluster(s) with matching name/prefix and tags
community.aws.redshift_info:
tags:
env: dev
stack: web
name: user-
register: redshift_web
- name: Fail if no cluster(s) is/are found
community.aws.redshift_info:
tags:
env: stg
stack: db
register: redshift_user
failed_when: "{{ redshift_user.results | length == 0 }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A Boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window. Returned: success Sample: |
|
The number of days that automatic cluster snapshots are retained. Returned: success Sample: |
|
The name of the Availability Zone in which the cluster is located. Returned: success Sample: |
|
The date and time that the cluster was created. Returned: success Sample: |
|
Unique key to identify the cluster. Returned: success Sample: |
|
The nodes in the cluster. Returned: success Sample: |
|
The list of cluster parameters that are associated with this cluster. Returned: success Sample: |
|
The public key for the cluster. Returned: success Sample: |
|
The specific revision number of the database in the cluster. Returned: success Sample: |
|
A list of cluster security groups that are associated with the cluster. Returned: success Sample: |
|
A value that returns the destination region and retention period that are configured for cross-region snapshot copy. Returned: success Sample: |
|
Current state of the cluster. Returned: success Sample: |
|
The name of the subnet group that is associated with the cluster. Returned: success Sample: |
|
The version ID of the Amazon Redshift engine that is running on the cluster. Returned: success Sample: |
|
The name of the initial database that was created when the cluster was created. Returned: success Sample: |
|
The status of the elastic IP (EIP) address. Returned: success Sample: |
|
Boolean value that, if true , indicates that data in the cluster is encrypted at rest. Returned: success Sample: |
|
The connection endpoint. Returned: success Sample: |
|
An option that specifies whether to create the cluster with enhanced VPC routing enabled. Returned: success Sample: |
|
A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (HSM) settings changes specified in a modify cluster command. Returned: success Sample: |
|
List of IAM roles attached to the cluster. Returned: success Sample: |
|
The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster. Returned: success Sample: |
|
The master user name for the cluster. Returned: success Sample: |
|
The status of a modify operation. Returned: optional Sample: |
|
The node type for nodes in the cluster. Returned: success Sample: |
|
The number of compute nodes in the cluster. Returned: success Sample: |
|
A value that, if present, indicates that changes to the cluster are pending. Returned: success Sample: |
|
The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur. Returned: success Sample: |
|
A Boolean value that, if true , indicates that the cluster can be accessed from a public network. Returned: success Sample: |
|
A value that describes the status of a cluster restore action. Returned: success Sample: |
|
The list of tags for the cluster. Returned: success Sample: |
|
The identifier of the VPC the cluster is in, if the cluster is in a VPC. Returned: success Sample: |
|
A list of VPC security groups the are associated with the cluster. Returned: success Sample: |