@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DBInstance extends Object implements Serializable, Cloneable
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
Constructor and Description |
---|
DBInstance() |
Modifier and Type | Method and Description |
---|---|
DBInstance |
clone() |
boolean |
equals(Object obj) |
Integer |
getAllocatedStorage()
Specifies the allocated storage size specified in gigabytes.
|
Boolean |
getAutoMinorVersionUpgrade()
Indicates that minor version patches are applied automatically.
|
String |
getAvailabilityZone()
Specifies the name of the Availability Zone the DB instance is located in.
|
Integer |
getBackupRetentionPeriod()
Specifies the number of days for which automatic DB snapshots are retained.
|
String |
getCACertificateIdentifier()
The identifier of the CA certificate for this DB instance.
|
String |
getCharacterSetName()
If present, specifies the name of the character set that this instance is associated with.
|
Boolean |
getCopyTagsToSnapshot()
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
|
String |
getDBClusterIdentifier()
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 |
getDBInstanceArn()
The Amazon Resource Name (ARN) for the DB instance.
|
String |
getDBInstanceClass()
Contains the name of the compute and memory capacity class of the DB instance.
|
String |
getDBInstanceIdentifier()
Contains a user-supplied database identifier.
|
Integer |
getDbInstancePort()
Specifies the port that the DB instance listens on.
|
String |
getDBInstanceStatus()
Specifies the current state of this database.
|
String |
getDbiResourceId()
The region-unique, immutable identifier for the DB instance.
|
String |
getDBName()
The meaning of this parameter differs according to the database engine you use.
|
List<DBParameterGroupStatus> |
getDBParameterGroups()
Provides the list of DB parameter groups applied to this DB instance.
|
List<DBSecurityGroupMembership> |
getDBSecurityGroups()
Provides List of DB security group elements containing only
DBSecurityGroup.Name and
DBSecurityGroup.Status subelements. |
DBSubnetGroup |
getDBSubnetGroup()
Specifies information on the subnet group associated with the DB instance, including the name, description, and
subnets in the subnet group.
|
List<DomainMembership> |
getDomainMemberships()
The Active Directory Domain membership records associated with the DB instance.
|
Endpoint |
getEndpoint()
Specifies the connection endpoint.
|
String |
getEngine()
Provides the name of the database engine to be used for this DB instance.
|
String |
getEngineVersion()
Indicates the database engine version.
|
String |
getEnhancedMonitoringResourceArn()
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring
metrics data for the DB instance.
|
Boolean |
getIAMDatabaseAuthenticationEnabled()
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise
false.
|
Date |
getInstanceCreateTime()
Provides the date and time the DB instance was created.
|
Integer |
getIops()
Specifies the Provisioned IOPS (I/O operations per second) value.
|
String |
getKmsKeyId()
If
StorageEncrypted is true, the KMS key identifier for the encrypted DB instance. |
Date |
getLatestRestorableTime()
Specifies the latest time to which a database can be restored with point-in-time restore.
|
String |
getLicenseModel()
License model information for this DB instance.
|
String |
getMasterUsername()
Contains the master username for the DB instance.
|
Integer |
getMonitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
|
String |
getMonitoringRoleArn()
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to CloudWatch Logs.
|
Boolean |
getMultiAZ()
Specifies if the DB instance is a Multi-AZ deployment.
|
List<OptionGroupMembership> |
getOptionGroupMemberships()
Provides the list of option group memberships for this DB instance.
|
PendingModifiedValues |
getPendingModifiedValues()
Specifies that changes to the DB instance are pending.
|
Boolean |
getPerformanceInsightsEnabled()
True if Performance Insights is enabled for the DB instance; otherwise false.
|
String |
getPerformanceInsightsKMSKeyId()
The KMS key identifier for encryption of Performance Insights data.
|
String |
getPreferredBackupWindow()
Specifies the daily time range during which automated backups are created if automated backups are enabled, as
determined by the
BackupRetentionPeriod . |
String |
getPreferredMaintenanceWindow()
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
Integer |
getPromotionTier()
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure
of the existing primary instance.
|
Boolean |
getPubliclyAccessible()
Specifies the accessibility options for the DB instance.
|
List<String> |
getReadReplicaDBClusterIdentifiers()
Contains one or more identifiers of Aurora DB clusters that are Read Replicas of this DB instance.
|
List<String> |
getReadReplicaDBInstanceIdentifiers()
Contains one or more identifiers of the Read Replicas associated with this DB instance.
|
String |
getReadReplicaSourceDBInstanceIdentifier()
Contains the identifier of the source DB instance if this DB instance is a Read Replica.
|
String |
getSecondaryAvailabilityZone()
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
|
List<DBInstanceStatusInfo> |
getStatusInfos()
The status of a Read Replica.
|
Boolean |
getStorageEncrypted()
Specifies whether the DB instance is encrypted.
|
String |
getStorageType()
Specifies the storage type associated with DB instance.
|
String |
getTdeCredentialArn()
The ARN from the key store with which the instance is associated for TDE encryption.
|
String |
getTimezone()
The time zone of the DB instance.
|
List<VpcSecurityGroupMembership> |
getVpcSecurityGroups()
Provides a list of VPC security group elements that the DB instance belongs to.
|
int |
hashCode() |
Boolean |
isAutoMinorVersionUpgrade()
Indicates that minor version patches are applied automatically.
|
Boolean |
isCopyTagsToSnapshot()
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
|
Boolean |
isIAMDatabaseAuthenticationEnabled()
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise
false.
|
Boolean |
isMultiAZ()
Specifies if the DB instance is a Multi-AZ deployment.
|
Boolean |
isPerformanceInsightsEnabled()
True if Performance Insights is enabled for the DB instance; otherwise false.
|
Boolean |
isPubliclyAccessible()
Specifies the accessibility options for the DB instance.
|
Boolean |
isStorageEncrypted()
Specifies whether the DB instance is encrypted.
|
void |
setAllocatedStorage(Integer allocatedStorage)
Specifies the allocated storage size specified in gigabytes.
|
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor version patches are applied automatically.
|
void |
setAvailabilityZone(String availabilityZone)
Specifies the name of the Availability Zone the DB instance is located in.
|
void |
setBackupRetentionPeriod(Integer backupRetentionPeriod)
Specifies the number of days for which automatic DB snapshots are retained.
|
void |
setCACertificateIdentifier(String cACertificateIdentifier)
The identifier of the CA certificate for this DB instance.
|
void |
setCharacterSetName(String characterSetName)
If present, specifies the name of the character set that this instance is associated with.
|
void |
setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
|
void |
setDBClusterIdentifier(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.
|
void |
setDBInstanceArn(String dBInstanceArn)
The Amazon Resource Name (ARN) for the DB instance.
|
void |
setDBInstanceClass(String dBInstanceClass)
Contains the name of the compute and memory capacity class of the DB instance.
|
void |
setDBInstanceIdentifier(String dBInstanceIdentifier)
Contains a user-supplied database identifier.
|
void |
setDbInstancePort(Integer dbInstancePort)
Specifies the port that the DB instance listens on.
|
void |
setDBInstanceStatus(String dBInstanceStatus)
Specifies the current state of this database.
|
void |
setDbiResourceId(String dbiResourceId)
The region-unique, immutable identifier for the DB instance.
|
void |
setDBName(String dBName)
The meaning of this parameter differs according to the database engine you use.
|
void |
setDBParameterGroups(Collection<DBParameterGroupStatus> dBParameterGroups)
Provides the list of DB parameter groups applied to this DB instance.
|
void |
setDBSecurityGroups(Collection<DBSecurityGroupMembership> dBSecurityGroups)
Provides List of DB security group elements containing only
DBSecurityGroup.Name and
DBSecurityGroup.Status subelements. |
void |
setDBSubnetGroup(DBSubnetGroup dBSubnetGroup)
Specifies information on the subnet group associated with the DB instance, including the name, description, and
subnets in the subnet group.
|
void |
setDomainMemberships(Collection<DomainMembership> domainMemberships)
The Active Directory Domain membership records associated with the DB instance.
|
void |
setEndpoint(Endpoint endpoint)
Specifies the connection endpoint.
|
void |
setEngine(String engine)
Provides the name of the database engine to be used for this DB instance.
|
void |
setEngineVersion(String engineVersion)
Indicates the database engine version.
|
void |
setEnhancedMonitoringResourceArn(String enhancedMonitoringResourceArn)
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring
metrics data for the DB instance.
|
void |
setIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise
false.
|
void |
setInstanceCreateTime(Date instanceCreateTime)
Provides the date and time the DB instance was created.
|
void |
setIops(Integer iops)
Specifies the Provisioned IOPS (I/O operations per second) value.
|
void |
setKmsKeyId(String kmsKeyId)
If
StorageEncrypted is true, the KMS key identifier for the encrypted DB instance. |
void |
setLatestRestorableTime(Date latestRestorableTime)
Specifies the latest time to which a database can be restored with point-in-time restore.
|
void |
setLicenseModel(String licenseModel)
License model information for this DB instance.
|
void |
setMasterUsername(String masterUsername)
Contains the master username for the DB instance.
|
void |
setMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
|
void |
setMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to CloudWatch Logs.
|
void |
setMultiAZ(Boolean multiAZ)
Specifies if the DB instance is a Multi-AZ deployment.
|
void |
setOptionGroupMemberships(Collection<OptionGroupMembership> optionGroupMemberships)
Provides the list of option group memberships for this DB instance.
|
void |
setPendingModifiedValues(PendingModifiedValues pendingModifiedValues)
Specifies that changes to the DB instance are pending.
|
void |
setPerformanceInsightsEnabled(Boolean performanceInsightsEnabled)
True if Performance Insights is enabled for the DB instance; otherwise false.
|
void |
setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The KMS key identifier for encryption of Performance Insights data.
|
void |
setPreferredBackupWindow(String preferredBackupWindow)
Specifies the daily time range during which automated backups are created if automated backups are enabled, as
determined by the
BackupRetentionPeriod . |
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
void |
setPromotionTier(Integer promotionTier)
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure
of the existing primary instance.
|
void |
setPubliclyAccessible(Boolean publiclyAccessible)
Specifies the accessibility options for the DB instance.
|
void |
setReadReplicaDBClusterIdentifiers(Collection<String> readReplicaDBClusterIdentifiers)
Contains one or more identifiers of Aurora DB clusters that are Read Replicas of this DB instance.
|
void |
setReadReplicaDBInstanceIdentifiers(Collection<String> readReplicaDBInstanceIdentifiers)
Contains one or more identifiers of the Read Replicas associated with this DB instance.
|
void |
setReadReplicaSourceDBInstanceIdentifier(String readReplicaSourceDBInstanceIdentifier)
Contains the identifier of the source DB instance if this DB instance is a Read Replica.
|
void |
setSecondaryAvailabilityZone(String secondaryAvailabilityZone)
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
|
void |
setStatusInfos(Collection<DBInstanceStatusInfo> statusInfos)
The status of a Read Replica.
|
void |
setStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB instance is encrypted.
|
void |
setStorageType(String storageType)
Specifies the storage type associated with DB instance.
|
void |
setTdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which the instance is associated for TDE encryption.
|
void |
setTimezone(String timezone)
The time zone of the DB instance.
|
void |
setVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
Provides a list of VPC security group elements that the DB instance belongs to.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
DBInstance |
withAllocatedStorage(Integer allocatedStorage)
Specifies the allocated storage size specified in gigabytes.
|
DBInstance |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor version patches are applied automatically.
|
DBInstance |
withAvailabilityZone(String availabilityZone)
Specifies the name of the Availability Zone the DB instance is located in.
|
DBInstance |
withBackupRetentionPeriod(Integer backupRetentionPeriod)
Specifies the number of days for which automatic DB snapshots are retained.
|
DBInstance |
withCACertificateIdentifier(String cACertificateIdentifier)
The identifier of the CA certificate for this DB instance.
|
DBInstance |
withCharacterSetName(String characterSetName)
If present, specifies the name of the character set that this instance is associated with.
|
DBInstance |
withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
|
DBInstance |
withDBClusterIdentifier(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.
|
DBInstance |
withDBInstanceArn(String dBInstanceArn)
The Amazon Resource Name (ARN) for the DB instance.
|
DBInstance |
withDBInstanceClass(String dBInstanceClass)
Contains the name of the compute and memory capacity class of the DB instance.
|
DBInstance |
withDBInstanceIdentifier(String dBInstanceIdentifier)
Contains a user-supplied database identifier.
|
DBInstance |
withDbInstancePort(Integer dbInstancePort)
Specifies the port that the DB instance listens on.
|
DBInstance |
withDBInstanceStatus(String dBInstanceStatus)
Specifies the current state of this database.
|
DBInstance |
withDbiResourceId(String dbiResourceId)
The region-unique, immutable identifier for the DB instance.
|
DBInstance |
withDBName(String dBName)
The meaning of this parameter differs according to the database engine you use.
|
DBInstance |
withDBParameterGroups(Collection<DBParameterGroupStatus> dBParameterGroups)
Provides the list of DB parameter groups applied to this DB instance.
|
DBInstance |
withDBParameterGroups(DBParameterGroupStatus... dBParameterGroups)
Provides the list of DB parameter groups applied to this DB instance.
|
DBInstance |
withDBSecurityGroups(Collection<DBSecurityGroupMembership> dBSecurityGroups)
Provides List of DB security group elements containing only
DBSecurityGroup.Name and
DBSecurityGroup.Status subelements. |
DBInstance |
withDBSecurityGroups(DBSecurityGroupMembership... dBSecurityGroups)
Provides List of DB security group elements containing only
DBSecurityGroup.Name and
DBSecurityGroup.Status subelements. |
DBInstance |
withDBSubnetGroup(DBSubnetGroup dBSubnetGroup)
Specifies information on the subnet group associated with the DB instance, including the name, description, and
subnets in the subnet group.
|
DBInstance |
withDomainMemberships(Collection<DomainMembership> domainMemberships)
The Active Directory Domain membership records associated with the DB instance.
|
DBInstance |
withDomainMemberships(DomainMembership... domainMemberships)
The Active Directory Domain membership records associated with the DB instance.
|
DBInstance |
withEndpoint(Endpoint endpoint)
Specifies the connection endpoint.
|
DBInstance |
withEngine(String engine)
Provides the name of the database engine to be used for this DB instance.
|
DBInstance |
withEngineVersion(String engineVersion)
Indicates the database engine version.
|
DBInstance |
withEnhancedMonitoringResourceArn(String enhancedMonitoringResourceArn)
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring
metrics data for the DB instance.
|
DBInstance |
withIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise
false.
|
DBInstance |
withInstanceCreateTime(Date instanceCreateTime)
Provides the date and time the DB instance was created.
|
DBInstance |
withIops(Integer iops)
Specifies the Provisioned IOPS (I/O operations per second) value.
|
DBInstance |
withKmsKeyId(String kmsKeyId)
If
StorageEncrypted is true, the KMS key identifier for the encrypted DB instance. |
DBInstance |
withLatestRestorableTime(Date latestRestorableTime)
Specifies the latest time to which a database can be restored with point-in-time restore.
|
DBInstance |
withLicenseModel(String licenseModel)
License model information for this DB instance.
|
DBInstance |
withMasterUsername(String masterUsername)
Contains the master username for the DB instance.
|
DBInstance |
withMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
|
DBInstance |
withMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to CloudWatch Logs.
|
DBInstance |
withMultiAZ(Boolean multiAZ)
Specifies if the DB instance is a Multi-AZ deployment.
|
DBInstance |
withOptionGroupMemberships(Collection<OptionGroupMembership> optionGroupMemberships)
Provides the list of option group memberships for this DB instance.
|
DBInstance |
withOptionGroupMemberships(OptionGroupMembership... optionGroupMemberships)
Provides the list of option group memberships for this DB instance.
|
DBInstance |
withPendingModifiedValues(PendingModifiedValues pendingModifiedValues)
Specifies that changes to the DB instance are pending.
|
DBInstance |
withPerformanceInsightsEnabled(Boolean performanceInsightsEnabled)
True if Performance Insights is enabled for the DB instance; otherwise false.
|
DBInstance |
withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The KMS key identifier for encryption of Performance Insights data.
|
DBInstance |
withPreferredBackupWindow(String preferredBackupWindow)
Specifies the daily time range during which automated backups are created if automated backups are enabled, as
determined by the
BackupRetentionPeriod . |
DBInstance |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
DBInstance |
withPromotionTier(Integer promotionTier)
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure
of the existing primary instance.
|
DBInstance |
withPubliclyAccessible(Boolean publiclyAccessible)
Specifies the accessibility options for the DB instance.
|
DBInstance |
withReadReplicaDBClusterIdentifiers(Collection<String> readReplicaDBClusterIdentifiers)
Contains one or more identifiers of Aurora DB clusters that are Read Replicas of this DB instance.
|
DBInstance |
withReadReplicaDBClusterIdentifiers(String... readReplicaDBClusterIdentifiers)
Contains one or more identifiers of Aurora DB clusters that are Read Replicas of this DB instance.
|
DBInstance |
withReadReplicaDBInstanceIdentifiers(Collection<String> readReplicaDBInstanceIdentifiers)
Contains one or more identifiers of the Read Replicas associated with this DB instance.
|
DBInstance |
withReadReplicaDBInstanceIdentifiers(String... readReplicaDBInstanceIdentifiers)
Contains one or more identifiers of the Read Replicas associated with this DB instance.
|
DBInstance |
withReadReplicaSourceDBInstanceIdentifier(String readReplicaSourceDBInstanceIdentifier)
Contains the identifier of the source DB instance if this DB instance is a Read Replica.
|
DBInstance |
withSecondaryAvailabilityZone(String secondaryAvailabilityZone)
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
|
DBInstance |
withStatusInfos(Collection<DBInstanceStatusInfo> statusInfos)
The status of a Read Replica.
|
DBInstance |
withStatusInfos(DBInstanceStatusInfo... statusInfos)
The status of a Read Replica.
|
DBInstance |
withStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB instance is encrypted.
|
DBInstance |
withStorageType(String storageType)
Specifies the storage type associated with DB instance.
|
DBInstance |
withTdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which the instance is associated for TDE encryption.
|
DBInstance |
withTimezone(String timezone)
The time zone of the DB instance.
|
DBInstance |
withVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
Provides a list of VPC security group elements that the DB instance belongs to.
|
DBInstance |
withVpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
Provides a list of VPC security group elements that the DB instance belongs to.
|
public void setDBInstanceIdentifier(String dBInstanceIdentifier)
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
dBInstanceIdentifier
- Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB
instance.public String getDBInstanceIdentifier()
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
public DBInstance withDBInstanceIdentifier(String dBInstanceIdentifier)
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
dBInstanceIdentifier
- Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB
instance.public void setDBInstanceClass(String dBInstanceClass)
Contains the name of the compute and memory capacity class of the DB instance.
dBInstanceClass
- Contains the name of the compute and memory capacity class of the DB instance.public String getDBInstanceClass()
Contains the name of the compute and memory capacity class of the DB instance.
public DBInstance withDBInstanceClass(String dBInstanceClass)
Contains the name of the compute and memory capacity class of the DB instance.
dBInstanceClass
- Contains the name of the compute and memory capacity class of the DB instance.public void setEngine(String engine)
Provides the name of the database engine to be used for this DB instance.
engine
- Provides the name of the database engine to be used for this DB instance.public String getEngine()
Provides the name of the database engine to be used for this DB instance.
public DBInstance withEngine(String engine)
Provides the name of the database engine to be used for this DB instance.
engine
- Provides the name of the database engine to be used for this DB instance.public void setDBInstanceStatus(String dBInstanceStatus)
Specifies the current state of this database.
dBInstanceStatus
- Specifies the current state of this database.public String getDBInstanceStatus()
Specifies the current state of this database.
public DBInstance withDBInstanceStatus(String dBInstanceStatus)
Specifies the current state of this database.
dBInstanceStatus
- Specifies the current state of this database.public void setMasterUsername(String masterUsername)
Contains the master username for the DB instance.
masterUsername
- Contains the master username for the DB instance.public String getMasterUsername()
Contains the master username for the DB instance.
public DBInstance withMasterUsername(String masterUsername)
Contains the master username for the DB instance.
masterUsername
- Contains the master username for the DB instance.public void setDBName(String dBName)
The meaning of this parameter differs according to the database engine you use. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
dBName
- The meaning of this parameter differs according to the database engine you use. For example, this value
returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica
since Read Replicas are only supported for these engines.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
public String getDBName()
The meaning of this parameter differs according to the database engine you use. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
public DBInstance withDBName(String dBName)
The meaning of this parameter differs according to the database engine you use. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
dBName
- The meaning of this parameter differs according to the database engine you use. For example, this value
returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica
since Read Replicas are only supported for these engines.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
public void setEndpoint(Endpoint endpoint)
Specifies the connection endpoint.
endpoint
- Specifies the connection endpoint.public Endpoint getEndpoint()
Specifies the connection endpoint.
public DBInstance withEndpoint(Endpoint endpoint)
Specifies the connection endpoint.
endpoint
- Specifies the connection endpoint.public void setAllocatedStorage(Integer allocatedStorage)
Specifies the allocated storage size specified in gigabytes.
allocatedStorage
- Specifies the allocated storage size specified in gigabytes.public Integer getAllocatedStorage()
Specifies the allocated storage size specified in gigabytes.
public DBInstance withAllocatedStorage(Integer allocatedStorage)
Specifies the allocated storage size specified in gigabytes.
allocatedStorage
- Specifies the allocated storage size specified in gigabytes.public void setInstanceCreateTime(Date instanceCreateTime)
Provides the date and time the DB instance was created.
instanceCreateTime
- Provides the date and time the DB instance was created.public Date getInstanceCreateTime()
Provides the date and time the DB instance was created.
public DBInstance withInstanceCreateTime(Date instanceCreateTime)
Provides the date and time the DB instance was created.
instanceCreateTime
- Provides the date and time the DB instance was created.public void setPreferredBackupWindow(String preferredBackupWindow)
Specifies the daily time range during which automated backups are created if automated backups are enabled, as
determined by the BackupRetentionPeriod
.
preferredBackupWindow
- Specifies the daily time range during which automated backups are created if automated backups are
enabled, as determined by the BackupRetentionPeriod
.public String getPreferredBackupWindow()
Specifies the daily time range during which automated backups are created if automated backups are enabled, as
determined by the BackupRetentionPeriod
.
BackupRetentionPeriod
.public DBInstance withPreferredBackupWindow(String preferredBackupWindow)
Specifies the daily time range during which automated backups are created if automated backups are enabled, as
determined by the BackupRetentionPeriod
.
preferredBackupWindow
- Specifies the daily time range during which automated backups are created if automated backups are
enabled, as determined by the BackupRetentionPeriod
.public void setBackupRetentionPeriod(Integer backupRetentionPeriod)
Specifies the number of days for which automatic DB snapshots are retained.
backupRetentionPeriod
- Specifies the number of days for which automatic DB snapshots are retained.public Integer getBackupRetentionPeriod()
Specifies the number of days for which automatic DB snapshots are retained.
public DBInstance withBackupRetentionPeriod(Integer backupRetentionPeriod)
Specifies the number of days for which automatic DB snapshots are retained.
backupRetentionPeriod
- Specifies the number of days for which automatic DB snapshots are retained.public List<DBSecurityGroupMembership> getDBSecurityGroups()
Provides List of DB security group elements containing only DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.
DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.public void setDBSecurityGroups(Collection<DBSecurityGroupMembership> dBSecurityGroups)
Provides List of DB security group elements containing only DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.
dBSecurityGroups
- Provides List of DB security group elements containing only DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.public DBInstance withDBSecurityGroups(DBSecurityGroupMembership... dBSecurityGroups)
Provides List of DB security group elements containing only DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.
NOTE: This method appends the values to the existing list (if any). Use
setDBSecurityGroups(java.util.Collection)
or withDBSecurityGroups(java.util.Collection)
if you
want to override the existing values.
dBSecurityGroups
- Provides List of DB security group elements containing only DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.public DBInstance withDBSecurityGroups(Collection<DBSecurityGroupMembership> dBSecurityGroups)
Provides List of DB security group elements containing only DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.
dBSecurityGroups
- Provides List of DB security group elements containing only DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.public List<VpcSecurityGroupMembership> getVpcSecurityGroups()
Provides a list of VPC security group elements that the DB instance belongs to.
public void setVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
Provides a list of VPC security group elements that the DB instance belongs to.
vpcSecurityGroups
- Provides a list of VPC security group elements that the DB instance belongs to.public DBInstance withVpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
Provides a list of VPC security group elements that the DB instance belongs to.
NOTE: This method appends the values to the existing list (if any). Use
setVpcSecurityGroups(java.util.Collection)
or withVpcSecurityGroups(java.util.Collection)
if
you want to override the existing values.
vpcSecurityGroups
- Provides a list of VPC security group elements that the DB instance belongs to.public DBInstance withVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
Provides a list of VPC security group elements that the DB instance belongs to.
vpcSecurityGroups
- Provides a list of VPC security group elements that the DB instance belongs to.public List<DBParameterGroupStatus> getDBParameterGroups()
Provides the list of DB parameter groups applied to this DB instance.
public void setDBParameterGroups(Collection<DBParameterGroupStatus> dBParameterGroups)
Provides the list of DB parameter groups applied to this DB instance.
dBParameterGroups
- Provides the list of DB parameter groups applied to this DB instance.public DBInstance withDBParameterGroups(DBParameterGroupStatus... dBParameterGroups)
Provides the list of DB parameter groups applied to this DB instance.
NOTE: This method appends the values to the existing list (if any). Use
setDBParameterGroups(java.util.Collection)
or withDBParameterGroups(java.util.Collection)
if
you want to override the existing values.
dBParameterGroups
- Provides the list of DB parameter groups applied to this DB instance.public DBInstance withDBParameterGroups(Collection<DBParameterGroupStatus> dBParameterGroups)
Provides the list of DB parameter groups applied to this DB instance.
dBParameterGroups
- Provides the list of DB parameter groups applied to this DB instance.public void setAvailabilityZone(String availabilityZone)
Specifies the name of the Availability Zone the DB instance is located in.
availabilityZone
- Specifies the name of the Availability Zone the DB instance is located in.public String getAvailabilityZone()
Specifies the name of the Availability Zone the DB instance is located in.
public DBInstance withAvailabilityZone(String availabilityZone)
Specifies the name of the Availability Zone the DB instance is located in.
availabilityZone
- Specifies the name of the Availability Zone the DB instance is located in.public void setDBSubnetGroup(DBSubnetGroup dBSubnetGroup)
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
dBSubnetGroup
- Specifies information on the subnet group associated with the DB instance, including the name,
description, and subnets in the subnet group.public DBSubnetGroup getDBSubnetGroup()
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
public DBInstance withDBSubnetGroup(DBSubnetGroup dBSubnetGroup)
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
dBSubnetGroup
- Specifies information on the subnet group associated with the DB instance, including the name,
description, and subnets in the subnet group.public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
preferredMaintenanceWindow
- Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time
(UTC).public String getPreferredMaintenanceWindow()
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
public DBInstance withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
preferredMaintenanceWindow
- Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time
(UTC).public void setPendingModifiedValues(PendingModifiedValues pendingModifiedValues)
Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
pendingModifiedValues
- Specifies that changes to the DB instance are pending. This element is only included when changes are
pending. Specific changes are identified by subelements.public PendingModifiedValues getPendingModifiedValues()
Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
public DBInstance withPendingModifiedValues(PendingModifiedValues pendingModifiedValues)
Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
pendingModifiedValues
- Specifies that changes to the DB instance are pending. This element is only included when changes are
pending. Specific changes are identified by subelements.public void setLatestRestorableTime(Date latestRestorableTime)
Specifies the latest time to which a database can be restored with point-in-time restore.
latestRestorableTime
- Specifies the latest time to which a database can be restored with point-in-time restore.public Date getLatestRestorableTime()
Specifies the latest time to which a database can be restored with point-in-time restore.
public DBInstance withLatestRestorableTime(Date latestRestorableTime)
Specifies the latest time to which a database can be restored with point-in-time restore.
latestRestorableTime
- Specifies the latest time to which a database can be restored with point-in-time restore.public void setMultiAZ(Boolean multiAZ)
Specifies if the DB instance is a Multi-AZ deployment.
multiAZ
- Specifies if the DB instance is a Multi-AZ deployment.public Boolean getMultiAZ()
Specifies if the DB instance is a Multi-AZ deployment.
public DBInstance withMultiAZ(Boolean multiAZ)
Specifies if the DB instance is a Multi-AZ deployment.
multiAZ
- Specifies if the DB instance is a Multi-AZ deployment.public Boolean isMultiAZ()
Specifies if the DB instance is a Multi-AZ deployment.
public void setEngineVersion(String engineVersion)
Indicates the database engine version.
engineVersion
- Indicates the database engine version.public String getEngineVersion()
Indicates the database engine version.
public DBInstance withEngineVersion(String engineVersion)
Indicates the database engine version.
engineVersion
- Indicates the database engine version.public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor version patches are applied automatically.
autoMinorVersionUpgrade
- Indicates that minor version patches are applied automatically.public Boolean getAutoMinorVersionUpgrade()
Indicates that minor version patches are applied automatically.
public DBInstance withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor version patches are applied automatically.
autoMinorVersionUpgrade
- Indicates that minor version patches are applied automatically.public Boolean isAutoMinorVersionUpgrade()
Indicates that minor version patches are applied automatically.
public void setReadReplicaSourceDBInstanceIdentifier(String readReplicaSourceDBInstanceIdentifier)
Contains the identifier of the source DB instance if this DB instance is a Read Replica.
readReplicaSourceDBInstanceIdentifier
- Contains the identifier of the source DB instance if this DB instance is a Read Replica.public String getReadReplicaSourceDBInstanceIdentifier()
Contains the identifier of the source DB instance if this DB instance is a Read Replica.
public DBInstance withReadReplicaSourceDBInstanceIdentifier(String readReplicaSourceDBInstanceIdentifier)
Contains the identifier of the source DB instance if this DB instance is a Read Replica.
readReplicaSourceDBInstanceIdentifier
- Contains the identifier of the source DB instance if this DB instance is a Read Replica.public List<String> getReadReplicaDBInstanceIdentifiers()
Contains one or more identifiers of the Read Replicas associated with this DB instance.
public void setReadReplicaDBInstanceIdentifiers(Collection<String> readReplicaDBInstanceIdentifiers)
Contains one or more identifiers of the Read Replicas associated with this DB instance.
readReplicaDBInstanceIdentifiers
- Contains one or more identifiers of the Read Replicas associated with this DB instance.public DBInstance withReadReplicaDBInstanceIdentifiers(String... readReplicaDBInstanceIdentifiers)
Contains one or more identifiers of the Read Replicas associated with this DB instance.
NOTE: This method appends the values to the existing list (if any). Use
setReadReplicaDBInstanceIdentifiers(java.util.Collection)
or
withReadReplicaDBInstanceIdentifiers(java.util.Collection)
if you want to override the existing values.
readReplicaDBInstanceIdentifiers
- Contains one or more identifiers of the Read Replicas associated with this DB instance.public DBInstance withReadReplicaDBInstanceIdentifiers(Collection<String> readReplicaDBInstanceIdentifiers)
Contains one or more identifiers of the Read Replicas associated with this DB instance.
readReplicaDBInstanceIdentifiers
- Contains one or more identifiers of the Read Replicas associated with this DB instance.public List<String> getReadReplicaDBClusterIdentifiers()
Contains one or more identifiers of Aurora DB clusters that are Read Replicas of this DB instance.
public void setReadReplicaDBClusterIdentifiers(Collection<String> readReplicaDBClusterIdentifiers)
Contains one or more identifiers of Aurora DB clusters that are Read Replicas of this DB instance.
readReplicaDBClusterIdentifiers
- Contains one or more identifiers of Aurora DB clusters that are Read Replicas of this DB instance.public DBInstance withReadReplicaDBClusterIdentifiers(String... readReplicaDBClusterIdentifiers)
Contains one or more identifiers of Aurora DB clusters that are Read Replicas of this DB instance.
NOTE: This method appends the values to the existing list (if any). Use
setReadReplicaDBClusterIdentifiers(java.util.Collection)
or
withReadReplicaDBClusterIdentifiers(java.util.Collection)
if you want to override the existing values.
readReplicaDBClusterIdentifiers
- Contains one or more identifiers of Aurora DB clusters that are Read Replicas of this DB instance.public DBInstance withReadReplicaDBClusterIdentifiers(Collection<String> readReplicaDBClusterIdentifiers)
Contains one or more identifiers of Aurora DB clusters that are Read Replicas of this DB instance.
readReplicaDBClusterIdentifiers
- Contains one or more identifiers of Aurora DB clusters that are Read Replicas of this DB instance.public void setLicenseModel(String licenseModel)
License model information for this DB instance.
licenseModel
- License model information for this DB instance.public String getLicenseModel()
License model information for this DB instance.
public DBInstance withLicenseModel(String licenseModel)
License model information for this DB instance.
licenseModel
- License model information for this DB instance.public void setIops(Integer iops)
Specifies the Provisioned IOPS (I/O operations per second) value.
iops
- Specifies the Provisioned IOPS (I/O operations per second) value.public Integer getIops()
Specifies the Provisioned IOPS (I/O operations per second) value.
public DBInstance withIops(Integer iops)
Specifies the Provisioned IOPS (I/O operations per second) value.
iops
- Specifies the Provisioned IOPS (I/O operations per second) value.public List<OptionGroupMembership> getOptionGroupMemberships()
Provides the list of option group memberships for this DB instance.
public void setOptionGroupMemberships(Collection<OptionGroupMembership> optionGroupMemberships)
Provides the list of option group memberships for this DB instance.
optionGroupMemberships
- Provides the list of option group memberships for this DB instance.public DBInstance withOptionGroupMemberships(OptionGroupMembership... optionGroupMemberships)
Provides the list of option group memberships for this DB instance.
NOTE: This method appends the values to the existing list (if any). Use
setOptionGroupMemberships(java.util.Collection)
or
withOptionGroupMemberships(java.util.Collection)
if you want to override the existing values.
optionGroupMemberships
- Provides the list of option group memberships for this DB instance.public DBInstance withOptionGroupMemberships(Collection<OptionGroupMembership> optionGroupMemberships)
Provides the list of option group memberships for this DB instance.
optionGroupMemberships
- Provides the list of option group memberships for this DB instance.public void setCharacterSetName(String characterSetName)
If present, specifies the name of the character set that this instance is associated with.
characterSetName
- If present, specifies the name of the character set that this instance is associated with.public String getCharacterSetName()
If present, specifies the name of the character set that this instance is associated with.
public DBInstance withCharacterSetName(String characterSetName)
If present, specifies the name of the character set that this instance is associated with.
characterSetName
- If present, specifies the name of the character set that this instance is associated with.public void setSecondaryAvailabilityZone(String secondaryAvailabilityZone)
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
secondaryAvailabilityZone
- If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.public String getSecondaryAvailabilityZone()
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
public DBInstance withSecondaryAvailabilityZone(String secondaryAvailabilityZone)
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
secondaryAvailabilityZone
- If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.public void setPubliclyAccessible(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.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC:true
VPC:false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
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.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC:true
VPC:false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
public Boolean getPubliclyAccessible()
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.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC:true
VPC:false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC:true
VPC:false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
public DBInstance withPubliclyAccessible(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.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC:true
VPC:false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
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.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC:true
VPC:false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
public Boolean isPubliclyAccessible()
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.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC:true
VPC:false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC:true
VPC:false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
public List<DBInstanceStatusInfo> getStatusInfos()
The status of a Read Replica. If the instance is not a Read Replica, this is blank.
public void setStatusInfos(Collection<DBInstanceStatusInfo> statusInfos)
The status of a Read Replica. If the instance is not a Read Replica, this is blank.
statusInfos
- The status of a Read Replica. If the instance is not a Read Replica, this is blank.public DBInstance withStatusInfos(DBInstanceStatusInfo... statusInfos)
The status of a Read Replica. If the instance is not a Read Replica, this is blank.
NOTE: This method appends the values to the existing list (if any). Use
setStatusInfos(java.util.Collection)
or withStatusInfos(java.util.Collection)
if you want to
override the existing values.
statusInfos
- The status of a Read Replica. If the instance is not a Read Replica, this is blank.public DBInstance withStatusInfos(Collection<DBInstanceStatusInfo> statusInfos)
The status of a Read Replica. If the instance is not a Read Replica, this is blank.
statusInfos
- The status of a Read Replica. If the instance is not a Read Replica, this is blank.public void setStorageType(String storageType)
Specifies the storage type associated with DB instance.
storageType
- Specifies the storage type associated with DB instance.public String getStorageType()
Specifies the storage type associated with DB instance.
public DBInstance withStorageType(String storageType)
Specifies the storage type associated with DB instance.
storageType
- Specifies the storage type associated with DB instance.public void setTdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which the instance is associated for TDE encryption.
tdeCredentialArn
- The ARN from the key store with which the instance is associated for TDE encryption.public String getTdeCredentialArn()
The ARN from the key store with which the instance is associated for TDE encryption.
public DBInstance withTdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which the instance is associated for TDE encryption.
tdeCredentialArn
- The ARN from the key store with which the instance is associated for TDE encryption.public void setDbInstancePort(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.
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 Integer getDbInstancePort()
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 DBInstance withDbInstancePort(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.
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 void setDBClusterIdentifier(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.
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 String getDBClusterIdentifier()
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 DBInstance withDBClusterIdentifier(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.
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 void setStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB instance is encrypted.
storageEncrypted
- Specifies whether the DB instance is encrypted.public Boolean getStorageEncrypted()
Specifies whether the DB instance is encrypted.
public DBInstance withStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB instance is encrypted.
storageEncrypted
- Specifies whether the DB instance is encrypted.public Boolean isStorageEncrypted()
Specifies whether the DB instance is encrypted.
public void setKmsKeyId(String kmsKeyId)
If StorageEncrypted
is true, the KMS key identifier for the encrypted DB instance.
kmsKeyId
- If StorageEncrypted
is true, the KMS key identifier for the encrypted DB instance.public String getKmsKeyId()
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 DBInstance withKmsKeyId(String kmsKeyId)
If StorageEncrypted
is true, the KMS key identifier for the encrypted DB instance.
kmsKeyId
- If StorageEncrypted
is true, the KMS key identifier for the encrypted DB instance.public void setDbiResourceId(String dbiResourceId)
The region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB instance is accessed.
dbiResourceId
- The region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail
log entries whenever the KMS key for the DB instance is accessed.public String getDbiResourceId()
The region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB instance is accessed.
public DBInstance withDbiResourceId(String dbiResourceId)
The region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB instance is accessed.
dbiResourceId
- The region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail
log entries whenever the KMS key for the DB instance is accessed.public void setCACertificateIdentifier(String cACertificateIdentifier)
The identifier of the CA certificate for this DB instance.
cACertificateIdentifier
- The identifier of the CA certificate for this DB instance.public String getCACertificateIdentifier()
The identifier of the CA certificate for this DB instance.
public DBInstance withCACertificateIdentifier(String cACertificateIdentifier)
The identifier of the CA certificate for this DB instance.
cACertificateIdentifier
- The identifier of the CA certificate for this DB instance.public List<DomainMembership> getDomainMemberships()
The Active Directory Domain membership records associated with the DB instance.
public void setDomainMemberships(Collection<DomainMembership> domainMemberships)
The Active Directory Domain membership records associated with the DB instance.
domainMemberships
- The Active Directory Domain membership records associated with the DB instance.public DBInstance withDomainMemberships(DomainMembership... domainMemberships)
The Active Directory Domain membership records associated with the DB instance.
NOTE: This method appends the values to the existing list (if any). Use
setDomainMemberships(java.util.Collection)
or withDomainMemberships(java.util.Collection)
if
you want to override the existing values.
domainMemberships
- The Active Directory Domain membership records associated with the DB instance.public DBInstance withDomainMemberships(Collection<DomainMembership> domainMemberships)
The Active Directory Domain membership records associated with the DB instance.
domainMemberships
- The Active Directory Domain membership records associated with the DB instance.public void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
copyTagsToSnapshot
- Specifies whether tags are copied from the DB instance to snapshots of the DB instance.public Boolean getCopyTagsToSnapshot()
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
public DBInstance withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
copyTagsToSnapshot
- Specifies whether tags are copied from the DB instance to snapshots of the DB instance.public Boolean isCopyTagsToSnapshot()
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
public void setMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB
instance.public Integer getMonitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
public DBInstance withMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB
instance.public void setEnhancedMonitoringResourceArn(String enhancedMonitoringResourceArn)
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
enhancedMonitoringResourceArn
- The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced
Monitoring metrics data for the DB instance.public String getEnhancedMonitoringResourceArn()
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
public DBInstance withEnhancedMonitoringResourceArn(String enhancedMonitoringResourceArn)
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
enhancedMonitoringResourceArn
- The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced
Monitoring metrics data for the DB instance.public void setMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to CloudWatch Logs.
monitoringRoleArn
- The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to CloudWatch Logs.public String getMonitoringRoleArn()
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to CloudWatch Logs.
public DBInstance withMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to CloudWatch Logs.
monitoringRoleArn
- The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to CloudWatch Logs.public void setPromotionTier(Integer promotionTier)
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.
promotionTier
- A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a
failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.public Integer getPromotionTier()
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.
public DBInstance withPromotionTier(Integer promotionTier)
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.
promotionTier
- A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a
failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.public void setDBInstanceArn(String dBInstanceArn)
The Amazon Resource Name (ARN) for the DB instance.
dBInstanceArn
- The Amazon Resource Name (ARN) for the DB instance.public String getDBInstanceArn()
The Amazon Resource Name (ARN) for the DB instance.
public DBInstance withDBInstanceArn(String dBInstanceArn)
The Amazon Resource Name (ARN) for the DB instance.
dBInstanceArn
- The Amazon Resource Name (ARN) for the DB instance.public void setTimezone(String timezone)
The time zone of the DB instance. In most cases, the Timezone
element is empty.
Timezone
content appears only for Microsoft SQL Server DB instances that were created with a time
zone specified.
timezone
- 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.public String getTimezone()
The time zone of the DB instance. In most cases, the Timezone
element is empty.
Timezone
content appears only for Microsoft SQL Server DB instances that were created with a time
zone specified.
Timezone
element is empty.
Timezone
content appears only for Microsoft SQL Server DB instances that were created with a
time zone specified.public DBInstance withTimezone(String timezone)
The time zone of the DB instance. In most cases, the Timezone
element is empty.
Timezone
content appears only for Microsoft SQL Server DB instances that were created with a time
zone specified.
timezone
- 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.public void setIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.
IAM database authentication can be enabled for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
iAMDatabaseAuthenticationEnabled
- True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled;
otherwise false.
IAM database authentication can be enabled for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
public Boolean getIAMDatabaseAuthenticationEnabled()
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.
IAM database authentication can be enabled for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
IAM database authentication can be enabled for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
public DBInstance withIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.
IAM database authentication can be enabled for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
iAMDatabaseAuthenticationEnabled
- True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled;
otherwise false.
IAM database authentication can be enabled for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
public Boolean isIAMDatabaseAuthenticationEnabled()
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.
IAM database authentication can be enabled for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
IAM database authentication can be enabled for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
public void setPerformanceInsightsEnabled(Boolean performanceInsightsEnabled)
True if Performance Insights is enabled for the DB instance; otherwise false.
performanceInsightsEnabled
- True if Performance Insights is enabled for the DB instance; otherwise false.public Boolean getPerformanceInsightsEnabled()
True if Performance Insights is enabled for the DB instance; otherwise false.
public DBInstance withPerformanceInsightsEnabled(Boolean performanceInsightsEnabled)
True if Performance Insights is enabled for the DB instance; otherwise false.
performanceInsightsEnabled
- True if Performance Insights is enabled for the DB instance; otherwise false.public Boolean isPerformanceInsightsEnabled()
True if Performance Insights is enabled for the DB instance; otherwise false.
public void setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
performanceInsightsKMSKeyId
- The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource
Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.public String getPerformanceInsightsKMSKeyId()
The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
public DBInstance withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
performanceInsightsKMSKeyId
- The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource
Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.public String toString()
toString
in class Object
Object.toString()
public DBInstance clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.