@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DBInstance extends Object implements Serializable, Cloneable
Contains the details of an Amazon RDS DB instance.
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) |
Boolean |
getActivityStreamEngineNativeAuditFieldsIncluded()
Indicates whether engine-native audit fields are included in the database activity stream.
|
String |
getActivityStreamKinesisStreamName()
The name of the Amazon Kinesis data stream used for the database activity stream.
|
String |
getActivityStreamKmsKeyId()
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
|
String |
getActivityStreamMode()
The mode of the database activity stream.
|
String |
getActivityStreamStatus()
The status of the database activity stream.
|
Integer |
getAllocatedStorage()
Specifies the allocated storage size specified in gibibytes.
|
List<DBInstanceRole> |
getAssociatedRoles()
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
|
Boolean |
getAutoMinorVersionUpgrade()
A value that indicates that minor version patches are applied automatically.
|
String |
getAvailabilityZone()
Specifies the name of the Availability Zone the DB instance is located in.
|
String |
getAwsBackupRecoveryPointArn()
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
|
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.
|
Boolean |
getCustomerOwnedIpEnabled()
Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
|
String |
getDBClusterIdentifier()
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a
member of.
|
String |
getDBInstanceArn()
The Amazon Resource Name (ARN) for the DB instance.
|
List<DBInstanceAutomatedBackupsReplication> |
getDBInstanceAutomatedBackupsReplications()
The list of replicated automated backups associated with the DB instance.
|
String |
getDBInstanceClass()
Contains the name of the compute and memory capacity class of the DB instance.
|
String |
getDBInstanceIdentifier()
Contains a user-supplied database identifier.
|
Integer |
getDbInstancePort()
Specifies the port that the DB instance listens on.
|
String |
getDBInstanceStatus()
Specifies the current state of this database.
|
String |
getDbiResourceId()
The Amazon Web Services Region-unique, immutable identifier for the DB instance.
|
String |
getDBName()
The meaning of this parameter differs according to the database engine you use.
|
List<DBParameterGroupStatus> |
getDBParameterGroups()
Provides the list of DB parameter groups applied to this DB instance.
|
List<DBSecurityGroupMembership> |
getDBSecurityGroups()
A list of DB security group elements containing
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.
|
Boolean |
getDeletionProtection()
Indicates if the DB instance has deletion protection enabled.
|
List<DomainMembership> |
getDomainMemberships()
The Active Directory Domain membership records associated with the DB instance.
|
List<String> |
getEnabledCloudwatchLogsExports()
A list of log types that this DB instance is configured to export to CloudWatch Logs.
|
Endpoint |
getEndpoint()
Specifies the connection endpoint.
|
String |
getEngine()
The name of the database engine to be used for this DB instance.
|
String |
getEngineVersion()
Indicates the database engine version.
|
String |
getEnhancedMonitoringResourceArn()
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring
metrics data for the DB instance.
|
Boolean |
getIAMDatabaseAuthenticationEnabled()
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is
enabled, and otherwise false.
|
Date |
getInstanceCreateTime()
Provides the date and time the DB instance was created.
|
Integer |
getIops()
Specifies the Provisioned IOPS (I/O operations per second) value.
|
String |
getKmsKeyId()
If
StorageEncrypted is true, the Amazon Web Services 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.
|
Endpoint |
getListenerEndpoint()
Specifies the listener connection endpoint for SQL Server Always On.
|
String |
getMasterUsername()
Contains the master username for the DB instance.
|
Integer |
getMaxAllocatedStorage()
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
|
Integer |
getMonitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
|
String |
getMonitoringRoleArn()
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
|
Boolean |
getMultiAZ()
Specifies if the DB instance is a Multi-AZ deployment.
|
String |
getNcharCharacterSetName()
The name of the NCHAR character set for the Oracle DB instance.
|
List<OptionGroupMembership> |
getOptionGroupMemberships()
Provides the list of option group memberships for this DB instance.
|
PendingModifiedValues |
getPendingModifiedValues()
A value that specifies that changes to the DB instance are pending.
|
Boolean |
getPerformanceInsightsEnabled()
True if Performance Insights is enabled for the DB instance, and otherwise false.
|
String |
getPerformanceInsightsKMSKeyId()
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
|
Integer |
getPerformanceInsightsRetentionPeriod()
The amount of time, in days, to retain Performance Insights data.
|
String |
getPreferredBackupWindow()
Specifies the daily time range during which automated backups are created if automated backups are enabled, as
determined by the
BackupRetentionPeriod . |
String |
getPreferredMaintenanceWindow()
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
List<ProcessorFeature> |
getProcessorFeatures()
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
Integer |
getPromotionTier()
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure
of the existing primary instance.
|
Boolean |
getPubliclyAccessible()
Specifies the accessibility options for the DB instance.
|
List<String> |
getReadReplicaDBClusterIdentifiers()
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read
replica.
|
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 |
getReplicaMode()
The open mode of an Oracle 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.
|
List<Tag> |
getTagList() |
String |
getTdeCredentialArn()
The ARN from the key store with which the instance is associated for TDE encryption.
|
String |
getTimezone()
The time zone of the DB instance.
|
List<VpcSecurityGroupMembership> |
getVpcSecurityGroups()
Provides a list of VPC security group elements that the DB instance belongs to.
|
int |
hashCode() |
Boolean |
isActivityStreamEngineNativeAuditFieldsIncluded()
Indicates whether engine-native audit fields are included in the database activity stream.
|
Boolean |
isAutoMinorVersionUpgrade()
A value that 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 |
isCustomerOwnedIpEnabled()
Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
|
Boolean |
isDeletionProtection()
Indicates if the DB instance has deletion protection enabled.
|
Boolean |
isIAMDatabaseAuthenticationEnabled()
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is
enabled, and otherwise false.
|
Boolean |
isMultiAZ()
Specifies if the DB instance is a Multi-AZ deployment.
|
Boolean |
isPerformanceInsightsEnabled()
True if Performance Insights is enabled for the DB instance, and otherwise false.
|
Boolean |
isPubliclyAccessible()
Specifies the accessibility options for the DB instance.
|
Boolean |
isStorageEncrypted()
Specifies whether the DB instance is encrypted.
|
void |
setActivityStreamEngineNativeAuditFieldsIncluded(Boolean activityStreamEngineNativeAuditFieldsIncluded)
Indicates whether engine-native audit fields are included in the database activity stream.
|
void |
setActivityStreamKinesisStreamName(String activityStreamKinesisStreamName)
The name of the Amazon Kinesis data stream used for the database activity stream.
|
void |
setActivityStreamKmsKeyId(String activityStreamKmsKeyId)
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
|
void |
setActivityStreamMode(String activityStreamMode)
The mode of the database activity stream.
|
void |
setActivityStreamStatus(String activityStreamStatus)
The status of the database activity stream.
|
void |
setAllocatedStorage(Integer allocatedStorage)
Specifies the allocated storage size specified in gibibytes.
|
void |
setAssociatedRoles(Collection<DBInstanceRole> associatedRoles)
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
|
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
A value that 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 |
setAwsBackupRecoveryPointArn(String awsBackupRecoveryPointArn)
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
|
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 |
setCustomerOwnedIpEnabled(Boolean customerOwnedIpEnabled)
Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
|
void |
setDBClusterIdentifier(String dBClusterIdentifier)
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a
member of.
|
void |
setDBInstanceArn(String dBInstanceArn)
The Amazon Resource Name (ARN) for the DB instance.
|
void |
setDBInstanceAutomatedBackupsReplications(Collection<DBInstanceAutomatedBackupsReplication> dBInstanceAutomatedBackupsReplications)
The list of replicated automated backups associated with the DB instance.
|
void |
setDBInstanceClass(String dBInstanceClass)
Contains the name of the compute and memory capacity class of the DB instance.
|
void |
setDBInstanceIdentifier(String dBInstanceIdentifier)
Contains a user-supplied database identifier.
|
void |
setDbInstancePort(Integer dbInstancePort)
Specifies the port that the DB instance listens on.
|
void |
setDBInstanceStatus(String dBInstanceStatus)
Specifies the current state of this database.
|
void |
setDbiResourceId(String dbiResourceId)
The Amazon Web Services Region-unique, immutable identifier for the DB instance.
|
void |
setDBName(String dBName)
The meaning of this parameter differs according to the database engine you use.
|
void |
setDBParameterGroups(Collection<DBParameterGroupStatus> dBParameterGroups)
Provides the list of DB parameter groups applied to this DB instance.
|
void |
setDBSecurityGroups(Collection<DBSecurityGroupMembership> dBSecurityGroups)
A list of DB security group elements containing
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 |
setDeletionProtection(Boolean deletionProtection)
Indicates if the DB instance has deletion protection enabled.
|
void |
setDomainMemberships(Collection<DomainMembership> domainMemberships)
The Active Directory Domain membership records associated with the DB instance.
|
void |
setEnabledCloudwatchLogsExports(Collection<String> enabledCloudwatchLogsExports)
A list of log types that this DB instance is configured to export to CloudWatch Logs.
|
void |
setEndpoint(Endpoint endpoint)
Specifies the connection endpoint.
|
void |
setEngine(String engine)
The name of the database engine to be used for this DB instance.
|
void |
setEngineVersion(String engineVersion)
Indicates the database engine version.
|
void |
setEnhancedMonitoringResourceArn(String enhancedMonitoringResourceArn)
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring
metrics data for the DB instance.
|
void |
setIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is
enabled, and otherwise false.
|
void |
setInstanceCreateTime(Date instanceCreateTime)
Provides the date and time the DB instance was created.
|
void |
setIops(Integer iops)
Specifies the Provisioned IOPS (I/O operations per second) value.
|
void |
setKmsKeyId(String kmsKeyId)
If
StorageEncrypted is true, the Amazon Web Services 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 |
setListenerEndpoint(Endpoint listenerEndpoint)
Specifies the listener connection endpoint for SQL Server Always On.
|
void |
setMasterUsername(String masterUsername)
Contains the master username for the DB instance.
|
void |
setMaxAllocatedStorage(Integer maxAllocatedStorage)
The upper limit to which Amazon RDS can automatically scale the storage of 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 Amazon CloudWatch Logs.
|
void |
setMultiAZ(Boolean multiAZ)
Specifies if the DB instance is a Multi-AZ deployment.
|
void |
setNcharCharacterSetName(String ncharCharacterSetName)
The name of the NCHAR character set for the Oracle DB instance.
|
void |
setOptionGroupMemberships(Collection<OptionGroupMembership> optionGroupMemberships)
Provides the list of option group memberships for this DB instance.
|
void |
setPendingModifiedValues(PendingModifiedValues pendingModifiedValues)
A value that specifies that changes to the DB instance are pending.
|
void |
setPerformanceInsightsEnabled(Boolean performanceInsightsEnabled)
True if Performance Insights is enabled for the DB instance, and otherwise false.
|
void |
setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
|
void |
setPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The amount of time, in days, to retain Performance Insights data.
|
void |
setPreferredBackupWindow(String preferredBackupWindow)
Specifies the daily time range during which automated backups are created if automated backups are enabled, as
determined by the
BackupRetentionPeriod . |
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
void |
setProcessorFeatures(Collection<ProcessorFeature> processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
void |
setPromotionTier(Integer promotionTier)
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure
of the existing primary instance.
|
void |
setPubliclyAccessible(Boolean publiclyAccessible)
Specifies the accessibility options for the DB instance.
|
void |
setReadReplicaDBClusterIdentifiers(Collection<String> readReplicaDBClusterIdentifiers)
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read
replica.
|
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 |
setReplicaMode(String replicaMode)
The open mode of an Oracle 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 |
setTagList(Collection<Tag> tagList) |
void |
setTdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which the instance is associated for TDE encryption.
|
void |
setTimezone(String timezone)
The time zone of the DB instance.
|
void |
setVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
Provides a list of VPC security group elements that the DB instance belongs to.
|
String |
toString()
Returns a string representation of this object.
|
DBInstance |
withActivityStreamEngineNativeAuditFieldsIncluded(Boolean activityStreamEngineNativeAuditFieldsIncluded)
Indicates whether engine-native audit fields are included in the database activity stream.
|
DBInstance |
withActivityStreamKinesisStreamName(String activityStreamKinesisStreamName)
The name of the Amazon Kinesis data stream used for the database activity stream.
|
DBInstance |
withActivityStreamKmsKeyId(String activityStreamKmsKeyId)
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
|
DBInstance |
withActivityStreamMode(ActivityStreamMode activityStreamMode)
The mode of the database activity stream.
|
DBInstance |
withActivityStreamMode(String activityStreamMode)
The mode of the database activity stream.
|
DBInstance |
withActivityStreamStatus(ActivityStreamStatus activityStreamStatus)
The status of the database activity stream.
|
DBInstance |
withActivityStreamStatus(String activityStreamStatus)
The status of the database activity stream.
|
DBInstance |
withAllocatedStorage(Integer allocatedStorage)
Specifies the allocated storage size specified in gibibytes.
|
DBInstance |
withAssociatedRoles(Collection<DBInstanceRole> associatedRoles)
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
|
DBInstance |
withAssociatedRoles(DBInstanceRole... associatedRoles)
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
|
DBInstance |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
A value that 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 |
withAwsBackupRecoveryPointArn(String awsBackupRecoveryPointArn)
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
|
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 |
withCustomerOwnedIpEnabled(Boolean customerOwnedIpEnabled)
Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
|
DBInstance |
withDBClusterIdentifier(String dBClusterIdentifier)
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a
member of.
|
DBInstance |
withDBInstanceArn(String dBInstanceArn)
The Amazon Resource Name (ARN) for the DB instance.
|
DBInstance |
withDBInstanceAutomatedBackupsReplications(Collection<DBInstanceAutomatedBackupsReplication> dBInstanceAutomatedBackupsReplications)
The list of replicated automated backups associated with the DB instance.
|
DBInstance |
withDBInstanceAutomatedBackupsReplications(DBInstanceAutomatedBackupsReplication... dBInstanceAutomatedBackupsReplications)
The list of replicated automated backups associated with the DB instance.
|
DBInstance |
withDBInstanceClass(String dBInstanceClass)
Contains the name of the compute and memory capacity class of the DB instance.
|
DBInstance |
withDBInstanceIdentifier(String dBInstanceIdentifier)
Contains a user-supplied database identifier.
|
DBInstance |
withDbInstancePort(Integer dbInstancePort)
Specifies the port that the DB instance listens on.
|
DBInstance |
withDBInstanceStatus(String dBInstanceStatus)
Specifies the current state of this database.
|
DBInstance |
withDbiResourceId(String dbiResourceId)
The Amazon Web Services Region-unique, immutable identifier for the DB instance.
|
DBInstance |
withDBName(String dBName)
The meaning of this parameter differs according to the database engine you use.
|
DBInstance |
withDBParameterGroups(Collection<DBParameterGroupStatus> dBParameterGroups)
Provides the list of DB parameter groups applied to this DB instance.
|
DBInstance |
withDBParameterGroups(DBParameterGroupStatus... dBParameterGroups)
Provides the list of DB parameter groups applied to this DB instance.
|
DBInstance |
withDBSecurityGroups(Collection<DBSecurityGroupMembership> dBSecurityGroups)
A list of DB security group elements containing
DBSecurityGroup.Name and
DBSecurityGroup.Status subelements. |
DBInstance |
withDBSecurityGroups(DBSecurityGroupMembership... dBSecurityGroups)
A list of DB security group elements containing
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 |
withDeletionProtection(Boolean deletionProtection)
Indicates if the DB instance has deletion protection enabled.
|
DBInstance |
withDomainMemberships(Collection<DomainMembership> domainMemberships)
The Active Directory Domain membership records associated with the DB instance.
|
DBInstance |
withDomainMemberships(DomainMembership... domainMemberships)
The Active Directory Domain membership records associated with the DB instance.
|
DBInstance |
withEnabledCloudwatchLogsExports(Collection<String> enabledCloudwatchLogsExports)
A list of log types that this DB instance is configured to export to CloudWatch Logs.
|
DBInstance |
withEnabledCloudwatchLogsExports(String... enabledCloudwatchLogsExports)
A list of log types that this DB instance is configured to export to CloudWatch Logs.
|
DBInstance |
withEndpoint(Endpoint endpoint)
Specifies the connection endpoint.
|
DBInstance |
withEngine(String engine)
The name of the database engine to be used for this DB instance.
|
DBInstance |
withEngineVersion(String engineVersion)
Indicates the database engine version.
|
DBInstance |
withEnhancedMonitoringResourceArn(String enhancedMonitoringResourceArn)
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring
metrics data for the DB instance.
|
DBInstance |
withIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is
enabled, and otherwise false.
|
DBInstance |
withInstanceCreateTime(Date instanceCreateTime)
Provides the date and time the DB instance was created.
|
DBInstance |
withIops(Integer iops)
Specifies the Provisioned IOPS (I/O operations per second) value.
|
DBInstance |
withKmsKeyId(String kmsKeyId)
If
StorageEncrypted is true, the Amazon Web Services 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 |
withListenerEndpoint(Endpoint listenerEndpoint)
Specifies the listener connection endpoint for SQL Server Always On.
|
DBInstance |
withMasterUsername(String masterUsername)
Contains the master username for the DB instance.
|
DBInstance |
withMaxAllocatedStorage(Integer maxAllocatedStorage)
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
|
DBInstance |
withMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
|
DBInstance |
withMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
|
DBInstance |
withMultiAZ(Boolean multiAZ)
Specifies if the DB instance is a Multi-AZ deployment.
|
DBInstance |
withNcharCharacterSetName(String ncharCharacterSetName)
The name of the NCHAR character set for the Oracle DB instance.
|
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)
A value that specifies that changes to the DB instance are pending.
|
DBInstance |
withPerformanceInsightsEnabled(Boolean performanceInsightsEnabled)
True if Performance Insights is enabled for the DB instance, and otherwise false.
|
DBInstance |
withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
|
DBInstance |
withPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The amount of time, in days, to retain Performance Insights data.
|
DBInstance |
withPreferredBackupWindow(String preferredBackupWindow)
Specifies the daily time range during which automated backups are created if automated backups are enabled, as
determined by the
BackupRetentionPeriod . |
DBInstance |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
DBInstance |
withProcessorFeatures(Collection<ProcessorFeature> processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
DBInstance |
withProcessorFeatures(ProcessorFeature... processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
DBInstance |
withPromotionTier(Integer promotionTier)
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure
of the existing primary instance.
|
DBInstance |
withPubliclyAccessible(Boolean publiclyAccessible)
Specifies the accessibility options for the DB instance.
|
DBInstance |
withReadReplicaDBClusterIdentifiers(Collection<String> readReplicaDBClusterIdentifiers)
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read
replica.
|
DBInstance |
withReadReplicaDBClusterIdentifiers(String... readReplicaDBClusterIdentifiers)
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read
replica.
|
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 |
withReplicaMode(ReplicaMode replicaMode)
The open mode of an Oracle read replica.
|
DBInstance |
withReplicaMode(String replicaMode)
The open mode of an Oracle 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 |
withTagList(Collection<Tag> tagList) |
DBInstance |
withTagList(Tag... tagList)
NOTE: This method appends the values to the existing list (if any).
|
DBInstance |
withTdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which the instance is associated for TDE encryption.
|
DBInstance |
withTimezone(String timezone)
The time zone of the DB instance.
|
DBInstance |
withVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
Provides a list of VPC security group elements that the DB instance belongs to.
|
DBInstance |
withVpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
Provides a list of VPC security group elements that the DB instance belongs to.
|
public void setDBInstanceIdentifier(String dBInstanceIdentifier)
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
dBInstanceIdentifier
- Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB
instance.public String getDBInstanceIdentifier()
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
public DBInstance withDBInstanceIdentifier(String dBInstanceIdentifier)
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
dBInstanceIdentifier
- Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB
instance.public void setDBInstanceClass(String dBInstanceClass)
Contains the name of the compute and memory capacity class of the DB instance.
dBInstanceClass
- Contains the name of the compute and memory capacity class of the DB instance.public String getDBInstanceClass()
Contains the name of the compute and memory capacity class of the DB instance.
public DBInstance withDBInstanceClass(String dBInstanceClass)
Contains the name of the compute and memory capacity class of the DB instance.
dBInstanceClass
- Contains the name of the compute and memory capacity class of the DB instance.public void setEngine(String engine)
The name of the database engine to be used for this DB instance.
engine
- The name of the database engine to be used for this DB instance.public String getEngine()
The name of the database engine to be used for this DB instance.
public DBInstance withEngine(String engine)
The name of the database engine to be used for this DB instance.
engine
- The name of the database engine to be used for this DB instance.public void setDBInstanceStatus(String dBInstanceStatus)
Specifies the current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
dBInstanceStatus
- Specifies the current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
public String getDBInstanceStatus()
Specifies the current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
public DBInstance withDBInstanceStatus(String dBInstanceStatus)
Specifies the current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
dBInstanceStatus
- Specifies the current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
public void setMasterUsername(String masterUsername)
Contains the master username for the DB instance.
masterUsername
- Contains the master username for the DB instance.public String getMasterUsername()
Contains the master username for the DB instance.
public DBInstance withMasterUsername(String masterUsername)
Contains the master username for the DB instance.
masterUsername
- Contains the master username for the DB instance.public void setDBName(String dBName)
The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
dBName
- The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
public String getDBName()
The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
public DBInstance withDBName(String dBName)
The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
dBName
- The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
public void setEndpoint(Endpoint endpoint)
Specifies the connection endpoint.
endpoint
- Specifies the connection endpoint.public Endpoint getEndpoint()
Specifies the connection endpoint.
public DBInstance withEndpoint(Endpoint endpoint)
Specifies the connection endpoint.
endpoint
- Specifies the connection endpoint.public void setAllocatedStorage(Integer allocatedStorage)
Specifies the allocated storage size specified in gibibytes.
allocatedStorage
- Specifies the allocated storage size specified in gibibytes.public Integer getAllocatedStorage()
Specifies the allocated storage size specified in gibibytes.
public DBInstance withAllocatedStorage(Integer allocatedStorage)
Specifies the allocated storage size specified in gibibytes.
allocatedStorage
- Specifies the allocated storage size specified in gibibytes.public void setInstanceCreateTime(Date instanceCreateTime)
Provides the date and time the DB instance was created.
instanceCreateTime
- Provides the date and time the DB instance was created.public Date getInstanceCreateTime()
Provides the date and time the DB instance was created.
public DBInstance withInstanceCreateTime(Date instanceCreateTime)
Provides the date and time the DB instance was created.
instanceCreateTime
- Provides the date and time the DB instance was created.public void setPreferredBackupWindow(String preferredBackupWindow)
Specifies the daily time range during which automated backups are created if automated backups are enabled, as
determined by the BackupRetentionPeriod
.
preferredBackupWindow
- Specifies the daily time range during which automated backups are created if automated backups are
enabled, as determined by the BackupRetentionPeriod
.public String getPreferredBackupWindow()
Specifies the daily time range during which automated backups are created if automated backups are enabled, as
determined by the BackupRetentionPeriod
.
BackupRetentionPeriod
.public DBInstance withPreferredBackupWindow(String preferredBackupWindow)
Specifies the daily time range during which automated backups are created if automated backups are enabled, as
determined by the BackupRetentionPeriod
.
preferredBackupWindow
- Specifies the daily time range during which automated backups are created if automated backups are
enabled, as determined by the BackupRetentionPeriod
.public void setBackupRetentionPeriod(Integer backupRetentionPeriod)
Specifies the number of days for which automatic DB snapshots are retained.
backupRetentionPeriod
- Specifies the number of days for which automatic DB snapshots are retained.public Integer getBackupRetentionPeriod()
Specifies the number of days for which automatic DB snapshots are retained.
public DBInstance withBackupRetentionPeriod(Integer backupRetentionPeriod)
Specifies the number of days for which automatic DB snapshots are retained.
backupRetentionPeriod
- Specifies the number of days for which automatic DB snapshots are retained.public List<DBSecurityGroupMembership> getDBSecurityGroups()
A list of DB security group elements containing DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.
DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.public void setDBSecurityGroups(Collection<DBSecurityGroupMembership> dBSecurityGroups)
A list of DB security group elements containing DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.
dBSecurityGroups
- A list of DB security group elements containing DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.public DBInstance withDBSecurityGroups(DBSecurityGroupMembership... dBSecurityGroups)
A list of DB security group elements containing DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.
NOTE: This method appends the values to the existing list (if any). Use
setDBSecurityGroups(java.util.Collection)
or withDBSecurityGroups(java.util.Collection)
if you
want to override the existing values.
dBSecurityGroups
- A list of DB security group elements containing DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.public DBInstance withDBSecurityGroups(Collection<DBSecurityGroupMembership> dBSecurityGroups)
A list of DB security group elements containing DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.
dBSecurityGroups
- A list of DB security group elements containing DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.public List<VpcSecurityGroupMembership> getVpcSecurityGroups()
Provides a list of VPC security group elements that the DB instance belongs to.
public void setVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
Provides a list of VPC security group elements that the DB instance belongs to.
vpcSecurityGroups
- Provides a list of VPC security group elements that the DB instance belongs to.public DBInstance withVpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
Provides a list of VPC security group elements that the DB instance belongs to.
NOTE: This method appends the values to the existing list (if any). Use
setVpcSecurityGroups(java.util.Collection)
or withVpcSecurityGroups(java.util.Collection)
if
you want to override the existing values.
vpcSecurityGroups
- Provides a list of VPC security group elements that the DB instance belongs to.public DBInstance withVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
Provides a list of VPC security group elements that the DB instance belongs to.
vpcSecurityGroups
- Provides a list of VPC security group elements that the DB instance belongs to.public List<DBParameterGroupStatus> getDBParameterGroups()
Provides the list of DB parameter groups applied to this DB instance.
public void setDBParameterGroups(Collection<DBParameterGroupStatus> dBParameterGroups)
Provides the list of DB parameter groups applied to this DB instance.
dBParameterGroups
- Provides the list of DB parameter groups applied to this DB instance.public DBInstance withDBParameterGroups(DBParameterGroupStatus... dBParameterGroups)
Provides the list of DB parameter groups applied to this DB instance.
NOTE: This method appends the values to the existing list (if any). Use
setDBParameterGroups(java.util.Collection)
or withDBParameterGroups(java.util.Collection)
if
you want to override the existing values.
dBParameterGroups
- Provides the list of DB parameter groups applied to this DB instance.public DBInstance withDBParameterGroups(Collection<DBParameterGroupStatus> dBParameterGroups)
Provides the list of DB parameter groups applied to this DB instance.
dBParameterGroups
- Provides the list of DB parameter groups applied to this DB instance.public void setAvailabilityZone(String availabilityZone)
Specifies the name of the Availability Zone the DB instance is located in.
availabilityZone
- Specifies the name of the Availability Zone the DB instance is located in.public String getAvailabilityZone()
Specifies the name of the Availability Zone the DB instance is located in.
public DBInstance withAvailabilityZone(String availabilityZone)
Specifies the name of the Availability Zone the DB instance is located in.
availabilityZone
- Specifies the name of the Availability Zone the DB instance is located in.public void setDBSubnetGroup(DBSubnetGroup dBSubnetGroup)
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
dBSubnetGroup
- Specifies information on the subnet group associated with the DB instance, including the name,
description, and subnets in the subnet group.public DBSubnetGroup getDBSubnetGroup()
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
public DBInstance withDBSubnetGroup(DBSubnetGroup dBSubnetGroup)
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
dBSubnetGroup
- Specifies information on the subnet group associated with the DB instance, including the name,
description, and subnets in the subnet group.public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
preferredMaintenanceWindow
- Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time
(UTC).public String getPreferredMaintenanceWindow()
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
public DBInstance withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
preferredMaintenanceWindow
- Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time
(UTC).public void setPendingModifiedValues(PendingModifiedValues pendingModifiedValues)
A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
pendingModifiedValues
- A value that specifies that changes to the DB instance are pending. This element is only included when
changes are pending. Specific changes are identified by subelements.public PendingModifiedValues getPendingModifiedValues()
A value that 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)
A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
pendingModifiedValues
- A value that specifies that changes to the DB instance are pending. This element is only included when
changes are pending. Specific changes are identified by subelements.public void setLatestRestorableTime(Date latestRestorableTime)
Specifies the latest time to which a database can be restored with point-in-time restore.
latestRestorableTime
- Specifies the latest time to which a database can be restored with point-in-time restore.public Date getLatestRestorableTime()
Specifies the latest time to which a database can be restored with point-in-time restore.
public DBInstance withLatestRestorableTime(Date latestRestorableTime)
Specifies the latest time to which a database can be restored with point-in-time restore.
latestRestorableTime
- Specifies the latest time to which a database can be restored with point-in-time restore.public void setMultiAZ(Boolean multiAZ)
Specifies if the DB instance is a Multi-AZ deployment.
multiAZ
- Specifies if the DB instance is a Multi-AZ deployment.public Boolean getMultiAZ()
Specifies if the DB instance is a Multi-AZ deployment.
public DBInstance withMultiAZ(Boolean multiAZ)
Specifies if the DB instance is a Multi-AZ deployment.
multiAZ
- Specifies if the DB instance is a Multi-AZ deployment.public Boolean isMultiAZ()
Specifies if the DB instance is a Multi-AZ deployment.
public void setEngineVersion(String engineVersion)
Indicates the database engine version.
engineVersion
- Indicates the database engine version.public String getEngineVersion()
Indicates the database engine version.
public DBInstance withEngineVersion(String engineVersion)
Indicates the database engine version.
engineVersion
- Indicates the database engine version.public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
A value that indicates that minor version patches are applied automatically.
autoMinorVersionUpgrade
- A value that indicates that minor version patches are applied automatically.public Boolean getAutoMinorVersionUpgrade()
A value that indicates that minor version patches are applied automatically.
public DBInstance withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
A value that indicates that minor version patches are applied automatically.
autoMinorVersionUpgrade
- A value that indicates that minor version patches are applied automatically.public Boolean isAutoMinorVersionUpgrade()
A value that indicates that minor version patches are applied automatically.
public void setReadReplicaSourceDBInstanceIdentifier(String readReplicaSourceDBInstanceIdentifier)
Contains the identifier of the source DB instance if this DB instance is a read replica.
readReplicaSourceDBInstanceIdentifier
- Contains the identifier of the source DB instance if this DB instance is a read replica.public String getReadReplicaSourceDBInstanceIdentifier()
Contains the identifier of the source DB instance if this DB instance is a read replica.
public DBInstance withReadReplicaSourceDBInstanceIdentifier(String readReplicaSourceDBInstanceIdentifier)
Contains the identifier of the source DB instance if this DB instance is a read replica.
readReplicaSourceDBInstanceIdentifier
- Contains the identifier of the source DB instance if this DB instance is a read replica.public List<String> getReadReplicaDBInstanceIdentifiers()
Contains one or more identifiers of the read replicas associated with this DB instance.
public void setReadReplicaDBInstanceIdentifiers(Collection<String> readReplicaDBInstanceIdentifiers)
Contains one or more identifiers of the read replicas associated with this DB instance.
readReplicaDBInstanceIdentifiers
- Contains one or more identifiers of the read replicas associated with this DB instance.public DBInstance withReadReplicaDBInstanceIdentifiers(String... readReplicaDBInstanceIdentifiers)
Contains one or more identifiers of the read replicas associated with this DB instance.
NOTE: This method appends the values to the existing list (if any). Use
setReadReplicaDBInstanceIdentifiers(java.util.Collection)
or
withReadReplicaDBInstanceIdentifiers(java.util.Collection)
if you want to override the existing values.
readReplicaDBInstanceIdentifiers
- Contains one or more identifiers of the read replicas associated with this DB instance.public DBInstance withReadReplicaDBInstanceIdentifiers(Collection<String> readReplicaDBInstanceIdentifiers)
Contains one or more identifiers of the read replicas associated with this DB instance.
readReplicaDBInstanceIdentifiers
- Contains one or more identifiers of the read replicas associated with this DB instance.public List<String> getReadReplicaDBClusterIdentifiers()
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not contain information about cross region Aurora read replicas.
Currently, each RDS DB instance can have only one Aurora read replica.
Currently, each RDS DB instance can have only one Aurora read replica.
public void setReadReplicaDBClusterIdentifiers(Collection<String> readReplicaDBClusterIdentifiers)
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not contain information about cross region Aurora read replicas.
Currently, each RDS DB instance can have only one Aurora read replica.
readReplicaDBClusterIdentifiers
- Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a
read replica. For example, when you create an Aurora read replica of an RDS MySQL DB instance, the Aurora
MySQL DB cluster for the Aurora read replica is shown. This output does not contain information about
cross region Aurora read replicas. Currently, each RDS DB instance can have only one Aurora read replica.
public DBInstance withReadReplicaDBClusterIdentifiers(String... readReplicaDBClusterIdentifiers)
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not contain information about cross region Aurora read replicas.
Currently, each RDS DB instance can have only one Aurora read replica.
NOTE: This method appends the values to the existing list (if any). Use
setReadReplicaDBClusterIdentifiers(java.util.Collection)
or
withReadReplicaDBClusterIdentifiers(java.util.Collection)
if you want to override the existing values.
readReplicaDBClusterIdentifiers
- Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a
read replica. For example, when you create an Aurora read replica of an RDS MySQL DB instance, the Aurora
MySQL DB cluster for the Aurora read replica is shown. This output does not contain information about
cross region Aurora read replicas. Currently, each RDS DB instance can have only one Aurora read replica.
public DBInstance withReadReplicaDBClusterIdentifiers(Collection<String> readReplicaDBClusterIdentifiers)
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not contain information about cross region Aurora read replicas.
Currently, each RDS DB instance can have only one Aurora read replica.
readReplicaDBClusterIdentifiers
- Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a
read replica. For example, when you create an Aurora read replica of an RDS MySQL DB instance, the Aurora
MySQL DB cluster for the Aurora read replica is shown. This output does not contain information about
cross region Aurora read replicas. Currently, each RDS DB instance can have only one Aurora read replica.
public void setReplicaMode(String replicaMode)
The open mode of an Oracle read replica. The default is open-read-only
. For more information, see Working with Oracle Read
Replicas for Amazon RDS in the Amazon RDS User Guide.
This attribute is only supported in RDS for Oracle.
replicaMode
- The open mode of an Oracle read replica. The default is open-read-only
. For more information,
see Working
with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This attribute is only supported in RDS for Oracle.
ReplicaMode
public String getReplicaMode()
The open mode of an Oracle read replica. The default is open-read-only
. For more information, see Working with Oracle Read
Replicas for Amazon RDS in the Amazon RDS User Guide.
This attribute is only supported in RDS for Oracle.
open-read-only
. For more
information, see Working with
Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This attribute is only supported in RDS for Oracle.
ReplicaMode
public DBInstance withReplicaMode(String replicaMode)
The open mode of an Oracle read replica. The default is open-read-only
. For more information, see Working with Oracle Read
Replicas for Amazon RDS in the Amazon RDS User Guide.
This attribute is only supported in RDS for Oracle.
replicaMode
- The open mode of an Oracle read replica. The default is open-read-only
. For more information,
see Working
with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This attribute is only supported in RDS for Oracle.
ReplicaMode
public DBInstance withReplicaMode(ReplicaMode replicaMode)
The open mode of an Oracle read replica. The default is open-read-only
. For more information, see Working with Oracle Read
Replicas for Amazon RDS in the Amazon RDS User Guide.
This attribute is only supported in RDS for Oracle.
replicaMode
- The open mode of an Oracle read replica. The default is open-read-only
. For more information,
see Working
with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This attribute is only supported in RDS for Oracle.
ReplicaMode
public void setLicenseModel(String licenseModel)
License model information for this DB instance.
licenseModel
- License model information for this DB instance.public String getLicenseModel()
License model information for this DB instance.
public DBInstance withLicenseModel(String licenseModel)
License model information for this DB instance.
licenseModel
- License model information for this DB instance.public void setIops(Integer iops)
Specifies the Provisioned IOPS (I/O operations per second) value.
iops
- Specifies the Provisioned IOPS (I/O operations per second) value.public Integer getIops()
Specifies the Provisioned IOPS (I/O operations per second) value.
public DBInstance withIops(Integer iops)
Specifies the Provisioned IOPS (I/O operations per second) value.
iops
- Specifies the Provisioned IOPS (I/O operations per second) value.public List<OptionGroupMembership> getOptionGroupMemberships()
Provides the list of option group memberships for this DB instance.
public void setOptionGroupMemberships(Collection<OptionGroupMembership> optionGroupMemberships)
Provides the list of option group memberships for this DB instance.
optionGroupMemberships
- Provides the list of option group memberships for this DB instance.public DBInstance withOptionGroupMemberships(OptionGroupMembership... optionGroupMemberships)
Provides the list of option group memberships for this DB instance.
NOTE: This method appends the values to the existing list (if any). Use
setOptionGroupMemberships(java.util.Collection)
or
withOptionGroupMemberships(java.util.Collection)
if you want to override the existing values.
optionGroupMemberships
- Provides the list of option group memberships for this DB instance.public DBInstance withOptionGroupMemberships(Collection<OptionGroupMembership> optionGroupMemberships)
Provides the list of option group memberships for this DB instance.
optionGroupMemberships
- Provides the list of option group memberships for this DB instance.public void setCharacterSetName(String characterSetName)
If present, specifies the name of the character set that this instance is associated with.
characterSetName
- If present, specifies the name of the character set that this instance is associated with.public String getCharacterSetName()
If present, specifies the name of the character set that this instance is associated with.
public DBInstance withCharacterSetName(String characterSetName)
If present, specifies the name of the character set that this instance is associated with.
characterSetName
- If present, specifies the name of the character set that this instance is associated with.public void setNcharCharacterSetName(String ncharCharacterSetName)
The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
ncharCharacterSetName
- The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode
encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.public String getNcharCharacterSetName()
The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
public DBInstance withNcharCharacterSetName(String ncharCharacterSetName)
The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
ncharCharacterSetName
- The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode
encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.public void setSecondaryAvailabilityZone(String secondaryAvailabilityZone)
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
secondaryAvailabilityZone
- If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.public String getSecondaryAvailabilityZone()
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
public DBInstance withSecondaryAvailabilityZone(String secondaryAvailabilityZone)
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
secondaryAvailabilityZone
- If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.public void setPubliclyAccessible(Boolean publiclyAccessible)
Specifies the accessibility options for the DB instance.
When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
publiclyAccessible
- Specifies the accessibility options for the DB instance.
When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
public Boolean getPubliclyAccessible()
Specifies the accessibility options for the DB instance.
When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
public DBInstance withPubliclyAccessible(Boolean publiclyAccessible)
Specifies the accessibility options for the DB instance.
When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
publiclyAccessible
- Specifies the accessibility options for the DB instance.
When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
public Boolean isPubliclyAccessible()
Specifies the accessibility options for the DB instance.
When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
public List<DBInstanceStatusInfo> getStatusInfos()
The status of a read replica. If the instance isn't a read replica, this is blank.
public void setStatusInfos(Collection<DBInstanceStatusInfo> statusInfos)
The status of a read replica. If the instance isn't a read replica, this is blank.
statusInfos
- The status of a read replica. If the instance isn't a read replica, this is blank.public DBInstance withStatusInfos(DBInstanceStatusInfo... statusInfos)
The status of a read replica. If the instance isn't a read replica, this is blank.
NOTE: This method appends the values to the existing list (if any). Use
setStatusInfos(java.util.Collection)
or withStatusInfos(java.util.Collection)
if you want to
override the existing values.
statusInfos
- The status of a read replica. If the instance isn't a read replica, this is blank.public DBInstance withStatusInfos(Collection<DBInstanceStatusInfo> statusInfos)
The status of a read replica. If the instance isn't a read replica, this is blank.
statusInfos
- The status of a read replica. If the instance isn't a read replica, this is blank.public void setStorageType(String storageType)
Specifies the storage type associated with DB instance.
storageType
- Specifies the storage type associated with DB instance.public String getStorageType()
Specifies the storage type associated with DB instance.
public DBInstance withStorageType(String storageType)
Specifies the storage type associated with DB instance.
storageType
- Specifies the storage type associated with DB instance.public void setTdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which the instance is associated for TDE encryption.
tdeCredentialArn
- The ARN from the key store with which the instance is associated for TDE encryption.public String getTdeCredentialArn()
The ARN from the key store with which the instance is associated for TDE encryption.
public DBInstance withTdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which the instance is associated for TDE encryption.
tdeCredentialArn
- The ARN from the key store with which the instance is associated for TDE encryption.public void setDbInstancePort(Integer dbInstancePort)
Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
dbInstancePort
- Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can
be a different port than the DB cluster port.public Integer getDbInstancePort()
Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
public DBInstance withDbInstancePort(Integer dbInstancePort)
Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
dbInstancePort
- Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can
be a different port than the DB cluster port.public void setDBClusterIdentifier(String dBClusterIdentifier)
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
dBClusterIdentifier
- If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance
is a member of.public String getDBClusterIdentifier()
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
public DBInstance withDBClusterIdentifier(String dBClusterIdentifier)
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
dBClusterIdentifier
- If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance
is a member of.public void setStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB instance is encrypted.
storageEncrypted
- Specifies whether the DB instance is encrypted.public Boolean getStorageEncrypted()
Specifies whether the DB instance is encrypted.
public DBInstance withStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB instance is encrypted.
storageEncrypted
- Specifies whether the DB instance is encrypted.public Boolean isStorageEncrypted()
Specifies whether the DB instance is encrypted.
public void setKmsKeyId(String kmsKeyId)
If StorageEncrypted
is true, the Amazon Web Services KMS key identifier for the encrypted DB
instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
kmsKeyId
- If StorageEncrypted
is true, the Amazon Web Services KMS key identifier for the encrypted DB
instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
public String getKmsKeyId()
If StorageEncrypted
is true, the Amazon Web Services KMS key identifier for the encrypted DB
instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
StorageEncrypted
is true, the Amazon Web Services KMS key identifier for the encrypted DB
instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
public DBInstance withKmsKeyId(String kmsKeyId)
If StorageEncrypted
is true, the Amazon Web Services KMS key identifier for the encrypted DB
instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
kmsKeyId
- If StorageEncrypted
is true, the Amazon Web Services KMS key identifier for the encrypted DB
instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
public void setDbiResourceId(String dbiResourceId)
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS customer master key (CMK) for the DB instance is accessed.
dbiResourceId
- The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found
in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS customer master key
(CMK) for the DB instance is accessed.public String getDbiResourceId()
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS customer master key (CMK) for the DB instance is accessed.
public DBInstance withDbiResourceId(String dbiResourceId)
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS customer master key (CMK) for the DB instance is accessed.
dbiResourceId
- The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found
in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS customer master key
(CMK) for the DB instance is accessed.public void setCACertificateIdentifier(String cACertificateIdentifier)
The identifier of the CA certificate for this DB instance.
cACertificateIdentifier
- The identifier of the CA certificate for this DB instance.public String getCACertificateIdentifier()
The identifier of the CA certificate for this DB instance.
public DBInstance withCACertificateIdentifier(String cACertificateIdentifier)
The identifier of the CA certificate for this DB instance.
cACertificateIdentifier
- The identifier of the CA certificate for this DB instance.public List<DomainMembership> getDomainMemberships()
The Active Directory Domain membership records associated with the DB instance.
public void setDomainMemberships(Collection<DomainMembership> domainMemberships)
The Active Directory Domain membership records associated with the DB instance.
domainMemberships
- The Active Directory Domain membership records associated with the DB instance.public DBInstance withDomainMemberships(DomainMembership... domainMemberships)
The Active Directory Domain membership records associated with the DB instance.
NOTE: This method appends the values to the existing list (if any). Use
setDomainMemberships(java.util.Collection)
or withDomainMemberships(java.util.Collection)
if
you want to override the existing values.
domainMemberships
- The Active Directory Domain membership records associated with the DB instance.public DBInstance withDomainMemberships(Collection<DomainMembership> domainMemberships)
The Active Directory Domain membership records associated with the DB instance.
domainMemberships
- The Active Directory Domain membership records associated with the DB instance.public void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB
instance has no effect on the DB cluster setting. For more information, see DBCluster
.
copyTagsToSnapshot
- Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora
DB instance has no effect on the DB cluster setting. For more information, see DBCluster
.
public Boolean getCopyTagsToSnapshot()
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB
instance has no effect on the DB cluster setting. For more information, see DBCluster
.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora
DB instance has no effect on the DB cluster setting. For more information, see DBCluster
.
public DBInstance withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB
instance has no effect on the DB cluster setting. For more information, see DBCluster
.
copyTagsToSnapshot
- Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora
DB instance has no effect on the DB cluster setting. For more information, see DBCluster
.
public Boolean isCopyTagsToSnapshot()
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB
instance has no effect on the DB cluster setting. For more information, see DBCluster
.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora
DB instance has no effect on the DB cluster setting. For more information, see DBCluster
.
public void setMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB
instance.public Integer getMonitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
public DBInstance withMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB
instance.public void setEnhancedMonitoringResourceArn(String enhancedMonitoringResourceArn)
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
enhancedMonitoringResourceArn
- The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced
Monitoring metrics data for the DB instance.public String getEnhancedMonitoringResourceArn()
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
public DBInstance withEnhancedMonitoringResourceArn(String enhancedMonitoringResourceArn)
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
enhancedMonitoringResourceArn
- The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced
Monitoring metrics data for the DB instance.public void setMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
monitoringRoleArn
- The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.public String getMonitoringRoleArn()
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
public DBInstance withMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
monitoringRoleArn
- The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.public void setPromotionTier(Integer promotionTier)
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
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 in the Amazon Aurora User Guide.public Integer getPromotionTier()
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
public DBInstance withPromotionTier(Integer promotionTier)
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
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 in the Amazon Aurora User Guide.public void setDBInstanceArn(String dBInstanceArn)
The Amazon Resource Name (ARN) for the DB instance.
dBInstanceArn
- The Amazon Resource Name (ARN) for the DB instance.public String getDBInstanceArn()
The Amazon Resource Name (ARN) for the DB instance.
public DBInstance withDBInstanceArn(String dBInstanceArn)
The Amazon Resource Name (ARN) for the DB instance.
dBInstanceArn
- The Amazon Resource Name (ARN) for the DB instance.public void setTimezone(String timezone)
The time zone of the DB instance. In most cases, the Timezone
element is empty.
Timezone
content appears only for Microsoft SQL Server DB instances that were created with a time
zone specified.
timezone
- The time zone of the DB instance. In most cases, the Timezone
element is empty.
Timezone
content appears only for Microsoft SQL Server DB instances that were created with a
time zone specified.public String getTimezone()
The time zone of the DB instance. In most cases, the Timezone
element is empty.
Timezone
content appears only for Microsoft SQL Server DB instances that were created with a time
zone specified.
Timezone
element is empty.
Timezone
content appears only for Microsoft SQL Server DB instances that were created with a
time zone specified.public DBInstance withTimezone(String timezone)
The time zone of the DB instance. In most cases, the Timezone
element is empty.
Timezone
content appears only for Microsoft SQL Server DB instances that were created with a time
zone specified.
timezone
- The time zone of the DB instance. In most cases, the Timezone
element is empty.
Timezone
content appears only for Microsoft SQL Server DB instances that were created with a
time zone specified.public void setIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
iAMDatabaseAuthenticationEnabled
- True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts
is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
public Boolean getIAMDatabaseAuthenticationEnabled()
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
IAM database authentication can be enabled for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
public DBInstance withIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
iAMDatabaseAuthenticationEnabled
- True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts
is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
public Boolean isIAMDatabaseAuthenticationEnabled()
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
IAM database authentication can be enabled for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
public void setPerformanceInsightsEnabled(Boolean performanceInsightsEnabled)
True if Performance Insights is enabled for the DB instance, and otherwise false.
performanceInsightsEnabled
- True if Performance Insights is enabled for the DB instance, and otherwise false.public Boolean getPerformanceInsightsEnabled()
True if Performance Insights is enabled for the DB instance, and otherwise false.
public DBInstance withPerformanceInsightsEnabled(Boolean performanceInsightsEnabled)
True if Performance Insights is enabled for the DB instance, and otherwise false.
performanceInsightsEnabled
- True if Performance Insights is enabled for the DB instance, and otherwise false.public Boolean isPerformanceInsightsEnabled()
True if Performance Insights is enabled for the DB instance, and otherwise false.
public void setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
performanceInsightsKMSKeyId
- The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
public String getPerformanceInsightsKMSKeyId()
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
public DBInstance withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
performanceInsightsKMSKeyId
- The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
public void setPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
performanceInsightsRetentionPeriod
- The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).public Integer getPerformanceInsightsRetentionPeriod()
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
public DBInstance withPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
performanceInsightsRetentionPeriod
- The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).public List<String> getEnabledCloudwatchLogsExports()
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
public void setEnabledCloudwatchLogsExports(Collection<String> enabledCloudwatchLogsExports)
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
enabledCloudwatchLogsExports
- A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
public DBInstance withEnabledCloudwatchLogsExports(String... enabledCloudwatchLogsExports)
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
NOTE: This method appends the values to the existing list (if any). Use
setEnabledCloudwatchLogsExports(java.util.Collection)
or
withEnabledCloudwatchLogsExports(java.util.Collection)
if you want to override the existing values.
enabledCloudwatchLogsExports
- A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
public DBInstance withEnabledCloudwatchLogsExports(Collection<String> enabledCloudwatchLogsExports)
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
enabledCloudwatchLogsExports
- A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
public List<ProcessorFeature> getProcessorFeatures()
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
public void setProcessorFeatures(Collection<ProcessorFeature> processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
processorFeatures
- The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.public DBInstance withProcessorFeatures(ProcessorFeature... processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
NOTE: This method appends the values to the existing list (if any). Use
setProcessorFeatures(java.util.Collection)
or withProcessorFeatures(java.util.Collection)
if
you want to override the existing values.
processorFeatures
- The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.public DBInstance withProcessorFeatures(Collection<ProcessorFeature> processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
processorFeatures
- The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.public void setDeletionProtection(Boolean deletionProtection)
Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.
deletionProtection
- Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion
protection is enabled. For more information, see Deleting a DB
Instance.public Boolean getDeletionProtection()
Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.
public DBInstance withDeletionProtection(Boolean deletionProtection)
Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.
deletionProtection
- Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion
protection is enabled. For more information, see Deleting a DB
Instance.public Boolean isDeletionProtection()
Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.
public List<DBInstanceRole> getAssociatedRoles()
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
public void setAssociatedRoles(Collection<DBInstanceRole> associatedRoles)
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
associatedRoles
- The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.public DBInstance withAssociatedRoles(DBInstanceRole... associatedRoles)
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
NOTE: This method appends the values to the existing list (if any). Use
setAssociatedRoles(java.util.Collection)
or withAssociatedRoles(java.util.Collection)
if you
want to override the existing values.
associatedRoles
- The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.public DBInstance withAssociatedRoles(Collection<DBInstanceRole> associatedRoles)
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
associatedRoles
- The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.public void setListenerEndpoint(Endpoint listenerEndpoint)
Specifies the listener connection endpoint for SQL Server Always On.
listenerEndpoint
- Specifies the listener connection endpoint for SQL Server Always On.public Endpoint getListenerEndpoint()
Specifies the listener connection endpoint for SQL Server Always On.
public DBInstance withListenerEndpoint(Endpoint listenerEndpoint)
Specifies the listener connection endpoint for SQL Server Always On.
listenerEndpoint
- Specifies the listener connection endpoint for SQL Server Always On.public void setMaxAllocatedStorage(Integer maxAllocatedStorage)
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
maxAllocatedStorage
- The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.public Integer getMaxAllocatedStorage()
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
public DBInstance withMaxAllocatedStorage(Integer maxAllocatedStorage)
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
maxAllocatedStorage
- The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.public void setTagList(Collection<Tag> tagList)
tagList
- public DBInstance withTagList(Tag... tagList)
NOTE: This method appends the values to the existing list (if any). Use
setTagList(java.util.Collection)
or withTagList(java.util.Collection)
if you want to override
the existing values.
tagList
- public DBInstance withTagList(Collection<Tag> tagList)
tagList
- public List<DBInstanceAutomatedBackupsReplication> getDBInstanceAutomatedBackupsReplications()
The list of replicated automated backups associated with the DB instance.
public void setDBInstanceAutomatedBackupsReplications(Collection<DBInstanceAutomatedBackupsReplication> dBInstanceAutomatedBackupsReplications)
The list of replicated automated backups associated with the DB instance.
dBInstanceAutomatedBackupsReplications
- The list of replicated automated backups associated with the DB instance.public DBInstance withDBInstanceAutomatedBackupsReplications(DBInstanceAutomatedBackupsReplication... dBInstanceAutomatedBackupsReplications)
The list of replicated automated backups associated with the DB instance.
NOTE: This method appends the values to the existing list (if any). Use
setDBInstanceAutomatedBackupsReplications(java.util.Collection)
or
withDBInstanceAutomatedBackupsReplications(java.util.Collection)
if you want to override the existing
values.
dBInstanceAutomatedBackupsReplications
- The list of replicated automated backups associated with the DB instance.public DBInstance withDBInstanceAutomatedBackupsReplications(Collection<DBInstanceAutomatedBackupsReplication> dBInstanceAutomatedBackupsReplications)
The list of replicated automated backups associated with the DB instance.
dBInstanceAutomatedBackupsReplications
- The list of replicated automated backups associated with the DB instance.public void setCustomerOwnedIpEnabled(Boolean customerOwnedIpEnabled)
Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
customerOwnedIpEnabled
- Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
public Boolean getCustomerOwnedIpEnabled()
Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
public DBInstance withCustomerOwnedIpEnabled(Boolean customerOwnedIpEnabled)
Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
customerOwnedIpEnabled
- Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
public Boolean isCustomerOwnedIpEnabled()
Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
public void setAwsBackupRecoveryPointArn(String awsBackupRecoveryPointArn)
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
awsBackupRecoveryPointArn
- The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.public String getAwsBackupRecoveryPointArn()
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
public DBInstance withAwsBackupRecoveryPointArn(String awsBackupRecoveryPointArn)
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
awsBackupRecoveryPointArn
- The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.public void setActivityStreamStatus(String activityStreamStatus)
The status of the database activity stream.
activityStreamStatus
- The status of the database activity stream.ActivityStreamStatus
public String getActivityStreamStatus()
The status of the database activity stream.
ActivityStreamStatus
public DBInstance withActivityStreamStatus(String activityStreamStatus)
The status of the database activity stream.
activityStreamStatus
- The status of the database activity stream.ActivityStreamStatus
public DBInstance withActivityStreamStatus(ActivityStreamStatus activityStreamStatus)
The status of the database activity stream.
activityStreamStatus
- The status of the database activity stream.ActivityStreamStatus
public void setActivityStreamKmsKeyId(String activityStreamKmsKeyId)
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
activityStreamKmsKeyId
- The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon
Web Services KMS customer master key (CMK).public String getActivityStreamKmsKeyId()
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
public DBInstance withActivityStreamKmsKeyId(String activityStreamKmsKeyId)
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
activityStreamKmsKeyId
- The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon
Web Services KMS customer master key (CMK).public void setActivityStreamKinesisStreamName(String activityStreamKinesisStreamName)
The name of the Amazon Kinesis data stream used for the database activity stream.
activityStreamKinesisStreamName
- The name of the Amazon Kinesis data stream used for the database activity stream.public String getActivityStreamKinesisStreamName()
The name of the Amazon Kinesis data stream used for the database activity stream.
public DBInstance withActivityStreamKinesisStreamName(String activityStreamKinesisStreamName)
The name of the Amazon Kinesis data stream used for the database activity stream.
activityStreamKinesisStreamName
- The name of the Amazon Kinesis data stream used for the database activity stream.public void setActivityStreamMode(String activityStreamMode)
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
activityStreamMode
- The mode of the database activity stream. Database events such as a change or access generate an activity
stream event. RDS for Oracle always handles these events asynchronously.ActivityStreamMode
public String getActivityStreamMode()
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
ActivityStreamMode
public DBInstance withActivityStreamMode(String activityStreamMode)
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
activityStreamMode
- The mode of the database activity stream. Database events such as a change or access generate an activity
stream event. RDS for Oracle always handles these events asynchronously.ActivityStreamMode
public DBInstance withActivityStreamMode(ActivityStreamMode activityStreamMode)
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
activityStreamMode
- The mode of the database activity stream. Database events such as a change or access generate an activity
stream event. RDS for Oracle always handles these events asynchronously.ActivityStreamMode
public void setActivityStreamEngineNativeAuditFieldsIncluded(Boolean activityStreamEngineNativeAuditFieldsIncluded)
Indicates whether engine-native audit fields are included in the database activity stream.
activityStreamEngineNativeAuditFieldsIncluded
- Indicates whether engine-native audit fields are included in the database activity stream.public Boolean getActivityStreamEngineNativeAuditFieldsIncluded()
Indicates whether engine-native audit fields are included in the database activity stream.
public DBInstance withActivityStreamEngineNativeAuditFieldsIncluded(Boolean activityStreamEngineNativeAuditFieldsIncluded)
Indicates whether engine-native audit fields are included in the database activity stream.
activityStreamEngineNativeAuditFieldsIncluded
- Indicates whether engine-native audit fields are included in the database activity stream.public Boolean isActivityStreamEngineNativeAuditFieldsIncluded()
Indicates whether engine-native audit fields are included in the database activity stream.
public String toString()
toString
in class Object
Object.toString()
public DBInstance clone()