AwsRedshiftClusterDetails - AWS Security Hub

AwsRedshiftClusterDetails

Details about an Amazon Redshift cluster.

Contents

AllowVersionUpgrade

Indicates whether major version upgrades are applied automatically to the cluster during the maintenance window.

Type: Boolean

Required: No

AutomatedSnapshotRetentionPeriod

The number of days that automatic cluster snapshots are retained.

Type: Integer

Required: No

AvailabilityZone

The name of the Availability Zone in which the cluster is located.

Type: String

Pattern: .*\S.*

Required: No

ClusterAvailabilityStatus

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.

Type: String

Pattern: .*\S.*

Required: No

ClusterCreateTime

Indicates when the cluster was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Type: String

Pattern: .*\S.*

Required: No

ClusterIdentifier

The unique identifier of the cluster.

Type: String

Pattern: .*\S.*

Required: No

ClusterNodes

The nodes in the cluster.

Type: Array of AwsRedshiftClusterClusterNode objects

Required: No

ClusterParameterGroups

The list of cluster parameter groups that are associated with this cluster.

Type: Array of AwsRedshiftClusterClusterParameterGroup objects

Required: No

ClusterPublicKey

The public key for the cluster.

Type: String

Pattern: .*\S.*

Required: No

ClusterRevisionNumber

The specific revision number of the database in the cluster.

Type: String

Pattern: .*\S.*

Required: No

ClusterSecurityGroups

A list of cluster security groups that are associated with the cluster.

Type: Array of AwsRedshiftClusterClusterSecurityGroup objects

Required: No

ClusterSnapshotCopyStatus

Information about the destination Region and retention period for the cross-Region snapshot copy.

Type: AwsRedshiftClusterClusterSnapshotCopyStatus object

Required: No

ClusterStatus

The current status of the cluster.

Valid values: 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

Type: String

Pattern: .*\S.*

Required: No

ClusterSubnetGroupName

The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.

Type: String

Pattern: .*\S.*

Required: No

ClusterVersion

The version ID of the Amazon Redshift engine that runs on the cluster.

Type: String

Pattern: .*\S.*

Required: No

DBName

The name of the initial database that was created when the cluster was created.

The same name is returned for the life of the cluster.

If an initial database is not specified, a database named devdev is created by default.

Type: String

Pattern: .*\S.*

Required: No

DeferredMaintenanceWindows

List of time windows during which maintenance was deferred.

Type: Array of AwsRedshiftClusterDeferredMaintenanceWindow objects

Required: No

ElasticIpStatus

Information about the status of the Elastic IP (EIP) address.

Type: AwsRedshiftClusterElasticIpStatus object

Required: No

ElasticResizeNumberOfNodeOptions

The number of nodes that you can use the elastic resize method to resize the cluster to.

Type: String

Pattern: .*\S.*

Required: No

Encrypted

Indicates whether the data in the cluster is encrypted at rest.

Type: Boolean

Required: No

Endpoint

The connection endpoint.

Type: AwsRedshiftClusterEndpoint object

Required: No

EnhancedVpcRouting

Indicates whether to create the cluster with enhanced VPC routing enabled.

Type: Boolean

Required: No

ExpectedNextSnapshotScheduleTime

Indicates when the next snapshot is expected to be taken. The cluster must have a valid snapshot schedule and have backups enabled.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Type: String

Pattern: .*\S.*

Required: No

ExpectedNextSnapshotScheduleTimeStatus

The status of the next expected snapshot.

Valid values: OnTrack | Pending

Type: String

Pattern: .*\S.*

Required: No

HsmStatus

Information about whether the Amazon Redshift cluster finished applying any changes to hardware security module (HSM) settings that were specified in a modify cluster command.

Type: AwsRedshiftClusterHsmStatus object

Required: No

IamRoles

A list of IAM roles that the cluster can use to access other AWS services.

Type: Array of AwsRedshiftClusterIamRole objects

Required: No

KmsKeyId

The identifier of the AWS KMS encryption key that is used to encrypt data in the cluster.

Type: String

Pattern: .*\S.*

Required: No

MaintenanceTrackName

The name of the maintenance track for the cluster.

Type: String

Pattern: .*\S.*

Required: No

ManualSnapshotRetentionPeriod

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.

Valid values: Either -1 or an integer between 1 and 3,653

Type: Integer

Required: No

MasterUsername

The master user name for the cluster. This name is used to connect to the database that is specified in as the value of DBName.

Type: String

Pattern: .*\S.*

Required: No

NextMaintenanceWindowStartTime

Indicates the start of the next maintenance window.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Type: String

Pattern: .*\S.*

Required: No

NodeType

The node type for the nodes in the cluster.

Type: String

Pattern: .*\S.*

Required: No

NumberOfNodes

The number of compute nodes in the cluster.

Type: Integer

Required: No

PendingActions

A list of cluster operations that are waiting to start.

Type: Array of strings

Pattern: .*\S.*

Required: No

PendingModifiedValues

A list of changes to the cluster that are currently pending.

Type: AwsRedshiftClusterPendingModifiedValues object

Required: No

PreferredMaintenanceWindow

The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.

Format: <day>:HH:MM-<day>:HH:MM

For the day values, use mon | tue | wed | thu | fri | sat | sun

For example, sun:09:32-sun:10:02

Type: String

Pattern: .*\S.*

Required: No

PubliclyAccessible

Whether the cluster can be accessed from a public network.

Type: Boolean

Required: No

ResizeInfo

Information about the resize operation for the cluster.

Type: AwsRedshiftClusterResizeInfo object

Required: No

RestoreStatus

Information about the status of a cluster restore action. Only applies to a cluster that was created by restoring a snapshot.

Type: AwsRedshiftClusterRestoreStatus object

Required: No

SnapshotScheduleIdentifier

A unique identifier for the cluster snapshot schedule.

Type: String

Pattern: .*\S.*

Required: No

SnapshotScheduleState

The current state of the cluster snapshot schedule.

Valid values: MODIFYING | ACTIVE | FAILED

Type: String

Pattern: .*\S.*

Required: No

VpcId

The identifier of the VPC that the cluster is in, if the cluster is in a VPC.

Type: String

Pattern: .*\S.*

Required: No

VpcSecurityGroups

The list of VPC security groups that the cluster belongs to, if the cluster is in a VPC.

Type: Array of AwsRedshiftClusterVpcSecurityGroup objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: