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.

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBClusters action.

Inheritance Hierarchy

System.Object
  Amazon.RDS.Model.DBCluster

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

Syntax

C#
public class DBCluster

The DBCluster type exposes the following members

Constructors

NameDescription
Public Method DBCluster()

Properties

NameTypeDescription
Public Property AllocatedStorage System.Int32

Gets and sets the property AllocatedStorage.

For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gigabytes (GB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size is not fixed, but instead automatically adjusts as needed.

Public Property AssociatedRoles System.Collections.Generic.List<Amazon.RDS.Model.DBClusterRole>

Gets and sets the property AssociatedRoles.

Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.

Public Property AvailabilityZones System.Collections.Generic.List<System.String>

Gets and sets the property AvailabilityZones.

Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

Public Property BackupRetentionPeriod System.Int32

Gets and sets the property BackupRetentionPeriod.

Specifies the number of days for which automatic DB snapshots are retained.

Public Property CharacterSetName System.String

Gets and sets the property CharacterSetName.

If present, specifies the name of the character set that this cluster is associated with.

Public Property CloneGroupId System.String

Gets and sets the property CloneGroupId.

Identifies the clone group to which the DB cluster is associated.

Public Property ClusterCreateTime System.DateTime

Gets and sets the property ClusterCreateTime.

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

Public Property DatabaseName System.String

Gets and sets the property DatabaseName.

Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

Public Property DBClusterArn System.String

Gets and sets the property DBClusterArn.

The Amazon Resource Name (ARN) for the DB cluster.

Public Property DBClusterIdentifier System.String

Gets and sets the property DBClusterIdentifier.

Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

Public Property DBClusterMembers System.Collections.Generic.List<Amazon.RDS.Model.DBClusterMember>

Gets and sets the property DBClusterMembers.

Provides the list of instances that make up the DB cluster.

Public Property DBClusterOptionGroupMemberships System.Collections.Generic.List<Amazon.RDS.Model.DBClusterOptionGroupStatus>

Gets and sets the property DBClusterOptionGroupMemberships.

Provides the list of option group memberships for this DB cluster.

Public Property DBClusterParameterGroup System.String

Gets and sets the property DBClusterParameterGroup.

Specifies the name of the DB cluster parameter group for the DB cluster.

Public Property DbClusterResourceId System.String

Gets and sets the property DbClusterResourceId.

The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

Public Property DBSubnetGroup System.String

Gets and sets the property DBSubnetGroup.

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

Public Property EarliestRestorableTime System.DateTime

Gets and sets the property EarliestRestorableTime.

Specifies the earliest time to which a database can be restored with point-in-time restore.

Public Property Endpoint System.String

Gets and sets the property Endpoint.

Specifies the connection endpoint for the primary instance of the DB cluster.

Public Property Engine System.String

Gets and sets the property Engine.

Provides the name of the database engine to be used for this DB cluster.

Public Property EngineVersion System.String

Gets and sets the property EngineVersion.

Indicates the database engine version.

Public Property HostedZoneId System.String

Gets and sets the property HostedZoneId.

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

Public Property IAMDatabaseAuthenticationEnabled System.Boolean

Gets and sets the property IAMDatabaseAuthenticationEnabled.

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.

Public Property KmsKeyId System.String

Gets and sets the property KmsKeyId.

If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster.

Public Property LatestRestorableTime System.DateTime

Gets and sets the property LatestRestorableTime.

Specifies the latest time to which a database can be restored with point-in-time restore.

Public Property MasterUsername System.String

Gets and sets the property MasterUsername.

Contains the master username for the DB cluster.

Public Property MultiAZ System.Boolean

Gets and sets the property MultiAZ.

Specifies whether the DB cluster has instances in multiple Availability Zones.

Public Property PercentProgress System.String

Gets and sets the property PercentProgress.

Specifies the progress of the operation as a percentage.

Public Property Port System.Int32

Gets and sets the property Port.

Specifies the port that the database engine is listening on.

Public Property PreferredBackupWindow System.String

Gets and sets the property PreferredBackupWindow.

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Public Property PreferredMaintenanceWindow System.String

Gets and sets the property PreferredMaintenanceWindow.

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

Public Property ReaderEndpoint System.String

Gets and sets the property ReaderEndpoint.

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection will be dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

Public Property ReadReplicaIdentifiers System.Collections.Generic.List<System.String>

Gets and sets the property ReadReplicaIdentifiers.

Contains one or more identifiers of the Read Replicas associated with this DB cluster.

Public Property ReplicationSourceIdentifier System.String

Gets and sets the property ReplicationSourceIdentifier.

Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.

Public Property Status System.String

Gets and sets the property Status.

Specifies the current state of this DB cluster.

Public Property StorageEncrypted System.Boolean

Gets and sets the property StorageEncrypted.

Specifies whether the DB cluster is encrypted.

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

Gets and sets the property VpcSecurityGroups.

Provides a list of VPC security groups that the DB cluster belongs to.

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