AWS SDK for .NET Documentation
Cluster Class
AmazonAmazon.Redshift.ModelCluster Did this page help you?   Yes   No    Tell us about it...
Describes a cluster.
Declaration Syntax
C#
public class Cluster
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
Cluster()()()()
Initializes a new instance of the Cluster class

AllowVersionUpgrade
Gets and sets the property AllowVersionUpgrade.

If

CopyC#
true
, version upgrades will be applied automatically to the cluster during the maintenance window.


AutomatedSnapshotRetentionPeriod
Gets and sets the property AutomatedSnapshotRetentionPeriod.

The number of days that automatic cluster snapshots are retained.


AvailabilityZone
Gets and sets the property AvailabilityZone.

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


ClusterCreateTime
Gets and sets the property ClusterCreateTime.

The date and time that the cluster was created.


ClusterIdentifier
Gets and sets the property ClusterIdentifier.

The unique identifier of the cluster.


ClusterNodes
Gets and sets the property ClusterNodes.

The nodes in a cluster.


ClusterParameterGroups
Gets and sets the property ClusterParameterGroups.

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


ClusterPublicKey
Gets and sets the property ClusterPublicKey.

The public key for the cluster.


ClusterRevisionNumber
Gets and sets the property ClusterRevisionNumber.

The specific revision number of the database in the cluster.


ClusterSecurityGroups
Gets and sets the property ClusterSecurityGroups.

A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains

CopyC#
ClusterSecurityGroup.Name
and
CopyC#
ClusterSecurityGroup.Status
subelements.

Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.


ClusterSnapshotCopyStatus
Gets and sets the property ClusterSnapshotCopyStatus.

Returns the destination region and retention period that are configured for cross-region snapshot copy.


ClusterStatus
Gets and sets the property ClusterStatus.

The current state of this cluster. Possible values include

CopyC#
available
,
CopyC#
creating
,
CopyC#
deleting
,
CopyC#
rebooting
,
CopyC#
renaming
, and
CopyC#
resizing
.


ClusterSubnetGroupName
Gets and sets the property 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.


ClusterVersion
Gets and sets the property ClusterVersion.

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


DBName
Gets and sets the property DBName.

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 "dev" was created by default.


ElasticIpStatus
Gets and sets the property ElasticIpStatus.

Describes the status of the elastic IP (EIP) address.


Encrypted
Gets and sets the property Encrypted.

If

CopyC#
true
, data in the cluster is encrypted at rest.


Endpoint
Gets and sets the property Endpoint.

The connection endpoint.


Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
HsmStatus
Gets and sets the property HsmStatus.

Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.

Values: active, applying


MasterUsername
Gets and sets the property MasterUsername.

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


ModifyStatus
Gets and sets the property ModifyStatus.

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


NodeType
Gets and sets the property NodeType.

The node type for the nodes in the cluster.


NumberOfNodes
Gets and sets the property NumberOfNodes.

The number of compute nodes in the cluster.


PendingModifiedValues
Gets and sets the property PendingModifiedValues.

If present, changes to the cluster are pending. Specific pending changes are identified by subelements.


PreferredMaintenanceWindow
Gets and sets the property PreferredMaintenanceWindow.

The weekly time range (in UTC) during which system maintenance can occur.


PubliclyAccessible
Gets and sets the property PubliclyAccessible.

If

CopyC#
true
, the cluster can be accessed from a public network.


RestoreStatus
Gets and sets the property RestoreStatus.

Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.


ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
VpcId
Gets and sets the property VpcId.

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


VpcSecurityGroups
Gets and sets the property VpcSecurityGroups.

A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.


WithAllowVersionUpgrade(Boolean) Obsolete.
Sets the AllowVersionUpgrade property

WithAutomatedSnapshotRetentionPeriod(Int32) Obsolete.
Sets the AutomatedSnapshotRetentionPeriod property

WithAvailabilityZone(String) Obsolete.
Sets the AvailabilityZone property

WithClusterCreateTime(DateTime) Obsolete.
Sets the ClusterCreateTime property

WithClusterIdentifier(String) Obsolete.
Sets the ClusterIdentifier property

WithClusterNodes(array<ClusterNode>[]()[][]) Obsolete.
Sets the ClusterNodes property

WithClusterNodes(IEnumerable<(Of <<'(ClusterNode>)>>)) Obsolete.
Sets the ClusterNodes property

WithClusterParameterGroups(array<ClusterParameterGroupStatus>[]()[][]) Obsolete.
Sets the ClusterParameterGroups property

WithClusterParameterGroups(IEnumerable<(Of <<'(ClusterParameterGroupStatus>)>>)) Obsolete.
Sets the ClusterParameterGroups property

WithClusterPublicKey(String) Obsolete.
Sets the ClusterPublicKey property

WithClusterRevisionNumber(String) Obsolete.
Sets the ClusterRevisionNumber property

WithClusterSecurityGroups(array<ClusterSecurityGroupMembership>[]()[][]) Obsolete.
Sets the ClusterSecurityGroups property

WithClusterSecurityGroups(IEnumerable<(Of <<'(ClusterSecurityGroupMembership>)>>)) Obsolete.
Sets the ClusterSecurityGroups property

WithClusterSnapshotCopyStatus(ClusterSnapshotCopyStatus) Obsolete.
Sets the ClusterSnapshotCopyStatus property

WithClusterStatus(String) Obsolete.
Sets the ClusterStatus property

WithClusterSubnetGroupName(String) Obsolete.
Sets the ClusterSubnetGroupName property

WithClusterVersion(String) Obsolete.
Sets the ClusterVersion property

WithDBName(String) Obsolete.
Sets the DBName property

WithElasticIpStatus(ElasticIpStatus) Obsolete.
Sets the ElasticIpStatus property

WithEncrypted(Boolean) Obsolete.
Sets the Encrypted property

WithEndpoint(Endpoint) Obsolete.
Sets the Endpoint property

WithHsmStatus(HsmStatus) Obsolete.
Sets the HsmStatus property

WithMasterUsername(String) Obsolete.
Sets the MasterUsername property

WithModifyStatus(String) Obsolete.
Sets the ModifyStatus property

WithNodeType(String) Obsolete.
Sets the NodeType property

WithNumberOfNodes(Int32) Obsolete.
Sets the NumberOfNodes property

WithPendingModifiedValues(PendingModifiedValues) Obsolete.
Sets the PendingModifiedValues property

WithPreferredMaintenanceWindow(String) Obsolete.
Sets the PreferredMaintenanceWindow property

WithPubliclyAccessible(Boolean) Obsolete.
Sets the PubliclyAccessible property

WithRestoreStatus(RestoreStatus) Obsolete.
Sets the RestoreStatus property

WithVpcId(String) Obsolete.
Sets the VpcId property

WithVpcSecurityGroups(array<VpcSecurityGroupMembership>[]()[][]) Obsolete.
Sets the VpcSecurityGroups property

WithVpcSecurityGroups(IEnumerable<(Of <<'(VpcSecurityGroupMembership>)>>)) Obsolete.
Sets the VpcSecurityGroups property

Inheritance Hierarchy
Object
Cluster

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)