DBCluster class

Detailed information about a cluster.

Constructors

DBCluster({List<DBClusterRole>? associatedRoles, List<String>? availabilityZones, int? backupRetentionPeriod, DateTime? clusterCreateTime, String? dBClusterArn, String? dBClusterIdentifier, List<DBClusterMember>? dBClusterMembers, String? dBClusterParameterGroup, String? dBSubnetGroup, String? dbClusterResourceId, bool? deletionProtection, DateTime? earliestRestorableTime, List<String>? enabledCloudwatchLogsExports, String? endpoint, String? engine, String? engineVersion, String? hostedZoneId, String? kmsKeyId, DateTime? latestRestorableTime, String? masterUsername, bool? multiAZ, String? percentProgress, int? port, String? preferredBackupWindow, String? preferredMaintenanceWindow, String? readerEndpoint, String? status, bool? storageEncrypted, List<VpcSecurityGroupMembership>? vpcSecurityGroups})

DBCluster.fromXml(XmlElement elem)

factory

Properties

associatedRoles → List<DBClusterRole>?

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

final

availabilityZones → List<String>?

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

final

backupRetentionPeriod → int?

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

final

clusterCreateTime → DateTime?

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

final

dBClusterArn → String?

The Amazon Resource Name (ARN) for the cluster.

final

dBClusterIdentifier → String?

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

final

dBClusterMembers → List<DBClusterMember>?

Provides the list of instances that make up the cluster.

final

dBClusterParameterGroup → String?

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

final

dbClusterResourceId → String?

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

final

dBSubnetGroup → String?

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

final

deletionProtection → bool?

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

final

earliestRestorableTime → DateTime?

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

final

enabledCloudwatchLogsExports → List<String>?

A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.

final

endpoint → String?

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

final

engine → String?

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

final

engineVersion → String?

Indicates the database engine version.

final

hashCode → int

The hash code for this object.

no setter, inherited

hostedZoneId → String?

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

final

kmsKeyId → String?

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

final

latestRestorableTime → DateTime?

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

final

masterUsername → String?

Contains the master user name for the cluster.

final

multiAZ → bool?

Specifies whether the cluster has instances in multiple Availability Zones.

final

percentProgress → String?

Specifies the progress of the operation as a percentage.

final

port → int?

Specifies the port that the database engine is listening on.

final

preferredBackupWindow → String?

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

final

preferredMaintenanceWindow → String?

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

final

readerEndpoint → String?

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

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

status → String?

Specifies the current state of this cluster.

final

storageEncrypted → bool?

Specifies whether the cluster is encrypted.

final

vpcSecurityGroups → List<VpcSecurityGroupMembership>?

Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited