@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()
Specifies the allocated storage size specified in gibibytes.
|
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 AWS 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()
Returns true if the DBParameterGroups property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasDbSecurityGroups()
Returns true if the DBSecurityGroups property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasDomainMemberships()
Returns true if the DomainMemberships property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasEnabledCloudwatchLogsExports()
Returns true if the EnabledCloudwatchLogsExports property was specified by the sender (it may be empty), or false
if the sender did not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasOptionGroupMemberships()
Returns true if the OptionGroupMemberships property was specified by the sender (it may be empty), or false if
the sender did not specify the value (it will be empty).
|
boolean |
hasReadReplicaDBClusterIdentifiers()
Returns true if the ReadReplicaDBClusterIdentifiers property was specified by the sender (it may be empty), or
false if the sender did not specify the value (it will be empty).
|
boolean |
hasReadReplicaDBInstanceIdentifiers()
Returns true if the ReadReplicaDBInstanceIdentifiers property was specified by the sender (it may be empty), or
false if the sender did not specify the value (it will be empty).
|
boolean |
hasStatusInfos()
Returns true if the StatusInfos property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
boolean |
hasVpcSecurityGroups()
Returns true if the VpcSecurityGroups property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
Boolean |
iamDatabaseAuthenticationEnabled()
True if AWS 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()
Contains the master username for the DB instance.
|
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()
This flag should no longer be used.
|
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 String dbInstanceIdentifier()
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
public String dbInstanceClass()
Contains the name of the compute and memory capacity class of the DB instance.
public String engine()
Provides the name of the database engine to be used for this DB instance.
public String dbInstanceStatus()
Specifies the current state of this database.
public String masterUsername()
Contains the master username for the DB instance.
public String dbName()
The database name.
public Endpoint endpoint()
Specifies the connection endpoint.
public Integer allocatedStorage()
Specifies the allocated storage size specified in gibibytes.
public Instant instanceCreateTime()
Provides the date and time the DB instance was created.
public 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 Integer backupRetentionPeriod()
Specifies the number of days for which automatic DB snapshots are retained.
public boolean hasDbSecurityGroups()
public 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.
You can use hasDbSecurityGroups() to see if a value was sent in this field.
DBSecurityGroup.Name and
DBSecurityGroup.Status subelements.public boolean hasVpcSecurityGroups()
public 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.
You can use hasVpcSecurityGroups() to see if a value was sent in this field.
public boolean hasDbParameterGroups()
public 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.
You can use hasDbParameterGroups() to see if a value was sent in this field.
public String availabilityZone()
Specifies the name of the Availability Zone the DB instance is located in.
public DBSubnetGroup dbSubnetGroup()
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
public String preferredMaintenanceWindow()
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
public 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 Instant latestRestorableTime()
Specifies the latest time to which a database can be restored with point-in-time restore.
public Boolean multiAZ()
Specifies if the DB instance is a Multi-AZ deployment.
public String engineVersion()
Indicates the database engine version.
public Boolean autoMinorVersionUpgrade()
Indicates that minor version patches are applied automatically.
public String readReplicaSourceDBInstanceIdentifier()
Contains the identifier of the source DB instance if this DB instance is a Read Replica.
public boolean hasReadReplicaDBInstanceIdentifiers()
public 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.
You can use hasReadReplicaDBInstanceIdentifiers() to see if a value was sent in this field.
public boolean hasReadReplicaDBClusterIdentifiers()
public 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.
You can use hasReadReplicaDBClusterIdentifiers() to see if a value was sent in this field.
public String licenseModel()
License model information for this DB instance.
public Integer iops()
Specifies the Provisioned IOPS (I/O operations per second) value.
public boolean hasOptionGroupMemberships()
public List<OptionGroupMembership> optionGroupMemberships()
(Not supported by Neptune)
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasOptionGroupMemberships() to see if a value was sent in this field.
public String characterSetName()
(Not supported by Neptune)
public String secondaryAvailabilityZone()
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
public Boolean publiclyAccessible()
This flag should no longer be used.
public boolean hasStatusInfos()
public 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.
You can use hasStatusInfos() to see if a value was sent in this field.
public String storageType()
Specifies the storage type associated with DB instance.
public String tdeCredentialArn()
The ARN from the key store with which the instance is associated for TDE encryption.
public 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 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 Boolean storageEncrypted()
Not supported: The encryption for DB instances is managed by the DB cluster.
public String kmsKeyId()
Not supported: The encryption for DB instances is managed by the DB cluster.
public String dbiResourceId()
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.
public String caCertificateIdentifier()
The identifier of the CA certificate for this DB instance.
public boolean hasDomainMemberships()
public List<DomainMembership> domainMemberships()
Not supported
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasDomainMemberships() to see if a value was sent in this field.
public Boolean copyTagsToSnapshot()
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
public Integer monitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
public 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 String monitoringRoleArn()
The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
public 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 String dbInstanceArn()
The Amazon Resource Name (ARN) for the DB instance.
public String timezone()
Not supported.
public Boolean iamDatabaseAuthenticationEnabled()
True if AWS Identity and Access Management (IAM) authentication is enabled, and otherwise false.
public Boolean performanceInsightsEnabled()
(Not supported by Neptune)
public String performanceInsightsKMSKeyId()
(Not supported by Neptune)
public boolean hasEnabledCloudwatchLogsExports()
public 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.
You can use hasEnabledCloudwatchLogsExports() to see if a value was sent in this field.
public 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 boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic String toString()
Copyright © 2020. All rights reserved.