Try SpotterGather facts about Redshift cluster(s)
| "added in version" 2.4 of ansible.builtin"
Authors: Jens Carl (@j-carl)
preview | supported by community
pipInstall with pip install ansible==2.4.4.0.post1
Gather facts about Redshift cluster(s)
# Note: These examples do net set authentication details, see the AWS guide for details. # Find all clusters - redshift_facts: register: redshift
# Find cluster(s) with matching tags
- redshift_facts:
tags:
env: prd
stack: monitoring
register: redshift_tags
# Find cluster(s) with matching name/prefix and tags
- redshift_facts:
tags:
env: dev
stack: web
name: user-
register: redshift_web
# Fail if no cluster(s) is/are found
- redshift_facts:
tags:
env: stg
stack: db
register: redshift_user
failed_when: "{{ redshift_user.results | length == 0 }}"
tags:
description:
- '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.'
required: false
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
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. Prior to release 6.0.0
the C(AWS_PROFILE) environment variable will be ignored if any of I(access_key),
I(secret_key), or I(session_token) are passed. After release 6.0.0 I(profile) will
always fall back to the C(AWS_PROFILE) environment variable if set.
- The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
and I(security_token) options.
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. Prior to release 6.0.0 these
environment variables will be ignored if the I(profile) parameter is passed. After
release 6.0.0 I(access_key) will always fall back to the environment variables if
set.
- 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
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. Prior to release
6.0.0 these environment variables will be ignored if the I(profile) parameter is
passed. After release 6.0.0 I(secret_key) will always fall back to the environment
variables if set.
- 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
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
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. Prior to release 6.0.0
these environment variables will be ignored if the I(profile) parameter is passed. After
release 6.0.0 I(session_token) will always fall back to the environment variables
if set.
- 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_identifier:
aliases:
- name
- identifier
description:
- 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.
required: false
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
allow_version_upgrade:
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: true|false
type: boolean
automated_snapshot_retention_period:
description: The number of days that automatic cluster snapshots are retained.
returned: success
sample: 1
type: int
availibility_zone:
description: The name of the Availability Zone in which the cluster is located.
returned: success
sample: us-east-1b
type: string
cluster_create_time:
description: The date and time that the cluster was created.
returned: success
sample: '2016-05-10T08:33:16.629000+00:00'
type: string
cluster_identifier:
description: Unique key to identify the cluster.
returned: success
sample: redshift-identifier
type: string
cluster_nodes:
description: 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
type: list
cluster_paramater_groups:
description: 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
type: list
cluster_public_keys:
description: The public key for the cluster.
returned: success
sample: 'ssh-rsa anjigfam Amazon-Redshift '
type: string
cluster_revision_number:
description: The specific revision number of the database in the cluster.
returned: success
sample: '1231'
type: string
cluster_security_groups:
description: A list of cluster security groups that are associated with the cluster.
returned: success
sample: []
type: list
cluster_snapshot_copy_status:
description: A value that returns the destination region and retention period that
are configured for cross-region snapshot copy.
returned: success
sample: {}
type: dict
cluster_status:
description: Current state of the cluster.
returned: success
sample: available
type: string
cluster_subnet_group_name:
description: The name of the subnet group that is associated with the cluster.
returned: success
sample: redshift-subnet
type: string
cluster_version:
description: The version ID of the Amazon Redshift engine that is running on the
cluster.
returned: success
sample: '1.0'
type: string
db_name:
description: The name of the initial database that was created when the cluster
was created.
returned: success
sample: dev
type: string
elastic_ip_status:
description: The status of the elastic IP (EIP) address.
returned: success
sample: {}
type: dict
encrypted:
description: Boolean value that, if true , indicates that data in the cluster is
encrypted at rest.
returned: success
sample: true|false
type: boolean
endpoint:
description: The connection endpoint.
returned: success
sample:
address: cluster-ds2.ocmugla0rf.us-east-1.redshift.amazonaws.com
port: 5439
type: string
enhanced_vpc_routing:
description: An option that specifies whether to create the cluster with enhanced
VPC routing enabled.
returned: success
sample: true|false
type: boolean
hsm_status:
description: '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: {}
type: dict
iam_roles:
description: List of IAM roles attached to the cluster.
returned: success
sample: []
type: list
kms_key_id:
description: The AWS Key Management Service (AWS KMS) key ID of the encryption key
used to encrypt data in the cluster.
returned: success
sample: ''
type: string
master_username:
description: The master user name for the cluster.
returned: success
sample: admin
type: string
modify_status:
description: The status of a modify operation.
returned: optional
sample: ''
type: string
node_type:
description: The node type for nodes in the cluster.
returned: success
sample: ds2.xlarge
type: string
number_of_nodes:
description: The number of compute nodes in the cluster.
returned: success
sample: 12
type: int
pending_modified_values:
description: A value that, if present, indicates that changes to the cluster are
pending.
returned: success
sample: {}
type: dict
preferred_maintenance_window:
description: The weekly time range, in Universal Coordinated Time (UTC), during
which system maintenance can occur.
returned: success
sample: tue:07:30-tue:08:00
type: string
publicly_accessible:
description: A Boolean value that, if true , indicates that the cluster can be accessed
from a public network.
returned: success
sample: true|false
type: boolean
restore_status:
description: A value that describes the status of a cluster restore action.
returned: success
sample: {}
type: dict
tags:
description: The list of tags for the cluster.
returned: success
sample: []
type: list
vpc_id:
description: The identifier of the VPC the cluster is in, if the cluster is in a
VPC.
returned: success
sample: vpc-1234567
type: string
vpc_security_groups:
description: A list of VPC security groups the are associated with the cluster.
returned: success
sample:
- status: active
vpc_security_group_id: sg-12cghhg
type: list