| Column Name | Column Data Type |
|---|
cluster_identifier Input Column
The unique identifier of the cluster. | VARCHAR |
tag_keys Input Column
A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. | VARCHAR[] |
Show child fields- tag_keys[]
|
tag_values Input Column
A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. | VARCHAR[] |
Show child fields- tag_values[]
|
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
Show child fields- _aws_profile.account_id
The AWS account id - _aws_profile.assumed_role_arn
The ARN of the assumed role - _aws_profile.name
The unique name of the profile. - _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization - _aws_profile.organization.id
The organization id - _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address - _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent - _aws_profile.organization.parents[].name
The name of the parent - _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role' - _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
_aws_region Input Column
The AWS region to use. | VARCHAR |
allow_version_upgrade
A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window. | BOOLEAN |
aqua_configuration
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator). | STRUCT(
"aqua_status" VARCHAR,
"aqua_configuration_status" VARCHAR
) |
Show child fields- aqua_configuration.aqua_configuration_status
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator). - aqua_configuration.aqua_status
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
|
automated_snapshot_retention_period
The number of days that automatic cluster snapshots are retained. | BIGINT |
availability_zone
The name of the Availability Zone in which the cluster is located. | VARCHAR |
availability_zone_relocation_status
Describes the status of the Availability Zone relocation operation. | VARCHAR |
cluster_availability_status
The availability status of the cluster for queries. Possible values are the following: -
Available - The cluster is available for queries. -
Unavailable - The cluster is not available for queries. -
Maintenance - The cluster is intermittently available for queries due to maintenance activities. -
Modifying - The cluster is intermittently available for queries due to changes that modify the cluster. -
Failed - The cluster failed and is not available for queries. | VARCHAR |
cluster_create_time
The date and time that the cluster was created. | TIMESTAMP_S |
cluster_namespace_arn
The namespace Amazon Resource Name (ARN) of the cluster. | VARCHAR |
cluster_nodes
The nodes in the cluster. | STRUCT(
"node_role" VARCHAR,
"private_ip_address" VARCHAR,
"public_ip_address" VARCHAR
)[] |
Show child fields- cluster_nodes[]
Show child fields- cluster_nodes[].node_role
Whether the node is a leader node or a compute node. - cluster_nodes[].private_ip_address
The private IP address of a node within a cluster. - cluster_nodes[].public_ip_address
The public IP address of a node within a cluster.
|
cluster_parameter_groups
The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status. | STRUCT(
"parameter_group_name" VARCHAR,
"parameter_apply_status" VARCHAR,
"cluster_parameter_status_list" STRUCT(
"parameter_name" VARCHAR,
"parameter_apply_status" VARCHAR,
"parameter_apply_error_description" VARCHAR
)[]
)[] |
Show child fields- cluster_parameter_groups[]
Show child fields- cluster_parameter_groups[].cluster_parameter_status_list[]
Show child fields- cluster_parameter_groups[].cluster_parameter_status_list[].parameter_apply_error_description
The error that prevented the parameter from being applied to the database. - cluster_parameter_groups[].cluster_parameter_status_list[].parameter_apply_status
The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied. The following are possible statuses and descriptions. -
in-sync: The parameter value is in sync with the database. -
pending-reboot: The parameter value will be applied after the cluster reboots. -
applying: The parameter value is being applied to the database. -
invalid-parameter: Cannot apply the parameter value because it has an invalid value or syntax. -
apply-deferred: The parameter contains static property changes. The changes are deferred until the cluster reboots. -
apply-error: Cannot connect to the cluster. The parameter change will be applied after the cluster reboots. -
unknown-error: Cannot apply the parameter change right now. The change will be applied after the cluster reboots. - cluster_parameter_groups[].cluster_parameter_status_list[].parameter_name
The name of the parameter.
- cluster_parameter_groups[].parameter_apply_status
The status of parameter updates. - cluster_parameter_groups[].parameter_group_name
The name of the cluster parameter group.
|
cluster_public_key
The public key for the cluster. | VARCHAR |
cluster_revision_number
The specific revision number of the database in the cluster. | VARCHAR |
cluster_security_groups
A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements. Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter. | STRUCT(
"cluster_security_group_name" VARCHAR,
"status" VARCHAR
)[] |
Show child fields- cluster_security_groups[]
Show child fields- cluster_security_groups[].cluster_security_group_name
The name of the cluster security group. - cluster_security_groups[].status
The status of the cluster security group.
|
cluster_snapshot_copy_status
A value that returns the destination region and retention period that are configured for cross-region snapshot copy. | STRUCT(
"destination_region" VARCHAR,
"retention_period" BIGINT,
"manual_snapshot_retention_period" BIGINT,
"snapshot_copy_grant_name" VARCHAR
) |
Show child fields- cluster_snapshot_copy_status.destination_region
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled. - cluster_snapshot_copy_status.manual_snapshot_retention_period
The number of days that automated snapshots are retained in the destination region after they are copied from a source 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. - cluster_snapshot_copy_status.retention_period
The number of days that automated snapshots are retained in the destination region after they are copied from a source region. - cluster_snapshot_copy_status.snapshot_copy_grant_name
The name of the snapshot copy grant.
|
cluster_status
The current state of the cluster. Possible values are the following: -
available -
available, prep-for-resize -
available, resize-cleanup -
cancelling-resize -
creating -
deleting -
final-snapshot -
hardware-failure -
incompatible-hsm -
incompatible-network -
incompatible-parameters -
incompatible-restore -
modifying -
paused -
rebooting -
renaming -
resizing -
rotating-keys -
storage-full -
updating-hsm | VARCHAR |
cluster_subnet_group_name
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC. | VARCHAR |
cluster_version
The version ID of the Amazon Redshift engine that is running on the cluster. | VARCHAR |
custom_domain_certificate_arn
The certificate Amazon Resource Name (ARN) for the custom domain name. | VARCHAR |
custom_domain_certificate_expiry_date
The expiration date for the certificate associated with the custom domain name. | TIMESTAMP_S |
custom_domain_name
The custom domain name associated with the cluster. | VARCHAR |
data_transfer_progress
| STRUCT(
"status" VARCHAR,
"current_rate_in_mega_bytes_per_second" DOUBLE,
"total_data_in_mega_bytes" BIGINT,
"data_transferred_in_mega_bytes" BIGINT,
"estimated_time_to_completion_in_seconds" BIGINT,
"elapsed_time_in_seconds" BIGINT
) |
Show child fields- data_transfer_progress.current_rate_in_mega_bytes_per_second
Describes the data transfer rate in MB's per second. - data_transfer_progress.data_transferred_in_mega_bytes
Describes the total amount of data that has been transfered in MB's. - data_transfer_progress.elapsed_time_in_seconds
Describes the number of seconds that have elapsed during the data transfer. - data_transfer_progress.estimated_time_to_completion_in_seconds
Describes the estimated number of seconds remaining to complete the transfer. - data_transfer_progress.status
Describes the status of the cluster. While the transfer is in progress the status is transferringdata. - data_transfer_progress.total_data_in_mega_bytes
Describes the total amount of data to be transfered in megabytes.
|
db_name
The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default. | VARCHAR |
default_iam_role_arn
The Amazon Resource Name (ARN) for the IAM role set as default for the cluster. | VARCHAR |
deferred_maintenance_windows
Describes a group of DeferredMaintenanceWindow objects. | STRUCT(
"defer_maintenance_identifier" VARCHAR,
"defer_maintenance_start_time" TIMESTAMP_S,
"defer_maintenance_end_time" TIMESTAMP_S
)[] |
Show child fields- deferred_maintenance_windows[]
Show child fields- deferred_maintenance_windows[].defer_maintenance_end_time
A timestamp for the end of the time period when we defer maintenance. - deferred_maintenance_windows[].defer_maintenance_identifier
A unique identifier for the maintenance window. - deferred_maintenance_windows[].defer_maintenance_start_time
A timestamp for the beginning of the time period when we defer maintenance.
|
elastic_ip_status
The status of the elastic IP (EIP) address. | STRUCT(
"elastic_ip" VARCHAR,
"status" VARCHAR
) |
Show child fields- elastic_ip_status.elastic_ip
The elastic IP (EIP) address for the cluster. - elastic_ip_status.status
The status of the elastic IP (EIP) address.
|
elastic_resize_number_of_node_options
The number of nodes that you can resize the cluster to with the elastic resize method. | VARCHAR |
encrypted
A boolean value that, if true, indicates that data in the cluster is encrypted at rest. | BOOLEAN |
endpoint
The connection endpoint. | STRUCT(
"address" VARCHAR,
"port" BIGINT,
"vpc_endpoints" STRUCT(
"vpc_endpoint_id" VARCHAR,
"vpc_id" VARCHAR,
"network_interfaces" STRUCT(
"network_interface_id" VARCHAR,
"subnet_id" VARCHAR,
"private_ip_address" VARCHAR,
"availability_zone" VARCHAR,
"ipv6_address" VARCHAR
)[]
)[]
) |
Show child fields- endpoint.address
The DNS address of the Cluster. - endpoint.port
The port that the database engine is listening on. - endpoint.vpc_endpoints[]
Show child fields- endpoint.vpc_endpoints[].network_interfaces[]
Show child fields- endpoint.vpc_endpoints[].network_interfaces[].availability_zone
The Availability Zone. - endpoint.vpc_endpoints[].network_interfaces[].ipv6_address
The IPv6 address of the network interface within the subnet. - endpoint.vpc_endpoints[].network_interfaces[].network_interface_id
The network interface identifier. - endpoint.vpc_endpoints[].network_interfaces[].private_ip_address
The IPv4 address of the network interface within the subnet. - endpoint.vpc_endpoints[].network_interfaces[].subnet_id
The subnet identifier.
- endpoint.vpc_endpoints[].vpc_endpoint_id
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy. - endpoint.vpc_endpoints[].vpc_id
The VPC identifier that the endpoint is associated.
|
enhanced_vpc_routing
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 | BOOLEAN |
expected_next_snapshot_schedule_time
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled. | TIMESTAMP_S |
expected_next_snapshot_schedule_time_status
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following: | VARCHAR |
hsm_status
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. Values: active, applying | STRUCT(
"hsm_client_certificate_identifier" VARCHAR,
"hsm_configuration_identifier" VARCHAR,
"status" VARCHAR
) |
Show child fields- hsm_status.hsm_client_certificate_identifier
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. - hsm_status.hsm_configuration_identifier
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. - hsm_status.status
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command. Values: active, applying
|
iam_roles
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. | STRUCT(
"iam_role_arn" VARCHAR,
"apply_status" VARCHAR
)[] |
Show child fields- iam_roles[]
Show child fields- iam_roles[].apply_status
A value that describes the status of the IAM role's association with an Amazon Redshift cluster. The following are possible statuses and descriptions. -
in-sync: The role is available for use by the cluster. -
adding: The role is in the process of being associated with the cluster. -
removing: The role is in the process of being disassociated with the cluster. - iam_roles[].iam_role_arn
The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload.
|
ip_address_type
The IP address type for the cluster. Possible values are ipv4 and dualstack. | VARCHAR |
kms_key_id
The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster. | VARCHAR |
maintenance_track_name
The name of the maintenance track for the cluster. | VARCHAR |
manual_snapshot_retention_period
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots. The value must be either -1 or an integer between 1 and 3,653. | BIGINT |
master_password_secret_arn
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret. | VARCHAR |
master_password_secret_kms_key_id
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. | VARCHAR |
master_username
The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter. | VARCHAR |
modify_status
The status of a modify operation, if any, initiated for the cluster. | VARCHAR |
multi_az
A boolean value that, if true, indicates that the cluster is deployed in two Availability Zones. | VARCHAR |
multi_az_secondary
The secondary compute unit of a cluster, if Multi-AZ deployment is turned on. | STRUCT(
"availability_zone" VARCHAR,
"cluster_nodes" STRUCT(
"node_role" VARCHAR,
"private_ip_address" VARCHAR,
"public_ip_address" VARCHAR
)[]
) |
Show child fields- multi_az_secondary.availability_zone
The name of the Availability Zone in which the secondary compute unit of the cluster is located. - multi_az_secondary.cluster_nodes[]
Show child fields- multi_az_secondary.cluster_nodes[].node_role
Whether the node is a leader node or a compute node. - multi_az_secondary.cluster_nodes[].private_ip_address
The private IP address of a node within a cluster. - multi_az_secondary.cluster_nodes[].public_ip_address
The public IP address of a node within a cluster.
|
next_maintenance_window_start_time
The date and time in UTC when system maintenance can begin. | TIMESTAMP_S |
node_type
The node type for the nodes in the cluster. | VARCHAR |
number_of_nodes
The number of compute nodes in the cluster. | BIGINT |
pending_actions
Cluster operations that are waiting to be started. | VARCHAR[] |
Show child fields- pending_actions[]
|
pending_modified_values
A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements. | STRUCT(
"master_user_password" VARCHAR,
"node_type" VARCHAR,
"number_of_nodes" BIGINT,
"cluster_type" VARCHAR,
"cluster_version" VARCHAR,
"automated_snapshot_retention_period" BIGINT,
"cluster_identifier" VARCHAR,
"publicly_accessible" BOOLEAN,
"enhanced_vpc_routing" BOOLEAN,
"maintenance_track_name" VARCHAR,
"encryption_type" VARCHAR
) |
Show child fields- pending_modified_values.automated_snapshot_retention_period
The pending or in-progress change of the automated snapshot retention period. - pending_modified_values.cluster_identifier
The pending or in-progress change of the new identifier for the cluster. - pending_modified_values.cluster_type
The pending or in-progress change of the cluster type. - pending_modified_values.cluster_version
The pending or in-progress change of the service version. - pending_modified_values.encryption_type
The encryption type for a cluster. Possible values are: KMS and None. - pending_modified_values.enhanced_vpc_routing
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 - pending_modified_values.maintenance_track_name
The name of the maintenance track that the cluster will change to during the next maintenance window. - pending_modified_values.master_user_password
The pending or in-progress change of the admin user password for the cluster. - pending_modified_values.node_type
The pending or in-progress change of the cluster's node type. - pending_modified_values.number_of_nodes
The pending or in-progress change of the number of nodes in the cluster. - pending_modified_values.publicly_accessible
The pending or in-progress change of the ability to connect to the cluster from the public network.
|
preferred_maintenance_window
The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur. | VARCHAR |
publicly_accessible
A boolean value that, if true, indicates that the cluster can be accessed from a public network. | BOOLEAN |
reserved_node_exchange_status
The status of the reserved-node exchange request. Statuses include in-progress and requested. | STRUCT(
"reserved_node_exchange_request_id" VARCHAR,
"status" VARCHAR,
"request_time" TIMESTAMP_S,
"source_reserved_node_id" VARCHAR,
"source_reserved_node_type" VARCHAR,
"source_reserved_node_count" BIGINT,
"target_reserved_node_offering_id" VARCHAR,
"target_reserved_node_type" VARCHAR,
"target_reserved_node_count" BIGINT
) |
Show child fields- reserved_node_exchange_status.request_time
A date and time that indicate when the reserved-node exchange was requested. - reserved_node_exchange_status.reserved_node_exchange_request_id
The identifier of the reserved-node exchange request. - reserved_node_exchange_status.source_reserved_node_count
The source reserved-node count in the cluster. - reserved_node_exchange_status.source_reserved_node_id
The identifier of the source reserved node. - reserved_node_exchange_status.source_reserved_node_type
The source reserved-node type, for example ra3.4xlarge. - reserved_node_exchange_status.status
The status of the reserved-node exchange request. Statuses include in-progress and requested. - reserved_node_exchange_status.target_reserved_node_count
The count of target reserved nodes in the cluster. - reserved_node_exchange_status.target_reserved_node_offering_id
The identifier of the target reserved node offering. - reserved_node_exchange_status.target_reserved_node_type
The node type of the target reserved node, for example ra3.4xlarge.
|
resize_info
Returns the following: | STRUCT(
"resize_type" VARCHAR,
"allow_cancel_resize" BOOLEAN
) |
Show child fields- resize_info.allow_cancel_resize
A boolean value indicating if the resize operation can be cancelled. - resize_info.resize_type
Returns the value ClassicResize.
|
restore_status
A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot. | STRUCT(
"status" VARCHAR,
"current_restore_rate_in_mega_bytes_per_second" DOUBLE,
"snapshot_size_in_mega_bytes" BIGINT,
"progress_in_mega_bytes" BIGINT,
"elapsed_time_in_seconds" BIGINT,
"estimated_time_to_completion_in_seconds" BIGINT
) |
Show child fields- restore_status.current_restore_rate_in_mega_bytes_per_second
The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 node types. - restore_status.elapsed_time_in_seconds
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 node types. - restore_status.estimated_time_to_completion_in_seconds
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 node types. - restore_status.progress_in_mega_bytes
The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 node types. - restore_status.snapshot_size_in_mega_bytes
The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 node types. - restore_status.status
The status of the restore action. Returns starting, restoring, completed, or failed.
|
snapshot_schedule_identifier
A unique identifier for the cluster snapshot schedule. | VARCHAR |
snapshot_schedule_state
The current state of the cluster snapshot schedule. | VARCHAR |
tags
The list of tags for the cluster. | STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[] |
Show child fields- tags[]
Show child fields- tags[].key
The key, or name, for the resource tag. - tags[].value
The value for the resource tag.
|
total_storage_capacity_in_mega_bytes
The total storage capacity of the cluster in megabytes. | BIGINT |
vpc_id
The identifier of the VPC the cluster is in, if the cluster is in a VPC. | VARCHAR |
vpc_security_groups
A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC. | STRUCT(
"vpc_security_group_id" VARCHAR,
"status" VARCHAR
)[] |
Show child fields- vpc_security_groups[]
Show child fields- vpc_security_groups[].status
The status of the VPC security group. - vpc_security_groups[].vpc_security_group_id
The identifier of the VPC security group.
|