Class DBInstance
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DBInstance.Builder,
DBInstance>
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations CreateDBInstance
,
CreateDBInstanceReadReplica
, DeleteDBInstance
, DescribeDBInstances
,
ModifyDBInstance
, PromoteReadReplica
, RebootDBInstance
,
RestoreDBInstanceFromDBSnapshot
, RestoreDBInstanceFromS3
,
RestoreDBInstanceToPointInTime
, StartDBInstance
, and StopDBInstance
.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Indicates whether engine-native audit fields are included in the database activity stream.final String
The name of the Amazon Kinesis data stream used for the database activity stream.final String
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.final ActivityStreamMode
The mode of the database activity stream.final String
The mode of the database activity stream.The status of the policy state of the activity stream.final String
The status of the policy state of the activity stream.final ActivityStreamStatus
The status of the database activity stream.final String
The status of the database activity stream.final Integer
The amount of storage in gibibytes (GiB) allocated for the DB instance.final List
<DBInstanceRole> The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.final Instant
The time when a stopped DB instance is restarted automatically.final AutomationMode
The automation mode of the RDS Custom DB instance:full
orall paused
.final String
The automation mode of the RDS Custom DB instance:full
orall paused
.final Boolean
Indicates whether minor version patches are applied automatically.final String
The name of the Availability Zone where the DB instance is located.final String
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.final Integer
The number of days for which automatic DB snapshots are retained.final String
The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.static DBInstance.Builder
builder()
final String
The identifier of the CA certificate for this DB instance.final CertificateDetails
The details of the DB instance's server certificate.final String
If present, specifies the name of the character set that this instance is associated with.final Boolean
Indicates whether tags are copied from the DB instance to snapshots of the DB instance.final Boolean
Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.final String
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.final String
If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is a member of.final String
The Amazon Resource Name (ARN) for the DB instance.The list of replicated automated backups associated with the DB instance.final String
The name of the compute and memory capacity class of the DB instance.final String
The user-supplied database identifier.final Integer
The port that the DB instance listens on.final String
The current state of this database.final String
The Amazon Web Services Region-unique, immutable identifier for the DB instance.final String
dbName()
The initial database name that you provided (if required) when you created the DB instance.final List
<DBParameterGroupStatus> The list of DB parameter groups applied to this DB instance.final List
<DBSecurityGroupMembership> A list of DB security group elements containingDBSecurityGroup.Name
andDBSecurityGroup.Status
subelements.final DBSubnetGroup
Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.final String
The Oracle system ID (Oracle SID) for a container database (CDB).final Boolean
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.final Boolean
Indicates whether the DB instance has deletion protection enabled.final List
<DomainMembership> 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 Endpoint
endpoint()
The connection endpoint for the DB instance.final String
engine()
The database engine used for this DB instance.final String
The version of the database engine.final String
The Amazon Resource Name (ARN) of the Amazon 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 DBInstanceAutomatedBackupsReplications 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 TagList property.final boolean
For responses, this returns true if the service returned a value for the VpcSecurityGroups property.final Boolean
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance.final Instant
The date and time when the DB instance was created.final Integer
iops()
The Provisioned IOPS (I/O operations per second) value for the DB instance.final Boolean
Indicates whether an upgrade is recommended for the storage file system configuration on the DB instance.final String
kmsKeyId()
IfStorageEncrypted
is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance.final Instant
The latest time to which a database in this DB instance can be restored with point-in-time restore.final String
The license model information for this DB instance.final Endpoint
The listener connection endpoint for SQL Server Always On.final String
The master username for the DB instance.final MasterUserSecret
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.final Integer
The upper limit in gibibytes (GiB) 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 RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.final Boolean
multiAZ()
Indicates whether the DB instance is a Multi-AZ deployment.final Boolean
Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).final String
The name of the NCHAR character set for the Oracle DB instance.final String
The network type of the DB instance.final List
<OptionGroupMembership> The list of option group memberships for this DB instance.final PendingModifiedValues
Information about pending changes to the DB instance.final String
The progress of the storage optimization operation as a percentage.final Boolean
Indicates whether Performance Insights is enabled for the DB instance.final String
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.final Integer
The number of days to retain Performance Insights data.final String
The daily time range during which automated backups are created if automated backups are enabled, as determined by theBackupRetentionPeriod
.final String
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).final List
<ProcessorFeature> 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 of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.final Boolean
Indicates whether the DB instance is publicly accessible.The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.The identifiers of the read replicas associated with this DB instance.final String
The identifier of the source DB cluster if this DB instance is a read replica.final String
The identifier of the source DB instance if this DB instance is a read replica.final ReplicaMode
The open mode of an Oracle read replica.final String
The open mode of an Oracle read replica.final Instant
The number of minutes to pause the automation.final String
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.static Class
<? extends DBInstance.Builder> final List
<DBInstanceStatusInfo> The status of a read replica.final Boolean
Indicates whether the DB instance is encrypted.final Integer
The storage throughput for the DB instance.final String
The storage type associated with the DB instance.tagList()
Returns the value of the TagList property for this object.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.final List
<VpcSecurityGroupMembership> The list of Amazon EC2 VPC security groups that the DB instance belongs to.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
dbInstanceIdentifier
The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
- Returns:
- The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
-
dbInstanceClass
The name of the compute and memory capacity class of the DB instance.
- Returns:
- The name of the compute and memory capacity class of the DB instance.
-
engine
The database engine used for this DB instance.
- Returns:
- The database engine used for this DB instance.
-
dbInstanceStatus
The current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
- Returns:
- The current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
-
automaticRestartTime
The time when a stopped DB instance is restarted automatically.
- Returns:
- The time when a stopped DB instance is restarted automatically.
-
masterUsername
The master username for the DB instance.
- Returns:
- The master username for the DB instance.
-
dbName
The initial database name that you provided (if required) when you created the DB instance. This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name identifies the PDB rather than the CDB.
- Returns:
- The initial database name that you provided (if required) when you created the DB instance. This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name identifies the PDB rather than the CDB.
-
endpoint
The connection endpoint for the DB instance.
The endpoint might not be shown for instances with the status of
creating
.- Returns:
- The connection endpoint for the DB instance.
The endpoint might not be shown for instances with the status of
creating
.
-
allocatedStorage
The amount of storage in gibibytes (GiB) allocated for the DB instance.
- Returns:
- The amount of storage in gibibytes (GiB) allocated for the DB instance.
-
instanceCreateTime
The date and time when the DB instance was created.
- Returns:
- The date and time when the DB instance was created.
-
preferredBackupWindow
The daily time range during which automated backups are created if automated backups are enabled, as determined by the
BackupRetentionPeriod
.- Returns:
- The daily time range during which automated backups are created if automated backups are enabled, as
determined by the
BackupRetentionPeriod
.
-
backupRetentionPeriod
The number of days for which automatic DB snapshots are retained.
- Returns:
- The number of days for which automatic DB snapshots are retained.
-
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 DB security group elements containing
DBSecurityGroup.Name
andDBSecurityGroup.Status
subelements.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDbSecurityGroups()
method.- Returns:
- A list of DB security group elements containing
DBSecurityGroup.Name
andDBSecurityGroup.Status
subelements.
-
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
The list of Amazon EC2 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:
- The list of Amazon EC2 VPC security groups that the DB instance belongs to.
-
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
The list of DB parameter groups applied to this DB instance.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDbParameterGroups()
method.- Returns:
- The list of DB parameter groups applied to this DB instance.
-
availabilityZone
The name of the Availability Zone where the DB instance is located.
- Returns:
- The name of the Availability Zone where the DB instance is located.
-
dbSubnetGroup
Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
- Returns:
- Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
-
preferredMaintenanceWindow
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
- Returns:
- The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
-
pendingModifiedValues
Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.
- Returns:
- Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.
-
latestRestorableTime
The latest time to which a database in this DB instance can be restored with point-in-time restore.
- Returns:
- The latest time to which a database in this DB instance can be restored with point-in-time restore.
-
multiAZ
Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.
- Returns:
- Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.
-
engineVersion
The version of the database engine.
- Returns:
- The version of the database engine.
-
autoMinorVersionUpgrade
Indicates whether minor version patches are applied automatically.
- Returns:
- Indicates whether minor version patches are applied automatically.
-
readReplicaSourceDBInstanceIdentifier
The identifier of the source DB instance if this DB instance is a read replica.
- Returns:
- The identifier of the source DB instance if this DB instance is a read replica.
-
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
The 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:
- The 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
The 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 for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.
Currently, each RDS DB instance can have only one Aurora 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:
- The 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 for MySQL DB instance, the Aurora MySQL DB
cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region
Aurora read replicas.
Currently, each RDS DB instance can have only one Aurora read replica.
-
replicaMode
The open mode of an Oracle read replica. The default is
open-read-only
. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.This attribute is only supported in RDS for Oracle.
If the service returns an enum value that is not available in the current SDK version,
replicaMode
will returnReplicaMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromreplicaModeAsString()
.- Returns:
- The open mode of an Oracle read replica. The default is
open-read-only
. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.This attribute is only supported in RDS for Oracle.
- See Also:
-
replicaModeAsString
The open mode of an Oracle read replica. The default is
open-read-only
. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.This attribute is only supported in RDS for Oracle.
If the service returns an enum value that is not available in the current SDK version,
replicaMode
will returnReplicaMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromreplicaModeAsString()
.- Returns:
- The open mode of an Oracle read replica. The default is
open-read-only
. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.This attribute is only supported in RDS for Oracle.
- See Also:
-
licenseModel
The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.
- Returns:
- The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.
-
iops
The Provisioned IOPS (I/O operations per second) value for the DB instance.
- Returns:
- The Provisioned IOPS (I/O operations per second) value for the 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
If present, specifies the name of the character set that this instance is associated with.
- Returns:
- If present, specifies the name of the character set that this instance is associated with.
-
ncharCharacterSetName
The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
- Returns:
- The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
-
secondaryAvailabilityZone
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
- Returns:
- If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
-
publiclyAccessible
Indicates whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
- Returns:
- Indicates whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
-
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 DB instance isn't a read replica, the value is blank.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasStatusInfos()
method.- Returns:
- The status of a read replica. If the DB instance isn't a read replica, the value is blank.
-
storageType
The storage type associated with the DB instance.
- Returns:
- The storage type associated with the DB instance.
-
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.
-
dbInstancePort
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:
- 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.
-
dbClusterIdentifier
If the DB instance is a member of a DB cluster, indicates 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, indicates the name of the DB cluster that the DB instance is a member of.
-
storageEncrypted
Indicates whether the DB instance is encrypted.
- Returns:
- Indicates whether the DB instance is encrypted.
-
kmsKeyId
If
StorageEncrypted
is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance.The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
- Returns:
- If
StorageEncrypted
is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance.The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
-
dbiResourceId
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services 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 Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
-
caCertificateIdentifier
The identifier of the CA certificate for this DB instance.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- Returns:
- The identifier of the CA certificate for this DB instance.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
-
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
Indicates whether tags are copied from the DB instance to snapshots of the DB instance.
This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see
DBCluster
.- Returns:
- Indicates whether tags are copied from the DB instance to snapshots of the DB instance.
This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see
DBCluster
.
-
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.
-
enhancedMonitoringResourceArn
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
- Returns:
- The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
-
monitoringRoleArn
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
- Returns:
- The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
-
promotionTier
The order of priority 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.
- Returns:
- The order of priority 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.
-
dbInstanceArn
The Amazon Resource Name (ARN) for the DB instance.
- Returns:
- The Amazon Resource Name (ARN) for the DB instance.
-
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.- Returns:
- 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.
-
iamDatabaseAuthenticationEnabled
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance.
For a list of engine versions that support IAM database authentication, see IAM database authentication in the Amazon RDS User Guide and IAM database authentication in Aurora in the Amazon Aurora User Guide.
- Returns:
- Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to
database accounts is enabled for the DB instance.
For a list of engine versions that support IAM database authentication, see IAM database authentication in the Amazon RDS User Guide and IAM database authentication in Aurora in the Amazon Aurora User Guide.
-
performanceInsightsEnabled
Indicates whether Performance Insights is enabled for the DB instance.
- Returns:
- Indicates whether Performance Insights is enabled for the DB instance.
-
performanceInsightsKMSKeyId
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
- Returns:
- The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
-
performanceInsightsRetentionPeriod
The number of days to retain Performance Insights data.
Valid Values:
-
7
-
month * 31, where month is a number of months from 1-23. Examples:
93
(3 months * 31),341
(11 months * 31),589
(19 months * 31) -
731
Default:
7
days- Returns:
- The number of days to retain Performance Insights data.
Valid Values:
-
7
-
month * 31, where month is a number of months from 1-23. Examples:
93
(3 months * 31),341
(11 months * 31),589
(19 months * 31) -
731
Default:
7
days -
-
-
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.
Log types vary by DB engine. For information about the log types for each DB engine, see Monitoring Amazon RDS log files in the Amazon RDS User Guide.
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.
Log types vary by DB engine. For information about the log types for each DB engine, see Monitoring Amazon RDS log files in the Amazon RDS User Guide.
-
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.
-
deletionProtection
Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.
- Returns:
- Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.
-
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 Amazon Web Services Identity and Access Management (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 Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
-
listenerEndpoint
The listener connection endpoint for SQL Server Always On.
- Returns:
- The listener connection endpoint for SQL Server Always On.
-
maxAllocatedStorage
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
- Returns:
- The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
-
hasTagList
public final boolean hasTagList()For responses, this returns true if the service returned a value for the TagList 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. -
tagList
Returns the value of the TagList property for this object.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
hasTagList()
method.- Returns:
- The value of the TagList property for this object.
-
hasDbInstanceAutomatedBackupsReplications
public final boolean hasDbInstanceAutomatedBackupsReplications()For responses, this returns true if the service returned a value for the DBInstanceAutomatedBackupsReplications 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. -
dbInstanceAutomatedBackupsReplications
The list of replicated automated backups 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
hasDbInstanceAutomatedBackupsReplications()
method.- Returns:
- The list of replicated automated backups associated with the DB instance.
-
customerOwnedIpEnabled
Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
- Returns:
- Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
-
awsBackupRecoveryPointArn
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
- Returns:
- The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
-
activityStreamStatus
The status of the database activity stream.
If the service returns an enum value that is not available in the current SDK version,
activityStreamStatus
will returnActivityStreamStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactivityStreamStatusAsString()
.- Returns:
- The status of the database activity stream.
- See Also:
-
activityStreamStatusAsString
The status of the database activity stream.
If the service returns an enum value that is not available in the current SDK version,
activityStreamStatus
will returnActivityStreamStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactivityStreamStatusAsString()
.- Returns:
- The status of the database activity stream.
- See Also:
-
activityStreamKmsKeyId
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
- Returns:
- The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
-
activityStreamKinesisStreamName
The name of the Amazon Kinesis data stream used for the database activity stream.
- Returns:
- The name of the Amazon Kinesis data stream used for the database activity stream.
-
activityStreamMode
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
If the service returns an enum value that is not available in the current SDK version,
activityStreamMode
will returnActivityStreamMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactivityStreamModeAsString()
.- Returns:
- The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
- See Also:
-
activityStreamModeAsString
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
If the service returns an enum value that is not available in the current SDK version,
activityStreamMode
will returnActivityStreamMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactivityStreamModeAsString()
.- Returns:
- The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
- See Also:
-
activityStreamEngineNativeAuditFieldsIncluded
Indicates whether engine-native audit fields are included in the database activity stream.
- Returns:
- Indicates whether engine-native audit fields are included in the database activity stream.
-
automationMode
The automation mode of the RDS Custom DB instance:
full
orall paused
. Iffull
, the DB instance automates monitoring and instance recovery. Ifall paused
, the instance pauses automation for the duration set by--resume-full-automation-mode-minutes
.If the service returns an enum value that is not available in the current SDK version,
automationMode
will returnAutomationMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromautomationModeAsString()
.- Returns:
- The automation mode of the RDS Custom DB instance:
full
orall paused
. Iffull
, the DB instance automates monitoring and instance recovery. Ifall paused
, the instance pauses automation for the duration set by--resume-full-automation-mode-minutes
. - See Also:
-
automationModeAsString
The automation mode of the RDS Custom DB instance:
full
orall paused
. Iffull
, the DB instance automates monitoring and instance recovery. Ifall paused
, the instance pauses automation for the duration set by--resume-full-automation-mode-minutes
.If the service returns an enum value that is not available in the current SDK version,
automationMode
will returnAutomationMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromautomationModeAsString()
.- Returns:
- The automation mode of the RDS Custom DB instance:
full
orall paused
. Iffull
, the DB instance automates monitoring and instance recovery. Ifall paused
, the instance pauses automation for the duration set by--resume-full-automation-mode-minutes
. - See Also:
-
resumeFullAutomationModeTime
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
- Returns:
- The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
-
customIamInstanceProfile
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
-
The profile must exist in your account.
-
The profile must have an IAM role that Amazon EC2 has permissions to assume.
-
The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom
.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
- Returns:
- The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The
instance profile must meet the following requirements:
-
The profile must exist in your account.
-
The profile must have an IAM role that Amazon EC2 has permissions to assume.
-
The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom
.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
-
-
-
backupTarget
The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
- Returns:
- The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
-
networkType
The network type of the DB instance.
The network type is determined by the
DBSubnetGroup
specified for the DB instance. ADBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL
).For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid Values:
IPV4 | DUAL
- Returns:
- The network type of the DB instance.
The network type is determined by the
DBSubnetGroup
specified for the DB instance. ADBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL
).For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid Values:
IPV4 | DUAL
-
activityStreamPolicyStatus
The status of the policy state of the activity stream.
If the service returns an enum value that is not available in the current SDK version,
activityStreamPolicyStatus
will returnActivityStreamPolicyStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactivityStreamPolicyStatusAsString()
.- Returns:
- The status of the policy state of the activity stream.
- See Also:
-
activityStreamPolicyStatusAsString
The status of the policy state of the activity stream.
If the service returns an enum value that is not available in the current SDK version,
activityStreamPolicyStatus
will returnActivityStreamPolicyStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactivityStreamPolicyStatusAsString()
.- Returns:
- The status of the policy state of the activity stream.
- See Also:
-
storageThroughput
The storage throughput for the DB instance.
This setting applies only to the
gp3
storage type.- Returns:
- The storage throughput for the DB instance.
This setting applies only to the
gp3
storage type.
-
dbSystemId
The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is only valid for RDS Custom DB instances.
- Returns:
- The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is only valid for RDS Custom DB instances.
-
masterUserSecret
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
- Returns:
- The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
-
certificateDetails
The details of the DB instance's server certificate.
- Returns:
- The details of the DB instance's server certificate.
-
readReplicaSourceDBClusterIdentifier
The identifier of the source DB cluster if this DB instance is a read replica.
- Returns:
- The identifier of the source DB cluster if this DB instance is a read replica.
-
percentProgress
The progress of the storage optimization operation as a percentage.
- Returns:
- The progress of the storage optimization operation as a percentage.
-
dedicatedLogVolume
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
- Returns:
- Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
-
isStorageConfigUpgradeAvailable
Indicates whether an upgrade is recommended for the storage file system configuration on the DB instance. To migrate to the preferred configuration, you can either create a blue/green deployment, or create a read replica from the DB instance. For more information, see Upgrading the storage file system for a DB instance.
- Returns:
- Indicates whether an upgrade is recommended for the storage file system configuration on the DB instance. To migrate to the preferred configuration, you can either create a blue/green deployment, or create a read replica from the DB instance. For more information, see Upgrading the storage file system for a DB instance.
-
multiTenant
Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
- Returns:
- Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
-
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<DBInstance.Builder,
DBInstance> - 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
-