DBInstance class

Detailed information about an instance.

Constructors

DBInstance({bool? autoMinorVersionUpgrade, String? availabilityZone, int? backupRetentionPeriod, String? cACertificateIdentifier, String? dBClusterIdentifier, String? dBInstanceArn, String? dBInstanceClass, String? dBInstanceIdentifier, String? dBInstanceStatus, DBSubnetGroup? dBSubnetGroup, String? dbiResourceId, List<String>? enabledCloudwatchLogsExports, Endpoint? endpoint, String? engine, String? engineVersion, DateTime? instanceCreateTime, String? kmsKeyId, DateTime? latestRestorableTime, PendingModifiedValues? pendingModifiedValues, String? preferredBackupWindow, String? preferredMaintenanceWindow, int? promotionTier, bool? publiclyAccessible, List<DBInstanceStatusInfo>? statusInfos, bool? storageEncrypted, List<VpcSecurityGroupMembership>? vpcSecurityGroups})

DBInstance.fromXml(XmlElement elem)

factory

Properties

autoMinorVersionUpgrade → bool?

Indicates that minor version patches are applied automatically.

final

availabilityZone → String?

Specifies the name of the Availability Zone that the instance is located in.

final

backupRetentionPeriod → int?

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

final

cACertificateIdentifier → String?

The identifier of the CA certificate for this DB instance.

final

dBClusterIdentifier → String?

Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

final

dBInstanceArn → String?

The Amazon Resource Name (ARN) for the instance.

final

dBInstanceClass → String?

Contains the name of the compute and memory capacity class of the instance.

final

dBInstanceIdentifier → String?

Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

final

dBInstanceStatus → String?

Specifies the current state of this database.

final

dbiResourceId → String?

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

final

dBSubnetGroup → DBSubnetGroup?

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

final

enabledCloudwatchLogsExports → List<String>?

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

final

endpoint → Endpoint?

Specifies the connection endpoint.

final

engine → String?

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

final

engineVersion → String?

Indicates the database engine version.

final

hashCode → int

The hash code for this object.

no setter, inherited

instanceCreateTime → DateTime?

Provides the date and time that the instance was created.

final

kmsKeyId → String?

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

final

latestRestorableTime → DateTime?

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

final

pendingModifiedValues → PendingModifiedValues?

Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

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

promotionTier → int?

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

final

publiclyAccessible → bool?

Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

statusInfos → List<DBInstanceStatusInfo>?

The status of a read replica. If the instance is not a read replica, this is blank.

final

storageEncrypted → bool?

Specifies whether or not the instance is encrypted.

final

vpcSecurityGroups → List<VpcSecurityGroupMembership>?

Provides a list of VPC security group elements that the instance 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