DBInstance class

Contains the details of an Amazon RDS DB instance.

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

Constructors

DBInstance({int? allocatedStorage, List<DBInstanceRole>? associatedRoles, bool? autoMinorVersionUpgrade, String? availabilityZone, int? backupRetentionPeriod, String? cACertificateIdentifier, String? characterSetName, bool? copyTagsToSnapshot, bool? customerOwnedIpEnabled, String? dBClusterIdentifier, String? dBInstanceArn, List<DBInstanceAutomatedBackupsReplication>? dBInstanceAutomatedBackupsReplications, String? dBInstanceClass, String? dBInstanceIdentifier, String? dBInstanceStatus, String? dBName, List<DBParameterGroupStatus>? dBParameterGroups, List<DBSecurityGroupMembership>? dBSecurityGroups, DBSubnetGroup? dBSubnetGroup, int? dbInstancePort, String? dbiResourceId, bool? deletionProtection, List<DomainMembership>? domainMemberships, List<String>? enabledCloudwatchLogsExports, Endpoint? endpoint, String? engine, String? engineVersion, String? enhancedMonitoringResourceArn, bool? iAMDatabaseAuthenticationEnabled, DateTime? instanceCreateTime, int? iops, String? kmsKeyId, DateTime? latestRestorableTime, String? licenseModel, Endpoint? listenerEndpoint, String? masterUsername, int? maxAllocatedStorage, int? monitoringInterval, String? monitoringRoleArn, bool? multiAZ, String? ncharCharacterSetName, List<OptionGroupMembership>? optionGroupMemberships, PendingModifiedValues? pendingModifiedValues, bool? performanceInsightsEnabled, String? performanceInsightsKMSKeyId, int? performanceInsightsRetentionPeriod, String? preferredBackupWindow, String? preferredMaintenanceWindow, List<ProcessorFeature>? processorFeatures, int? promotionTier, bool? publiclyAccessible, List<String>? readReplicaDBClusterIdentifiers, List<String>? readReplicaDBInstanceIdentifiers, String? readReplicaSourceDBInstanceIdentifier, ReplicaMode? replicaMode, String? secondaryAvailabilityZone, List<DBInstanceStatusInfo>? statusInfos, bool? storageEncrypted, String? storageType, List<Tag>? tagList, String? tdeCredentialArn, String? timezone, List<VpcSecurityGroupMembership>? vpcSecurityGroups})
DBInstance.fromXml(XmlElement elem)
factory

Properties

allocatedStorage → int?
Specifies the allocated storage size specified in gibibytes.
final
associatedRoles → List<DBInstanceRole>?
The AWS Identity and Access Management (IAM) roles associated with the DB instance.
final
autoMinorVersionUpgrade → bool?
Indicates that minor version patches are applied automatically.
final
availabilityZone → String?
Specifies the name of the Availability Zone the DB instance is located in.
final
backupRetentionPeriod → int?
Specifies the number of days for which automatic DB snapshots are retained.
final
cACertificateIdentifier → String?
The identifier of the CA certificate for this DB instance.
final
characterSetName → String?
If present, specifies the name of the character set that this instance is associated with.
final
copyTagsToSnapshot → bool?
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
final
customerOwnedIpEnabled → bool?
Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
final
dBClusterIdentifier → String?
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
final
dBInstanceArn → String?
The Amazon Resource Name (ARN) for the DB instance.
final
dBInstanceAutomatedBackupsReplications → List<DBInstanceAutomatedBackupsReplication>?
The list of replicated automated backups associated with the DB instance.
final
dBInstanceClass → String?
Contains the name of the compute and memory capacity class of the DB instance.
final
dBInstanceIdentifier → String?
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
final
dbInstancePort → int?
Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
final
dBInstanceStatus → String?
Specifies the current state of this database.
final
dbiResourceId → String?
The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the DB instance is accessed.
final
dBName → String?
The meaning of this parameter differs according to the database engine you use.
final
dBParameterGroups → List<DBParameterGroupStatus>?
Provides the list of DB parameter groups applied to this DB instance.
final
dBSecurityGroups → List<DBSecurityGroupMembership>?
A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
final
dBSubnetGroup → DBSubnetGroup?
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
final
deletionProtection → bool?
Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.
final
domainMemberships → List<DomainMembership>?
The Active Directory Domain membership records associated with the DB instance.
final
enabledCloudwatchLogsExports → List<String>?
A list of log types that this DB instance is configured to export to CloudWatch Logs.
final
endpoint → Endpoint?
Specifies the connection endpoint.
final
engine → String?
The name of the database engine to be used for this DB instance.
final
engineVersion → String?
Indicates the database engine version.
final
enhancedMonitoringResourceArn → String?
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
final
hashCode → int
The hash code for this object.
no setterinherited
iAMDatabaseAuthenticationEnabled → bool?
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
final
instanceCreateTime → DateTime?
Provides the date and time the DB instance was created.
final
iops → int?
Specifies the Provisioned IOPS (I/O operations per second) value.
final
kmsKeyId → String?
If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.
final
latestRestorableTime → DateTime?
Specifies the latest time to which a database can be restored with point-in-time restore.
final
licenseModel → String?
License model information for this DB instance.
final
listenerEndpoint → Endpoint?
Specifies the listener connection endpoint for SQL Server Always On.
final
masterUsername → String?
Contains the master username for the DB instance.
final
maxAllocatedStorage → int?
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
final
monitoringInterval → int?
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
final
monitoringRoleArn → String?
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
final
multiAZ → bool?
Specifies if the DB instance is a Multi-AZ deployment.
final
ncharCharacterSetName → String?
The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
final
optionGroupMemberships → List<OptionGroupMembership>?
Provides the list of option group memberships for this DB instance.
final
pendingModifiedValues → PendingModifiedValues?
Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
final
performanceInsightsEnabled → bool?
True if Performance Insights is enabled for the DB instance, and otherwise false.
final
performanceInsightsKMSKeyId → String?
The AWS KMS key identifier for encryption of Performance Insights data.
final
performanceInsightsRetentionPeriod → int?
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
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
processorFeatures → List<ProcessorFeature>?
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
final
promotionTier → int?
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
final
publiclyAccessible → bool?
Specifies the accessibility options for the DB instance.
final
readReplicaDBClusterIdentifiers → List<String>?
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not contain information about cross region Aurora read replicas.
final
readReplicaDBInstanceIdentifiers → List<String>?
Contains one or more identifiers of the read replicas associated with this DB instance.
final
readReplicaSourceDBInstanceIdentifier → String?
Contains the identifier of the source DB instance if this DB instance is a read replica.
final
replicaMode → ReplicaMode?
The open mode of an Oracle read replica. The default is open-read-only. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
secondaryAvailabilityZone → String?
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
final
statusInfos → List<DBInstanceStatusInfo>?
The status of a read replica. If the instance isn't a read replica, this is blank.
final
storageEncrypted → bool?
Specifies whether the DB instance is encrypted.
final
storageType → String?
Specifies the storage type associated with DB instance.
final
tagList → List<Tag>?
final
tdeCredentialArn → String?
The ARN from the key store with which the instance is associated for TDE encryption.
final
timezone → String?
The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
final
vpcSecurityGroups → List<VpcSecurityGroupMembership>?
Provides a list of VPC security group elements that the DB 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