DBCluster class

Contains the details of an Amazon Aurora DB cluster.

This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.

Constructors

DBCluster({String? activityStreamKinesisStreamName, String? activityStreamKmsKeyId, ActivityStreamMode? activityStreamMode, ActivityStreamStatus? activityStreamStatus, int? allocatedStorage, List<DBClusterRole>? associatedRoles, List<String>? availabilityZones, int? backtrackConsumedChangeRecords, int? backtrackWindow, int? backupRetentionPeriod, int? capacity, String? characterSetName, String? cloneGroupId, DateTime? clusterCreateTime, bool? copyTagsToSnapshot, bool? crossAccountClone, List<String>? customEndpoints, String? dBClusterArn, String? dBClusterIdentifier, List<DBClusterMember>? dBClusterMembers, List<DBClusterOptionGroupStatus>? dBClusterOptionGroupMemberships, String? dBClusterParameterGroup, String? dBSubnetGroup, String? databaseName, String? dbClusterResourceId, bool? deletionProtection, List<DomainMembership>? domainMemberships, DateTime? earliestBacktrackTime, DateTime? earliestRestorableTime, List<String>? enabledCloudwatchLogsExports, String? endpoint, String? engine, String? engineMode, String? engineVersion, bool? globalWriteForwardingRequested, WriteForwardingStatus? globalWriteForwardingStatus, String? hostedZoneId, bool? httpEndpointEnabled, bool? iAMDatabaseAuthenticationEnabled, String? kmsKeyId, DateTime? latestRestorableTime, String? masterUsername, bool? multiAZ, ClusterPendingModifiedValues? pendingModifiedValues, String? percentProgress, int? port, String? preferredBackupWindow, String? preferredMaintenanceWindow, List<String>? readReplicaIdentifiers, String? readerEndpoint, String? replicationSourceIdentifier, ScalingConfigurationInfo? scalingConfigurationInfo, String? status, bool? storageEncrypted, List<Tag>? tagList, List<VpcSecurityGroupMembership>? vpcSecurityGroups})
DBCluster.fromXml(XmlElement elem)
factory

Properties

activityStreamKinesisStreamName → String?
The name of the Amazon Kinesis data stream used for the database activity stream.
final
activityStreamKmsKeyId → String?
The AWS KMS key identifier used for encrypting messages in the database activity stream.
final
activityStreamMode → ActivityStreamMode?
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
final
activityStreamStatus → ActivityStreamStatus?
The status of the database activity stream.
final
allocatedStorage → int?
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
final
associatedRoles → List<DBClusterRole>?
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.
final
availabilityZones → List<String>?
Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
final
backtrackConsumedChangeRecords → int?
The number of change records stored for Backtrack.
final
backtrackWindow → int?
The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
final
backupRetentionPeriod → int?
Specifies the number of days for which automatic DB snapshots are retained.
final
capacity → int?
The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) when the cluster is paused.
final
characterSetName → String?
If present, specifies the name of the character set that this cluster is associated with.
final
cloneGroupId → String?
Identifies the clone group to which the DB cluster is associated.
final
clusterCreateTime → DateTime?
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
final
copyTagsToSnapshot → bool?
Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
final
crossAccountClone → bool?
Specifies whether the DB cluster is a clone of a DB cluster owned by a different AWS account.
final
customEndpoints → List<String>?
Identifies all custom endpoints associated with the cluster.
final
databaseName → String?
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.
final
dBClusterArn → String?
The Amazon Resource Name (ARN) for the DB cluster.
final
dBClusterIdentifier → String?
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
final
dBClusterMembers → List<DBClusterMember>?
Provides the list of instances that make up the DB cluster.
final
dBClusterOptionGroupMemberships → List<DBClusterOptionGroupStatus>?
Provides the list of option group memberships for this DB cluster.
final
dBClusterParameterGroup → String?
Specifies the name of the DB cluster parameter group for the DB cluster.
final
dbClusterResourceId → String?
The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS CMK for the DB cluster is accessed.
final
dBSubnetGroup → String?
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
final
deletionProtection → bool?
Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
final
domainMemberships → List<DomainMembership>?
The Active Directory Domain membership records associated with the DB cluster.
final
earliestBacktrackTime → DateTime?
The earliest time to which a DB cluster can be backtracked.
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 DB cluster is configured to export to CloudWatch Logs.
final
endpoint → String?
Specifies the connection endpoint for the primary instance of the DB cluster.
final
engine → String?
The name of the database engine to be used for this DB cluster.
final
engineMode → String?
The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
final
engineVersion → String?
Indicates the database engine version.
final
globalWriteForwardingRequested → bool?
Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
final
globalWriteForwardingStatus → WriteForwardingStatus?
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
final
hashCode → int
The hash code for this object.
no setterinherited
hostedZoneId → String?
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
final
httpEndpointEnabled → bool?
A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
final
iAMDatabaseAuthenticationEnabled → bool?
A value that indicates whether the mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
final
kmsKeyId → String?
If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB 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 username for the DB cluster.
final
multiAZ → bool?
Specifies whether the DB cluster has instances in multiple Availability Zones.
final
pendingModifiedValues → ClusterPendingModifiedValues?
Specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
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 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.
final
readReplicaIdentifiers → List<String>?
Contains one or more identifiers of the read replicas associated with this DB cluster.
final
replicationSourceIdentifier → String?
Contains the identifier of the source DB cluster if this DB cluster is a read replica.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scalingConfigurationInfo → ScalingConfigurationInfo?
final
status → String?
Specifies the current state of this DB cluster.
final
storageEncrypted → bool?
Specifies whether the DB cluster is encrypted.
final
tagList → List<Tag>?
final
vpcSecurityGroups → List<VpcSecurityGroupMembership>?
Provides a list of VPC security groups that the DB 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