@Generated(value="software.amazon.awssdk:codegen") public final class AwsRdsDbInstanceDetails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AwsRdsDbInstanceDetails.Builder,AwsRdsDbInstanceDetails>
Contains the details of an Amazon RDS DB instance.
| Modifier and Type | Class and Description |
|---|---|
static interface |
AwsRdsDbInstanceDetails.Builder |
| Modifier and Type | Method and Description |
|---|---|
Integer |
allocatedStorage()
The amount of storage (in gigabytes) to initially allocate for the DB instance.
|
List<AwsRdsDbInstanceAssociatedRole> |
associatedRoles()
The IAM roles associated with the DB instance.
|
Boolean |
autoMinorVersionUpgrade()
Indicates whether minor version patches are applied automatically.
|
String |
availabilityZone()
The Availability Zone where the DB instance will be created.
|
Integer |
backupRetentionPeriod()
The number of days for which to retain automated backups.
|
static AwsRdsDbInstanceDetails.Builder |
builder() |
String |
caCertificateIdentifier()
The identifier of the CA certificate for this DB instance.
|
String |
characterSetName()
The name of the character set that this DB instance is associated with.
|
Boolean |
copyTagsToSnapshot()
Whether to copy resource tags 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 |
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()
The current status of the DB instance.
|
String |
dbiResourceId()
The Amazon Web Services Region-unique, immutable identifier for the DB instance.
|
String |
dbName()
The meaning of this parameter differs according to the database engine you use.
|
List<AwsRdsDbParameterGroup> |
dbParameterGroups()
A list of the DB parameter groups to assign to the DB instance.
|
List<String> |
dbSecurityGroups()
A list of the DB security groups to assign to the DB instance.
|
AwsRdsDbSubnetGroup |
dbSubnetGroup()
Information about the subnet group that is associated with the DB instance.
|
Boolean |
deletionProtection()
Indicates whether the DB instance has deletion protection enabled.
|
List<AwsRdsDbDomainMembership> |
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.
|
AwsRdsDbInstanceEndpoint |
endpoint()
Specifies the connection endpoint.
|
String |
engine()
Provides the name of the database engine to use for this DB instance.
|
String |
engineVersion()
Indicates the database engine version.
|
String |
enhancedMonitoringResourceArn()
The ARN of the 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 |
hasAssociatedRoles()
For responses, this returns true if the service returned a value for the AssociatedRoles property.
|
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 |
hasProcessorFeatures()
For responses, this returns true if the service returned a value for the ProcessorFeatures 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 mapping of IAM accounts to database accounts is enabled, and otherwise false.
|
String |
instanceCreateTime()
Indicates when the DB instance was created.
|
Integer |
iops()
Specifies the provisioned IOPS (I/O operations per second) for this DB instance.
|
String |
kmsKeyId()
If
StorageEncrypted is true, the KMS key identifier for the encrypted DB instance. |
String |
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.
|
AwsRdsDbInstanceEndpoint |
listenerEndpoint()
Returns the value of the ListenerEndpoint property for this object.
|
String |
masterUsername()
The master user name of the DB instance.
|
Integer |
maxAllocatedStorage()
The upper limit to which Amazon RDS can automatically scale the storage of 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 Amazon RDS to send enhanced monitoring metrics to CloudWatch Logs.
|
Boolean |
multiAz()
Whether the DB instance is a multiple Availability Zone deployment.
|
List<AwsRdsDbOptionGroupMembership> |
optionGroupMemberships()
The list of option group memberships for this DB instance.
|
AwsRdsDbPendingModifiedValues |
pendingModifiedValues()
Changes to the DB instance that are currently pending.
|
Boolean |
performanceInsightsEnabled()
Indicates whether Performance Insights is enabled for the DB instance.
|
String |
performanceInsightsKmsKeyId()
The identifier of the KMS key used to encrypt the Performance Insights data.
|
Integer |
performanceInsightsRetentionPeriod()
The number of days to retain Performance Insights data.
|
String |
preferredBackupWindow()
The range of time each day when automated backups are created, if automated backups are enabled.
|
String |
preferredMaintenanceWindow()
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
List<AwsRdsDbProcessorFeature> |
processorFeatures()
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
Integer |
promotionTier()
The order in which to promote an Aurora replica 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()
List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.
|
List<String> |
readReplicaDBInstanceIdentifiers()
List of identifiers of the read replicas associated with this DB instance.
|
String |
readReplicaSourceDBInstanceIdentifier()
If this DB instance is a read replica, contains the identifier of the source DB instance.
|
List<SdkField<?>> |
sdkFields() |
String |
secondaryAvailabilityZone()
For a DB instance with multi-Availability Zone support, the name of the secondary Availability Zone.
|
static Class<? extends AwsRdsDbInstanceDetails.Builder> |
serializableBuilderClass() |
List<AwsRdsDbStatusInfo> |
statusInfos()
The status of a read replica.
|
Boolean |
storageEncrypted()
Specifies whether the DB instance is encrypted.
|
String |
storageType()
The storage type for the 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.
|
AwsRdsDbInstanceDetails.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
List<AwsRdsDbInstanceVpcSecurityGroup> |
vpcSecurityGroups()
A list of VPC security groups that the DB instance belongs to.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final boolean hasAssociatedRoles()
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<AwsRdsDbInstanceAssociatedRole> associatedRoles()
The IAM roles associated with the 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 hasAssociatedRoles() method.
public final String caCertificateIdentifier()
The identifier of the CA certificate for this DB instance.
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 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 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 dbiResourceId()
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in CloudTrail log entries whenever the KMS key for the DB instance is accessed.
public final String dbName()
The meaning of this parameter differs according to the database engine you use.
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.
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.
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 final Boolean deletionProtection()
Indicates whether the DB instance has deletion protection enabled.
When deletion protection is enabled, the database cannot be deleted.
When deletion protection is enabled, the database cannot be deleted.
public final AwsRdsDbInstanceEndpoint endpoint()
Specifies the connection endpoint.
public final String engine()
Provides the name of the database engine to use for this DB instance.
public final String engineVersion()
Indicates the database engine version.
public final Boolean iamDatabaseAuthenticationEnabled()
True if mapping of 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
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
public final String instanceCreateTime()
Indicates when the DB instance was created.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be
separated by T. For example, 2020-03-22T13:22:13.933Z.
Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
Format. The value cannot contain spaces, and date and time should be separated by T. For
example, 2020-03-22T13:22:13.933Z.
public final String kmsKeyId()
If StorageEncrypted is true, the KMS key identifier for the encrypted DB instance.
StorageEncrypted is true, the KMS key identifier for the encrypted DB instance.public final 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.
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 final Boolean storageEncrypted()
Specifies whether the DB instance is encrypted.
public final String tdeCredentialArn()
The ARN from the key store with which the instance is associated for TDE encryption.
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<AwsRdsDbInstanceVpcSecurityGroup> vpcSecurityGroups()
A list of VPC security groups 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 multiAz()
Whether the DB instance is a multiple Availability Zone deployment.
public final String enhancedMonitoringResourceArn()
The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics data for the DB instance.
public final String dbInstanceStatus()
The current status of the DB instance.
public final String masterUsername()
The master user name of the DB instance.
public final Integer allocatedStorage()
The amount of storage (in gigabytes) to initially allocate for the DB instance.
public final String preferredBackupWindow()
The range of time each day when automated backups are created, if automated backups are enabled.
Uses the format HH:MM-HH:MM. For example, 04:52-05:22.
Uses the format HH:MM-HH:MM. For example, 04:52-05:22.
public final Integer backupRetentionPeriod()
The number of days for which to retain automated backups.
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<String> dbSecurityGroups()
A list of the DB security groups to assign to the 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 hasDbSecurityGroups() 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<AwsRdsDbParameterGroup> dbParameterGroups()
A list of the DB parameter groups to assign to the 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()
The Availability Zone where the DB instance will be created.
public final AwsRdsDbSubnetGroup dbSubnetGroup()
Information about the subnet group that is associated with the DB instance.
public final String preferredMaintenanceWindow()
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Uses the format <day>:HH:MM-<day>:HH:MM.
For the day values, use mon|tue|wed|thu|fri|
sat|sun.
For example, sun:09:32-sun:10:02.
Uses the format <day>:HH:MM-<day>:HH:MM.
For the day values, use mon|tue|wed|thu|
fri|sat|sun.
For example, sun:09:32-sun:10:02.
public final AwsRdsDbPendingModifiedValues pendingModifiedValues()
Changes to the DB instance that are currently pending.
public final String latestRestorableTime()
Specifies the latest time to which a database can be restored with point-in-time restore.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be
separated by T. For example, 2020-03-22T13:22:13.933Z.
Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
Format. The value cannot contain spaces, and date and time should be separated by T. For
example, 2020-03-22T13:22:13.933Z.
public final Boolean autoMinorVersionUpgrade()
Indicates whether minor version patches are applied automatically.
public final String readReplicaSourceDBInstanceIdentifier()
If this DB instance is a read replica, contains the identifier of the source DB instance.
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()
List of 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()
List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.
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) for this DB instance.
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<AwsRdsDbOptionGroupMembership> optionGroupMemberships()
The list of option group memberships for 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 hasOptionGroupMemberships() method.
public final String characterSetName()
The name of the character set that this DB instance is associated with.
public final String secondaryAvailabilityZone()
For a DB instance with multi-Availability Zone support, the name of the secondary Availability Zone.
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<AwsRdsDbStatusInfo> statusInfos()
The status of a read replica. If the instance isn't a read replica, this is empty.
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()
The storage type for the 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<AwsRdsDbDomainMembership> 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.
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()
Whether to copy resource tags 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 monitoringRoleArn()
The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring metrics to CloudWatch Logs.
public final Integer promotionTier()
The order in which to promote an Aurora replica to the primary instance after a failure of the existing primary instance.
public final String timezone()
The time zone of the DB instance.
public final Boolean performanceInsightsEnabled()
Indicates whether Performance Insights is enabled for the DB instance.
public final String performanceInsightsKmsKeyId()
The identifier of the KMS key used to encrypt the Performance Insights data.
public final Integer performanceInsightsRetentionPeriod()
The number of days to retain Performance Insights data.
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 hasProcessorFeatures()
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<AwsRdsDbProcessorFeature> 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.
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 hasProcessorFeatures() method.
public final AwsRdsDbInstanceEndpoint listenerEndpoint()
public final Integer maxAllocatedStorage()
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
public AwsRdsDbInstanceDetails.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<AwsRdsDbInstanceDetails.Builder,AwsRdsDbInstanceDetails>public static AwsRdsDbInstanceDetails.Builder builder()
public static Class<? extends AwsRdsDbInstanceDetails.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2023. All rights reserved.