DBInstance class
Contains the details of an Amazon Neptune DB instance.
This data type is used as a response element in the DescribeDBInstances action.
Constructors
-
DBInstance({int? allocatedStorage, bool? autoMinorVersionUpgrade, String? availabilityZone, int? backupRetentionPeriod, String? cACertificateIdentifier, String? characterSetName, bool? copyTagsToSnapshot, String? dBClusterIdentifier, String? dBInstanceArn, 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, String? masterUsername, int? monitoringInterval, String? monitoringRoleArn, bool? multiAZ, List<OptionGroupMembership> ? optionGroupMemberships, PendingModifiedValues? pendingModifiedValues, bool? performanceInsightsEnabled, String? performanceInsightsKMSKeyId, String? preferredBackupWindow, String? preferredMaintenanceWindow, int? promotionTier, bool? publiclyAccessible, List<String> ? readReplicaDBClusterIdentifiers, List<String> ? readReplicaDBInstanceIdentifiers, String? readReplicaSourceDBInstanceIdentifier, String? secondaryAvailabilityZone, List<DBInstanceStatusInfo> ? statusInfos, bool? storageEncrypted, String? storageType, String? tdeCredentialArn, String? timezone, List<VpcSecurityGroupMembership> ? vpcSecurityGroups}) - DBInstance.fromXml(XmlElement elem)
-
factory
Properties
- allocatedStorage → int?
-
Specifies the allocated storage size specified in gibibytes.
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?
-
(Not supported by Neptune)
final
- copyTagsToSnapshot → bool?
-
Specifies whether tags are copied from the DB instance to snapshots of the
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
- 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 key
for the DB instance is accessed.
final
- dBName → String?
-
The database name.
final
-
dBParameterGroups
→ List<
DBParameterGroupStatus> ? -
Provides the list of DB parameter groups applied to this DB instance.
final
-
dBSecurityGroups
→ List<
DBSecurityGroupMembership> ? -
Provides List of DB security group elements containing only
DBSecurityGroup.NameandDBSecurityGroup.Statussubelements.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 whether or not the DB instance has deletion protection enabled.
The instance can't be deleted when deletion protection is enabled. See Deleting
a DB Instance.
final
-
domainMemberships
→ List<
DomainMembership> ? -
Not supported
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?
-
Provides 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 AWS Identity and Access Management (IAM) authentication 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?
-
Not supported: The encryption for DB instances is managed by the DB cluster.
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
- masterUsername → String?
-
Contains the master username for 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 Neptune to send Enhanced Monitoring
metrics to Amazon CloudWatch Logs.
final
- multiAZ → bool?
-
Specifies if the DB instance is a Multi-AZ deployment.
final
-
optionGroupMemberships
→ List<
OptionGroupMembership> ? -
(Not supported by Neptune)
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?
-
(Not supported by Neptune)
final
- performanceInsightsKMSKeyId → String?
-
(Not supported by Neptune)
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 a Read Replica is promoted to the
primary instance after a failure of the existing primary instance.
final
- publiclyAccessible → bool?
-
This flag should no longer be used.
final
-
readReplicaDBClusterIdentifiers
→ List<
String> ? -
Contains one or more identifiers of DB clusters that are Read Replicas of
this DB instance.
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
- 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 is not a Read Replica, this is
blank.
final
- storageEncrypted → bool?
-
Not supported: The encryption for DB instances is managed by the DB cluster.
final
- storageType → String?
-
Specifies the storage type associated with DB instance.
final
- tdeCredentialArn → String?
-
The ARN from the key store with which the instance is associated for TDE
encryption.
final
- timezone → String?
-
Not supported.
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