Redshift Cluster

An Amazon Redshift Cluster is a fully managed data warehouse that allows you to run complex analytical queries on large datasets. It consists of one or more compute nodes and a leader node that coordinates query execution and data distribution. Redshift clusters are designed for high performance, scalability, and integration with other AWS services, making them suitable for business intelligence, reporting, and big data analytics.

aws.redshift_cluster

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
allow_version_upgradecoreboolA boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.
aqua_configurationcorejsonThis field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
automated_snapshot_retention_periodcoreint64The number of days that automatic cluster snapshots are retained.
availability_zonecorestringThe name of the Availability Zone in which the cluster is located.
availability_zone_relocation_statuscorestringDescribes the status of the Availability Zone relocation operation.
cluster_availability_statuscorestringThe 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.
cluster_create_timecoretimestampThe date and time that the cluster was created.
cluster_identifiercorestringThe unique identifier of the cluster.
cluster_loggingcorejson
cluster_namespace_arncorestringThe namespace Amazon Resource Name (ARN) of the cluster.
cluster_nodescorejsonThe nodes in the cluster.
cluster_parameter_groupscorejsonThe list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
cluster_revision_numbercorestringThe specific revision number of the database in the cluster.
cluster_security_groupscorejsonA 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.
cluster_snapshot_copy_statuscorejsonA value that returns the destination region and retention period that are configured for cross-region snapshot copy.
cluster_statuscorestringThe 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
cluster_subnet_group_namecorestringThe name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
cluster_versioncorestringThe version ID of the Amazon Redshift engine that is running on the cluster.
custom_domain_certificate_arncorestringThe certificate Amazon Resource Name (ARN) for the custom domain name.
custom_domain_certificate_expiry_datecoretimestampThe expiration date for the certificate associated with the custom domain name.
custom_domain_namecorestringThe custom domain name associated with the cluster.
data_transfer_progresscorejson<p/>
db_namecorestringThe 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.
default_iam_role_arncorestringThe Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
deferred_maintenance_windowscorejsonDescribes a group of DeferredMaintenanceWindow objects.
elastic_ip_statuscorejsonThe status of the elastic IP (EIP) address.
elastic_resize_number_of_node_optionscorestringThe number of nodes that you can resize the cluster to with the elastic resize method.
encryptedcoreboolA boolean value that, if true, indicates that data in the cluster is encrypted at rest.
endpointcorejsonThe connection endpoint.
endpoint_access_listcorejsonThe list of endpoints with access to the cluster.
enhanced_vpc_routingcoreboolAn 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
expected_next_snapshot_schedule_timecoretimestampThe date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
expected_next_snapshot_schedule_time_statuscorestringThe status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following: OnTrack - The next snapshot is expected to be taken on time. Pending - The next snapshot is pending to be taken.
hsm_statuscorejsonA 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
iam_rolescorejsonA list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
ip_address_typecorestringThe IP address type for the cluster. Possible values are ipv4 and dualstack.
kms_key_idcorestringThe Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
maintenance_track_namecorestringThe name of the maintenance track for the cluster.
manual_snapshot_retention_periodcoreint64The 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.
master_password_secret_arncorestringThe Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
master_password_secret_kms_key_idcorestringThe ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
master_usernamecorestringThe admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
modify_statuscorestringThe status of a modify operation, if any, initiated for the cluster.
multi_azcorestringA boolean value that, if true, indicates that the cluster is deployed in two Availability Zones.
multi_az_secondarycorejsonThe secondary compute unit of a cluster, if Multi-AZ deployment is turned on.
next_maintenance_window_start_timecoretimestampThe date and time in UTC when system maintenance can begin.
node_typecorestringThe node type for the nodes in the cluster.
number_of_nodescoreint64The number of compute nodes in the cluster.
parameterscorejsonA list of Parameter instances. Each instance lists the parameters of one cluster parameter group.
pending_actionscorearray<string>Cluster operations that are waiting to be started.
pending_modified_valuescorejsonA value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
preferred_maintenance_windowcorestringThe weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
publicly_accessiblecoreboolA boolean value that, if true, indicates that the cluster can be accessed from a public network. Default: false
redshift_cluster_arncorestring
reserved_node_exchange_statuscorejsonThe status of the reserved-node exchange request. Statuses include in-progress and requested.
resize_infocorejsonReturns the following: AllowCancelResize: a boolean value indicating if the resize operation can be cancelled. ResizeType: Returns ClassicResize
restore_statuscorejsonA value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.
snapshot_schedule_identifiercorestringA unique identifier for the cluster snapshot schedule.
snapshot_schedule_statecorestringThe current state of the cluster snapshot schedule.
tagscorehstore
total_storage_capacity_in_mega_bytescoreint64The total storage capacity of the cluster in megabytes.
vpc_idcorestringThe identifier of the VPC the cluster is in, if the cluster is in a VPC.
vpc_security_groupscorejsonA 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.