Documentation

Contains the details of an Amazon Neptune DB instance.

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

See: newDBInstance smart constructor.

Create a value of DBInstance with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:engineVersion:DBInstance', dbInstance_engineVersion - Indicates the database engine version.

$sel:dbSecurityGroups:DBInstance', dbInstance_dbSecurityGroups - Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

$sel:deletionProtection:DBInstance', dbInstance_deletionProtection - 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.

$sel:storageEncrypted:DBInstance', dbInstance_storageEncrypted - Not supported: The encryption for DB instances is managed by the DB cluster.

$sel:dbClusterIdentifier:DBInstance', dbInstance_dbClusterIdentifier - 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.

$sel:publiclyAccessible:DBInstance', dbInstance_publiclyAccessible - This flag should no longer be used.

$sel:autoMinorVersionUpgrade:DBInstance', dbInstance_autoMinorVersionUpgrade - Indicates that minor version patches are applied automatically.

$sel:dbInstanceArn:DBInstance', dbInstance_dbInstanceArn - The Amazon Resource Name (ARN) for the DB instance.

$sel:masterUsername:DBInstance', dbInstance_masterUsername - Not supported by Neptune.

$sel:readReplicaDBInstanceIdentifiers:DBInstance', dbInstance_readReplicaDBInstanceIdentifiers - Contains one or more identifiers of the Read Replicas associated with this DB instance.

$sel:iAMDatabaseAuthenticationEnabled:DBInstance', dbInstance_iAMDatabaseAuthenticationEnabled - True if Amazon Identity and Access Management (IAM) authentication is enabled, and otherwise false.

$sel:monitoringRoleArn:DBInstance', dbInstance_monitoringRoleArn - The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

$sel:iops:DBInstance', dbInstance_iops - Specifies the Provisioned IOPS (I/O operations per second) value.

$sel:instanceCreateTime:DBInstance', dbInstance_instanceCreateTime - Provides the date and time the DB instance was created.

$sel:readReplicaSourceDBInstanceIdentifier:DBInstance', dbInstance_readReplicaSourceDBInstanceIdentifier - Contains the identifier of the source DB instance if this DB instance is a Read Replica.

$sel:monitoringInterval:DBInstance', dbInstance_monitoringInterval - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

$sel:engine:DBInstance', dbInstance_engine - Provides the name of the database engine to be used for this DB instance.

$sel:latestRestorableTime:DBInstance', dbInstance_latestRestorableTime - Specifies the latest time to which a database can be restored with point-in-time restore.

$sel:dbInstanceClass:DBInstance', dbInstance_dbInstanceClass - Contains the name of the compute and memory capacity class of the DB instance.

$sel:promotionTier:DBInstance', dbInstance_promotionTier - 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.

$sel:licenseModel:DBInstance', dbInstance_licenseModel - License model information for this DB instance.

$sel:preferredMaintenanceWindow:DBInstance', dbInstance_preferredMaintenanceWindow - Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

$sel:cACertificateIdentifier:DBInstance', dbInstance_cACertificateIdentifier - The identifier of the CA certificate for this DB instance.

$sel:dbInstanceIdentifier:DBInstance', dbInstance_dbInstanceIdentifier - Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

$sel:characterSetName:DBInstance', dbInstance_characterSetName - (Not supported by Neptune)

$sel:kmsKeyId:DBInstance', dbInstance_kmsKeyId - Not supported: The encryption for DB instances is managed by the DB cluster.

$sel:preferredBackupWindow:DBInstance', dbInstance_preferredBackupWindow - Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

$sel:availabilityZone:DBInstance', dbInstance_availabilityZone - Specifies the name of the Availability Zone the DB instance is located in.

$sel:vpcSecurityGroups:DBInstance', dbInstance_vpcSecurityGroups - Provides a list of VPC security group elements that the DB instance belongs to.

$sel:backupRetentionPeriod:DBInstance', dbInstance_backupRetentionPeriod - Specifies the number of days for which automatic DB snapshots are retained.

$sel:performanceInsightsKMSKeyId:DBInstance', dbInstance_performanceInsightsKMSKeyId - (Not supported by Neptune)

$sel:dbSubnetGroup:DBInstance', dbInstance_dbSubnetGroup - Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

$sel:multiAZ:DBInstance', dbInstance_multiAZ - Specifies if the DB instance is a Multi-AZ deployment.

$sel:optionGroupMemberships:DBInstance', dbInstance_optionGroupMemberships - (Not supported by Neptune)

$sel:enabledCloudwatchLogsExports:DBInstance', dbInstance_enabledCloudwatchLogsExports - A list of log types that this DB instance is configured to export to CloudWatch Logs.

$sel:enhancedMonitoringResourceArn:DBInstance', dbInstance_enhancedMonitoringResourceArn - The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

$sel:secondaryAvailabilityZone:DBInstance', dbInstance_secondaryAvailabilityZone - If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

$sel:performanceInsightsEnabled:DBInstance', dbInstance_performanceInsightsEnabled - (Not supported by Neptune)

$sel:allocatedStorage:DBInstance', dbInstance_allocatedStorage - Not supported by Neptune.

$sel:dbiResourceId:DBInstance', dbInstance_dbiResourceId - The Amazon Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon CloudTrail log entries whenever the Amazon KMS key for the DB instance is accessed.

$sel:dbParameterGroups:DBInstance', dbInstance_dbParameterGroups - Provides the list of DB parameter groups applied to this DB instance.

$sel:copyTagsToSnapshot:DBInstance', dbInstance_copyTagsToSnapshot - Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

$sel:timezone:DBInstance', dbInstance_timezone - Not supported.

$sel:tdeCredentialArn:DBInstance', dbInstance_tdeCredentialArn - The ARN from the key store with which the instance is associated for TDE encryption.

$sel:endpoint:DBInstance', dbInstance_endpoint - Specifies the connection endpoint.

$sel:dbInstanceStatus:DBInstance', dbInstance_dbInstanceStatus - Specifies the current state of this database.

$sel:dbInstancePort:DBInstance', dbInstance_dbInstancePort - 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.

$sel:pendingModifiedValues:DBInstance', dbInstance_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.

$sel:readReplicaDBClusterIdentifiers:DBInstance', dbInstance_readReplicaDBClusterIdentifiers - Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.

$sel:storageType:DBInstance', dbInstance_storageType - Specifies the storage type associated with DB instance.

$sel:statusInfos:DBInstance', dbInstance_statusInfos - The status of a Read Replica. If the instance is not a Read Replica, this is blank.

$sel:domainMemberships:DBInstance', dbInstance_domainMemberships - Not supported

$sel:dbName:DBInstance', dbInstance_dbName - The database name.

Indicates the database engine version.

Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

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.

Not supported: The encryption for DB instances is managed by the DB cluster.

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.

This flag should no longer be used.

Indicates that minor version patches are applied automatically.

The Amazon Resource Name (ARN) for the DB instance.

Not supported by Neptune.

Contains one or more identifiers of the Read Replicas associated with this DB instance.

True if Amazon Identity and Access Management (IAM) authentication is enabled, and otherwise false.

The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

Specifies the Provisioned IOPS (I/O operations per second) value.

Provides the date and time the DB instance was created.

Contains the identifier of the source DB instance if this DB instance is a Read Replica.

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

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

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

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

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.

License model information for this DB instance.

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

The identifier of the CA certificate for this DB instance.

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

(Not supported by Neptune)

Not supported: The encryption for DB instances is managed by the DB cluster.

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

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

Provides a list of VPC security group elements that the DB instance belongs to.

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

(Not supported by Neptune)

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

Specifies if the DB instance is a Multi-AZ deployment.

(Not supported by Neptune)

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

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

(Not supported by Neptune)

Not supported by Neptune.

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

Provides the list of DB parameter groups applied to this DB instance.

Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

Not supported.

The ARN from the key store with which the instance is associated for TDE encryption.

Specifies the connection endpoint.

Specifies the current state of this database.

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.

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

Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.

Specifies the storage type associated with DB instance.

The status of a Read Replica. If the instance is not a Read Replica, this is blank.

Not supported

The database name.