You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.aws.redshift_info module – Gather information about Redshift cluster(s)

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_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.16.0
botocore >= 1.19.0

Parameters 

Parameter	Comments
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. 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.
aws_ca_bundle path	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.
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. 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.
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. 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.
cluster_identifier aliases: name, identifier string	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.
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`
ec2_url aliases: aws_endpoint_url, endpoint_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.
profile aliases: aws_profile string	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.
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. 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.
tags dictionary	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.
validate_certs boolean	When set to “no”, SSL certificates will not be validated for communication with the AWS APIs. Choices: `false` `true` ← (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 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.
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 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 

# 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
allow_version_upgrade boolean	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: `"true\|false"`
automated_snapshot_retention_period integer	The number of days that automatic cluster snapshots are retained. Returned: success Sample: `1`
availability_zone string	The name of the Availability Zone in which the cluster is located. Returned: success Sample: `"us-east-1b"`
cluster_create_time string	The date and time that the cluster was created. Returned: success Sample: `"2016-05-10T08:33:16.629000+00:00"`
cluster_identifier string	Unique key to identify the cluster. Returned: success Sample: `"redshift-identifier"`
cluster_nodes list / elements=string	The nodes in the cluster. Returned: success Sample: `[{"node_role": "LEADER", "private_ip_address": "10.0.0.1", "public_ip_address": "x.x.x.x"}, {"node_role": "COMPUTE-1", "private_ip_address": "10.0.0.3", "public_ip_address": "x.x.x.x"}]`
cluster_paramater_groups list / elements=string	The list of cluster parameters that are associated with this cluster. Returned: success Sample: `[{"cluster_parameter_status_list": [{"parameter_apply_status": "in-sync", "parameter_name": "statement_timeout"}, {"parameter_apply_status": "in-sync", "parameter_name": "require_ssl"}], "parameter_apply_status": "in-sync", "parameter_group_name": "tuba"}]`
cluster_public_keys string	The public key for the cluster. Returned: success Sample: `"ssh-rsa anjigfam Amazon-Redshift "`
cluster_revision_number string	The specific revision number of the database in the cluster. Returned: success Sample: `"1231"`
cluster_security_groups list / elements=string	A list of cluster security groups that are associated with the cluster. Returned: success Sample: `[]`
cluster_snapshot_copy_status dictionary	A value that returns the destination region and retention period that are configured for cross-region snapshot copy. Returned: success Sample: `{}`
cluster_status string	Current state of the cluster. Returned: success Sample: `"available"`
cluster_subnet_group_name string	The name of the subnet group that is associated with the cluster. Returned: success Sample: `"redshift-subnet"`
cluster_version string	The version ID of the Amazon Redshift engine that is running on the cluster. Returned: success Sample: `"1.0"`
db_name string	The name of the initial database that was created when the cluster was created. Returned: success Sample: `"dev"`
elastic_ip_status dictionary	The status of the elastic IP (EIP) address. Returned: success Sample: `{}`
encrypted boolean	Boolean value that, if true , indicates that data in the cluster is encrypted at rest. Returned: success Sample: `"true\|false"`
endpoint string	The connection endpoint. Returned: success Sample: `"{'address': 'cluster-ds2.ocmugla0rf.us-east-1.redshift.amazonaws.com', 'port': 5439}"`
enhanced_vpc_routing boolean	An option that specifies whether to create the cluster with enhanced VPC routing enabled. Returned: success Sample: `"true\|false"`
hsm_status dictionary	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: `{}`
iam_roles list / elements=string	List of IAM roles attached to the cluster. Returned: success Sample: `[]`
kms_key_id string	The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster. Returned: success Sample: `""`
master_username string	The master user name for the cluster. Returned: success Sample: `"admin"`
modify_status string	The status of a modify operation. Returned: optional Sample: `""`
node_type string	The node type for nodes in the cluster. Returned: success Sample: `"ds2.xlarge"`
number_of_nodes integer	The number of compute nodes in the cluster. Returned: success Sample: `12`
pending_modified_values dictionary	A value that, if present, indicates that changes to the cluster are pending. Returned: success Sample: `{}`
preferred_maintenance_window string	The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur. Returned: success Sample: `"tue:07:30-tue:08:00"`
publicly_accessible boolean	A Boolean value that, if true , indicates that the cluster can be accessed from a public network. Returned: success Sample: `"true\|false"`
restore_status dictionary	A value that describes the status of a cluster restore action. Returned: success Sample: `{}`
tags list / elements=string	The list of tags for the cluster. Returned: success Sample: `[]`
vpc_id string	The identifier of the VPC the cluster is in, if the cluster is in a VPC. Returned: success Sample: `"vpc-1234567"`
vpc_security_groups list / elements=string	A list of VPC security groups the are associated with the cluster. Returned: success Sample: `[{"status": "active", "vpc_security_group_id": "sg-12cghhg"}]`

Authors

Jens Carl (@j-carl)

Collection links

Issue Tracker Repository (Sources) Communication

community.aws.redshift_info module – Gather information about Redshift cluster(s)

Synopsis

Requirements

Parameters

Notes

Examples

Return Values