You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Redshift::Types::Cluster

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#allow_version_upgradeBoolean

A Boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

Returns:

  • (Boolean)

    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_periodInteger

The number of days that automatic cluster snapshots are retained.

Returns:

  • (Integer)

    The number of days that automatic cluster snapshots are retained.

#availability_zoneString

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

Returns:

  • (String)

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

#cluster_create_timeTime

The date and time that the cluster was created.

Returns:

  • (Time)

    The date and time that the cluster was created.

#cluster_identifierString

The unique identifier of the cluster.

Returns:

  • (String)

    The unique identifier of the cluster.

#cluster_nodesArray<Types::ClusterNode>

The nodes in the cluster.

Returns:

#cluster_parameter_groupsArray<Types::ClusterParameterGroupStatus>

The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

Returns:

#cluster_public_keyString

The public key for the cluster.

Returns:

  • (String)

    The public key for the cluster.

#cluster_revision_numberString

The specific revision number of the database in the cluster.

Returns:

  • (String)

    The specific revision number of the database in the cluster.

#cluster_security_groupsArray<Types::ClusterSecurityGroupMembership>

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.

Returns:

#cluster_snapshot_copy_statusTypes::ClusterSnapshotCopyStatus

A value that returns the destination region and retention period that are configured for cross-region snapshot copy.

Returns:

#cluster_statusString

The current state of the cluster. Possible values are the following:

  • available

  • creating

  • deleting

  • final-snapshot

  • hardware-failure

  • incompatible-hsm

  • incompatible-network

  • incompatible-parameters

  • incompatible-restore

  • modifying

  • rebooting

  • renaming

  • resizing

  • rotating-keys

  • storage-full

  • updating-hsm

Returns:

  • (String)

    The current state of the cluster.

#cluster_subnet_group_nameString

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

Returns:

  • (String)

    The name of the subnet group that is associated with the cluster.

#cluster_versionString

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

Returns:

  • (String)

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

#db_nameString

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.

Returns:

  • (String)

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

#elastic_ip_statusTypes::ElasticIpStatus

The status of the elastic IP (EIP) address.

Returns:

#encryptedBoolean

A Boolean value that, if true, indicates that data in the cluster is encrypted at rest.

Returns:

  • (Boolean)

    A Boolean value that, if true, indicates that data in the cluster is encrypted at rest.

#endpointTypes::Endpoint

The connection endpoint.

Returns:

#enhanced_vpc_routingBoolean

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

Returns:

  • (Boolean)

    An option that specifies whether to create the cluster with enhanced VPC routing enabled.

#hsm_statusTypes::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.

Values: active, applying

Returns:

  • (Types::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_rolesArray<Types::ClusterIamRole>

A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.

Returns:

  • (Array<Types::ClusterIamRole>)

    A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.

#kms_key_idString

The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.

Returns:

  • (String)

    The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.

#master_usernameString

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

Returns:

  • (String)

    The master user name for the cluster.

#modify_statusString

The status of a modify operation, if any, initiated for the cluster.

Returns:

  • (String)

    The status of a modify operation, if any, initiated for the cluster.

#node_typeString

The node type for the nodes in the cluster.

Returns:

  • (String)

    The node type for the nodes in the cluster.

#number_of_nodesInteger

The number of compute nodes in the cluster.

Returns:

  • (Integer)

    The number of compute nodes in the cluster.

#pending_modified_valuesTypes::PendingModifiedValues

A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.

Returns:

#preferred_maintenance_windowString

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

Returns:

  • (String)

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

#publicly_accessibleBoolean

A Boolean value that, if true, indicates that the cluster can be accessed from a public network.

Returns:

  • (Boolean)

    A Boolean value that, if true, indicates that the cluster can be accessed from a public network.

#restore_statusTypes::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.

Returns:

#tagsArray<Types::Tag>

The list of tags for the cluster.

Returns:

  • (Array<Types::Tag>)

    The list of tags for the cluster.

#vpc_idString

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

Returns:

  • (String)

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

#vpc_security_groupsArray<Types::VpcSecurityGroupMembership>

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.

Returns: