Skip to content

Redshift Cluster Data Model Documentation

Table of Contents

Top

protos/clouddb/wire/aws/redshift/cluster.proto

RedshiftClusterSettings

Field Type Label Description
allow_version_upgrade bool A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.
automated_snapshot_retention_period int32 The number of days that automatic cluster snapshots are retained.
availability_zone string The name of the Availability Zone in which the cluster is located.
cluster_availability_status RedshiftClusterSettings.ClusterAvailabilityStatus The availability status of the cluster for queries
cluster_create_time google.protobuf.Timestamp The date and time that the cluster was created.
cluster_identifier string The unique identifier of the cluster.
cluster_nodes RedshiftClusterSettings.ClusterNode repeated The nodes in the cluster.
cluster_parameter_groups RedshiftClusterSettings.ClusterParameterGroupStatus repeated The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
cluster_public_key string The public key for the cluster.
cluster_revision_number string The specific revision number of the database in the cluster.
cluster_security_groups RedshiftClusterSettings.ClusterSecurityGroupMembership repeated 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. | | cluster_snapshot_copy_status | RedshiftClusterSettings.ClusterSnapshotCopyStatus | | A value that returns the destination region and retention period that are configured for cross-region snapshot copy. | | cluster_status | RedshiftClusterSettings.ClusterStatus | | The current state of the cluster. | | cluster_subnet_group_name | string | | The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC. | | cluster_version | string | | The version ID of the Amazon Redshift engine that is running on the cluster. | | data_transfer_progress | RedshiftClusterSettings.DataTransferProgress | | | | db_name | string | | 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. | | deferred_maintenance_windows | RedshiftClusterSettings.DeferredMaintenanceWindow | repeated | | | elastic_ip_status | RedshiftClusterSettings.ElasticIpStatus | | The status of the elastic IP (EIP) address. | | elastic_resize_number_of_node_options | string | | The number of nodes that you can resize the cluster to with the elastic resize method. | | encrypted | bool | | A boolean value that, if true, indicates that data in the cluster is encrypted at rest. | | endpoint | RedshiftClusterSettings.Endpoint | | The connection endpoint. | | enhanced_vpc_routing | bool | | 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. | | expected_next_snapshot_schedule_time | google.protobuf.Timestamp | | The 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_status | RedshiftClusterSettings.ExpectedNextSnapshotScheduleTimeStatus | | The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. | | hsm_status | RedshiftClusterSettings.HsmStatus | | 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. | | iam_roles | RedshiftClusterSettings.ClusterIamRole | repeated | A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. | | kms_key_id | string | | The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster. | | maintenance_track_name | string | | The name of the maintenance track for the cluster. | | manual_snapshot_retention_period | int32 | | 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. | | master_username | string | | The master user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter. | | modify_status | string | | The status of a modify operation, if any, initiated for the cluster. | | next_maintenance_window_start_time | google.protobuf.Timestamp | | The date and time in UTC when system maintenance can begin. | | node_type | string | | The node type for the nodes in the cluster. | | number_of_nodes | int32 | | The number of compute nodes in the cluster. | | pending_actions | string | repeated | Cluster operations that are waiting to be started. | | pending_modified_values | RedshiftClusterSettings.PendingModifiedValues | | A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements. | | preferred_maintenance_window | string | | The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur. | | publicly_accessible | bool | | A boolean value that, if true, indicates that the cluster can be accessed from a public network. | | resize_info | RedshiftClusterSettings.ResizeInfo | | | | restore_status | RedshiftClusterSettings.RestoreStatus | | 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. | | snapshot_schedule_identifier | string | | A unique identifier for the cluster snapshot schedule. | | snapshot_schedule_state | RedshiftClusterSettings.SnapshotScheduleState | | The current state of the cluster snapshot schedule. | | tags | Tag | repeated | The list of tags for the cluster. | | vpc_id | string | | The identifier of the VPC the cluster is in, if the cluster is in a VPC. | | vpc_security_groups | RedshiftClusterSettings.VpcSecurityGroupMembership | repeated | |

RedshiftClusterSettings.ClusterIamRole

https://docs.aws.amazon.com/redshift/latest/APIReference/API_ClusterIamRole.html

Field Type Label Description
apply_status RedshiftClusterSettings.ClusterIamRole.ApplyStatus A value that describes the status of the IAM role's association with an Amazon Redshift cluster.
iam_role_arn string The Amazon Resource Name (ARN) of the IAM role

RedshiftClusterSettings.ClusterNode

From: https://docs.aws.amazon.com/redshift/latest/APIReference/API_ClusterNode.html

Field Type Label Description
node_role string Whether the node is a leader node or a compute node.
private_ip_address string The private IP address of a node within a cluster.
public_ip_address string The public IP address of a node within a cluster.

RedshiftClusterSettings.ClusterParameterGroupStatus

From: https://docs.aws.amazon.com/redshift/latest/APIReference/API_ClusterParameterGroupStatus.html

Field Type Label Description
cluster_parameter_status_list RedshiftClusterSettings.ClusterParameterGroupStatus.ClusterParameterStatus repeated The list of parameter statuses.
parameter_apply_status RedshiftClusterSettings.ClusterParameterGroupStatus.ParameterApplyStatus The status of parameter updates.
parameter_group_name string The name of the cluster parameter group.

RedshiftClusterSettings.ClusterParameterGroupStatus.ClusterParameterStatus

Field Type Label Description
parameter_apply_error_description string The error that prevented the parameter from being applied to the database.
parameter_apply_status RedshiftClusterSettings.ClusterParameterGroupStatus.ParameterApplyStatus 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.
parameter_name string The name of the parameter.

RedshiftClusterSettings.ClusterSecurityGroupMembership

https://docs.aws.amazon.com/redshift/latest/APIReference/API_ClusterSecurityGroupMembership.html

Field Type Label Description
cluster_security_group_name string The name of the cluster security group.
status string The status of the cluster security group.

RedshiftClusterSettings.ClusterSnapshotCopyStatus

https://docs.aws.amazon.com/redshift/latest/APIReference/API_ClusterSnapshotCopyStatus.html

Field Type Label Description
destination_region string The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
manual_snapshot_retention_period int32 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.
retention_period int64 The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
snapshot_copy_grant_name string The name of the snapshot copy grant.

RedshiftClusterSettings.DataTransferProgress

https://docs.aws.amazon.com/redshift/latest/APIReference/API_DataTransferProgress.html

Field Type Label Description
current_rate_in_megabytes_per_second double Describes the data transfer rate in MB's per second.
data_transferred_in_megabytes int64 Describes the total amount of data that has been transfered in MB's.
elapsed_time_in_seconds int64 Describes the number of seconds that have elapsed during the data transfer.
estimated_time_to_completion_in_seconds int64 Describes the estimated number of seconds remaining to complete the transfer.
status string Describes the status of the cluster. While the transfer is in progress the status is transferringdata.
total_data_in_megabytes int64 Describes the total amount of data to be transfered in megabytes.

RedshiftClusterSettings.DeferredMaintenanceWindow

https://docs.aws.amazon.com/redshift/latest/APIReference/API_DeferredMaintenanceWindow.html

Field Type Label Description
defer_maintenance_end_time google.protobuf.Timestamp A timestamp for the end of the time period when we defer maintenance.
defer_maintenance_identifier string A unique identifier for the maintenance window.
defer_maintenance_start_time google.protobuf.Timestamp A timestamp for the beginning of the time period when we defer maintenance.

RedshiftClusterSettings.ElasticIpStatus

From: https://docs.aws.amazon.com/redshift/latest/APIReference/API_ElasticIpStatus.html

Field Type Label Description
elastic_ip string The elastic IP (EIP) address for the cluster.
status string The status of the elastic IP (EIP) address.

RedshiftClusterSettings.Endpoint

Field Type Label Description
address string
port int32

RedshiftClusterSettings.HsmStatus

https://docs.aws.amazon.com/redshift/latest/APIReference/API_HsmStatus.html

Field Type Label Description
hsm_client_certificate_identifier string Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
hsm_configuration_identifier string 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.
status RedshiftClusterSettings.HsmStatus.Status Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.

RedshiftClusterSettings.PendingModifiedValues

Field Type Label Description
automated_snapshot_retention_period int32 The pending or in-progress change of the automated snapshot retention period.
cluster_identifier string The pending or in-progress change of the new identifier for the cluster.
cluster_type string The pending or in-progress change of the cluster type.
cluster_version string The pending or in-progress change of the service version.
encryption_type string The encryption type for a cluster. Possible values are: KMS and None. For the China region the possible values are None, and Legacy.
enhanced_vpc_routing bool 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.
maintenance_track_name string The name of the maintenance track that the cluster will change to during the next maintenance window.
master_user_password string The pending or in-progress change of the master user password for the cluster.
node_type string The pending or in-progress change of the cluster's node type.
number_of_nodes int32 The pending or in-progress change of the number of nodes in the cluster.
publicly_accessible bool The pending or in-progress change of the ability to connect to the cluster from the public network.

RedshiftClusterSettings.ResizeInfo

https://docs.aws.amazon.com/redshift/latest/APIReference/API_ResizeInfo.html

Field Type Label Description
allow_cancel_resize bool
resize_type string

RedshiftClusterSettings.RestoreStatus

https://docs.aws.amazon.com/redshift/latest/APIReference/API_RestoreStatus.html

Field Type Label Description
current_restore_rate_in_megabytes_per_second double 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 and DS2 node types.
elapsed_time_in_seconds int64 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 and DS2 node types.
estimated_time_to_completion_in_seconds int64 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 and DS2 node types.
progress_in_megabytes int64 The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.
snapshot_size_in_megabytes int64 The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.
status string The status of the restore action. Returns starting, restoring, completed, or failed.

RedshiftClusterSettings.VpcSecurityGroupMembership

https://docs.aws.amazon.com/redshift/latest/APIReference/API_VpcSecurityGroupMembership.html

Field Type Label Description
status string
vpc_security_group_id string

RedshiftDatabaseInstance

From: https://docs.aws.amazon.com/redshift/latest/APIReference/API_Cluster.html

Field Type Label Description
availability_zone string The name of the Availability Zone in which the cluster is located.
cluster_create_time google.protobuf.Timestamp The date and time that the cluster was created.
cluster_identifier string The unique identifier of the cluster.
cluster_public_key string The public key for the cluster.
db_name string 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.
cluster_subnet_group_name string The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
tags Tag repeated The list of tags for the cluster.
vpc_id string The identifier of the VPC the cluster is in, if the cluster is in a VPC.
kms_key_id string The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.

RedshiftClusterSettings.ClusterAvailabilityStatus

Name Number Description
CLUSTER_STATUS_UNKNOWN 0 enums prefixed with CLUSTER_ due to enum scoping rules
CLUSTER_AVAILABLE 1
CLUSTER_UNAVAILABLE 2
CLUSTER_MAINTENANCE 3
CLUSTER_MODIFYING 4
CLUSTER_FAILED 5

RedshiftClusterSettings.ClusterIamRole.ApplyStatus

Name Number Description
APPLY_STATUS_UNKNOWN 0
APPLY_STATUS_IN_SYNC 1
APPLY_STATUS_ADDING 2
APPLY_STATUS_REMOVING 3

RedshiftClusterSettings.ClusterParameterGroupStatus.ParameterApplyStatus

Name Number Description
UNKNOWN 0
IN_SYNC 1
PENDING_REBOOT 2
APPLYING 3
INVALID_PARAMETER 4
APPLY_DEFERRED 5
APPLY_ERROR 6
UNKNOWN_ERROR 7

RedshiftClusterSettings.ClusterStatus

Name Number Description
UNKNOWN 0
AVAILABLE 1
AVAILABLE_PREP_FOR_RESIZE 2
AVAILABLE_RESIZE_CLEANUP 3
CANCELLING_RESIZE 4
CREATING 5
DELETING 6
FINAL_SNAPSHOT 7
HARDWARE_FAILURE 8
INCOMPATIBLE_HSM 9
INCOMPATIBLE_NETWORK 10
INCOMPATIBLE_PARAMETERS 11
INCOMPATIBLE_RESTORE 12
MODIFYING 13
PAUSED 14
REBOOTING 15
RENAMING 16
RESIZING 17
ROTATING_KEYS 18
STORAGE_FULL 19
UPDATING_HSM 20

RedshiftClusterSettings.ExpectedNextSnapshotScheduleTimeStatus

Name Number Description
STATUS_UNKNOWN 0
ON_TRACK 1
PENDING 2

RedshiftClusterSettings.HsmStatus.Status

Name Number Description
HSM_STATUS_UNKNOWN 0
HSM_STATUS_ACTIVE 1
HSM_STATUS_APPLYING 2

RedshiftClusterSettings.SnapshotScheduleState

Name Number Description
SNAPSHOT_SCHEDULE_UNKNOWN 0 names prefixed with SNAPSHOT because of enum rules
SNAPSHOT_MODIFYING 1
SNAPSHOT_ACTIVE 2
SNAPSHOT_FAILED 3

Scalar Value Types

.proto Type Notes C++ Java Python Go C# PHP Ruby
double double double float float64 double float Float
float float float float float32 float float Float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)