AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Describes a cluster.

Inheritance Hierarchy

System.Object
  Amazon.Redshift.Model.Cluster

Namespace: Amazon.Redshift.Model
Assembly: AWSSDK.Redshift.dll
Version: 3.x.y.z

Syntax

C#
public class Cluster

The Cluster type exposes the following members

Constructors

NameDescription
Public Method Cluster()

Properties

NameTypeDescription
Public Property AllowVersionUpgrade System.Boolean

Gets and sets the property AllowVersionUpgrade.

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

Public Property AutomatedSnapshotRetentionPeriod System.Int32

Gets and sets the property AutomatedSnapshotRetentionPeriod.

The number of days that automatic cluster snapshots are retained.

Public Property AvailabilityZone System.String

Gets and sets the property AvailabilityZone.

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

Public Property ClusterCreateTime System.DateTime

Gets and sets the property ClusterCreateTime.

The date and time that the cluster was created.

Public Property ClusterIdentifier System.String

Gets and sets the property ClusterIdentifier.

The unique identifier of the cluster.

Public Property ClusterNodes System.Collections.Generic.List<Amazon.Redshift.Model.ClusterNode>

Gets and sets the property ClusterNodes.

The nodes in the cluster.

Public Property ClusterParameterGroups System.Collections.Generic.List<Amazon.Redshift.Model.ClusterParameterGroupStatus>

Gets and sets the property ClusterParameterGroups.

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

Public Property ClusterPublicKey System.String

Gets and sets the property ClusterPublicKey.

The public key for the cluster.

Public Property ClusterRevisionNumber System.String

Gets and sets the property ClusterRevisionNumber.

The specific revision number of the database in the cluster.

Public Property ClusterSecurityGroups System.Collections.Generic.List<Amazon.Redshift.Model.ClusterSecurityGroupMembership>

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 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.

Public Property ClusterSnapshotCopyStatus Amazon.Redshift.Model.ClusterSnapshotCopyStatus

Gets and sets the property ClusterSnapshotCopyStatus.

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

Public Property ClusterStatus System.String

Gets and sets the property ClusterStatus.

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

Public Property ClusterSubnetGroupName System.String

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.

Public Property ClusterVersion System.String

Gets and sets the property ClusterVersion.

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

Public Property DBName System.String

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

Public Property ElasticIpStatus Amazon.Redshift.Model.ElasticIpStatus

Gets and sets the property ElasticIpStatus.

The status of the elastic IP (EIP) address.

Public Property Encrypted System.Boolean

Gets and sets the property Encrypted.

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

Public Property Endpoint Amazon.Redshift.Model.Endpoint

Gets and sets the property Endpoint.

The connection endpoint.

Public Property EnhancedVpcRouting System.Boolean

Gets and sets the property EnhancedVpcRouting.

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

Public Property HsmStatus Amazon.Redshift.Model.HsmStatus

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

Public Property IamRoles System.Collections.Generic.List<Amazon.Redshift.Model.ClusterIamRole>

Gets and sets the property IamRoles.

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

Public Property KmsKeyId System.String

Gets and sets the property KmsKeyId.

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

Public Property MasterUsername System.String

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 the DBName parameter.

Public Property ModifyStatus System.String

Gets and sets the property ModifyStatus.

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

Public Property NodeType System.String

Gets and sets the property NodeType.

The node type for the nodes in the cluster.

Public Property NumberOfNodes System.Int32

Gets and sets the property NumberOfNodes.

The number of compute nodes in the cluster.

Public Property PendingModifiedValues Amazon.Redshift.Model.PendingModifiedValues

Gets and sets the property PendingModifiedValues.

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

Public Property PreferredMaintenanceWindow System.String

Gets and sets the property PreferredMaintenanceWindow.

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

Public Property PubliclyAccessible System.Boolean

Gets and sets the property PubliclyAccessible.

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

Public Property RestoreStatus Amazon.Redshift.Model.RestoreStatus

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

Public Property Tags System.Collections.Generic.List<Amazon.Redshift.Model.Tag>

Gets and sets the property Tags.

The list of tags for the cluster.

Public Property VpcId System.String

Gets and sets the property VpcId.

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

Public Property VpcSecurityGroups System.Collections.Generic.List<Amazon.Redshift.Model.VpcSecurityGroupMembership>

Gets and sets the property VpcSecurityGroups.

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.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms