@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 RDS 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()
If present, specifies the name of the character set that this instance is associated with.
|
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 meaning of this parameter differs according to the database engine you use.
|
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 if the DB instance has deletion protection enabled.
|
List<DomainMembership> |
domainMemberships()
The Active Directory Domain membership records associated with the DB instance.
|
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) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
Boolean |
iamDatabaseAuthenticationEnabled()
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts 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()
If
StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance. |
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.
|
Endpoint |
listenerEndpoint()
Specifies the listener connection endpoint for SQL Server Always On.
|
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 RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
|
Boolean |
multiAZ()
Specifies if the DB instance is a Multi-AZ deployment.
|
List<OptionGroupMembership> |
optionGroupMemberships()
Provides the list of option group memberships for this DB instance.
|
PendingModifiedValues |
pendingModifiedValues()
Specifies that changes to the DB instance are pending.
|
Boolean |
performanceInsightsEnabled()
True if Performance Insights is enabled for the DB instance, and otherwise false.
|
String |
performanceInsightsKMSKeyId()
The AWS KMS key identifier for encryption of Performance Insights data.
|
Integer |
performanceInsightsRetentionPeriod()
The amount of time, in days, to retain Performance Insights data.
|
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).
|
List<ProcessorFeature> |
processorFeatures()
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
Integer |
promotionTier()
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.
|
Boolean |
publiclyAccessible()
Specifies the accessibility options for the DB instance.
|
List<String> |
readReplicaDBClusterIdentifiers()
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a Read
Replica.
|
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()
Specifies whether the DB instance is encrypted.
|
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()
The time zone of the DB instance.
|
DBInstance.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
List<VpcSecurityGroupMembership> |
vpcSecurityGroups()
Provides a list of VPC security group elements that the DB instance belongs to.
|
copy
public 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 meaning of this parameter differs according to the database engine you use. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
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 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.
DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.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.
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.
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 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.
public List<String> readReplicaDBClusterIdentifiers()
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String licenseModel()
License model information for this DB instance.
public Integer iops()
Specifies the Provisioned IOPS (I/O operations per second) value.
public List<OptionGroupMembership> optionGroupMemberships()
Provides the list of option group memberships for this DB instance.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String characterSetName()
If present, specifies the name of the character set that this instance is associated with.
public String secondaryAvailabilityZone()
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
public Boolean publiclyAccessible()
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
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.
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()
Specifies whether the DB instance is encrypted.
public String kmsKeyId()
If StorageEncrypted
is true, the AWS KMS key identifier for the encrypted DB instance.
StorageEncrypted
is true, the AWS KMS key identifier for the encrypted DB instance.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 List<DomainMembership> domainMemberships()
The Active Directory Domain membership records associated with the DB instance.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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 RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
public Integer promotionTier()
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.
public String dbInstanceArn()
The Amazon Resource Name (ARN) for the DB instance.
public String timezone()
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.
Timezone
element is empty.
Timezone
content appears only for Microsoft SQL Server DB instances that were created with a
time zone specified.public Boolean iamDatabaseAuthenticationEnabled()
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
IAM database authentication can be enabled for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
public Boolean performanceInsightsEnabled()
True if Performance Insights is enabled for the DB instance, and otherwise false.
public String performanceInsightsKMSKeyId()
The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
public Integer performanceInsightsRetentionPeriod()
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
public List<String> enabledCloudwatchLogsExports()
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
public List<ProcessorFeature> processorFeatures()
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public Boolean deletionProtection()
Indicates if the DB instance has deletion protection enabled. The database can't be deleted when this value is set to true. For more information, see Deleting a DB Instance.
public Endpoint listenerEndpoint()
Specifies the listener connection endpoint for SQL Server Always On.
public DBInstance.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DBInstance.Builder,DBInstance>
public static DBInstance.Builder builder()
public static Class<? extends DBInstance.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.