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 |
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()
If
StorageEncrypted is true, the region-unique, immutable
identifier for the encrypted 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.
|
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.
|
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.
|
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 the
BackupRetentionPeriod . |
String |
getPreferredMaintenanceWindow()
Specifies the weekly time range during which system maintenance can
occur, in Universal Coordinated Time (UTC).
|
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)
If
StorageEncrypted is true, the region-unique, immutable
identifier for the encrypted 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 |
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 |
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 |
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 the
BackupRetentionPeriod . |
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which system maintenance can
occur, in Universal Coordinated Time (UTC).
|
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)
If
StorageEncrypted is true, the region-unique, immutable
identifier for the encrypted 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 |
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 |
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 |
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 |
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 |
withPubliclyAccessible(Boolean publiclyAccessible)
Specifies the accessibility options for the 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 |
withVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
Provides List of VPC security group elements that the DB instance
belongs to.
|
DBInstance |
withVpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
Provides List of VPC security group elements that the DB instance
belongs to.
|
public String getDBInstanceIdentifier()
public void setDBInstanceIdentifier(String dBInstanceIdentifier)
dBInstanceIdentifier
- Contains a user-supplied database identifier. This identifier is the
unique key that identifies a DB instance.public DBInstance withDBInstanceIdentifier(String dBInstanceIdentifier)
Returns a reference to this object so that method calls can be chained together.
dBInstanceIdentifier
- Contains a user-supplied database identifier. This identifier is the
unique key that identifies a DB instance.public String getDBInstanceClass()
public void setDBInstanceClass(String dBInstanceClass)
dBInstanceClass
- Contains the name of the compute and memory capacity class of the DB
instance.public DBInstance withDBInstanceClass(String dBInstanceClass)
Returns a reference to this object so that method calls can be chained together.
dBInstanceClass
- Contains the name of the compute and memory capacity class of the DB
instance.public String getEngine()
public void setEngine(String engine)
engine
- Provides the name of the database engine to be used for this DB
instance.public DBInstance withEngine(String engine)
Returns a reference to this object so that method calls can be chained together.
engine
- Provides the name of the database engine to be used for this DB
instance.public String getDBInstanceStatus()
public void setDBInstanceStatus(String dBInstanceStatus)
dBInstanceStatus
- Specifies the current state of this database.public DBInstance withDBInstanceStatus(String dBInstanceStatus)
Returns a reference to this object so that method calls can be chained together.
dBInstanceStatus
- Specifies the current state of this database.public String getMasterUsername()
public void setMasterUsername(String masterUsername)
masterUsername
- Contains the master username for the DB instance.public DBInstance withMasterUsername(String masterUsername)
Returns a reference to this object so that method calls can be chained together.
masterUsername
- Contains the master username for the DB instance.public String getDBName()
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.
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.
public void setDBName(String dBName)
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.
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.
public DBInstance withDBName(String dBName)
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 a reference to this object so that method calls can be chained together.
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.
public Endpoint getEndpoint()
public void setEndpoint(Endpoint endpoint)
endpoint
- Specifies the connection endpoint.public DBInstance withEndpoint(Endpoint endpoint)
Returns a reference to this object so that method calls can be chained together.
endpoint
- Specifies the connection endpoint.public Integer getAllocatedStorage()
public void setAllocatedStorage(Integer allocatedStorage)
allocatedStorage
- Specifies the allocated storage size specified in gigabytes.public DBInstance withAllocatedStorage(Integer allocatedStorage)
Returns a reference to this object so that method calls can be chained together.
allocatedStorage
- Specifies the allocated storage size specified in gigabytes.public Date getInstanceCreateTime()
public void setInstanceCreateTime(Date instanceCreateTime)
instanceCreateTime
- Provides the date and time the DB instance was created.public DBInstance withInstanceCreateTime(Date instanceCreateTime)
Returns a reference to this object so that method calls can be chained together.
instanceCreateTime
- Provides the date and time the DB instance was created.public String getPreferredBackupWindow()
BackupRetentionPeriod
.BackupRetentionPeriod
.public void setPreferredBackupWindow(String preferredBackupWindow)
BackupRetentionPeriod
.preferredBackupWindow
- Specifies the daily time range during which automated backups are
created if automated backups are enabled, as determined by the
BackupRetentionPeriod
.public DBInstance withPreferredBackupWindow(String preferredBackupWindow)
BackupRetentionPeriod
.
Returns a reference to this object so that method calls can be chained together.
preferredBackupWindow
- Specifies the daily time range during which automated backups are
created if automated backups are enabled, as determined by the
BackupRetentionPeriod
.public Integer getBackupRetentionPeriod()
public void setBackupRetentionPeriod(Integer backupRetentionPeriod)
backupRetentionPeriod
- Specifies the number of days for which automatic DB snapshots are
retained.public DBInstance withBackupRetentionPeriod(Integer backupRetentionPeriod)
Returns a reference to this object so that method calls can be chained together.
backupRetentionPeriod
- Specifies the number of days for which automatic DB snapshots are
retained.public List<DBSecurityGroupMembership> getDBSecurityGroups()
DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.public void setDBSecurityGroups(Collection<DBSecurityGroupMembership> dBSecurityGroups)
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)
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.
Returns a reference to this object so that method calls can be chained together.
dBSecurityGroups
- Provides List of DB security group elements containing only
DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.public DBInstance withDBSecurityGroups(Collection<DBSecurityGroupMembership> dBSecurityGroups)
DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.
Returns a reference to this object so that method calls can be chained together.
dBSecurityGroups
- Provides List of DB security group elements containing only
DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.public List<VpcSecurityGroupMembership> getVpcSecurityGroups()
public void setVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
vpcSecurityGroups
- Provides List of VPC security group elements that the DB instance
belongs to.public DBInstance withVpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
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.
Returns a reference to this object so that method calls can be chained together.
vpcSecurityGroups
- Provides List of VPC security group elements that the DB instance
belongs to.public DBInstance withVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
Returns a reference to this object so that method calls can be chained together.
vpcSecurityGroups
- Provides List of VPC security group elements that the DB instance
belongs to.public List<DBParameterGroupStatus> getDBParameterGroups()
public void setDBParameterGroups(Collection<DBParameterGroupStatus> dBParameterGroups)
dBParameterGroups
- Provides the list of DB parameter groups applied to this DB instance.public DBInstance withDBParameterGroups(DBParameterGroupStatus... dBParameterGroups)
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.
Returns a reference to this object so that method calls can be chained together.
dBParameterGroups
- Provides the list of DB parameter groups applied to this DB instance.public DBInstance withDBParameterGroups(Collection<DBParameterGroupStatus> dBParameterGroups)
Returns a reference to this object so that method calls can be chained together.
dBParameterGroups
- Provides the list of DB parameter groups applied to this DB instance.public String getAvailabilityZone()
public void setAvailabilityZone(String availabilityZone)
availabilityZone
- Specifies the name of the Availability Zone the DB instance is located
in.public DBInstance withAvailabilityZone(String availabilityZone)
Returns a reference to this object so that method calls can be chained together.
availabilityZone
- Specifies the name of the Availability Zone the DB instance is located
in.public DBSubnetGroup getDBSubnetGroup()
public void setDBSubnetGroup(DBSubnetGroup dBSubnetGroup)
dBSubnetGroup
- 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)
Returns a reference to this object so that method calls can be chained together.
dBSubnetGroup
- Specifies information on the subnet group associated with the DB
instance, including the name, description, and subnets in the subnet
group.public String getPreferredMaintenanceWindow()
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
preferredMaintenanceWindow
- Specifies the weekly time range during which system maintenance can
occur, in Universal Coordinated Time (UTC).public DBInstance withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Returns a reference to this object so that method calls can be chained together.
preferredMaintenanceWindow
- Specifies the weekly time range during which system maintenance can
occur, in Universal Coordinated Time (UTC).public PendingModifiedValues getPendingModifiedValues()
public void setPendingModifiedValues(PendingModifiedValues 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.public DBInstance withPendingModifiedValues(PendingModifiedValues pendingModifiedValues)
Returns a reference to this object so that method calls can be chained together.
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 Date getLatestRestorableTime()
public void setLatestRestorableTime(Date latestRestorableTime)
latestRestorableTime
- Specifies the latest time to which a database can be restored with
point-in-time restore.public DBInstance withLatestRestorableTime(Date latestRestorableTime)
Returns a reference to this object so that method calls can be chained together.
latestRestorableTime
- Specifies the latest time to which a database can be restored with
point-in-time restore.public Boolean isMultiAZ()
public void setMultiAZ(Boolean multiAZ)
multiAZ
- Specifies if the DB instance is a Multi-AZ deployment.public DBInstance withMultiAZ(Boolean multiAZ)
Returns a reference to this object so that method calls can be chained together.
multiAZ
- Specifies if the DB instance is a Multi-AZ deployment.public Boolean getMultiAZ()
public String getEngineVersion()
public void setEngineVersion(String engineVersion)
engineVersion
- Indicates the database engine version.public DBInstance withEngineVersion(String engineVersion)
Returns a reference to this object so that method calls can be chained together.
engineVersion
- Indicates the database engine version.public Boolean isAutoMinorVersionUpgrade()
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
autoMinorVersionUpgrade
- Indicates that minor version patches are applied automatically.public DBInstance withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Returns a reference to this object so that method calls can be chained together.
autoMinorVersionUpgrade
- Indicates that minor version patches are applied automatically.public Boolean getAutoMinorVersionUpgrade()
public String getReadReplicaSourceDBInstanceIdentifier()
public void setReadReplicaSourceDBInstanceIdentifier(String readReplicaSourceDBInstanceIdentifier)
readReplicaSourceDBInstanceIdentifier
- Contains the identifier of the source DB instance if this DB instance
is a Read Replica.public DBInstance withReadReplicaSourceDBInstanceIdentifier(String readReplicaSourceDBInstanceIdentifier)
Returns a reference to this object so that method calls can be chained together.
readReplicaSourceDBInstanceIdentifier
- Contains the identifier of the source DB instance if this DB instance
is a Read Replica.public List<String> getReadReplicaDBInstanceIdentifiers()
public void setReadReplicaDBInstanceIdentifiers(Collection<String> readReplicaDBInstanceIdentifiers)
readReplicaDBInstanceIdentifiers
- Contains one or more identifiers of the Read Replicas associated with
this DB instance.public DBInstance withReadReplicaDBInstanceIdentifiers(String... readReplicaDBInstanceIdentifiers)
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.
Returns a reference to this object so that method calls can be chained together.
readReplicaDBInstanceIdentifiers
- Contains one or more identifiers of the Read Replicas associated with
this DB instance.public DBInstance withReadReplicaDBInstanceIdentifiers(Collection<String> readReplicaDBInstanceIdentifiers)
Returns a reference to this object so that method calls can be chained together.
readReplicaDBInstanceIdentifiers
- Contains one or more identifiers of the Read Replicas associated with
this DB instance.public String getLicenseModel()
public void setLicenseModel(String licenseModel)
licenseModel
- License model information for this DB instance.public DBInstance withLicenseModel(String licenseModel)
Returns a reference to this object so that method calls can be chained together.
licenseModel
- License model information for this DB instance.public Integer getIops()
public void setIops(Integer iops)
iops
- Specifies the Provisioned IOPS (I/O operations per second) value.public DBInstance withIops(Integer iops)
Returns a reference to this object so that method calls can be chained together.
iops
- Specifies the Provisioned IOPS (I/O operations per second) value.public List<OptionGroupMembership> getOptionGroupMemberships()
public void setOptionGroupMemberships(Collection<OptionGroupMembership> optionGroupMemberships)
optionGroupMemberships
- Provides the list of option group memberships for this DB instance.public DBInstance withOptionGroupMemberships(OptionGroupMembership... optionGroupMemberships)
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.
Returns a reference to this object so that method calls can be chained together.
optionGroupMemberships
- Provides the list of option group memberships for this DB instance.public DBInstance withOptionGroupMemberships(Collection<OptionGroupMembership> optionGroupMemberships)
Returns a reference to this object so that method calls can be chained together.
optionGroupMemberships
- Provides the list of option group memberships for this DB instance.public String getCharacterSetName()
public void setCharacterSetName(String characterSetName)
characterSetName
- If present, specifies the name of the character set that this instance
is associated with.public DBInstance withCharacterSetName(String characterSetName)
Returns a reference to this object so that method calls can be chained together.
characterSetName
- If present, specifies the name of the character set that this instance
is associated with.public String getSecondaryAvailabilityZone()
public void setSecondaryAvailabilityZone(String secondaryAvailabilityZone)
secondaryAvailabilityZone
- If present, specifies the name of the secondary Availability Zone for
a DB instance with multi-AZ support.public DBInstance withSecondaryAvailabilityZone(String secondaryAvailabilityZone)
Returns a reference to this object so that method calls can be chained together.
secondaryAvailabilityZone
- If present, specifies the name of the secondary Availability Zone for
a DB instance with multi-AZ support.public Boolean isPubliclyAccessible()
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.
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.
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.
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.
public void setPubliclyAccessible(Boolean publiclyAccessible)
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.
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.
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.
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.
public DBInstance withPubliclyAccessible(Boolean publiclyAccessible)
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.
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 a reference to this object so that method calls can be chained together.
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.
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.
public Boolean getPubliclyAccessible()
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.
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.
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.
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.
public List<DBInstanceStatusInfo> getStatusInfos()
public void setStatusInfos(Collection<DBInstanceStatusInfo> statusInfos)
statusInfos
- The status of a Read Replica. If the instance is not a Read Replica,
this will be blank.public DBInstance withStatusInfos(DBInstanceStatusInfo... statusInfos)
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.
Returns a reference to this object so that method calls can be chained together.
statusInfos
- The status of a Read Replica. If the instance is not a Read Replica,
this will be blank.public DBInstance withStatusInfos(Collection<DBInstanceStatusInfo> statusInfos)
Returns a reference to this object so that method calls can be chained together.
statusInfos
- The status of a Read Replica. If the instance is not a Read Replica,
this will be blank.public String getStorageType()
public void setStorageType(String storageType)
storageType
- Specifies the storage type associated with DB instance.public DBInstance withStorageType(String storageType)
Returns a reference to this object so that method calls can be chained together.
storageType
- Specifies the storage type associated with DB instance.public String getTdeCredentialArn()
public void setTdeCredentialArn(String tdeCredentialArn)
tdeCredentialArn
- The ARN from the Key Store with which the instance is associated for
TDE encryption.public DBInstance withTdeCredentialArn(String tdeCredentialArn)
Returns a reference to this object so that method calls can be chained together.
tdeCredentialArn
- The ARN from the Key Store with which the instance is associated for
TDE encryption.public Integer getDbInstancePort()
public void setDbInstancePort(Integer dbInstancePort)
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 DBInstance withDbInstancePort(Integer dbInstancePort)
Returns a reference to this object so that method calls can be chained together.
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 String getDBClusterIdentifier()
public void setDBClusterIdentifier(String dBClusterIdentifier)
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 DBInstance withDBClusterIdentifier(String dBClusterIdentifier)
Returns a reference to this object so that method calls can be chained together.
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 Boolean isStorageEncrypted()
public void setStorageEncrypted(Boolean storageEncrypted)
storageEncrypted
- Specifies whether the DB instance is encrypted.public DBInstance withStorageEncrypted(Boolean storageEncrypted)
Returns a reference to this object so that method calls can be chained together.
storageEncrypted
- Specifies whether the DB instance is encrypted.public Boolean getStorageEncrypted()
public String getKmsKeyId()
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 void setKmsKeyId(String kmsKeyId)
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 DBInstance withKmsKeyId(String kmsKeyId)
StorageEncrypted
is true, the KMS key identifier for
the encrypted DB instance.
Returns a reference to this object so that method calls can be chained together.
kmsKeyId
- If StorageEncrypted
is true, the KMS key identifier for
the encrypted DB instance.public String getDbiResourceId()
StorageEncrypted
is true, the region-unique, immutable
identifier for the encrypted DB instance. This identifier is found in
AWS CloudTrail log entries whenever the KMS key for the DB instance is
accessed.StorageEncrypted
is true, the region-unique, immutable
identifier for the encrypted DB instance. This identifier is found in
AWS CloudTrail log entries whenever the KMS key for the DB instance is
accessed.public void setDbiResourceId(String dbiResourceId)
StorageEncrypted
is true, the region-unique, immutable
identifier for the encrypted DB instance. This identifier is found in
AWS CloudTrail log entries whenever the KMS key for the DB instance is
accessed.dbiResourceId
- If StorageEncrypted
is true, the region-unique, immutable
identifier for the encrypted 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)
StorageEncrypted
is true, the region-unique, immutable
identifier for the encrypted DB instance. This identifier is found in
AWS CloudTrail log entries whenever the KMS key for the DB instance is
accessed.
Returns a reference to this object so that method calls can be chained together.
dbiResourceId
- If StorageEncrypted
is true, the region-unique, immutable
identifier for the encrypted DB instance. This identifier is found in
AWS CloudTrail log entries whenever the KMS key for the DB instance is
accessed.public String getCACertificateIdentifier()
public void setCACertificateIdentifier(String cACertificateIdentifier)
cACertificateIdentifier
- The identifier of the CA certificate for this DB instance.public DBInstance withCACertificateIdentifier(String cACertificateIdentifier)
Returns a reference to this object so that method calls can be chained together.
cACertificateIdentifier
- The identifier of the CA certificate for this DB instance.public Boolean isCopyTagsToSnapshot()
public void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
copyTagsToSnapshot
- Specifies whether tags are copied from the DB instance to snapshots of
the DB instance.public DBInstance withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Returns a reference to this object so that method calls can be chained together.
copyTagsToSnapshot
- Specifies whether tags are copied from the DB instance to snapshots of
the DB instance.public Boolean getCopyTagsToSnapshot()
public String toString()
toString
in class Object
Object.toString()
public DBInstance clone()
Copyright © 2015. All rights reserved.