Class DBInstance
- java.lang.Object
-
- com.amazonaws.services.rds.model.DBInstance
-
- All Implemented Interfaces:
Serializable
,Cloneable
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.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description DBInstance()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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
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 onlyDBSecurityGroup.Name
andDBSecurityGroup.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.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()
IfStorageEncrypted
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.String
getPreferredBackupWindow()
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by theBackupRetentionPeriod
.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>
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.List<VpcSecurityGroupMembership>
getVpcSecurityGroups()
Provides 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
isMultiAZ()
Specifies if the DB instance is a Multi-AZ deployment.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
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 onlyDBSecurityGroup.Name
andDBSecurityGroup.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
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)
IfStorageEncrypted
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
setPreferredBackupWindow(String preferredBackupWindow)
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by theBackupRetentionPeriod
.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
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
setVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
Provides 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
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(DBParameterGroupStatus... dBParameterGroups)
Provides the list of DB parameter groups applied to this DB instance.DBInstance
withDBParameterGroups(Collection<DBParameterGroupStatus> dBParameterGroups)
Provides the list of DB parameter groups applied to this DB instance.DBInstance
withDBSecurityGroups(DBSecurityGroupMembership... dBSecurityGroups)
Provides List of DB security group elements containing onlyDBSecurityGroup.Name
andDBSecurityGroup.Status
subelements.DBInstance
withDBSecurityGroups(Collection<DBSecurityGroupMembership> dBSecurityGroups)
Provides List of DB security group elements containing onlyDBSecurityGroup.Name
andDBSecurityGroup.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(DomainMembership... domainMemberships)
The Active Directory Domain membership records associated with the DB instance.DBInstance
withDomainMemberships(Collection<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
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)
IfStorageEncrypted
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(OptionGroupMembership... optionGroupMemberships)
Provides the list of option group memberships for this DB instance.DBInstance
withOptionGroupMemberships(Collection<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
withPreferredBackupWindow(String preferredBackupWindow)
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by theBackupRetentionPeriod
.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
withReadReplicaDBInstanceIdentifiers(String... readReplicaDBInstanceIdentifiers)
Contains one or more identifiers of the Read Replicas associated with this DB instance.DBInstance
withReadReplicaDBInstanceIdentifiers(Collection<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(DBInstanceStatusInfo... statusInfos)
The status of a Read Replica.DBInstance
withStatusInfos(Collection<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
withVpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
Provides List of VPC security group elements that the DB instance belongs to.DBInstance
withVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
Provides List of VPC security group elements that the DB instance belongs to.
-
-
-
Method Detail
-
setDBInstanceIdentifier
public void setDBInstanceIdentifier(String dBInstanceIdentifier)
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
- Parameters:
dBInstanceIdentifier
- Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
-
getDBInstanceIdentifier
public String getDBInstanceIdentifier()
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
- Returns:
- Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
-
withDBInstanceIdentifier
public DBInstance withDBInstanceIdentifier(String dBInstanceIdentifier)
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
- Parameters:
dBInstanceIdentifier
- Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDBInstanceClass
public void setDBInstanceClass(String dBInstanceClass)
Contains the name of the compute and memory capacity class of the DB instance.
- Parameters:
dBInstanceClass
- Contains the name of the compute and memory capacity class of the DB instance.
-
getDBInstanceClass
public String getDBInstanceClass()
Contains the name of the compute and memory capacity class of the DB instance.
- Returns:
- Contains the name of the compute and memory capacity class of the DB instance.
-
withDBInstanceClass
public DBInstance withDBInstanceClass(String dBInstanceClass)
Contains the name of the compute and memory capacity class of the DB instance.
- Parameters:
dBInstanceClass
- Contains the name of the compute and memory capacity class of the DB instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEngine
public void setEngine(String engine)
Provides the name of the database engine to be used for this DB instance.
- Parameters:
engine
- Provides the name of the database engine to be used for this DB instance.
-
getEngine
public String getEngine()
Provides the name of the database engine to be used for this DB instance.
- Returns:
- Provides the name of the database engine to be used for this DB instance.
-
withEngine
public DBInstance withEngine(String engine)
Provides the name of the database engine to be used for this DB instance.
- Parameters:
engine
- Provides the name of the database engine to be used for this DB instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDBInstanceStatus
public void setDBInstanceStatus(String dBInstanceStatus)
Specifies the current state of this database.
- Parameters:
dBInstanceStatus
- Specifies the current state of this database.
-
getDBInstanceStatus
public String getDBInstanceStatus()
Specifies the current state of this database.
- Returns:
- Specifies the current state of this database.
-
withDBInstanceStatus
public DBInstance withDBInstanceStatus(String dBInstanceStatus)
Specifies the current state of this database.
- Parameters:
dBInstanceStatus
- Specifies the current state of this database.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMasterUsername
public void setMasterUsername(String masterUsername)
Contains the master username for the DB instance.
- Parameters:
masterUsername
- Contains the master username for the DB instance.
-
getMasterUsername
public String getMasterUsername()
Contains the master username for the DB instance.
- Returns:
- Contains the master username for the DB instance.
-
withMasterUsername
public DBInstance withMasterUsername(String masterUsername)
Contains the master username for the DB instance.
- Parameters:
masterUsername
- Contains the master username for the DB instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDBName
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, Amazon Aurora
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.
- Parameters:
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, Amazon Aurora
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.
-
getDBName
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, Amazon Aurora
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.
- Returns:
- 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, Amazon Aurora
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.
-
withDBName
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, Amazon Aurora
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.
- Parameters:
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, Amazon Aurora
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEndpoint
public void setEndpoint(Endpoint endpoint)
Specifies the connection endpoint.
- Parameters:
endpoint
- Specifies the connection endpoint.
-
getEndpoint
public Endpoint getEndpoint()
Specifies the connection endpoint.
- Returns:
- Specifies the connection endpoint.
-
withEndpoint
public DBInstance withEndpoint(Endpoint endpoint)
Specifies the connection endpoint.
- Parameters:
endpoint
- Specifies the connection endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAllocatedStorage
public void setAllocatedStorage(Integer allocatedStorage)
Specifies the allocated storage size specified in gigabytes.
- Parameters:
allocatedStorage
- Specifies the allocated storage size specified in gigabytes.
-
getAllocatedStorage
public Integer getAllocatedStorage()
Specifies the allocated storage size specified in gigabytes.
- Returns:
- Specifies the allocated storage size specified in gigabytes.
-
withAllocatedStorage
public DBInstance withAllocatedStorage(Integer allocatedStorage)
Specifies the allocated storage size specified in gigabytes.
- Parameters:
allocatedStorage
- Specifies the allocated storage size specified in gigabytes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setInstanceCreateTime
public void setInstanceCreateTime(Date instanceCreateTime)
Provides the date and time the DB instance was created.
- Parameters:
instanceCreateTime
- Provides the date and time the DB instance was created.
-
getInstanceCreateTime
public Date getInstanceCreateTime()
Provides the date and time the DB instance was created.
- Returns:
- Provides the date and time the DB instance was created.
-
withInstanceCreateTime
public DBInstance withInstanceCreateTime(Date instanceCreateTime)
Provides the date and time the DB instance was created.
- Parameters:
instanceCreateTime
- Provides the date and time the DB instance was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPreferredBackupWindow
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
.- Parameters:
preferredBackupWindow
- Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by theBackupRetentionPeriod
.
-
getPreferredBackupWindow
public String getPreferredBackupWindow()
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the
BackupRetentionPeriod
.- Returns:
- Specifies the daily time range during which automated backups are
created if automated backups are enabled, as determined by the
BackupRetentionPeriod
.
-
withPreferredBackupWindow
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
.- Parameters:
preferredBackupWindow
- Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by theBackupRetentionPeriod
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setBackupRetentionPeriod
public void setBackupRetentionPeriod(Integer backupRetentionPeriod)
Specifies the number of days for which automatic DB snapshots are retained.
- Parameters:
backupRetentionPeriod
- Specifies the number of days for which automatic DB snapshots are retained.
-
getBackupRetentionPeriod
public Integer getBackupRetentionPeriod()
Specifies the number of days for which automatic DB snapshots are retained.
- Returns:
- Specifies the number of days for which automatic DB snapshots are retained.
-
withBackupRetentionPeriod
public DBInstance withBackupRetentionPeriod(Integer backupRetentionPeriod)
Specifies the number of days for which automatic DB snapshots are retained.
- Parameters:
backupRetentionPeriod
- Specifies the number of days for which automatic DB snapshots are retained.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getDBSecurityGroups
public List<DBSecurityGroupMembership> getDBSecurityGroups()
Provides List of DB security group elements containing only
DBSecurityGroup.Name
andDBSecurityGroup.Status
subelements.- Returns:
- Provides List of DB security group elements containing only
DBSecurityGroup.Name
andDBSecurityGroup.Status
subelements.
-
setDBSecurityGroups
public void setDBSecurityGroups(Collection<DBSecurityGroupMembership> dBSecurityGroups)
Provides List of DB security group elements containing only
DBSecurityGroup.Name
andDBSecurityGroup.Status
subelements.- Parameters:
dBSecurityGroups
- Provides List of DB security group elements containing onlyDBSecurityGroup.Name
andDBSecurityGroup.Status
subelements.
-
withDBSecurityGroups
public DBInstance withDBSecurityGroups(DBSecurityGroupMembership... dBSecurityGroups)
Provides List of DB security group elements containing only
DBSecurityGroup.Name
andDBSecurityGroup.Status
subelements.NOTE: This method appends the values to the existing list (if any). Use
setDBSecurityGroups(java.util.Collection)
orwithDBSecurityGroups(java.util.Collection)
if you want to override the existing values.- Parameters:
dBSecurityGroups
- Provides List of DB security group elements containing onlyDBSecurityGroup.Name
andDBSecurityGroup.Status
subelements.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withDBSecurityGroups
public DBInstance withDBSecurityGroups(Collection<DBSecurityGroupMembership> dBSecurityGroups)
Provides List of DB security group elements containing only
DBSecurityGroup.Name
andDBSecurityGroup.Status
subelements.- Parameters:
dBSecurityGroups
- Provides List of DB security group elements containing onlyDBSecurityGroup.Name
andDBSecurityGroup.Status
subelements.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getVpcSecurityGroups
public List<VpcSecurityGroupMembership> getVpcSecurityGroups()
Provides List of VPC security group elements that the DB instance belongs to.
- Returns:
- Provides List of VPC security group elements that the DB instance belongs to.
-
setVpcSecurityGroups
public void setVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
Provides List of VPC security group elements that the DB instance belongs to.
- Parameters:
vpcSecurityGroups
- Provides List of VPC security group elements that the DB instance belongs to.
-
withVpcSecurityGroups
public DBInstance withVpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
Provides 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)
orwithVpcSecurityGroups(java.util.Collection)
if you want to override the existing values.- Parameters:
vpcSecurityGroups
- Provides List of VPC security group elements that the DB instance belongs to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withVpcSecurityGroups
public DBInstance withVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
Provides List of VPC security group elements that the DB instance belongs to.
- Parameters:
vpcSecurityGroups
- Provides List of VPC security group elements that the DB instance belongs to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getDBParameterGroups
public List<DBParameterGroupStatus> getDBParameterGroups()
Provides the list of DB parameter groups applied to this DB instance.
- Returns:
- Provides the list of DB parameter groups applied to this DB instance.
-
setDBParameterGroups
public void setDBParameterGroups(Collection<DBParameterGroupStatus> dBParameterGroups)
Provides the list of DB parameter groups applied to this DB instance.
- Parameters:
dBParameterGroups
- Provides the list of DB parameter groups applied to this DB instance.
-
withDBParameterGroups
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)
orwithDBParameterGroups(java.util.Collection)
if you want to override the existing values.- Parameters:
dBParameterGroups
- Provides the list of DB parameter groups applied to this DB instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withDBParameterGroups
public DBInstance withDBParameterGroups(Collection<DBParameterGroupStatus> dBParameterGroups)
Provides the list of DB parameter groups applied to this DB instance.
- Parameters:
dBParameterGroups
- Provides the list of DB parameter groups applied to this DB instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAvailabilityZone
public void setAvailabilityZone(String availabilityZone)
Specifies the name of the Availability Zone the DB instance is located in.
- Parameters:
availabilityZone
- Specifies the name of the Availability Zone the DB instance is located in.
-
getAvailabilityZone
public String getAvailabilityZone()
Specifies the name of the Availability Zone the DB instance is located in.
- Returns:
- Specifies the name of the Availability Zone the DB instance is located in.
-
withAvailabilityZone
public DBInstance withAvailabilityZone(String availabilityZone)
Specifies the name of the Availability Zone the DB instance is located in.
- Parameters:
availabilityZone
- Specifies the name of the Availability Zone the DB instance is located in.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDBSubnetGroup
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.
- Parameters:
dBSubnetGroup
- Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
-
getDBSubnetGroup
public DBSubnetGroup getDBSubnetGroup()
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
- Returns:
- Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
-
withDBSubnetGroup
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.
- Parameters:
dBSubnetGroup
- Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPreferredMaintenanceWindow
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
- Parameters:
preferredMaintenanceWindow
- Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
-
getPreferredMaintenanceWindow
public String getPreferredMaintenanceWindow()
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
- Returns:
- Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
-
withPreferredMaintenanceWindow
public DBInstance withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
- Parameters:
preferredMaintenanceWindow
- Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPendingModifiedValues
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.
- Parameters:
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.
-
getPendingModifiedValues
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.
- Returns:
- Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
-
withPendingModifiedValues
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLatestRestorableTime
public void setLatestRestorableTime(Date latestRestorableTime)
Specifies the latest time to which a database can be restored with point-in-time restore.
- Parameters:
latestRestorableTime
- Specifies the latest time to which a database can be restored with point-in-time restore.
-
getLatestRestorableTime
public Date getLatestRestorableTime()
Specifies the latest time to which a database can be restored with point-in-time restore.
- Returns:
- Specifies the latest time to which a database can be restored with point-in-time restore.
-
withLatestRestorableTime
public DBInstance withLatestRestorableTime(Date latestRestorableTime)
Specifies the latest time to which a database can be restored with point-in-time restore.
- Parameters:
latestRestorableTime
- Specifies the latest time to which a database can be restored with point-in-time restore.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMultiAZ
public void setMultiAZ(Boolean multiAZ)
Specifies if the DB instance is a Multi-AZ deployment.
- Parameters:
multiAZ
- Specifies if the DB instance is a Multi-AZ deployment.
-
getMultiAZ
public Boolean getMultiAZ()
Specifies if the DB instance is a Multi-AZ deployment.
- Returns:
- Specifies if the DB instance is a Multi-AZ deployment.
-
withMultiAZ
public DBInstance withMultiAZ(Boolean multiAZ)
Specifies if the DB instance is a Multi-AZ deployment.
- Parameters:
multiAZ
- Specifies if the DB instance is a Multi-AZ deployment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isMultiAZ
public Boolean isMultiAZ()
Specifies if the DB instance is a Multi-AZ deployment.
- Returns:
- Specifies if the DB instance is a Multi-AZ deployment.
-
setEngineVersion
public void setEngineVersion(String engineVersion)
Indicates the database engine version.
- Parameters:
engineVersion
- Indicates the database engine version.
-
getEngineVersion
public String getEngineVersion()
Indicates the database engine version.
- Returns:
- Indicates the database engine version.
-
withEngineVersion
public DBInstance withEngineVersion(String engineVersion)
Indicates the database engine version.
- Parameters:
engineVersion
- Indicates the database engine version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAutoMinorVersionUpgrade
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor version patches are applied automatically.
- Parameters:
autoMinorVersionUpgrade
- Indicates that minor version patches are applied automatically.
-
getAutoMinorVersionUpgrade
public Boolean getAutoMinorVersionUpgrade()
Indicates that minor version patches are applied automatically.
- Returns:
- Indicates that minor version patches are applied automatically.
-
withAutoMinorVersionUpgrade
public DBInstance withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor version patches are applied automatically.
- Parameters:
autoMinorVersionUpgrade
- Indicates that minor version patches are applied automatically.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isAutoMinorVersionUpgrade
public Boolean isAutoMinorVersionUpgrade()
Indicates that minor version patches are applied automatically.
- Returns:
- Indicates that minor version patches are applied automatically.
-
setReadReplicaSourceDBInstanceIdentifier
public void setReadReplicaSourceDBInstanceIdentifier(String readReplicaSourceDBInstanceIdentifier)
Contains the identifier of the source DB instance if this DB instance is a Read Replica.
- Parameters:
readReplicaSourceDBInstanceIdentifier
- Contains the identifier of the source DB instance if this DB instance is a Read Replica.
-
getReadReplicaSourceDBInstanceIdentifier
public String getReadReplicaSourceDBInstanceIdentifier()
Contains the identifier of the source DB instance if this DB instance is a Read Replica.
- Returns:
- Contains the identifier of the source DB instance if this DB instance is a Read Replica.
-
withReadReplicaSourceDBInstanceIdentifier
public DBInstance withReadReplicaSourceDBInstanceIdentifier(String readReplicaSourceDBInstanceIdentifier)
Contains the identifier of the source DB instance if this DB instance is a Read Replica.
- Parameters:
readReplicaSourceDBInstanceIdentifier
- Contains the identifier of the source DB instance if this DB instance is a Read Replica.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getReadReplicaDBInstanceIdentifiers
public List<String> getReadReplicaDBInstanceIdentifiers()
Contains one or more identifiers of the Read Replicas associated with this DB instance.
- Returns:
- Contains one or more identifiers of the Read Replicas associated with this DB instance.
-
setReadReplicaDBInstanceIdentifiers
public void setReadReplicaDBInstanceIdentifiers(Collection<String> readReplicaDBInstanceIdentifiers)
Contains one or more identifiers of the Read Replicas associated with this DB instance.
- Parameters:
readReplicaDBInstanceIdentifiers
- Contains one or more identifiers of the Read Replicas associated with this DB instance.
-
withReadReplicaDBInstanceIdentifiers
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)
orwithReadReplicaDBInstanceIdentifiers(java.util.Collection)
if you want to override the existing values.- Parameters:
readReplicaDBInstanceIdentifiers
- Contains one or more identifiers of the Read Replicas associated with this DB instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withReadReplicaDBInstanceIdentifiers
public DBInstance withReadReplicaDBInstanceIdentifiers(Collection<String> readReplicaDBInstanceIdentifiers)
Contains one or more identifiers of the Read Replicas associated with this DB instance.
- Parameters:
readReplicaDBInstanceIdentifiers
- Contains one or more identifiers of the Read Replicas associated with this DB instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLicenseModel
public void setLicenseModel(String licenseModel)
License model information for this DB instance.
- Parameters:
licenseModel
- License model information for this DB instance.
-
getLicenseModel
public String getLicenseModel()
License model information for this DB instance.
- Returns:
- License model information for this DB instance.
-
withLicenseModel
public DBInstance withLicenseModel(String licenseModel)
License model information for this DB instance.
- Parameters:
licenseModel
- License model information for this DB instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setIops
public void setIops(Integer iops)
Specifies the Provisioned IOPS (I/O operations per second) value.
- Parameters:
iops
- Specifies the Provisioned IOPS (I/O operations per second) value.
-
getIops
public Integer getIops()
Specifies the Provisioned IOPS (I/O operations per second) value.
- Returns:
- Specifies the Provisioned IOPS (I/O operations per second) value.
-
withIops
public DBInstance withIops(Integer iops)
Specifies the Provisioned IOPS (I/O operations per second) value.
- Parameters:
iops
- Specifies the Provisioned IOPS (I/O operations per second) value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getOptionGroupMemberships
public List<OptionGroupMembership> getOptionGroupMemberships()
Provides the list of option group memberships for this DB instance.
- Returns:
- Provides the list of option group memberships for this DB instance.
-
setOptionGroupMemberships
public void setOptionGroupMemberships(Collection<OptionGroupMembership> optionGroupMemberships)
Provides the list of option group memberships for this DB instance.
- Parameters:
optionGroupMemberships
- Provides the list of option group memberships for this DB instance.
-
withOptionGroupMemberships
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)
orwithOptionGroupMemberships(java.util.Collection)
if you want to override the existing values.- Parameters:
optionGroupMemberships
- Provides the list of option group memberships for this DB instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withOptionGroupMemberships
public DBInstance withOptionGroupMemberships(Collection<OptionGroupMembership> optionGroupMemberships)
Provides the list of option group memberships for this DB instance.
- Parameters:
optionGroupMemberships
- Provides the list of option group memberships for this DB instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCharacterSetName
public void setCharacterSetName(String characterSetName)
If present, specifies the name of the character set that this instance is associated with.
- Parameters:
characterSetName
- If present, specifies the name of the character set that this instance is associated with.
-
getCharacterSetName
public String getCharacterSetName()
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.
-
withCharacterSetName
public DBInstance withCharacterSetName(String characterSetName)
If present, specifies the name of the character set that this instance is associated with.
- Parameters:
characterSetName
- If present, specifies the name of the character set that this instance is associated with.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSecondaryAvailabilityZone
public void setSecondaryAvailabilityZone(String secondaryAvailabilityZone)
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
- Parameters:
secondaryAvailabilityZone
- If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
-
getSecondaryAvailabilityZone
public String getSecondaryAvailabilityZone()
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.
-
withSecondaryAvailabilityZone
public DBInstance withSecondaryAvailabilityZone(String secondaryAvailabilityZone)
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
- Parameters:
secondaryAvailabilityZone
- If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPubliclyAccessible
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 will be 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 will be private.
- Parameters:
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 will be 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 will be private.
-
getPubliclyAccessible
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 will be 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 will be private.
- Returns:
- Specifies the accessibility options for the DB instance. A value
of true specifies an Internet-facing instance with a publicly
resolvable DNS name, which resolves to a public IP address. A
value of false specifies an internal instance with a DNS name
that resolves to a private IP address.
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 will be 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 will be private.
-
withPubliclyAccessible
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 will be 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 will be private.
- Parameters:
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 will be 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 will be private.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isPubliclyAccessible
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 will be 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 will be private.
- Returns:
- Specifies the accessibility options for the DB instance. A value
of true specifies an Internet-facing instance with a publicly
resolvable DNS name, which resolves to a public IP address. A
value of false specifies an internal instance with a DNS name
that resolves to a private IP address.
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 will be 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 will be private.
-
getStatusInfos
public List<DBInstanceStatusInfo> getStatusInfos()
The status of a Read Replica. If the instance is not a Read Replica, this will be blank.
- Returns:
- The status of a Read Replica. If the instance is not a Read Replica, this will be blank.
-
setStatusInfos
public void setStatusInfos(Collection<DBInstanceStatusInfo> statusInfos)
The status of a Read Replica. If the instance is not a Read Replica, this will be blank.
- Parameters:
statusInfos
- The status of a Read Replica. If the instance is not a Read Replica, this will be blank.
-
withStatusInfos
public DBInstance withStatusInfos(DBInstanceStatusInfo... statusInfos)
The status of a Read Replica. If the instance is not a Read Replica, this will be blank.
NOTE: This method appends the values to the existing list (if any). Use
setStatusInfos(java.util.Collection)
orwithStatusInfos(java.util.Collection)
if you want to override the existing values.- Parameters:
statusInfos
- The status of a Read Replica. If the instance is not a Read Replica, this will be blank.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withStatusInfos
public DBInstance withStatusInfos(Collection<DBInstanceStatusInfo> statusInfos)
The status of a Read Replica. If the instance is not a Read Replica, this will be blank.
- Parameters:
statusInfos
- The status of a Read Replica. If the instance is not a Read Replica, this will be blank.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStorageType
public void setStorageType(String storageType)
Specifies the storage type associated with DB instance.
- Parameters:
storageType
- Specifies the storage type associated with DB instance.
-
getStorageType
public String getStorageType()
Specifies the storage type associated with DB instance.
- Returns:
- Specifies the storage type associated with DB instance.
-
withStorageType
public DBInstance withStorageType(String storageType)
Specifies the storage type associated with DB instance.
- Parameters:
storageType
- Specifies the storage type associated with DB instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTdeCredentialArn
public void setTdeCredentialArn(String tdeCredentialArn)
The ARN from the Key Store with which the instance is associated for TDE encryption.
- Parameters:
tdeCredentialArn
- The ARN from the Key Store with which the instance is associated for TDE encryption.
-
getTdeCredentialArn
public String getTdeCredentialArn()
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.
-
withTdeCredentialArn
public DBInstance withTdeCredentialArn(String tdeCredentialArn)
The ARN from the Key Store with which the instance is associated for TDE encryption.
- Parameters:
tdeCredentialArn
- The ARN from the Key Store with which the instance is associated for TDE encryption.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDbInstancePort
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.
- Parameters:
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.
-
getDbInstancePort
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.
- Returns:
- Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
-
withDbInstancePort
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.
- Parameters:
dbInstancePort
- Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDBClusterIdentifier
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.
- Parameters:
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.
-
getDBClusterIdentifier
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.
- Returns:
- If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
-
withDBClusterIdentifier
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.
- Parameters:
dBClusterIdentifier
- If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStorageEncrypted
public void setStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB instance is encrypted.
- Parameters:
storageEncrypted
- Specifies whether the DB instance is encrypted.
-
getStorageEncrypted
public Boolean getStorageEncrypted()
Specifies whether the DB instance is encrypted.
- Returns:
- Specifies whether the DB instance is encrypted.
-
withStorageEncrypted
public DBInstance withStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB instance is encrypted.
- Parameters:
storageEncrypted
- Specifies whether the DB instance is encrypted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isStorageEncrypted
public Boolean isStorageEncrypted()
Specifies whether the DB instance is encrypted.
- Returns:
- Specifies whether the DB instance is encrypted.
-
setKmsKeyId
public void setKmsKeyId(String kmsKeyId)
If
StorageEncrypted
is true, the KMS key identifier for the encrypted DB instance.- Parameters:
kmsKeyId
- IfStorageEncrypted
is true, the KMS key identifier for the encrypted DB instance.
-
getKmsKeyId
public String getKmsKeyId()
If
StorageEncrypted
is true, the KMS key identifier for the encrypted DB instance.- Returns:
- If
StorageEncrypted
is true, the KMS key identifier for the encrypted DB instance.
-
withKmsKeyId
public DBInstance withKmsKeyId(String kmsKeyId)
If
StorageEncrypted
is true, the KMS key identifier for the encrypted DB instance.- Parameters:
kmsKeyId
- IfStorageEncrypted
is true, the KMS key identifier for the encrypted DB instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDbiResourceId
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.
- Parameters:
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.
-
getDbiResourceId
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.
- Returns:
- 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.
-
withDbiResourceId
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCACertificateIdentifier
public void setCACertificateIdentifier(String cACertificateIdentifier)
The identifier of the CA certificate for this DB instance.
- Parameters:
cACertificateIdentifier
- The identifier of the CA certificate for this DB instance.
-
getCACertificateIdentifier
public String getCACertificateIdentifier()
The identifier of the CA certificate for this DB instance.
- Returns:
- The identifier of the CA certificate for this DB instance.
-
withCACertificateIdentifier
public DBInstance withCACertificateIdentifier(String cACertificateIdentifier)
The identifier of the CA certificate for this DB instance.
- Parameters:
cACertificateIdentifier
- The identifier of the CA certificate for this DB instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getDomainMemberships
public List<DomainMembership> getDomainMemberships()
The Active Directory Domain membership records associated with the DB instance.
- Returns:
- The Active Directory Domain membership records associated with the DB instance.
-
setDomainMemberships
public void setDomainMemberships(Collection<DomainMembership> domainMemberships)
The Active Directory Domain membership records associated with the DB instance.
- Parameters:
domainMemberships
- The Active Directory Domain membership records associated with the DB instance.
-
withDomainMemberships
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)
orwithDomainMemberships(java.util.Collection)
if you want to override the existing values.- Parameters:
domainMemberships
- The Active Directory Domain membership records associated with the DB instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withDomainMemberships
public DBInstance withDomainMemberships(Collection<DomainMembership> domainMemberships)
The Active Directory Domain membership records associated with the DB instance.
- Parameters:
domainMemberships
- The Active Directory Domain membership records associated with the DB instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCopyTagsToSnapshot
public void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
- Parameters:
copyTagsToSnapshot
- Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
-
getCopyTagsToSnapshot
public Boolean getCopyTagsToSnapshot()
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
- Returns:
- Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
-
withCopyTagsToSnapshot
public DBInstance withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
- Parameters:
copyTagsToSnapshot
- Specifies whether tags are copied from the DB instance to snapshots of the DB instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isCopyTagsToSnapshot
public Boolean isCopyTagsToSnapshot()
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
- Returns:
- Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
-
setMonitoringInterval
public void setMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
- Parameters:
monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
-
getMonitoringInterval
public Integer getMonitoringInterval()
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.
-
withMonitoringInterval
public DBInstance withMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
- Parameters:
monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEnhancedMonitoringResourceArn
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.
- Parameters:
enhancedMonitoringResourceArn
- The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
-
getEnhancedMonitoringResourceArn
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.
- Returns:
- The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
-
withEnhancedMonitoringResourceArn
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
setMonitoringRoleArn
public void setMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to CloudWatch Logs.
- Parameters:
monitoringRoleArn
- The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to CloudWatch Logs.
-
getMonitoringRoleArn
public String getMonitoringRoleArn()
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to CloudWatch Logs.
- Returns:
- The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to CloudWatch Logs.
-
withMonitoringRoleArn
public DBInstance withMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to CloudWatch Logs.
- Parameters:
monitoringRoleArn
- The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to CloudWatch Logs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPromotionTier
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.
- Parameters:
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.
-
getPromotionTier
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.
- Returns:
- 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.
-
withPromotionTier
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public DBInstance clone()
-
-