Class AwsRdsDbInstanceDetails
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AwsRdsDbInstanceDetails.Builder,
AwsRdsDbInstanceDetails>
Contains the details of an Amazon RDS DB instance.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Integer
The amount of storage (in gigabytes) to initially allocate for the DB instance.The IAM roles associated with the DB instance.final Boolean
Indicates whether minor version patches are applied automatically.final String
The Availability Zone where the DB instance will be created.final Integer
The number of days for which to retain automated backups.builder()
final String
The identifier of the CA certificate for this DB instance.final String
The name of the character set that this DB instance is associated with.final Boolean
Whether to copy resource tags to snapshots of the DB instance.final String
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.final String
Contains the name of the compute and memory capacity class of the DB instance.final String
Contains a user-supplied database identifier.final Integer
Specifies the port that the DB instance listens on.final String
The current status of the DB instance.final String
The Amazon Web Services Region-unique, immutable identifier for the DB instance.final String
dbName()
The meaning of this parameter differs according to the database engine you use.final List
<AwsRdsDbParameterGroup> A list of the DB parameter groups to assign to the DB instance.A list of the DB security groups to assign to the DB instance.final AwsRdsDbSubnetGroup
Information about the subnet group that is associated with the DB instance.final Boolean
Indicates whether the DB instance has deletion protection enabled.final List
<AwsRdsDbDomainMembership> The Active Directory domain membership records associated with the DB instance.A list of log types that this DB instance is configured to export to CloudWatch Logs.final AwsRdsDbInstanceEndpoint
endpoint()
Specifies the connection endpoint.final String
engine()
Provides the name of the database engine to use for this DB instance.final String
Indicates the database engine version.final String
The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics data for the DB instance.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AssociatedRoles property.final boolean
For responses, this returns true if the service returned a value for the DbParameterGroups property.final boolean
For responses, this returns true if the service returned a value for the DbSecurityGroups property.final boolean
For responses, this returns true if the service returned a value for the DomainMemberships property.final boolean
For responses, this returns true if the service returned a value for the EnabledCloudWatchLogsExports property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the OptionGroupMemberships property.final boolean
For responses, this returns true if the service returned a value for the ProcessorFeatures property.final boolean
For responses, this returns true if the service returned a value for the ReadReplicaDBClusterIdentifiers property.final boolean
For responses, this returns true if the service returned a value for the ReadReplicaDBInstanceIdentifiers property.final boolean
For responses, this returns true if the service returned a value for the StatusInfos property.final boolean
For responses, this returns true if the service returned a value for the VpcSecurityGroups property.final Boolean
True if mapping of IAM accounts to database accounts is enabled, and otherwise false.final String
Indicates when the DB instance was created.final Integer
iops()
Specifies the provisioned IOPS (I/O operations per second) for this DB instance.final String
kmsKeyId()
IfStorageEncrypted
is true, the KMS key identifier for the encrypted DB instance.final String
Specifies the latest time to which a database can be restored with point-in-time restore.final String
License model information for this DB instance.final AwsRdsDbInstanceEndpoint
Returns the value of the ListenerEndpoint property for this object.final String
The master user name of the DB instance.final Integer
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.final Integer
The interval, in seconds, between points when enhanced monitoring metrics are collected for the DB instance.final String
The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring metrics to CloudWatch Logs.final Boolean
multiAz()
Whether the DB instance is a multiple Availability Zone deployment.The list of option group memberships for this DB instance.Changes to the DB instance that are currently pending.final Boolean
Indicates whether Performance Insights is enabled for the DB instance.final String
The identifier of the KMS key used to encrypt the Performance Insights data.final Integer
The number of days to retain Performance Insights data.final String
The range of time each day when automated backups are created, if automated backups are enabled.final String
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).final List
<AwsRdsDbProcessorFeature> The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.final Integer
The order in which to promote an Aurora replica to the primary instance after a failure of the existing primary instance.final Boolean
Specifies the accessibility options for the DB instance.List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.List of identifiers of the read replicas associated with this DB instance.final String
If this DB instance is a read replica, contains the identifier of the source DB instance.final String
For a DB instance with multi-Availability Zone support, the name of the secondary Availability Zone.static Class
<? extends AwsRdsDbInstanceDetails.Builder> final List
<AwsRdsDbStatusInfo> The status of a read replica.final Boolean
Specifies whether the DB instance is encrypted.final String
The storage type for the DB instance.final String
The ARN from the key store with which the instance is associated for TDE encryption.final String
timezone()
The time zone of the DB instance.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.A list of VPC security groups that the DB instance belongs to.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasAssociatedRoles
public final boolean hasAssociatedRoles()For responses, this returns true if the service returned a value for the AssociatedRoles property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- The IAM roles associated with the DB instance.
-
caCertificateIdentifier
The identifier of the CA certificate for this DB instance.
- Returns:
- The identifier of the CA certificate for this DB instance.
-
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.
- Returns:
- 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.
-
dbInstanceIdentifier
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
- Returns:
- Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
-
dbInstanceClass
Contains the name of the compute and memory capacity class of the DB instance.
- Returns:
- Contains the name of the compute and memory capacity class of the DB instance.
-
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.
- Returns:
- 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.
-
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.
- Returns:
- 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.
-
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.
- Returns:
- 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.
-
deletionProtection
Indicates whether the DB instance has deletion protection enabled.
When deletion protection is enabled, the database cannot be deleted.
- Returns:
- Indicates whether the DB instance has deletion protection enabled.
When deletion protection is enabled, the database cannot be deleted.
-
endpoint
Specifies the connection endpoint.
- Returns:
- Specifies the connection endpoint.
-
engine
Provides the name of the database engine to use for this DB instance.
- Returns:
- Provides the name of the database engine to use for this DB instance.
-
engineVersion
Indicates the database engine version.
- Returns:
- Indicates the database engine version.
-
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
- Returns:
- 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
-
-
-
instanceCreateTime
Indicates when the DB instance was created.
This field accepts only the specified formats. Timestamps can end with
Z
or("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:-
YYYY-MM-DDTHH:MM:SSZ
(for example,2019-01-31T23:00:00Z
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example,2019-01-31T23:00:00.123456789Z
) -
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example,2024-01-04T15:25:10+17:59
) -
YYYY-MM-DDTHH:MM:SS-HHMM
(for example,2024-01-04T15:25:10-1759
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example,2024-01-04T15:25:10.123456789+17:59
)
- Returns:
- Indicates when the DB instance was created.
This field accepts only the specified formats. Timestamps can end with
Z
or("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:-
YYYY-MM-DDTHH:MM:SSZ
(for example,2019-01-31T23:00:00Z
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example,2019-01-31T23:00:00.123456789Z
) -
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example,2024-01-04T15:25:10+17:59
) -
YYYY-MM-DDTHH:MM:SS-HHMM
(for example,2024-01-04T15:25:10-1759
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example,2024-01-04T15:25:10.123456789+17:59
)
-
-
-
kmsKeyId
If
StorageEncrypted
is true, the KMS key identifier for the encrypted DB instance.- Returns:
- If
StorageEncrypted
is true, the KMS key identifier for the encrypted DB instance.
-
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.
- Returns:
- 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.
-
storageEncrypted
Specifies whether the DB instance is encrypted.
- Returns:
- Specifies whether the DB instance is encrypted.
-
tdeCredentialArn
The ARN from the key store with which the instance is associated for TDE encryption.
- Returns:
- The ARN from the key store with which the instance is associated for TDE encryption.
-
hasVpcSecurityGroups
public final boolean hasVpcSecurityGroups()For responses, this returns true if the service returned a value for the VpcSecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- A list of VPC security groups that the DB instance belongs to.
-
multiAz
Whether the DB instance is a multiple Availability Zone deployment.
- Returns:
- Whether the DB instance is a multiple Availability Zone deployment.
-
enhancedMonitoringResourceArn
The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics data for the DB instance.
- Returns:
- The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics data for the DB instance.
-
dbInstanceStatus
The current status of the DB instance.
- Returns:
- The current status of the DB instance.
-
masterUsername
The master user name of the DB instance.
- Returns:
- The master user name of the DB instance.
-
allocatedStorage
The amount of storage (in gigabytes) to initially allocate for the DB instance.
- Returns:
- The amount of storage (in gigabytes) to initially allocate for the DB instance.
-
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
.- Returns:
- 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
.
-
backupRetentionPeriod
The number of days for which to retain automated backups.
- Returns:
- The number of days for which to retain automated backups.
-
hasDbSecurityGroups
public final boolean hasDbSecurityGroups()For responses, this returns true if the service returned a value for the DbSecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- A list of the DB security groups to assign to the DB instance.
-
hasDbParameterGroups
public final boolean hasDbParameterGroups()For responses, this returns true if the service returned a value for the DbParameterGroups property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- A list of the DB parameter groups to assign to the DB instance.
-
availabilityZone
The Availability Zone where the DB instance will be created.
- Returns:
- The Availability Zone where the DB instance will be created.
-
dbSubnetGroup
Information about the subnet group that is associated with the DB instance.
- Returns:
- Information about the subnet group that is associated with the DB instance.
-
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
.- Returns:
- 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
.
-
pendingModifiedValues
Changes to the DB instance that are currently pending.
- Returns:
- Changes to the DB instance that are currently pending.
-
latestRestorableTime
Specifies the latest time to which a database can be restored with point-in-time restore.
This field accepts only the specified formats. Timestamps can end with
Z
or("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:-
YYYY-MM-DDTHH:MM:SSZ
(for example,2019-01-31T23:00:00Z
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example,2019-01-31T23:00:00.123456789Z
) -
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example,2024-01-04T15:25:10+17:59
) -
YYYY-MM-DDTHH:MM:SS-HHMM
(for example,2024-01-04T15:25:10-1759
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example,2024-01-04T15:25:10.123456789+17:59
)
- Returns:
- Specifies the latest time to which a database can be restored with point-in-time restore.
This field accepts only the specified formats. Timestamps can end with
Z
or("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:-
YYYY-MM-DDTHH:MM:SSZ
(for example,2019-01-31T23:00:00Z
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example,2019-01-31T23:00:00.123456789Z
) -
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example,2024-01-04T15:25:10+17:59
) -
YYYY-MM-DDTHH:MM:SS-HHMM
(for example,2024-01-04T15:25:10-1759
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example,2024-01-04T15:25:10.123456789+17:59
)
-
-
-
autoMinorVersionUpgrade
Indicates whether minor version patches are applied automatically.
- Returns:
- Indicates whether minor version patches are applied automatically.
-
readReplicaSourceDBInstanceIdentifier
If this DB instance is a read replica, contains the identifier of the source DB instance.
- Returns:
- If this DB instance is a read replica, contains the identifier of the source DB instance.
-
hasReadReplicaDBInstanceIdentifiers
public final boolean hasReadReplicaDBInstanceIdentifiers()For responses, this returns true if the service returned a value for the ReadReplicaDBInstanceIdentifiers property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- List of identifiers of the read replicas associated with this DB instance.
-
hasReadReplicaDBClusterIdentifiers
public final boolean hasReadReplicaDBClusterIdentifiers()For responses, this returns true if the service returned a value for the ReadReplicaDBClusterIdentifiers property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.
-
licenseModel
License model information for this DB instance.
- Returns:
- License model information for this DB instance.
-
iops
Specifies the provisioned IOPS (I/O operations per second) for this DB instance.
- Returns:
- Specifies the provisioned IOPS (I/O operations per second) for this DB instance.
-
hasOptionGroupMemberships
public final boolean hasOptionGroupMemberships()For responses, this returns true if the service returned a value for the OptionGroupMemberships property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- The list of option group memberships for this DB instance.
-
characterSetName
The name of the character set that this DB instance is associated with.
- Returns:
- The name of the character set that this DB instance is associated with.
-
secondaryAvailabilityZone
For a DB instance with multi-Availability Zone support, the name of the secondary Availability Zone.
- Returns:
- For a DB instance with multi-Availability Zone support, the name of the secondary Availability Zone.
-
hasStatusInfos
public final boolean hasStatusInfos()For responses, this returns true if the service returned a value for the StatusInfos property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- The status of a read replica. If the instance isn't a read replica, this is empty.
-
storageType
The storage type for the DB instance.
- Returns:
- The storage type for the DB instance.
-
hasDomainMemberships
public final boolean hasDomainMemberships()For responses, this returns true if the service returned a value for the DomainMemberships property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- The Active Directory domain membership records associated with the DB instance.
-
copyTagsToSnapshot
Whether to copy resource tags to snapshots of the DB instance.
- Returns:
- Whether to copy resource tags to snapshots of the DB instance.
-
monitoringInterval
The interval, in seconds, between points when enhanced monitoring metrics are collected for the DB instance.
- Returns:
- The interval, in seconds, between points when enhanced monitoring metrics are collected for the DB instance.
-
monitoringRoleArn
The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring metrics to CloudWatch Logs.
- Returns:
- The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring metrics to CloudWatch Logs.
-
promotionTier
The order in which to promote an Aurora replica to the primary instance after a failure of the existing primary instance.
- Returns:
- The order in which to promote an Aurora replica to the primary instance after a failure of the existing primary instance.
-
timezone
The time zone of the DB instance.
- Returns:
- The time zone of the DB instance.
-
performanceInsightsEnabled
Indicates whether Performance Insights is enabled for the DB instance.
- Returns:
- Indicates whether Performance Insights is enabled for the DB instance.
-
performanceInsightsKmsKeyId
The identifier of the KMS key used to encrypt the Performance Insights data.
- Returns:
- The identifier of the KMS key used to encrypt the Performance Insights data.
-
performanceInsightsRetentionPeriod
The number of days to retain Performance Insights data.
- Returns:
- The number of days to retain Performance Insights data.
-
hasEnabledCloudWatchLogsExports
public final boolean hasEnabledCloudWatchLogsExports()For responses, this returns true if the service returned a value for the EnabledCloudWatchLogsExports property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- A list of log types that this DB instance is configured to export to CloudWatch Logs.
-
hasProcessorFeatures
public final boolean hasProcessorFeatures()For responses, this returns true if the service returned a value for the ProcessorFeatures property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
-
listenerEndpoint
Returns the value of the ListenerEndpoint property for this object.- Returns:
- The value of the ListenerEndpoint property for this object.
-
maxAllocatedStorage
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
- Returns:
- The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AwsRdsDbInstanceDetails.Builder,
AwsRdsDbInstanceDetails> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-