Class DBInstance
- All Implemented Interfaces:
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:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
Specifies the allocated storage size specified in gigabytes.Indicates that minor version patches are applied automatically.Specifies the name of the Availability Zone the DB instance is located in.Specifies the number of days for which automatic DB snapshots are retained.The identifier of the CA certificate for this DB instance.If present, specifies the name of the character set that this instance is associated with.Specifies whether tags are copied from the DB instance to snapshots of the DB instance.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.Contains the name of the compute and memory capacity class of the DB instance.Contains a user-supplied database identifier.Specifies the port that the DB instance listens on.Specifies the current state of this database.The region-unique, immutable identifier for the DB instance.The meaning of this parameter differs according to the database engine you use.Provides the list of DB parameter groups applied to this DB instance.Provides List of DB security group elements containing onlyDBSecurityGroup.Name
andDBSecurityGroup.Status
subelements.Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.The Active Directory Domain membership records associated with the DB instance.Specifies the connection endpoint.Provides the name of the database engine to be used for this DB instance.Indicates the database engine version.The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.Provides the date and time the DB instance was created.getIops()
Specifies the Provisioned IOPS (I/O operations per second) value.IfStorageEncrypted
is true, the KMS key identifier for the encrypted DB instance.Specifies the latest time to which a database can be restored with point-in-time restore.License model information for this DB instance.Contains the master username for the DB instance.The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to CloudWatch Logs.Specifies if the DB instance is a Multi-AZ deployment.Provides the list of option group memberships for this DB instance.Specifies that changes to the DB instance are pending.Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by theBackupRetentionPeriod
.Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).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.Specifies the accessibility options for the DB instance.Contains one or more identifiers of the Read Replicas associated with this DB instance.Contains the identifier of the source DB instance if this DB instance is a Read Replica.If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.The status of a Read Replica.Specifies whether the DB instance is encrypted.Specifies the storage type associated with DB instance.The ARN from the Key Store with which the instance is associated for TDE encryption.Provides List of VPC security group elements that the DB instance belongs to.int
hashCode()
Indicates that minor version patches are applied automatically.Specifies whether tags are copied from the DB instance to snapshots of the DB instance.Specifies if the DB instance is a Multi-AZ deployment.Specifies the accessibility options for the DB instance.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
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
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
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.toString()
Returns a string representation of this object; useful for testing and debugging.withAllocatedStorage
(Integer allocatedStorage) Specifies the allocated storage size specified in gigabytes.withAutoMinorVersionUpgrade
(Boolean autoMinorVersionUpgrade) Indicates that minor version patches are applied automatically.withAvailabilityZone
(String availabilityZone) Specifies the name of the Availability Zone the DB instance is located in.withBackupRetentionPeriod
(Integer backupRetentionPeriod) Specifies the number of days for which automatic DB snapshots are retained.withCACertificateIdentifier
(String cACertificateIdentifier) The identifier of the CA certificate for this DB instance.withCharacterSetName
(String characterSetName) If present, specifies the name of the character set that this instance is associated with.withCopyTagsToSnapshot
(Boolean copyTagsToSnapshot) Specifies whether tags are copied from the DB instance to snapshots of the DB instance.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.withDBInstanceClass
(String dBInstanceClass) Contains the name of the compute and memory capacity class of the DB instance.withDBInstanceIdentifier
(String dBInstanceIdentifier) Contains a user-supplied database identifier.withDbInstancePort
(Integer dbInstancePort) Specifies the port that the DB instance listens on.withDBInstanceStatus
(String dBInstanceStatus) Specifies the current state of this database.withDbiResourceId
(String dbiResourceId) The region-unique, immutable identifier for the DB instance.withDBName
(String dBName) The meaning of this parameter differs according to the database engine you use.withDBParameterGroups
(DBParameterGroupStatus... dBParameterGroups) Provides the list of DB parameter groups applied to this DB instance.withDBParameterGroups
(Collection<DBParameterGroupStatus> dBParameterGroups) Provides the list of DB parameter groups applied to this DB instance.withDBSecurityGroups
(DBSecurityGroupMembership... dBSecurityGroups) Provides List of DB security group elements containing onlyDBSecurityGroup.Name
andDBSecurityGroup.Status
subelements.withDBSecurityGroups
(Collection<DBSecurityGroupMembership> dBSecurityGroups) Provides List of DB security group elements containing onlyDBSecurityGroup.Name
andDBSecurityGroup.Status
subelements.withDBSubnetGroup
(DBSubnetGroup dBSubnetGroup) Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.withDomainMemberships
(DomainMembership... domainMemberships) The Active Directory Domain membership records associated with the DB instance.withDomainMemberships
(Collection<DomainMembership> domainMemberships) The Active Directory Domain membership records associated with the DB instance.withEndpoint
(Endpoint endpoint) Specifies the connection endpoint.withEngine
(String engine) Provides the name of the database engine to be used for this DB instance.withEngineVersion
(String engineVersion) Indicates the database engine version.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.withInstanceCreateTime
(Date instanceCreateTime) Provides the date and time the DB instance was created.Specifies the Provisioned IOPS (I/O operations per second) value.withKmsKeyId
(String kmsKeyId) IfStorageEncrypted
is true, the KMS key identifier for the encrypted DB instance.withLatestRestorableTime
(Date latestRestorableTime) Specifies the latest time to which a database can be restored with point-in-time restore.withLicenseModel
(String licenseModel) License model information for this DB instance.withMasterUsername
(String masterUsername) Contains the master username for the DB instance.withMonitoringInterval
(Integer monitoringInterval) The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.withMonitoringRoleArn
(String monitoringRoleArn) The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to CloudWatch Logs.withMultiAZ
(Boolean multiAZ) Specifies if the DB instance is a Multi-AZ deployment.withOptionGroupMemberships
(OptionGroupMembership... optionGroupMemberships) Provides the list of option group memberships for this DB instance.withOptionGroupMemberships
(Collection<OptionGroupMembership> optionGroupMemberships) Provides the list of option group memberships for this DB instance.withPendingModifiedValues
(PendingModifiedValues pendingModifiedValues) Specifies that changes to the DB instance are pending.withPreferredBackupWindow
(String preferredBackupWindow) Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by theBackupRetentionPeriod
.withPreferredMaintenanceWindow
(String preferredMaintenanceWindow) Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).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.withPubliclyAccessible
(Boolean publiclyAccessible) Specifies the accessibility options for the DB instance.withReadReplicaDBInstanceIdentifiers
(String... readReplicaDBInstanceIdentifiers) Contains one or more identifiers of the Read Replicas associated with this DB instance.withReadReplicaDBInstanceIdentifiers
(Collection<String> readReplicaDBInstanceIdentifiers) Contains one or more identifiers of the Read Replicas associated with this DB instance.withReadReplicaSourceDBInstanceIdentifier
(String readReplicaSourceDBInstanceIdentifier) Contains the identifier of the source DB instance if this DB instance is a Read Replica.withSecondaryAvailabilityZone
(String secondaryAvailabilityZone) If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.withStatusInfos
(DBInstanceStatusInfo... statusInfos) The status of a Read Replica.withStatusInfos
(Collection<DBInstanceStatusInfo> statusInfos) The status of a Read Replica.withStorageEncrypted
(Boolean storageEncrypted) Specifies whether the DB instance is encrypted.withStorageType
(String storageType) Specifies the storage type associated with DB instance.withTdeCredentialArn
(String tdeCredentialArn) The ARN from the Key Store with which the instance is associated for TDE encryption.withVpcSecurityGroups
(VpcSecurityGroupMembership... vpcSecurityGroups) Provides List of VPC security group elements that the DB instance belongs to.withVpcSecurityGroups
(Collection<VpcSecurityGroupMembership> vpcSecurityGroups) Provides List of VPC security group elements that the DB instance belongs to.
-
Constructor Details
-
DBInstance
public DBInstance()
-
-
Method Details
-
setDBInstanceIdentifier
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
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
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
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
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
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
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
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
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
Specifies the current state of this database.
- Parameters:
dBInstanceStatus
- Specifies the current state of this database.
-
getDBInstanceStatus
Specifies the current state of this database.
- Returns:
- Specifies the current state of this database.
-
withDBInstanceStatus
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
Contains the master username for the DB instance.
- Parameters:
masterUsername
- Contains the master username for the DB instance.
-
getMasterUsername
Contains the master username for the DB instance.
- Returns:
- Contains the master username for the DB instance.
-
withMasterUsername
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
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
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
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
Specifies the connection endpoint.
- Parameters:
endpoint
- Specifies the connection endpoint.
-
getEndpoint
Specifies the connection endpoint.
- Returns:
- Specifies the connection endpoint.
-
withEndpoint
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
Specifies the allocated storage size specified in gigabytes.
- Parameters:
allocatedStorage
- Specifies the allocated storage size specified in gigabytes.
-
getAllocatedStorage
Specifies the allocated storage size specified in gigabytes.
- Returns:
- Specifies the allocated storage size specified in gigabytes.
-
withAllocatedStorage
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
Provides the date and time the DB instance was created.
- Parameters:
instanceCreateTime
- Provides the date and time the DB instance was created.
-
getInstanceCreateTime
Provides the date and time the DB instance was created.
- Returns:
- Provides the date and time the DB instance was created.
-
withInstanceCreateTime
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Specifies if the DB instance is a Multi-AZ deployment.
- Parameters:
multiAZ
- Specifies if the DB instance is a Multi-AZ deployment.
-
getMultiAZ
Specifies if the DB instance is a Multi-AZ deployment.
- Returns:
- Specifies if the DB instance is a Multi-AZ deployment.
-
withMultiAZ
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
Specifies if the DB instance is a Multi-AZ deployment.
- Returns:
- Specifies if the DB instance is a Multi-AZ deployment.
-
setEngineVersion
Indicates the database engine version.
- Parameters:
engineVersion
- Indicates the database engine version.
-
getEngineVersion
Indicates the database engine version.
- Returns:
- Indicates the database engine version.
-
withEngineVersion
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
Indicates that minor version patches are applied automatically.
- Parameters:
autoMinorVersionUpgrade
- Indicates that minor version patches are applied automatically.
-
getAutoMinorVersionUpgrade
Indicates that minor version patches are applied automatically.
- Returns:
- Indicates that minor version patches are applied automatically.
-
withAutoMinorVersionUpgrade
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
Indicates that minor version patches are applied automatically.
- Returns:
- Indicates that minor version patches are applied automatically.
-
setReadReplicaSourceDBInstanceIdentifier
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
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
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
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
License model information for this DB instance.
- Parameters:
licenseModel
- License model information for this DB instance.
-
getLicenseModel
License model information for this DB instance.
- Returns:
- License model information for this DB instance.
-
withLicenseModel
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
Specifies the Provisioned IOPS (I/O operations per second) value.
- Parameters:
iops
- Specifies the Provisioned IOPS (I/O operations per second) value.
-
getIops
Specifies the Provisioned IOPS (I/O operations per second) value.
- Returns:
- Specifies the Provisioned IOPS (I/O operations per second) value.
-
withIops
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
Provides the list of option group memberships for this DB instance.
- Returns:
- Provides the list of option group memberships for this DB instance.
-
setOptionGroupMemberships
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Specifies the storage type associated with DB instance.
- Parameters:
storageType
- Specifies the storage type associated with DB instance.
-
getStorageType
Specifies the storage type associated with DB instance.
- Returns:
- Specifies the storage type associated with DB instance.
-
withStorageType
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
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
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
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
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
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
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
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
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
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
Specifies whether the DB instance is encrypted.
- Parameters:
storageEncrypted
- Specifies whether the DB instance is encrypted.
-
getStorageEncrypted
Specifies whether the DB instance is encrypted.
- Returns:
- Specifies whether the DB instance is encrypted.
-
withStorageEncrypted
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
Specifies whether the DB instance is encrypted.
- Returns:
- Specifies whether the DB instance is encrypted.
-
setKmsKeyId
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
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
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
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
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
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
The identifier of the CA certificate for this DB instance.
- Parameters:
cACertificateIdentifier
- The identifier of the CA certificate for this DB instance.
-
getCACertificateIdentifier
The identifier of the CA certificate for this DB instance.
- Returns:
- The identifier of the CA certificate for this DB instance.
-
withCACertificateIdentifier
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
The Active Directory Domain membership records associated with the DB instance.
- Returns:
- The Active Directory Domain membership records associated with the DB instance.
-
setDomainMemberships
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-