@Generated(value="software.amazon.awssdk:codegen") public final class DBInstance extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DBInstance.Builder,DBInstance>
Contains the details of an Amazon Neptune DB instance.
This data type is used as a response element in the DescribeDBInstances action.
| Modifier and Type | Class and Description |
|---|---|
static interface |
DBInstance.Builder |
| Modifier and Type | Method and Description |
|---|---|
Integer |
allocatedStorage()
Not supported by Neptune.
|
Boolean |
autoMinorVersionUpgrade()
Indicates that minor version patches are applied automatically.
|
String |
availabilityZone()
Specifies the name of the Availability Zone the DB instance is located in.
|
Integer |
backupRetentionPeriod()
Specifies the number of days for which automatic DB snapshots are retained.
|
static DBInstance.Builder |
builder() |
String |
caCertificateIdentifier()
The identifier of the CA certificate for this DB instance.
|
String |
characterSetName()
(Not supported by Neptune)
|
Boolean |
copyTagsToSnapshot()
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
|
String |
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.
|
String |
dbInstanceArn()
The Amazon Resource Name (ARN) for the DB instance.
|
String |
dbInstanceClass()
Contains the name of the compute and memory capacity class of the DB instance.
|
String |
dbInstanceIdentifier()
Contains a user-supplied database identifier.
|
Integer |
dbInstancePort()
Specifies the port that the DB instance listens on.
|
String |
dbInstanceStatus()
Specifies the current state of this database.
|
String |
dbiResourceId()
The Amazon Region-unique, immutable identifier for the DB instance.
|
String |
dbName()
The database name.
|
List<DBParameterGroupStatus> |
dbParameterGroups()
Provides the list of DB parameter groups applied to this DB instance.
|
List<DBSecurityGroupMembership> |
dbSecurityGroups()
Provides List of DB security group elements containing only
DBSecurityGroup.Name and
DBSecurityGroup.Status subelements. |
DBSubnetGroup |
dbSubnetGroup()
Specifies information on the subnet group associated with the DB instance, including the name, description, and
subnets in the subnet group.
|
Boolean |
deletionProtection()
Indicates whether or not the DB instance has deletion protection enabled.
|
List<DomainMembership> |
domainMemberships()
Not supported
|
List<String> |
enabledCloudwatchLogsExports()
A list of log types that this DB instance is configured to export to CloudWatch Logs.
|
Endpoint |
endpoint()
Specifies the connection endpoint.
|
String |
engine()
Provides the name of the database engine to be used for this DB instance.
|
String |
engineVersion()
Indicates the database engine version.
|
String |
enhancedMonitoringResourceArn()
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring
metrics data for the DB instance.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasDbParameterGroups()
For responses, this returns true if the service returned a value for the DBParameterGroups property.
|
boolean |
hasDbSecurityGroups()
For responses, this returns true if the service returned a value for the DBSecurityGroups property.
|
boolean |
hasDomainMemberships()
For responses, this returns true if the service returned a value for the DomainMemberships property.
|
boolean |
hasEnabledCloudwatchLogsExports()
For responses, this returns true if the service returned a value for the EnabledCloudwatchLogsExports property.
|
int |
hashCode() |
boolean |
hasOptionGroupMemberships()
For responses, this returns true if the service returned a value for the OptionGroupMemberships property.
|
boolean |
hasReadReplicaDBClusterIdentifiers()
For responses, this returns true if the service returned a value for the ReadReplicaDBClusterIdentifiers
property.
|
boolean |
hasReadReplicaDBInstanceIdentifiers()
For responses, this returns true if the service returned a value for the ReadReplicaDBInstanceIdentifiers
property.
|
boolean |
hasStatusInfos()
For responses, this returns true if the service returned a value for the StatusInfos property.
|
boolean |
hasVpcSecurityGroups()
For responses, this returns true if the service returned a value for the VpcSecurityGroups property.
|
Boolean |
iamDatabaseAuthenticationEnabled()
True if Amazon Identity and Access Management (IAM) authentication is enabled, and otherwise false.
|
Instant |
instanceCreateTime()
Provides the date and time the DB instance was created.
|
Integer |
iops()
Specifies the Provisioned IOPS (I/O operations per second) value.
|
String |
kmsKeyId()
Not supported: The encryption for DB instances is managed by the DB cluster.
|
Instant |
latestRestorableTime()
Specifies the latest time to which a database can be restored with point-in-time restore.
|
String |
licenseModel()
License model information for this DB instance.
|
String |
masterUsername()
Not supported by Neptune.
|
Integer |
monitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
|
String |
monitoringRoleArn()
The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
|
Boolean |
multiAZ()
Specifies if the DB instance is a Multi-AZ deployment.
|
List<OptionGroupMembership> |
optionGroupMemberships()
(Not supported by Neptune)
|
PendingModifiedValues |
pendingModifiedValues()
Specifies that changes to the DB instance are pending.
|
Boolean |
performanceInsightsEnabled()
(Not supported by Neptune)
|
String |
performanceInsightsKMSKeyId()
(Not supported by Neptune)
|
String |
preferredBackupWindow()
Specifies the daily time range during which automated backups are created if automated backups are enabled, as
determined by the
BackupRetentionPeriod. |
String |
preferredMaintenanceWindow()
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
Integer |
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.
|
Boolean |
publiclyAccessible()
Deprecated.
|
List<String> |
readReplicaDBClusterIdentifiers()
Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.
|
List<String> |
readReplicaDBInstanceIdentifiers()
Contains one or more identifiers of the Read Replicas associated with this DB instance.
|
String |
readReplicaSourceDBInstanceIdentifier()
Contains the identifier of the source DB instance if this DB instance is a Read Replica.
|
List<SdkField<?>> |
sdkFields() |
String |
secondaryAvailabilityZone()
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
|
static Class<? extends DBInstance.Builder> |
serializableBuilderClass() |
List<DBInstanceStatusInfo> |
statusInfos()
The status of a Read Replica.
|
Boolean |
storageEncrypted()
Not supported: The encryption for DB instances is managed by the DB cluster.
|
String |
storageType()
Specifies the storage type associated with DB instance.
|
String |
tdeCredentialArn()
The ARN from the key store with which the instance is associated for TDE encryption.
|
String |
timezone()
Not supported.
|
DBInstance.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
List<VpcSecurityGroupMembership> |
vpcSecurityGroups()
Provides a list of VPC security group elements that the DB instance belongs to.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String dbInstanceIdentifier()
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
public final String dbInstanceClass()
Contains the name of the compute and memory capacity class of the DB instance.
public final String engine()
Provides the name of the database engine to be used for this DB instance.
public final String dbInstanceStatus()
Specifies the current state of this database.
public final String masterUsername()
Not supported by Neptune.
public final String dbName()
The database name.
public final Endpoint endpoint()
Specifies the connection endpoint.
public final Integer allocatedStorage()
Not supported by Neptune.
public final Instant instanceCreateTime()
Provides the date and time the DB instance was created.
public final String preferredBackupWindow()
Specifies the daily time range during which automated backups are created if automated backups are enabled, as
determined by the BackupRetentionPeriod.
BackupRetentionPeriod.public final Integer backupRetentionPeriod()
Specifies the number of days for which automatic DB snapshots are retained.
public final boolean hasDbSecurityGroups()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<DBSecurityGroupMembership> dbSecurityGroups()
Provides List of DB security group elements containing only DBSecurityGroup.Name and
DBSecurityGroup.Status subelements.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasDbSecurityGroups() method.
DBSecurityGroup.Name and
DBSecurityGroup.Status subelements.public final boolean hasVpcSecurityGroups()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<VpcSecurityGroupMembership> vpcSecurityGroups()
Provides a list of VPC security group elements that the DB instance belongs to.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasVpcSecurityGroups() method.
public final boolean hasDbParameterGroups()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<DBParameterGroupStatus> dbParameterGroups()
Provides the list of DB parameter groups applied to this DB instance.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasDbParameterGroups() method.
public final String availabilityZone()
Specifies the name of the Availability Zone the DB instance is located in.
public final DBSubnetGroup dbSubnetGroup()
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
public final String preferredMaintenanceWindow()
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
public 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.
public final Instant latestRestorableTime()
Specifies the latest time to which a database can be restored with point-in-time restore.
public final Boolean multiAZ()
Specifies if the DB instance is a Multi-AZ deployment.
public final String engineVersion()
Indicates the database engine version.
public final Boolean autoMinorVersionUpgrade()
Indicates that minor version patches are applied automatically.
public final String readReplicaSourceDBInstanceIdentifier()
Contains the identifier of the source DB instance if this DB instance is a Read Replica.
public final boolean hasReadReplicaDBInstanceIdentifiers()
isEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may
need to differentiate between the service returning nothing (or null) and the service returning an empty
collection or map. For requests, this returns true if a value for the property was specified in the request
builder, and false if a value was not specified.public final List<String> readReplicaDBInstanceIdentifiers()
Contains one or more identifiers of the Read Replicas associated with this DB instance.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasReadReplicaDBInstanceIdentifiers()
method.
public final boolean hasReadReplicaDBClusterIdentifiers()
isEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may
need to differentiate between the service returning nothing (or null) and the service returning an empty
collection or map. For requests, this returns true if a value for the property was specified in the request
builder, and false if a value was not specified.public final List<String> readReplicaDBClusterIdentifiers()
Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasReadReplicaDBClusterIdentifiers()
method.
public final String licenseModel()
License model information for this DB instance.
public final Integer iops()
Specifies the Provisioned IOPS (I/O operations per second) value.
public final boolean hasOptionGroupMemberships()
isEmpty() method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final List<OptionGroupMembership> optionGroupMemberships()
(Not supported by Neptune)
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasOptionGroupMemberships() method.
public final String characterSetName()
(Not supported by Neptune)
public final String secondaryAvailabilityZone()
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
@Deprecated public final Boolean publiclyAccessible()
This flag should no longer be used.
public final boolean hasStatusInfos()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<DBInstanceStatusInfo> statusInfos()
The status of a Read Replica. If the instance is not a Read Replica, this is blank.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasStatusInfos() method.
public final String storageType()
Specifies the storage type associated with DB instance.
public final String tdeCredentialArn()
The ARN from the key store with which the instance is associated for TDE encryption.
public final Integer 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.
public final String 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.
public final Boolean storageEncrypted()
Not supported: The encryption for DB instances is managed by the DB cluster.
public final String kmsKeyId()
Not supported: The encryption for DB instances is managed by the DB cluster.
public final String 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.
public final String caCertificateIdentifier()
The identifier of the CA certificate for this DB instance.
public final boolean hasDomainMemberships()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<DomainMembership> domainMemberships()
Not supported
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasDomainMemberships() method.
public final Boolean copyTagsToSnapshot()
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
public final Integer monitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
public final String enhancedMonitoringResourceArn()
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
public final String monitoringRoleArn()
The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
public final Integer 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.
public final String dbInstanceArn()
The Amazon Resource Name (ARN) for the DB instance.
public final String timezone()
Not supported.
public final Boolean iamDatabaseAuthenticationEnabled()
True if Amazon Identity and Access Management (IAM) authentication is enabled, and otherwise false.
public final Boolean performanceInsightsEnabled()
(Not supported by Neptune)
public final String performanceInsightsKMSKeyId()
(Not supported by Neptune)
public final boolean hasEnabledCloudwatchLogsExports()
isEmpty() method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final List<String> enabledCloudwatchLogsExports()
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasEnabledCloudwatchLogsExports() method.
public final Boolean 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.
public DBInstance.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<DBInstance.Builder,DBInstance>public static DBInstance.Builder builder()
public static Class<? extends DBInstance.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2023. All rights reserved.