AWS SDK for C++  1.9.123
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::RDS::Model::ModifyDBInstanceRequest Class Reference

#include <ModifyDBInstanceRequest.h>

+ Inheritance diagram for Aws::RDS::Model::ModifyDBInstanceRequest:

Public Member Functions

 ModifyDBInstanceRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetDBInstanceIdentifier () const
 
bool DBInstanceIdentifierHasBeenSet () const
 
void SetDBInstanceIdentifier (const Aws::String &value)
 
void SetDBInstanceIdentifier (Aws::String &&value)
 
void SetDBInstanceIdentifier (const char *value)
 
ModifyDBInstanceRequestWithDBInstanceIdentifier (const Aws::String &value)
 
ModifyDBInstanceRequestWithDBInstanceIdentifier (Aws::String &&value)
 
ModifyDBInstanceRequestWithDBInstanceIdentifier (const char *value)
 
int GetAllocatedStorage () const
 
bool AllocatedStorageHasBeenSet () const
 
void SetAllocatedStorage (int value)
 
ModifyDBInstanceRequestWithAllocatedStorage (int value)
 
const Aws::StringGetDBInstanceClass () const
 
bool DBInstanceClassHasBeenSet () const
 
void SetDBInstanceClass (const Aws::String &value)
 
void SetDBInstanceClass (Aws::String &&value)
 
void SetDBInstanceClass (const char *value)
 
ModifyDBInstanceRequestWithDBInstanceClass (const Aws::String &value)
 
ModifyDBInstanceRequestWithDBInstanceClass (Aws::String &&value)
 
ModifyDBInstanceRequestWithDBInstanceClass (const char *value)
 
const Aws::StringGetDBSubnetGroupName () const
 
bool DBSubnetGroupNameHasBeenSet () const
 
void SetDBSubnetGroupName (const Aws::String &value)
 
void SetDBSubnetGroupName (Aws::String &&value)
 
void SetDBSubnetGroupName (const char *value)
 
ModifyDBInstanceRequestWithDBSubnetGroupName (const Aws::String &value)
 
ModifyDBInstanceRequestWithDBSubnetGroupName (Aws::String &&value)
 
ModifyDBInstanceRequestWithDBSubnetGroupName (const char *value)
 
const Aws::Vector< Aws::String > & GetDBSecurityGroups () const
 
bool DBSecurityGroupsHasBeenSet () const
 
void SetDBSecurityGroups (const Aws::Vector< Aws::String > &value)
 
void SetDBSecurityGroups (Aws::Vector< Aws::String > &&value)
 
ModifyDBInstanceRequestWithDBSecurityGroups (const Aws::Vector< Aws::String > &value)
 
ModifyDBInstanceRequestWithDBSecurityGroups (Aws::Vector< Aws::String > &&value)
 
ModifyDBInstanceRequestAddDBSecurityGroups (const Aws::String &value)
 
ModifyDBInstanceRequestAddDBSecurityGroups (Aws::String &&value)
 
ModifyDBInstanceRequestAddDBSecurityGroups (const char *value)
 
const Aws::Vector< Aws::String > & GetVpcSecurityGroupIds () const
 
bool VpcSecurityGroupIdsHasBeenSet () const
 
void SetVpcSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
void SetVpcSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
ModifyDBInstanceRequestWithVpcSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
ModifyDBInstanceRequestWithVpcSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
ModifyDBInstanceRequestAddVpcSecurityGroupIds (const Aws::String &value)
 
ModifyDBInstanceRequestAddVpcSecurityGroupIds (Aws::String &&value)
 
ModifyDBInstanceRequestAddVpcSecurityGroupIds (const char *value)
 
bool GetApplyImmediately () const
 
bool ApplyImmediatelyHasBeenSet () const
 
void SetApplyImmediately (bool value)
 
ModifyDBInstanceRequestWithApplyImmediately (bool value)
 
const Aws::StringGetMasterUserPassword () const
 
bool MasterUserPasswordHasBeenSet () const
 
void SetMasterUserPassword (const Aws::String &value)
 
void SetMasterUserPassword (Aws::String &&value)
 
void SetMasterUserPassword (const char *value)
 
ModifyDBInstanceRequestWithMasterUserPassword (const Aws::String &value)
 
ModifyDBInstanceRequestWithMasterUserPassword (Aws::String &&value)
 
ModifyDBInstanceRequestWithMasterUserPassword (const char *value)
 
const Aws::StringGetDBParameterGroupName () const
 
bool DBParameterGroupNameHasBeenSet () const
 
void SetDBParameterGroupName (const Aws::String &value)
 
void SetDBParameterGroupName (Aws::String &&value)
 
void SetDBParameterGroupName (const char *value)
 
ModifyDBInstanceRequestWithDBParameterGroupName (const Aws::String &value)
 
ModifyDBInstanceRequestWithDBParameterGroupName (Aws::String &&value)
 
ModifyDBInstanceRequestWithDBParameterGroupName (const char *value)
 
int GetBackupRetentionPeriod () const
 
bool BackupRetentionPeriodHasBeenSet () const
 
void SetBackupRetentionPeriod (int value)
 
ModifyDBInstanceRequestWithBackupRetentionPeriod (int value)
 
const Aws::StringGetPreferredBackupWindow () const
 
bool PreferredBackupWindowHasBeenSet () const
 
void SetPreferredBackupWindow (const Aws::String &value)
 
void SetPreferredBackupWindow (Aws::String &&value)
 
void SetPreferredBackupWindow (const char *value)
 
ModifyDBInstanceRequestWithPreferredBackupWindow (const Aws::String &value)
 
ModifyDBInstanceRequestWithPreferredBackupWindow (Aws::String &&value)
 
ModifyDBInstanceRequestWithPreferredBackupWindow (const char *value)
 
const Aws::StringGetPreferredMaintenanceWindow () const
 
bool PreferredMaintenanceWindowHasBeenSet () const
 
void SetPreferredMaintenanceWindow (const Aws::String &value)
 
void SetPreferredMaintenanceWindow (Aws::String &&value)
 
void SetPreferredMaintenanceWindow (const char *value)
 
ModifyDBInstanceRequestWithPreferredMaintenanceWindow (const Aws::String &value)
 
ModifyDBInstanceRequestWithPreferredMaintenanceWindow (Aws::String &&value)
 
ModifyDBInstanceRequestWithPreferredMaintenanceWindow (const char *value)
 
bool GetMultiAZ () const
 
bool MultiAZHasBeenSet () const
 
void SetMultiAZ (bool value)
 
ModifyDBInstanceRequestWithMultiAZ (bool value)
 
const Aws::StringGetEngineVersion () const
 
bool EngineVersionHasBeenSet () const
 
void SetEngineVersion (const Aws::String &value)
 
void SetEngineVersion (Aws::String &&value)
 
void SetEngineVersion (const char *value)
 
ModifyDBInstanceRequestWithEngineVersion (const Aws::String &value)
 
ModifyDBInstanceRequestWithEngineVersion (Aws::String &&value)
 
ModifyDBInstanceRequestWithEngineVersion (const char *value)
 
bool GetAllowMajorVersionUpgrade () const
 
bool AllowMajorVersionUpgradeHasBeenSet () const
 
void SetAllowMajorVersionUpgrade (bool value)
 
ModifyDBInstanceRequestWithAllowMajorVersionUpgrade (bool value)
 
bool GetAutoMinorVersionUpgrade () const
 
bool AutoMinorVersionUpgradeHasBeenSet () const
 
void SetAutoMinorVersionUpgrade (bool value)
 
ModifyDBInstanceRequestWithAutoMinorVersionUpgrade (bool value)
 
const Aws::StringGetLicenseModel () const
 
bool LicenseModelHasBeenSet () const
 
void SetLicenseModel (const Aws::String &value)
 
void SetLicenseModel (Aws::String &&value)
 
void SetLicenseModel (const char *value)
 
ModifyDBInstanceRequestWithLicenseModel (const Aws::String &value)
 
ModifyDBInstanceRequestWithLicenseModel (Aws::String &&value)
 
ModifyDBInstanceRequestWithLicenseModel (const char *value)
 
int GetIops () const
 
bool IopsHasBeenSet () const
 
void SetIops (int value)
 
ModifyDBInstanceRequestWithIops (int value)
 
const Aws::StringGetOptionGroupName () const
 
bool OptionGroupNameHasBeenSet () const
 
void SetOptionGroupName (const Aws::String &value)
 
void SetOptionGroupName (Aws::String &&value)
 
void SetOptionGroupName (const char *value)
 
ModifyDBInstanceRequestWithOptionGroupName (const Aws::String &value)
 
ModifyDBInstanceRequestWithOptionGroupName (Aws::String &&value)
 
ModifyDBInstanceRequestWithOptionGroupName (const char *value)
 
const Aws::StringGetNewDBInstanceIdentifier () const
 
bool NewDBInstanceIdentifierHasBeenSet () const
 
void SetNewDBInstanceIdentifier (const Aws::String &value)
 
void SetNewDBInstanceIdentifier (Aws::String &&value)
 
void SetNewDBInstanceIdentifier (const char *value)
 
ModifyDBInstanceRequestWithNewDBInstanceIdentifier (const Aws::String &value)
 
ModifyDBInstanceRequestWithNewDBInstanceIdentifier (Aws::String &&value)
 
ModifyDBInstanceRequestWithNewDBInstanceIdentifier (const char *value)
 
const Aws::StringGetStorageType () const
 
bool StorageTypeHasBeenSet () const
 
void SetStorageType (const Aws::String &value)
 
void SetStorageType (Aws::String &&value)
 
void SetStorageType (const char *value)
 
ModifyDBInstanceRequestWithStorageType (const Aws::String &value)
 
ModifyDBInstanceRequestWithStorageType (Aws::String &&value)
 
ModifyDBInstanceRequestWithStorageType (const char *value)
 
const Aws::StringGetTdeCredentialArn () const
 
bool TdeCredentialArnHasBeenSet () const
 
void SetTdeCredentialArn (const Aws::String &value)
 
void SetTdeCredentialArn (Aws::String &&value)
 
void SetTdeCredentialArn (const char *value)
 
ModifyDBInstanceRequestWithTdeCredentialArn (const Aws::String &value)
 
ModifyDBInstanceRequestWithTdeCredentialArn (Aws::String &&value)
 
ModifyDBInstanceRequestWithTdeCredentialArn (const char *value)
 
const Aws::StringGetTdeCredentialPassword () const
 
bool TdeCredentialPasswordHasBeenSet () const
 
void SetTdeCredentialPassword (const Aws::String &value)
 
void SetTdeCredentialPassword (Aws::String &&value)
 
void SetTdeCredentialPassword (const char *value)
 
ModifyDBInstanceRequestWithTdeCredentialPassword (const Aws::String &value)
 
ModifyDBInstanceRequestWithTdeCredentialPassword (Aws::String &&value)
 
ModifyDBInstanceRequestWithTdeCredentialPassword (const char *value)
 
const Aws::StringGetCACertificateIdentifier () const
 
bool CACertificateIdentifierHasBeenSet () const
 
void SetCACertificateIdentifier (const Aws::String &value)
 
void SetCACertificateIdentifier (Aws::String &&value)
 
void SetCACertificateIdentifier (const char *value)
 
ModifyDBInstanceRequestWithCACertificateIdentifier (const Aws::String &value)
 
ModifyDBInstanceRequestWithCACertificateIdentifier (Aws::String &&value)
 
ModifyDBInstanceRequestWithCACertificateIdentifier (const char *value)
 
const Aws::StringGetDomain () const
 
bool DomainHasBeenSet () const
 
void SetDomain (const Aws::String &value)
 
void SetDomain (Aws::String &&value)
 
void SetDomain (const char *value)
 
ModifyDBInstanceRequestWithDomain (const Aws::String &value)
 
ModifyDBInstanceRequestWithDomain (Aws::String &&value)
 
ModifyDBInstanceRequestWithDomain (const char *value)
 
bool GetCopyTagsToSnapshot () const
 
bool CopyTagsToSnapshotHasBeenSet () const
 
void SetCopyTagsToSnapshot (bool value)
 
ModifyDBInstanceRequestWithCopyTagsToSnapshot (bool value)
 
int GetMonitoringInterval () const
 
bool MonitoringIntervalHasBeenSet () const
 
void SetMonitoringInterval (int value)
 
ModifyDBInstanceRequestWithMonitoringInterval (int value)
 
int GetDBPortNumber () const
 
bool DBPortNumberHasBeenSet () const
 
void SetDBPortNumber (int value)
 
ModifyDBInstanceRequestWithDBPortNumber (int value)
 
bool GetPubliclyAccessible () const
 
bool PubliclyAccessibleHasBeenSet () const
 
void SetPubliclyAccessible (bool value)
 
ModifyDBInstanceRequestWithPubliclyAccessible (bool value)
 
const Aws::StringGetMonitoringRoleArn () const
 
bool MonitoringRoleArnHasBeenSet () const
 
void SetMonitoringRoleArn (const Aws::String &value)
 
void SetMonitoringRoleArn (Aws::String &&value)
 
void SetMonitoringRoleArn (const char *value)
 
ModifyDBInstanceRequestWithMonitoringRoleArn (const Aws::String &value)
 
ModifyDBInstanceRequestWithMonitoringRoleArn (Aws::String &&value)
 
ModifyDBInstanceRequestWithMonitoringRoleArn (const char *value)
 
const Aws::StringGetDomainIAMRoleName () const
 
bool DomainIAMRoleNameHasBeenSet () const
 
void SetDomainIAMRoleName (const Aws::String &value)
 
void SetDomainIAMRoleName (Aws::String &&value)
 
void SetDomainIAMRoleName (const char *value)
 
ModifyDBInstanceRequestWithDomainIAMRoleName (const Aws::String &value)
 
ModifyDBInstanceRequestWithDomainIAMRoleName (Aws::String &&value)
 
ModifyDBInstanceRequestWithDomainIAMRoleName (const char *value)
 
int GetPromotionTier () const
 
bool PromotionTierHasBeenSet () const
 
void SetPromotionTier (int value)
 
ModifyDBInstanceRequestWithPromotionTier (int value)
 
bool GetEnableIAMDatabaseAuthentication () const
 
bool EnableIAMDatabaseAuthenticationHasBeenSet () const
 
void SetEnableIAMDatabaseAuthentication (bool value)
 
ModifyDBInstanceRequestWithEnableIAMDatabaseAuthentication (bool value)
 
bool GetEnablePerformanceInsights () const
 
bool EnablePerformanceInsightsHasBeenSet () const
 
void SetEnablePerformanceInsights (bool value)
 
ModifyDBInstanceRequestWithEnablePerformanceInsights (bool value)
 
const Aws::StringGetPerformanceInsightsKMSKeyId () const
 
bool PerformanceInsightsKMSKeyIdHasBeenSet () const
 
void SetPerformanceInsightsKMSKeyId (const Aws::String &value)
 
void SetPerformanceInsightsKMSKeyId (Aws::String &&value)
 
void SetPerformanceInsightsKMSKeyId (const char *value)
 
ModifyDBInstanceRequestWithPerformanceInsightsKMSKeyId (const Aws::String &value)
 
ModifyDBInstanceRequestWithPerformanceInsightsKMSKeyId (Aws::String &&value)
 
ModifyDBInstanceRequestWithPerformanceInsightsKMSKeyId (const char *value)
 
int GetPerformanceInsightsRetentionPeriod () const
 
bool PerformanceInsightsRetentionPeriodHasBeenSet () const
 
void SetPerformanceInsightsRetentionPeriod (int value)
 
ModifyDBInstanceRequestWithPerformanceInsightsRetentionPeriod (int value)
 
const CloudwatchLogsExportConfigurationGetCloudwatchLogsExportConfiguration () const
 
bool CloudwatchLogsExportConfigurationHasBeenSet () const
 
void SetCloudwatchLogsExportConfiguration (const CloudwatchLogsExportConfiguration &value)
 
void SetCloudwatchLogsExportConfiguration (CloudwatchLogsExportConfiguration &&value)
 
ModifyDBInstanceRequestWithCloudwatchLogsExportConfiguration (const CloudwatchLogsExportConfiguration &value)
 
ModifyDBInstanceRequestWithCloudwatchLogsExportConfiguration (CloudwatchLogsExportConfiguration &&value)
 
const Aws::Vector< ProcessorFeature > & GetProcessorFeatures () const
 
bool ProcessorFeaturesHasBeenSet () const
 
void SetProcessorFeatures (const Aws::Vector< ProcessorFeature > &value)
 
void SetProcessorFeatures (Aws::Vector< ProcessorFeature > &&value)
 
ModifyDBInstanceRequestWithProcessorFeatures (const Aws::Vector< ProcessorFeature > &value)
 
ModifyDBInstanceRequestWithProcessorFeatures (Aws::Vector< ProcessorFeature > &&value)
 
ModifyDBInstanceRequestAddProcessorFeatures (const ProcessorFeature &value)
 
ModifyDBInstanceRequestAddProcessorFeatures (ProcessorFeature &&value)
 
bool GetUseDefaultProcessorFeatures () const
 
bool UseDefaultProcessorFeaturesHasBeenSet () const
 
void SetUseDefaultProcessorFeatures (bool value)
 
ModifyDBInstanceRequestWithUseDefaultProcessorFeatures (bool value)
 
bool GetDeletionProtection () const
 
bool DeletionProtectionHasBeenSet () const
 
void SetDeletionProtection (bool value)
 
ModifyDBInstanceRequestWithDeletionProtection (bool value)
 
int GetMaxAllocatedStorage () const
 
bool MaxAllocatedStorageHasBeenSet () const
 
void SetMaxAllocatedStorage (int value)
 
ModifyDBInstanceRequestWithMaxAllocatedStorage (int value)
 
bool GetCertificateRotationRestart () const
 
bool CertificateRotationRestartHasBeenSet () const
 
void SetCertificateRotationRestart (bool value)
 
ModifyDBInstanceRequestWithCertificateRotationRestart (bool value)
 
const ReplicaModeGetReplicaMode () const
 
bool ReplicaModeHasBeenSet () const
 
void SetReplicaMode (const ReplicaMode &value)
 
void SetReplicaMode (ReplicaMode &&value)
 
ModifyDBInstanceRequestWithReplicaMode (const ReplicaMode &value)
 
ModifyDBInstanceRequestWithReplicaMode (ReplicaMode &&value)
 
bool GetEnableCustomerOwnedIp () const
 
bool EnableCustomerOwnedIpHasBeenSet () const
 
void SetEnableCustomerOwnedIp (bool value)
 
ModifyDBInstanceRequestWithEnableCustomerOwnedIp (bool value)
 
const Aws::StringGetAwsBackupRecoveryPointArn () const
 
bool AwsBackupRecoveryPointArnHasBeenSet () const
 
void SetAwsBackupRecoveryPointArn (const Aws::String &value)
 
void SetAwsBackupRecoveryPointArn (Aws::String &&value)
 
void SetAwsBackupRecoveryPointArn (const char *value)
 
ModifyDBInstanceRequestWithAwsBackupRecoveryPointArn (const Aws::String &value)
 
ModifyDBInstanceRequestWithAwsBackupRecoveryPointArn (Aws::String &&value)
 
ModifyDBInstanceRequestWithAwsBackupRecoveryPointArn (const char *value)
 
- Public Member Functions inherited from Aws::RDS::RDSRequest
virtual ~RDSRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::RDS::RDSRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

See Also:

AWS API Reference

Definition at line 28 of file ModifyDBInstanceRequest.h.

Constructor & Destructor Documentation

◆ ModifyDBInstanceRequest()

Aws::RDS::Model::ModifyDBInstanceRequest::ModifyDBInstanceRequest ( )

Member Function Documentation

◆ AddDBSecurityGroups() [1/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::AddDBSecurityGroups ( Aws::String &&  value)
inline

A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

  • If supplied, must match existing DBSecurityGroups.

Definition at line 432 of file ModifyDBInstanceRequest.h.

◆ AddDBSecurityGroups() [2/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::AddDBSecurityGroups ( const Aws::String value)
inline

A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

  • If supplied, must match existing DBSecurityGroups.

Definition at line 424 of file ModifyDBInstanceRequest.h.

◆ AddDBSecurityGroups() [3/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::AddDBSecurityGroups ( const char *  value)
inline

A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

  • If supplied, must match existing DBSecurityGroups.

Definition at line 440 of file ModifyDBInstanceRequest.h.

◆ AddProcessorFeatures() [1/2]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::AddProcessorFeatures ( const ProcessorFeature value)
inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Definition at line 2959 of file ModifyDBInstanceRequest.h.

◆ AddProcessorFeatures() [2/2]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::AddProcessorFeatures ( ProcessorFeature &&  value)
inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Definition at line 2965 of file ModifyDBInstanceRequest.h.

◆ AddVpcSecurityGroupIds() [1/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::AddVpcSecurityGroupIds ( Aws::String &&  value)
inline

A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

  • If supplied, must match existing VpcSecurityGroupIds.

Definition at line 521 of file ModifyDBInstanceRequest.h.

◆ AddVpcSecurityGroupIds() [2/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::AddVpcSecurityGroupIds ( const Aws::String value)
inline

A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

  • If supplied, must match existing VpcSecurityGroupIds.

Definition at line 511 of file ModifyDBInstanceRequest.h.

◆ AddVpcSecurityGroupIds() [3/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::AddVpcSecurityGroupIds ( const char *  value)
inline

A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

  • If supplied, must match existing VpcSecurityGroupIds.

Definition at line 531 of file ModifyDBInstanceRequest.h.

◆ AllocatedStorageHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::AllocatedStorageHasBeenSet ( ) const
inline

The new amount of storage in gibibytes (GiB) to allocate for the DB instance.

For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

For the valid values for allocated storage for each engine, see CreateDBInstance.

Definition at line 121 of file ModifyDBInstanceRequest.h.

◆ AllowMajorVersionUpgradeHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::AllowMajorVersionUpgradeHasBeenSet ( ) const
inline

A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

Definition at line 1414 of file ModifyDBInstanceRequest.h.

◆ ApplyImmediatelyHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::ApplyImmediatelyHasBeenSet ( ) const
inline

A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.

If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance in the Amazon RDS User Guide. to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to determine when the changes are applied.

Definition at line 564 of file ModifyDBInstanceRequest.h.

◆ AutoMinorVersionUpgradeHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::AutoMinorVersionUpgradeHasBeenSet ( ) const
inline

A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage results if this parameter is enabled during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.

Definition at line 1453 of file ModifyDBInstanceRequest.h.

◆ AwsBackupRecoveryPointArnHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::AwsBackupRecoveryPointArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

Definition at line 3314 of file ModifyDBInstanceRequest.h.

◆ BackupRetentionPeriodHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::BackupRetentionPeriodHasBeenSet ( ) const
inline

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.

These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

Amazon Aurora

Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

Constraints:

  • Must be a value from 0 to 35

  • Can be specified for a MySQL read replica only if the source is running MySQL 5.6 or later

  • Can be specified for a PostgreSQL read replica only if the source is running PostgreSQL 9.3.5

  • Can't be set to 0 if the DB instance is a source to read replicas

Definition at line 911 of file ModifyDBInstanceRequest.h.

◆ CACertificateIdentifierHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::CACertificateIdentifierHasBeenSet ( ) const
inline

Indicates the certificate that needs to be associated with the instance.

Definition at line 2123 of file ModifyDBInstanceRequest.h.

◆ CertificateRotationRestartHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::CertificateRotationRestartHasBeenSet ( ) const
inline

A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate.

By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.

Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:

Definition at line 3109 of file ModifyDBInstanceRequest.h.

◆ CloudwatchLogsExportConfigurationHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::CloudwatchLogsExportConfigurationHasBeenSet ( ) const
inline

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance.

A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect.

Definition at line 2880 of file ModifyDBInstanceRequest.h.

◆ CopyTagsToSnapshotHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::CopyTagsToSnapshotHasBeenSet ( ) const
inline

A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

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 ModifyDBCluster.

Definition at line 2261 of file ModifyDBInstanceRequest.h.

◆ DBInstanceClassHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::DBInstanceClassHasBeenSet ( ) const
inline

The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is enabled for this request.

Default: Uses existing setting

Definition at line 168 of file ModifyDBInstanceRequest.h.

◆ DBInstanceIdentifierHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::DBInstanceIdentifierHasBeenSet ( ) const
inline

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.

Definition at line 58 of file ModifyDBInstanceRequest.h.

◆ DBParameterGroupNameHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::DBParameterGroupNameHasBeenSet ( ) const
inline

The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. In this case, the DB instance isn't rebooted automatically and the parameter changes isn't applied during the next maintenance window.

Default: Uses existing setting

Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

Definition at line 798 of file ModifyDBInstanceRequest.h.

◆ DBPortNumberHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::DBPortNumberHasBeenSet ( ) const
inline

The port number on which the database accepts connections.

The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.

Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter.

MySQL

Default: 3306

Valid values: 1150-65535

MariaDB

Default: 3306

Valid values: 1150-65535

PostgreSQL

Default: 5432

Valid values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid values: 1150-65535

SQL Server

Default: 1433

Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156.

Amazon Aurora

Default: 3306

Valid values: 1150-65535

Definition at line 2357 of file ModifyDBInstanceRequest.h.

◆ DBSecurityGroupsHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::DBSecurityGroupsHasBeenSet ( ) const
inline

A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

  • If supplied, must match existing DBSecurityGroups.

Definition at line 384 of file ModifyDBInstanceRequest.h.

◆ DBSubnetGroupNameHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::DBSubnetGroupNameHasBeenSet ( ) const
inline

The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable ApplyImmediately.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetGroup

Definition at line 277 of file ModifyDBInstanceRequest.h.

◆ DeletionProtectionHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::DeletionProtectionHasBeenSet ( ) const
inline

A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.

Definition at line 3009 of file ModifyDBInstanceRequest.h.

◆ DomainHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::DomainHasBeenSet ( ) const
inline

The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

Definition at line 2176 of file ModifyDBInstanceRequest.h.

◆ DomainIAMRoleNameHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::DomainIAMRoleNameHasBeenSet ( ) const
inline

The name of the IAM role to use when making API calls to the Directory Service.

Definition at line 2576 of file ModifyDBInstanceRequest.h.

◆ DumpBodyToUrl()

void Aws::RDS::Model::ModifyDBInstanceRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ EnableCustomerOwnedIpHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::EnableCustomerOwnedIpHasBeenSet ( ) const
inline

A value that indicates whether to enable a customer-owned IP address (CoIP) 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.

Definition at line 3271 of file ModifyDBInstanceRequest.h.

◆ EnableIAMDatabaseAuthenticationHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::EnableIAMDatabaseAuthenticationHasBeenSet ( ) const
inline

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.

For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

Definition at line 2678 of file ModifyDBInstanceRequest.h.

◆ EnablePerformanceInsightsHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::EnablePerformanceInsightsHasBeenSet ( ) const
inline

A value that indicates whether to enable Performance Insights for the DB instance.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

Definition at line 2721 of file ModifyDBInstanceRequest.h.

◆ EngineVersionHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::EngineVersionHasBeenSet ( ) const
inline

The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.

For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

If you specify only a major version, Amazon RDS will update the DB instance to the default minor version if the current minor version is lower. For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

Definition at line 1305 of file ModifyDBInstanceRequest.h.

◆ GetAllocatedStorage()

int Aws::RDS::Model::ModifyDBInstanceRequest::GetAllocatedStorage ( ) const
inline

The new amount of storage in gibibytes (GiB) to allocate for the DB instance.

For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

For the valid values for allocated storage for each engine, see CreateDBInstance.

Definition at line 111 of file ModifyDBInstanceRequest.h.

◆ GetAllowMajorVersionUpgrade()

bool Aws::RDS::Model::ModifyDBInstanceRequest::GetAllowMajorVersionUpgrade ( ) const
inline

A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

Definition at line 1405 of file ModifyDBInstanceRequest.h.

◆ GetApplyImmediately()

bool Aws::RDS::Model::ModifyDBInstanceRequest::GetApplyImmediately ( ) const
inline

A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.

If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance in the Amazon RDS User Guide. to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to determine when the changes are applied.

Definition at line 548 of file ModifyDBInstanceRequest.h.

◆ GetAutoMinorVersionUpgrade()

bool Aws::RDS::Model::ModifyDBInstanceRequest::GetAutoMinorVersionUpgrade ( ) const
inline

A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage results if this parameter is enabled during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.

Definition at line 1443 of file ModifyDBInstanceRequest.h.

◆ GetAwsBackupRecoveryPointArn()

const Aws::String& Aws::RDS::Model::ModifyDBInstanceRequest::GetAwsBackupRecoveryPointArn ( ) const
inline

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

Definition at line 3308 of file ModifyDBInstanceRequest.h.

◆ GetBackupRetentionPeriod()

int Aws::RDS::Model::ModifyDBInstanceRequest::GetBackupRetentionPeriod ( ) const
inline

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.

These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

Amazon Aurora

Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

Constraints:

  • Must be a value from 0 to 35

  • Can be specified for a MySQL read replica only if the source is running MySQL 5.6 or later

  • Can be specified for a PostgreSQL read replica only if the source is running PostgreSQL 9.3.5

  • Can't be set to 0 if the DB instance is a source to read replicas

Definition at line 891 of file ModifyDBInstanceRequest.h.

◆ GetCACertificateIdentifier()

const Aws::String& Aws::RDS::Model::ModifyDBInstanceRequest::GetCACertificateIdentifier ( ) const
inline

Indicates the certificate that needs to be associated with the instance.

Definition at line 2118 of file ModifyDBInstanceRequest.h.

◆ GetCertificateRotationRestart()

bool Aws::RDS::Model::ModifyDBInstanceRequest::GetCertificateRotationRestart ( ) const
inline

A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate.

By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.

Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:

Definition at line 3089 of file ModifyDBInstanceRequest.h.

◆ GetCloudwatchLogsExportConfiguration()

const CloudwatchLogsExportConfiguration& Aws::RDS::Model::ModifyDBInstanceRequest::GetCloudwatchLogsExportConfiguration ( ) const
inline

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance.

A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect.

Definition at line 2871 of file ModifyDBInstanceRequest.h.

◆ GetCopyTagsToSnapshot()

bool Aws::RDS::Model::ModifyDBInstanceRequest::GetCopyTagsToSnapshot ( ) const
inline

A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

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 ModifyDBCluster.

Definition at line 2252 of file ModifyDBInstanceRequest.h.

◆ GetDBInstanceClass()

const Aws::String& Aws::RDS::Model::ModifyDBInstanceRequest::GetDBInstanceClass ( ) const
inline

The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is enabled for this request.

Default: Uses existing setting

Definition at line 155 of file ModifyDBInstanceRequest.h.

◆ GetDBInstanceIdentifier()

const Aws::String& Aws::RDS::Model::ModifyDBInstanceRequest::GetDBInstanceIdentifier ( ) const
inline

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.

Definition at line 51 of file ModifyDBInstanceRequest.h.

◆ GetDBParameterGroupName()

const Aws::String& Aws::RDS::Model::ModifyDBInstanceRequest::GetDBParameterGroupName ( ) const
inline

The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. In this case, the DB instance isn't rebooted automatically and the parameter changes isn't applied during the next maintenance window.

Default: Uses existing setting

Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

Definition at line 786 of file ModifyDBInstanceRequest.h.

◆ GetDBPortNumber()

int Aws::RDS::Model::ModifyDBInstanceRequest::GetDBPortNumber ( ) const
inline

The port number on which the database accepts connections.

The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.

Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter.

MySQL

Default: 3306

Valid values: 1150-65535

MariaDB

Default: 3306

Valid values: 1150-65535

PostgreSQL

Default: 5432

Valid values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid values: 1150-65535

SQL Server

Default: 1433

Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156.

Amazon Aurora

Default: 3306

Valid values: 1150-65535

Definition at line 2337 of file ModifyDBInstanceRequest.h.

◆ GetDBSecurityGroups()

const Aws::Vector<Aws::String>& Aws::RDS::Model::ModifyDBInstanceRequest::GetDBSecurityGroups ( ) const
inline

A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

  • If supplied, must match existing DBSecurityGroups.

Definition at line 376 of file ModifyDBInstanceRequest.h.

◆ GetDBSubnetGroupName()

const Aws::String& Aws::RDS::Model::ModifyDBInstanceRequest::GetDBSubnetGroupName ( ) const
inline

The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable ApplyImmediately.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetGroup

Definition at line 262 of file ModifyDBInstanceRequest.h.

◆ GetDeletionProtection()

bool Aws::RDS::Model::ModifyDBInstanceRequest::GetDeletionProtection ( ) const
inline

A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.

Definition at line 3000 of file ModifyDBInstanceRequest.h.

◆ GetDomain()

const Aws::String& Aws::RDS::Model::ModifyDBInstanceRequest::GetDomain ( ) const
inline

The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

Definition at line 2165 of file ModifyDBInstanceRequest.h.

◆ GetDomainIAMRoleName()

const Aws::String& Aws::RDS::Model::ModifyDBInstanceRequest::GetDomainIAMRoleName ( ) const
inline

The name of the IAM role to use when making API calls to the Directory Service.

Definition at line 2570 of file ModifyDBInstanceRequest.h.

◆ GetEnableCustomerOwnedIp()

bool Aws::RDS::Model::ModifyDBInstanceRequest::GetEnableCustomerOwnedIp ( ) const
inline

A value that indicates whether to enable a customer-owned IP address (CoIP) 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.

Definition at line 3256 of file ModifyDBInstanceRequest.h.

◆ GetEnableIAMDatabaseAuthentication()

bool Aws::RDS::Model::ModifyDBInstanceRequest::GetEnableIAMDatabaseAuthentication ( ) const
inline

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.

For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

Definition at line 2666 of file ModifyDBInstanceRequest.h.

◆ GetEnablePerformanceInsights()

bool Aws::RDS::Model::ModifyDBInstanceRequest::GetEnablePerformanceInsights ( ) const
inline

A value that indicates whether to enable Performance Insights for the DB instance.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

Definition at line 2712 of file ModifyDBInstanceRequest.h.

◆ GetEngineVersion()

const Aws::String& Aws::RDS::Model::ModifyDBInstanceRequest::GetEngineVersion ( ) const
inline

The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.

For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

If you specify only a major version, Amazon RDS will update the DB instance to the default minor version if the current minor version is lower. For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

Definition at line 1290 of file ModifyDBInstanceRequest.h.

◆ GetIops()

int Aws::RDS::Model::ModifyDBInstanceRequest::GetIops ( ) const
inline

The new Provisioned IOPS (I/O operations per second) value for the RDS instance.

Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Default: Uses existing setting

Definition at line 1557 of file ModifyDBInstanceRequest.h.

◆ GetLicenseModel()

const Aws::String& Aws::RDS::Model::ModifyDBInstanceRequest::GetLicenseModel ( ) const
inline

The license model for the DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

Definition at line 1481 of file ModifyDBInstanceRequest.h.

◆ GetMasterUserPassword()

const Aws::String& Aws::RDS::Model::ModifyDBInstanceRequest::GetMasterUserPassword ( ) const
inline

The new password for the master user. The password can include any printable ASCII character except "/", """, or "".

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.

Definition at line 619 of file ModifyDBInstanceRequest.h.

◆ GetMaxAllocatedStorage()

int Aws::RDS::Model::ModifyDBInstanceRequest::GetMaxAllocatedStorage ( ) const
inline

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.

Definition at line 3038 of file ModifyDBInstanceRequest.h.

◆ GetMonitoringInterval()

int Aws::RDS::Model::ModifyDBInstanceRequest::GetMonitoringInterval ( ) const
inline

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

Definition at line 2289 of file ModifyDBInstanceRequest.h.

◆ GetMonitoringRoleArn()

const Aws::String& Aws::RDS::Model::ModifyDBInstanceRequest::GetMonitoringRoleArn ( ) const
inline

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

Definition at line 2479 of file ModifyDBInstanceRequest.h.

◆ GetMultiAZ()

bool Aws::RDS::Model::ModifyDBInstanceRequest::GetMultiAZ ( ) const
inline

A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.

Definition at line 1250 of file ModifyDBInstanceRequest.h.

◆ GetNewDBInstanceIdentifier()

const Aws::String& Aws::RDS::Model::ModifyDBInstanceRequest::GetNewDBInstanceIdentifier ( ) const
inline

The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

Definition at line 1761 of file ModifyDBInstanceRequest.h.

◆ GetOptionGroupName()

const Aws::String& Aws::RDS::Model::ModifyDBInstanceRequest::GetOptionGroupName ( ) const
inline

A value that indicates the DB instance should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

Definition at line 1650 of file ModifyDBInstanceRequest.h.

◆ GetPerformanceInsightsKMSKeyId()

const Aws::String& Aws::RDS::Model::ModifyDBInstanceRequest::GetPerformanceInsightsKMSKeyId ( ) const
inline

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).

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default CMK. There is a default CMK for your Amazon Web Services account. Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region.

Definition at line 2752 of file ModifyDBInstanceRequest.h.

◆ GetPerformanceInsightsRetentionPeriod()

int Aws::RDS::Model::ModifyDBInstanceRequest::GetPerformanceInsightsRetentionPeriod ( ) const
inline

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

Definition at line 2843 of file ModifyDBInstanceRequest.h.

◆ GetPreferredBackupWindow()

const Aws::String& Aws::RDS::Model::ModifyDBInstanceRequest::GetPreferredBackupWindow ( ) const
inline

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

  • Must be in the format hh24:mi-hh24:mi

  • Must be in Universal Time Coordinated (UTC)

  • Must not conflict with the preferred maintenance window

  • Must be at least 30 minutes

Definition at line 970 of file ModifyDBInstanceRequest.h.

◆ GetPreferredMaintenanceWindow()

const Aws::String& Aws::RDS::Model::ModifyDBInstanceRequest::GetPreferredMaintenanceWindow ( ) const
inline

The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.

Default: Uses existing setting

Format: ddd:hh24:mi-ddd:hh24:mi

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

Definition at line 1115 of file ModifyDBInstanceRequest.h.

◆ GetProcessorFeatures()

const Aws::Vector<ProcessorFeature>& Aws::RDS::Model::ModifyDBInstanceRequest::GetProcessorFeatures ( ) const
inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Definition at line 2923 of file ModifyDBInstanceRequest.h.

◆ GetPromotionTier()

int Aws::RDS::Model::ModifyDBInstanceRequest::GetPromotionTier ( ) const
inline

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.

Default: 1

Valid Values: 0 - 15

Definition at line 2623 of file ModifyDBInstanceRequest.h.

◆ GetPubliclyAccessible()

bool Aws::RDS::Model::ModifyDBInstanceRequest::GetPubliclyAccessible ( ) const
inline

A value that indicates whether the DB instance is publicly accessible.

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.

PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.

Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.

Definition at line 2415 of file ModifyDBInstanceRequest.h.

◆ GetReplicaMode()

const ReplicaMode& Aws::RDS::Model::ModifyDBInstanceRequest::GetReplicaMode ( ) const
inline

A value that sets the open mode of a replica database to either mounted or read-only.

Currently, this parameter is only supported for Oracle DB instances.

Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

Definition at line 3165 of file ModifyDBInstanceRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::RDS::Model::ModifyDBInstanceRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file ModifyDBInstanceRequest.h.

◆ GetStorageType()

const Aws::String& Aws::RDS::Model::ModifyDBInstanceRequest::GetStorageType ( ) const
inline

Specifies the storage type to be associated with the DB instance.

If you specify Provisioned IOPS (io1), you must also include a value for the Iops parameter.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.

Valid values: standard | gp2 | io1

Default: io1 if the Iops parameter is specified, otherwise gp2

Definition at line 1867 of file ModifyDBInstanceRequest.h.

◆ GetTdeCredentialArn()

const Aws::String& Aws::RDS::Model::ModifyDBInstanceRequest::GetTdeCredentialArn ( ) const
inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 2021 of file ModifyDBInstanceRequest.h.

◆ GetTdeCredentialPassword()

const Aws::String& Aws::RDS::Model::ModifyDBInstanceRequest::GetTdeCredentialPassword ( ) const
inline

The password for the given ARN from the key store in order to access the device.

Definition at line 2070 of file ModifyDBInstanceRequest.h.

◆ GetUseDefaultProcessorFeatures()

bool Aws::RDS::Model::ModifyDBInstanceRequest::GetUseDefaultProcessorFeatures ( ) const
inline

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

Definition at line 2972 of file ModifyDBInstanceRequest.h.

◆ GetVpcSecurityGroupIds()

const Aws::Vector<Aws::String>& Aws::RDS::Model::ModifyDBInstanceRequest::GetVpcSecurityGroupIds ( ) const
inline

A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

  • If supplied, must match existing VpcSecurityGroupIds.

Definition at line 451 of file ModifyDBInstanceRequest.h.

◆ IopsHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::IopsHasBeenSet ( ) const
inline

The new Provisioned IOPS (I/O operations per second) value for the RDS instance.

Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Default: Uses existing setting

Definition at line 1583 of file ModifyDBInstanceRequest.h.

◆ LicenseModelHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::LicenseModelHasBeenSet ( ) const
inline

The license model for the DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

Definition at line 1488 of file ModifyDBInstanceRequest.h.

◆ MasterUserPasswordHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::MasterUserPasswordHasBeenSet ( ) const
inline

The new password for the master user. The password can include any printable ASCII character except "/", """, or "".

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.

Definition at line 641 of file ModifyDBInstanceRequest.h.

◆ MaxAllocatedStorageHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::MaxAllocatedStorageHasBeenSet ( ) const
inline

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.

Definition at line 3048 of file ModifyDBInstanceRequest.h.

◆ MonitoringIntervalHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::MonitoringIntervalHasBeenSet ( ) const
inline

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

Definition at line 2298 of file ModifyDBInstanceRequest.h.

◆ MonitoringRoleArnHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::MonitoringRoleArnHasBeenSet ( ) const
inline

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

Definition at line 2491 of file ModifyDBInstanceRequest.h.

◆ MultiAZHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::MultiAZHasBeenSet ( ) const
inline

A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.

Definition at line 1258 of file ModifyDBInstanceRequest.h.

◆ NewDBInstanceIdentifierHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::NewDBInstanceIdentifierHasBeenSet ( ) const
inline

The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

Definition at line 1773 of file ModifyDBInstanceRequest.h.

◆ OptionGroupNameHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::OptionGroupNameHasBeenSet ( ) const
inline

A value that indicates the DB instance should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

Definition at line 1664 of file ModifyDBInstanceRequest.h.

◆ PerformanceInsightsKMSKeyIdHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::PerformanceInsightsKMSKeyIdHasBeenSet ( ) const
inline

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).

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default CMK. There is a default CMK for your Amazon Web Services account. Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region.

Definition at line 2764 of file ModifyDBInstanceRequest.h.

◆ PerformanceInsightsRetentionPeriodHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::PerformanceInsightsRetentionPeriodHasBeenSet ( ) const
inline

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

Definition at line 2849 of file ModifyDBInstanceRequest.h.

◆ PreferredBackupWindowHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::PreferredBackupWindowHasBeenSet ( ) const
inline

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

  • Must be in the format hh24:mi-hh24:mi

  • Must be in Universal Time Coordinated (UTC)

  • Must not conflict with the preferred maintenance window

  • Must be at least 30 minutes

Definition at line 988 of file ModifyDBInstanceRequest.h.

◆ PreferredMaintenanceWindowHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::PreferredMaintenanceWindowHasBeenSet ( ) const
inline

The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.

Default: Uses existing setting

Format: ddd:hh24:mi-ddd:hh24:mi

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

Definition at line 1133 of file ModifyDBInstanceRequest.h.

◆ ProcessorFeaturesHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::ProcessorFeaturesHasBeenSet ( ) const
inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Definition at line 2929 of file ModifyDBInstanceRequest.h.

◆ PromotionTierHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::PromotionTierHasBeenSet ( ) const
inline

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.

Default: 1

Valid Values: 0 - 15

Definition at line 2633 of file ModifyDBInstanceRequest.h.

◆ PubliclyAccessibleHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::PubliclyAccessibleHasBeenSet ( ) const
inline

A value that indicates whether the DB instance is publicly accessible.

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.

PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.

Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.

Definition at line 2432 of file ModifyDBInstanceRequest.h.

◆ ReplicaModeHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::ReplicaModeHasBeenSet ( ) const
inline

A value that sets the open mode of a replica database to either mounted or read-only.

Currently, this parameter is only supported for Oracle DB instances.

Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

Definition at line 3180 of file ModifyDBInstanceRequest.h.

◆ SerializePayload()

Aws::String Aws::RDS::Model::ModifyDBInstanceRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAllocatedStorage()

void Aws::RDS::Model::ModifyDBInstanceRequest::SetAllocatedStorage ( int  value)
inline

The new amount of storage in gibibytes (GiB) to allocate for the DB instance.

For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

For the valid values for allocated storage for each engine, see CreateDBInstance.

Definition at line 131 of file ModifyDBInstanceRequest.h.

◆ SetAllowMajorVersionUpgrade()

void Aws::RDS::Model::ModifyDBInstanceRequest::SetAllowMajorVersionUpgrade ( bool  value)
inline

A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

Definition at line 1423 of file ModifyDBInstanceRequest.h.

◆ SetApplyImmediately()

void Aws::RDS::Model::ModifyDBInstanceRequest::SetApplyImmediately ( bool  value)
inline

A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.

If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance in the Amazon RDS User Guide. to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to determine when the changes are applied.

Definition at line 580 of file ModifyDBInstanceRequest.h.

◆ SetAutoMinorVersionUpgrade()

void Aws::RDS::Model::ModifyDBInstanceRequest::SetAutoMinorVersionUpgrade ( bool  value)
inline

A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage results if this parameter is enabled during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.

Definition at line 1463 of file ModifyDBInstanceRequest.h.

◆ SetAwsBackupRecoveryPointArn() [1/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetAwsBackupRecoveryPointArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

Definition at line 3326 of file ModifyDBInstanceRequest.h.

◆ SetAwsBackupRecoveryPointArn() [2/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetAwsBackupRecoveryPointArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

Definition at line 3320 of file ModifyDBInstanceRequest.h.

◆ SetAwsBackupRecoveryPointArn() [3/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetAwsBackupRecoveryPointArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

Definition at line 3332 of file ModifyDBInstanceRequest.h.

◆ SetBackupRetentionPeriod()

void Aws::RDS::Model::ModifyDBInstanceRequest::SetBackupRetentionPeriod ( int  value)
inline

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.

These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

Amazon Aurora

Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

Constraints:

  • Must be a value from 0 to 35

  • Can be specified for a MySQL read replica only if the source is running MySQL 5.6 or later

  • Can be specified for a PostgreSQL read replica only if the source is running PostgreSQL 9.3.5

  • Can't be set to 0 if the DB instance is a source to read replicas

Definition at line 931 of file ModifyDBInstanceRequest.h.

◆ SetCACertificateIdentifier() [1/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetCACertificateIdentifier ( Aws::String &&  value)
inline

Indicates the certificate that needs to be associated with the instance.

Definition at line 2133 of file ModifyDBInstanceRequest.h.

◆ SetCACertificateIdentifier() [2/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetCACertificateIdentifier ( const Aws::String value)
inline

Indicates the certificate that needs to be associated with the instance.

Definition at line 2128 of file ModifyDBInstanceRequest.h.

◆ SetCACertificateIdentifier() [3/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetCACertificateIdentifier ( const char *  value)
inline

Indicates the certificate that needs to be associated with the instance.

Definition at line 2138 of file ModifyDBInstanceRequest.h.

◆ SetCertificateRotationRestart()

void Aws::RDS::Model::ModifyDBInstanceRequest::SetCertificateRotationRestart ( bool  value)
inline

A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate.

By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.

Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:

Definition at line 3129 of file ModifyDBInstanceRequest.h.

◆ SetCloudwatchLogsExportConfiguration() [1/2]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetCloudwatchLogsExportConfiguration ( CloudwatchLogsExportConfiguration &&  value)
inline

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance.

A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect.

Definition at line 2898 of file ModifyDBInstanceRequest.h.

◆ SetCloudwatchLogsExportConfiguration() [2/2]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetCloudwatchLogsExportConfiguration ( const CloudwatchLogsExportConfiguration value)
inline

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance.

A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect.

Definition at line 2889 of file ModifyDBInstanceRequest.h.

◆ SetCopyTagsToSnapshot()

void Aws::RDS::Model::ModifyDBInstanceRequest::SetCopyTagsToSnapshot ( bool  value)
inline

A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

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 ModifyDBCluster.

Definition at line 2270 of file ModifyDBInstanceRequest.h.

◆ SetDBInstanceClass() [1/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetDBInstanceClass ( Aws::String &&  value)
inline

The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is enabled for this request.

Default: Uses existing setting

Definition at line 194 of file ModifyDBInstanceRequest.h.

◆ SetDBInstanceClass() [2/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetDBInstanceClass ( const Aws::String value)
inline

The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is enabled for this request.

Default: Uses existing setting

Definition at line 181 of file ModifyDBInstanceRequest.h.

◆ SetDBInstanceClass() [3/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetDBInstanceClass ( const char *  value)
inline

The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is enabled for this request.

Default: Uses existing setting

Definition at line 207 of file ModifyDBInstanceRequest.h.

◆ SetDBInstanceIdentifier() [1/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetDBInstanceIdentifier ( Aws::String &&  value)
inline

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.

Definition at line 72 of file ModifyDBInstanceRequest.h.

◆ SetDBInstanceIdentifier() [2/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetDBInstanceIdentifier ( const Aws::String value)
inline

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.

Definition at line 65 of file ModifyDBInstanceRequest.h.

◆ SetDBInstanceIdentifier() [3/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetDBInstanceIdentifier ( const char *  value)
inline

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.

Definition at line 79 of file ModifyDBInstanceRequest.h.

◆ SetDBParameterGroupName() [1/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetDBParameterGroupName ( Aws::String &&  value)
inline

The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. In this case, the DB instance isn't rebooted automatically and the parameter changes isn't applied during the next maintenance window.

Default: Uses existing setting

Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

Definition at line 822 of file ModifyDBInstanceRequest.h.

◆ SetDBParameterGroupName() [2/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetDBParameterGroupName ( const Aws::String value)
inline

The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. In this case, the DB instance isn't rebooted automatically and the parameter changes isn't applied during the next maintenance window.

Default: Uses existing setting

Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

Definition at line 810 of file ModifyDBInstanceRequest.h.

◆ SetDBParameterGroupName() [3/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetDBParameterGroupName ( const char *  value)
inline

The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. In this case, the DB instance isn't rebooted automatically and the parameter changes isn't applied during the next maintenance window.

Default: Uses existing setting

Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

Definition at line 834 of file ModifyDBInstanceRequest.h.

◆ SetDBPortNumber()

void Aws::RDS::Model::ModifyDBInstanceRequest::SetDBPortNumber ( int  value)
inline

The port number on which the database accepts connections.

The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.

Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter.

MySQL

Default: 3306

Valid values: 1150-65535

MariaDB

Default: 3306

Valid values: 1150-65535

PostgreSQL

Default: 5432

Valid values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid values: 1150-65535

SQL Server

Default: 1433

Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156.

Amazon Aurora

Default: 3306

Valid values: 1150-65535

Definition at line 2377 of file ModifyDBInstanceRequest.h.

◆ SetDBSecurityGroups() [1/2]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetDBSecurityGroups ( Aws::Vector< Aws::String > &&  value)
inline

A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

  • If supplied, must match existing DBSecurityGroups.

Definition at line 400 of file ModifyDBInstanceRequest.h.

◆ SetDBSecurityGroups() [2/2]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetDBSecurityGroups ( const Aws::Vector< Aws::String > &  value)
inline

A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

  • If supplied, must match existing DBSecurityGroups.

Definition at line 392 of file ModifyDBInstanceRequest.h.

◆ SetDBSubnetGroupName() [1/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetDBSubnetGroupName ( Aws::String &&  value)
inline

The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable ApplyImmediately.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetGroup

Definition at line 307 of file ModifyDBInstanceRequest.h.

◆ SetDBSubnetGroupName() [2/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetDBSubnetGroupName ( const Aws::String value)
inline

The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable ApplyImmediately.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetGroup

Definition at line 292 of file ModifyDBInstanceRequest.h.

◆ SetDBSubnetGroupName() [3/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetDBSubnetGroupName ( const char *  value)
inline

The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable ApplyImmediately.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetGroup

Definition at line 322 of file ModifyDBInstanceRequest.h.

◆ SetDeletionProtection()

void Aws::RDS::Model::ModifyDBInstanceRequest::SetDeletionProtection ( bool  value)
inline

A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.

Definition at line 3018 of file ModifyDBInstanceRequest.h.

◆ SetDomain() [1/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetDomain ( Aws::String &&  value)
inline

The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

Definition at line 2198 of file ModifyDBInstanceRequest.h.

◆ SetDomain() [2/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetDomain ( const Aws::String value)
inline

The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

Definition at line 2187 of file ModifyDBInstanceRequest.h.

◆ SetDomain() [3/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetDomain ( const char *  value)
inline

The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

Definition at line 2209 of file ModifyDBInstanceRequest.h.

◆ SetDomainIAMRoleName() [1/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetDomainIAMRoleName ( Aws::String &&  value)
inline

The name of the IAM role to use when making API calls to the Directory Service.

Definition at line 2588 of file ModifyDBInstanceRequest.h.

◆ SetDomainIAMRoleName() [2/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetDomainIAMRoleName ( const Aws::String value)
inline

The name of the IAM role to use when making API calls to the Directory Service.

Definition at line 2582 of file ModifyDBInstanceRequest.h.

◆ SetDomainIAMRoleName() [3/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetDomainIAMRoleName ( const char *  value)
inline

The name of the IAM role to use when making API calls to the Directory Service.

Definition at line 2594 of file ModifyDBInstanceRequest.h.

◆ SetEnableCustomerOwnedIp()

void Aws::RDS::Model::ModifyDBInstanceRequest::SetEnableCustomerOwnedIp ( bool  value)
inline

A value that indicates whether to enable a customer-owned IP address (CoIP) 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.

Definition at line 3286 of file ModifyDBInstanceRequest.h.

◆ SetEnableIAMDatabaseAuthentication()

void Aws::RDS::Model::ModifyDBInstanceRequest::SetEnableIAMDatabaseAuthentication ( bool  value)
inline

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.

For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

Definition at line 2690 of file ModifyDBInstanceRequest.h.

◆ SetEnablePerformanceInsights()

void Aws::RDS::Model::ModifyDBInstanceRequest::SetEnablePerformanceInsights ( bool  value)
inline

A value that indicates whether to enable Performance Insights for the DB instance.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

Definition at line 2730 of file ModifyDBInstanceRequest.h.

◆ SetEngineVersion() [1/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetEngineVersion ( Aws::String &&  value)
inline

The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.

For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

If you specify only a major version, Amazon RDS will update the DB instance to the default minor version if the current minor version is lower. For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

Definition at line 1335 of file ModifyDBInstanceRequest.h.

◆ SetEngineVersion() [2/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetEngineVersion ( const Aws::String value)
inline

The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.

For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

If you specify only a major version, Amazon RDS will update the DB instance to the default minor version if the current minor version is lower. For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

Definition at line 1320 of file ModifyDBInstanceRequest.h.

◆ SetEngineVersion() [3/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetEngineVersion ( const char *  value)
inline

The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.

For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

If you specify only a major version, Amazon RDS will update the DB instance to the default minor version if the current minor version is lower. For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

Definition at line 1350 of file ModifyDBInstanceRequest.h.

◆ SetIops()

void Aws::RDS::Model::ModifyDBInstanceRequest::SetIops ( int  value)
inline

The new Provisioned IOPS (I/O operations per second) value for the RDS instance.

Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Default: Uses existing setting

Definition at line 1609 of file ModifyDBInstanceRequest.h.

◆ SetLicenseModel() [1/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetLicenseModel ( Aws::String &&  value)
inline

The license model for the DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

Definition at line 1502 of file ModifyDBInstanceRequest.h.

◆ SetLicenseModel() [2/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetLicenseModel ( const Aws::String value)
inline

The license model for the DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

Definition at line 1495 of file ModifyDBInstanceRequest.h.

◆ SetLicenseModel() [3/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetLicenseModel ( const char *  value)
inline

The license model for the DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

Definition at line 1509 of file ModifyDBInstanceRequest.h.

◆ SetMasterUserPassword() [1/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetMasterUserPassword ( Aws::String &&  value)
inline

The new password for the master user. The password can include any printable ASCII character except "/", """, or "".

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.

Definition at line 685 of file ModifyDBInstanceRequest.h.

◆ SetMasterUserPassword() [2/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetMasterUserPassword ( const Aws::String value)
inline

The new password for the master user. The password can include any printable ASCII character except "/", """, or "".

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.

Definition at line 663 of file ModifyDBInstanceRequest.h.

◆ SetMasterUserPassword() [3/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetMasterUserPassword ( const char *  value)
inline

The new password for the master user. The password can include any printable ASCII character except "/", """, or "".

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.

Definition at line 707 of file ModifyDBInstanceRequest.h.

◆ SetMaxAllocatedStorage()

void Aws::RDS::Model::ModifyDBInstanceRequest::SetMaxAllocatedStorage ( int  value)
inline

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.

Definition at line 3058 of file ModifyDBInstanceRequest.h.

◆ SetMonitoringInterval()

void Aws::RDS::Model::ModifyDBInstanceRequest::SetMonitoringInterval ( int  value)
inline

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

Definition at line 2307 of file ModifyDBInstanceRequest.h.

◆ SetMonitoringRoleArn() [1/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetMonitoringRoleArn ( Aws::String &&  value)
inline

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

Definition at line 2515 of file ModifyDBInstanceRequest.h.

◆ SetMonitoringRoleArn() [2/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetMonitoringRoleArn ( const Aws::String value)
inline

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

Definition at line 2503 of file ModifyDBInstanceRequest.h.

◆ SetMonitoringRoleArn() [3/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetMonitoringRoleArn ( const char *  value)
inline

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

Definition at line 2527 of file ModifyDBInstanceRequest.h.

◆ SetMultiAZ()

void Aws::RDS::Model::ModifyDBInstanceRequest::SetMultiAZ ( bool  value)
inline

A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.

Definition at line 1266 of file ModifyDBInstanceRequest.h.

◆ SetNewDBInstanceIdentifier() [1/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetNewDBInstanceIdentifier ( Aws::String &&  value)
inline

The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

Definition at line 1797 of file ModifyDBInstanceRequest.h.

◆ SetNewDBInstanceIdentifier() [2/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetNewDBInstanceIdentifier ( const Aws::String value)
inline

The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

Definition at line 1785 of file ModifyDBInstanceRequest.h.

◆ SetNewDBInstanceIdentifier() [3/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetNewDBInstanceIdentifier ( const char *  value)
inline

The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

Definition at line 1809 of file ModifyDBInstanceRequest.h.

◆ SetOptionGroupName() [1/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetOptionGroupName ( Aws::String &&  value)
inline

A value that indicates the DB instance should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

Definition at line 1692 of file ModifyDBInstanceRequest.h.

◆ SetOptionGroupName() [2/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetOptionGroupName ( const Aws::String value)
inline

A value that indicates the DB instance should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

Definition at line 1678 of file ModifyDBInstanceRequest.h.

◆ SetOptionGroupName() [3/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetOptionGroupName ( const char *  value)
inline

A value that indicates the DB instance should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

Definition at line 1706 of file ModifyDBInstanceRequest.h.

◆ SetPerformanceInsightsKMSKeyId() [1/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetPerformanceInsightsKMSKeyId ( Aws::String &&  value)
inline

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).

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default CMK. There is a default CMK for your Amazon Web Services account. Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region.

Definition at line 2788 of file ModifyDBInstanceRequest.h.

◆ SetPerformanceInsightsKMSKeyId() [2/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetPerformanceInsightsKMSKeyId ( const Aws::String value)
inline

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).

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default CMK. There is a default CMK for your Amazon Web Services account. Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region.

Definition at line 2776 of file ModifyDBInstanceRequest.h.

◆ SetPerformanceInsightsKMSKeyId() [3/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetPerformanceInsightsKMSKeyId ( const char *  value)
inline

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).

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default CMK. There is a default CMK for your Amazon Web Services account. Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region.

Definition at line 2800 of file ModifyDBInstanceRequest.h.

◆ SetPerformanceInsightsRetentionPeriod()

void Aws::RDS::Model::ModifyDBInstanceRequest::SetPerformanceInsightsRetentionPeriod ( int  value)
inline

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

Definition at line 2855 of file ModifyDBInstanceRequest.h.

◆ SetPreferredBackupWindow() [1/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetPreferredBackupWindow ( Aws::String &&  value)
inline

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

  • Must be in the format hh24:mi-hh24:mi

  • Must be in Universal Time Coordinated (UTC)

  • Must not conflict with the preferred maintenance window

  • Must be at least 30 minutes

Definition at line 1024 of file ModifyDBInstanceRequest.h.

◆ SetPreferredBackupWindow() [2/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetPreferredBackupWindow ( const Aws::String value)
inline

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

  • Must be in the format hh24:mi-hh24:mi

  • Must be in Universal Time Coordinated (UTC)

  • Must not conflict with the preferred maintenance window

  • Must be at least 30 minutes

Definition at line 1006 of file ModifyDBInstanceRequest.h.

◆ SetPreferredBackupWindow() [3/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetPreferredBackupWindow ( const char *  value)
inline

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

  • Must be in the format hh24:mi-hh24:mi

  • Must be in Universal Time Coordinated (UTC)

  • Must not conflict with the preferred maintenance window

  • Must be at least 30 minutes

Definition at line 1042 of file ModifyDBInstanceRequest.h.

◆ SetPreferredMaintenanceWindow() [1/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetPreferredMaintenanceWindow ( Aws::String &&  value)
inline

The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.

Default: Uses existing setting

Format: ddd:hh24:mi-ddd:hh24:mi

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

Definition at line 1169 of file ModifyDBInstanceRequest.h.

◆ SetPreferredMaintenanceWindow() [2/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetPreferredMaintenanceWindow ( const Aws::String value)
inline

The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.

Default: Uses existing setting

Format: ddd:hh24:mi-ddd:hh24:mi

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

Definition at line 1151 of file ModifyDBInstanceRequest.h.

◆ SetPreferredMaintenanceWindow() [3/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetPreferredMaintenanceWindow ( const char *  value)
inline

The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.

Default: Uses existing setting

Format: ddd:hh24:mi-ddd:hh24:mi

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

Definition at line 1187 of file ModifyDBInstanceRequest.h.

◆ SetProcessorFeatures() [1/2]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetProcessorFeatures ( Aws::Vector< ProcessorFeature > &&  value)
inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Definition at line 2941 of file ModifyDBInstanceRequest.h.

◆ SetProcessorFeatures() [2/2]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetProcessorFeatures ( const Aws::Vector< ProcessorFeature > &  value)
inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Definition at line 2935 of file ModifyDBInstanceRequest.h.

◆ SetPromotionTier()

void Aws::RDS::Model::ModifyDBInstanceRequest::SetPromotionTier ( int  value)
inline

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.

Default: 1

Valid Values: 0 - 15

Definition at line 2643 of file ModifyDBInstanceRequest.h.

◆ SetPubliclyAccessible()

void Aws::RDS::Model::ModifyDBInstanceRequest::SetPubliclyAccessible ( bool  value)
inline

A value that indicates whether the DB instance is publicly accessible.

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.

PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.

Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.

Definition at line 2449 of file ModifyDBInstanceRequest.h.

◆ SetReplicaMode() [1/2]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetReplicaMode ( const ReplicaMode value)
inline

A value that sets the open mode of a replica database to either mounted or read-only.

Currently, this parameter is only supported for Oracle DB instances.

Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

Definition at line 3195 of file ModifyDBInstanceRequest.h.

◆ SetReplicaMode() [2/2]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetReplicaMode ( ReplicaMode &&  value)
inline

A value that sets the open mode of a replica database to either mounted or read-only.

Currently, this parameter is only supported for Oracle DB instances.

Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

Definition at line 3210 of file ModifyDBInstanceRequest.h.

◆ SetStorageType() [1/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetStorageType ( Aws::String &&  value)
inline

Specifies the storage type to be associated with the DB instance.

If you specify Provisioned IOPS (io1), you must also include a value for the Iops parameter.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.

Valid values: standard | gp2 | io1

Default: io1 if the Iops parameter is specified, otherwise gp2

Definition at line 1930 of file ModifyDBInstanceRequest.h.

◆ SetStorageType() [2/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetStorageType ( const Aws::String value)
inline

Specifies the storage type to be associated with the DB instance.

If you specify Provisioned IOPS (io1), you must also include a value for the Iops parameter.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.

Valid values: standard | gp2 | io1

Default: io1 if the Iops parameter is specified, otherwise gp2

Definition at line 1909 of file ModifyDBInstanceRequest.h.

◆ SetStorageType() [3/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetStorageType ( const char *  value)
inline

Specifies the storage type to be associated with the DB instance.

If you specify Provisioned IOPS (io1), you must also include a value for the Iops parameter.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.

Valid values: standard | gp2 | io1

Default: io1 if the Iops parameter is specified, otherwise gp2

Definition at line 1951 of file ModifyDBInstanceRequest.h.

◆ SetTdeCredentialArn() [1/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetTdeCredentialArn ( Aws::String &&  value)
inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 2039 of file ModifyDBInstanceRequest.h.

◆ SetTdeCredentialArn() [2/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetTdeCredentialArn ( const Aws::String value)
inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 2033 of file ModifyDBInstanceRequest.h.

◆ SetTdeCredentialArn() [3/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetTdeCredentialArn ( const char *  value)
inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 2045 of file ModifyDBInstanceRequest.h.

◆ SetTdeCredentialPassword() [1/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetTdeCredentialPassword ( Aws::String &&  value)
inline

The password for the given ARN from the key store in order to access the device.

Definition at line 2088 of file ModifyDBInstanceRequest.h.

◆ SetTdeCredentialPassword() [2/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetTdeCredentialPassword ( const Aws::String value)
inline

The password for the given ARN from the key store in order to access the device.

Definition at line 2082 of file ModifyDBInstanceRequest.h.

◆ SetTdeCredentialPassword() [3/3]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetTdeCredentialPassword ( const char *  value)
inline

The password for the given ARN from the key store in order to access the device.

Definition at line 2094 of file ModifyDBInstanceRequest.h.

◆ SetUseDefaultProcessorFeatures()

void Aws::RDS::Model::ModifyDBInstanceRequest::SetUseDefaultProcessorFeatures ( bool  value)
inline

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

Definition at line 2984 of file ModifyDBInstanceRequest.h.

◆ SetVpcSecurityGroupIds() [1/2]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetVpcSecurityGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

  • If supplied, must match existing VpcSecurityGroupIds.

Definition at line 481 of file ModifyDBInstanceRequest.h.

◆ SetVpcSecurityGroupIds() [2/2]

void Aws::RDS::Model::ModifyDBInstanceRequest::SetVpcSecurityGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

  • If supplied, must match existing VpcSecurityGroupIds.

Definition at line 471 of file ModifyDBInstanceRequest.h.

◆ StorageTypeHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::StorageTypeHasBeenSet ( ) const
inline

Specifies the storage type to be associated with the DB instance.

If you specify Provisioned IOPS (io1), you must also include a value for the Iops parameter.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.

Valid values: standard | gp2 | io1

Default: io1 if the Iops parameter is specified, otherwise gp2

Definition at line 1888 of file ModifyDBInstanceRequest.h.

◆ TdeCredentialArnHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::TdeCredentialArnHasBeenSet ( ) const
inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 2027 of file ModifyDBInstanceRequest.h.

◆ TdeCredentialPasswordHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::TdeCredentialPasswordHasBeenSet ( ) const
inline

The password for the given ARN from the key store in order to access the device.

Definition at line 2076 of file ModifyDBInstanceRequest.h.

◆ UseDefaultProcessorFeaturesHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::UseDefaultProcessorFeaturesHasBeenSet ( ) const
inline

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

Definition at line 2978 of file ModifyDBInstanceRequest.h.

◆ VpcSecurityGroupIdsHasBeenSet()

bool Aws::RDS::Model::ModifyDBInstanceRequest::VpcSecurityGroupIdsHasBeenSet ( ) const
inline

A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

  • If supplied, must match existing VpcSecurityGroupIds.

Definition at line 461 of file ModifyDBInstanceRequest.h.

◆ WithAllocatedStorage()

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithAllocatedStorage ( int  value)
inline

The new amount of storage in gibibytes (GiB) to allocate for the DB instance.

For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

For the valid values for allocated storage for each engine, see CreateDBInstance.

Definition at line 141 of file ModifyDBInstanceRequest.h.

◆ WithAllowMajorVersionUpgrade()

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithAllowMajorVersionUpgrade ( bool  value)
inline

A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

Definition at line 1432 of file ModifyDBInstanceRequest.h.

◆ WithApplyImmediately()

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithApplyImmediately ( bool  value)
inline

A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.

If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance in the Amazon RDS User Guide. to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to determine when the changes are applied.

Definition at line 596 of file ModifyDBInstanceRequest.h.

◆ WithAutoMinorVersionUpgrade()

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithAutoMinorVersionUpgrade ( bool  value)
inline

A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage results if this parameter is enabled during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.

Definition at line 1473 of file ModifyDBInstanceRequest.h.

◆ WithAwsBackupRecoveryPointArn() [1/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithAwsBackupRecoveryPointArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

Definition at line 3344 of file ModifyDBInstanceRequest.h.

◆ WithAwsBackupRecoveryPointArn() [2/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithAwsBackupRecoveryPointArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

Definition at line 3338 of file ModifyDBInstanceRequest.h.

◆ WithAwsBackupRecoveryPointArn() [3/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithAwsBackupRecoveryPointArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

Definition at line 3350 of file ModifyDBInstanceRequest.h.

◆ WithBackupRetentionPeriod()

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithBackupRetentionPeriod ( int  value)
inline

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.

These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

Amazon Aurora

Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

Constraints:

  • Must be a value from 0 to 35

  • Can be specified for a MySQL read replica only if the source is running MySQL 5.6 or later

  • Can be specified for a PostgreSQL read replica only if the source is running PostgreSQL 9.3.5

  • Can't be set to 0 if the DB instance is a source to read replicas

Definition at line 951 of file ModifyDBInstanceRequest.h.

◆ WithCACertificateIdentifier() [1/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithCACertificateIdentifier ( Aws::String &&  value)
inline

Indicates the certificate that needs to be associated with the instance.

Definition at line 2148 of file ModifyDBInstanceRequest.h.

◆ WithCACertificateIdentifier() [2/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithCACertificateIdentifier ( const Aws::String value)
inline

Indicates the certificate that needs to be associated with the instance.

Definition at line 2143 of file ModifyDBInstanceRequest.h.

◆ WithCACertificateIdentifier() [3/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithCACertificateIdentifier ( const char *  value)
inline

Indicates the certificate that needs to be associated with the instance.

Definition at line 2153 of file ModifyDBInstanceRequest.h.

◆ WithCertificateRotationRestart()

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithCertificateRotationRestart ( bool  value)
inline

A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate.

By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.

Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:

Definition at line 3149 of file ModifyDBInstanceRequest.h.

◆ WithCloudwatchLogsExportConfiguration() [1/2]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithCloudwatchLogsExportConfiguration ( CloudwatchLogsExportConfiguration &&  value)
inline

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance.

A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect.

Definition at line 2916 of file ModifyDBInstanceRequest.h.

◆ WithCloudwatchLogsExportConfiguration() [2/2]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithCloudwatchLogsExportConfiguration ( const CloudwatchLogsExportConfiguration value)
inline

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance.

A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect.

Definition at line 2907 of file ModifyDBInstanceRequest.h.

◆ WithCopyTagsToSnapshot()

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithCopyTagsToSnapshot ( bool  value)
inline

A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

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 ModifyDBCluster.

Definition at line 2279 of file ModifyDBInstanceRequest.h.

◆ WithDBInstanceClass() [1/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithDBInstanceClass ( Aws::String &&  value)
inline

The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is enabled for this request.

Default: Uses existing setting

Definition at line 233 of file ModifyDBInstanceRequest.h.

◆ WithDBInstanceClass() [2/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithDBInstanceClass ( const Aws::String value)
inline

The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is enabled for this request.

Default: Uses existing setting

Definition at line 220 of file ModifyDBInstanceRequest.h.

◆ WithDBInstanceClass() [3/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithDBInstanceClass ( const char *  value)
inline

The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is enabled for this request.

Default: Uses existing setting

Definition at line 246 of file ModifyDBInstanceRequest.h.

◆ WithDBInstanceIdentifier() [1/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithDBInstanceIdentifier ( Aws::String &&  value)
inline

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.

Definition at line 93 of file ModifyDBInstanceRequest.h.

◆ WithDBInstanceIdentifier() [2/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithDBInstanceIdentifier ( const Aws::String value)
inline

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.

Definition at line 86 of file ModifyDBInstanceRequest.h.

◆ WithDBInstanceIdentifier() [3/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithDBInstanceIdentifier ( const char *  value)
inline

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.

Definition at line 100 of file ModifyDBInstanceRequest.h.

◆ WithDBParameterGroupName() [1/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithDBParameterGroupName ( Aws::String &&  value)
inline

The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. In this case, the DB instance isn't rebooted automatically and the parameter changes isn't applied during the next maintenance window.

Default: Uses existing setting

Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

Definition at line 858 of file ModifyDBInstanceRequest.h.

◆ WithDBParameterGroupName() [2/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithDBParameterGroupName ( const Aws::String value)
inline

The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. In this case, the DB instance isn't rebooted automatically and the parameter changes isn't applied during the next maintenance window.

Default: Uses existing setting

Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

Definition at line 846 of file ModifyDBInstanceRequest.h.

◆ WithDBParameterGroupName() [3/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithDBParameterGroupName ( const char *  value)
inline

The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. In this case, the DB instance isn't rebooted automatically and the parameter changes isn't applied during the next maintenance window.

Default: Uses existing setting

Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

Definition at line 870 of file ModifyDBInstanceRequest.h.

◆ WithDBPortNumber()

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithDBPortNumber ( int  value)
inline

The port number on which the database accepts connections.

The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.

Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter.

MySQL

Default: 3306

Valid values: 1150-65535

MariaDB

Default: 3306

Valid values: 1150-65535

PostgreSQL

Default: 5432

Valid values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid values: 1150-65535

SQL Server

Default: 1433

Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156.

Amazon Aurora

Default: 3306

Valid values: 1150-65535

Definition at line 2397 of file ModifyDBInstanceRequest.h.

◆ WithDBSecurityGroups() [1/2]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithDBSecurityGroups ( Aws::Vector< Aws::String > &&  value)
inline

A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

  • If supplied, must match existing DBSecurityGroups.

Definition at line 416 of file ModifyDBInstanceRequest.h.

◆ WithDBSecurityGroups() [2/2]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithDBSecurityGroups ( const Aws::Vector< Aws::String > &  value)
inline

A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

  • If supplied, must match existing DBSecurityGroups.

Definition at line 408 of file ModifyDBInstanceRequest.h.

◆ WithDBSubnetGroupName() [1/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithDBSubnetGroupName ( Aws::String &&  value)
inline

The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable ApplyImmediately.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetGroup

Definition at line 352 of file ModifyDBInstanceRequest.h.

◆ WithDBSubnetGroupName() [2/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithDBSubnetGroupName ( const Aws::String value)
inline

The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable ApplyImmediately.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetGroup

Definition at line 337 of file ModifyDBInstanceRequest.h.

◆ WithDBSubnetGroupName() [3/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithDBSubnetGroupName ( const char *  value)
inline

The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable ApplyImmediately.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetGroup

Definition at line 367 of file ModifyDBInstanceRequest.h.

◆ WithDeletionProtection()

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithDeletionProtection ( bool  value)
inline

A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.

Definition at line 3027 of file ModifyDBInstanceRequest.h.

◆ WithDomain() [1/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithDomain ( Aws::String &&  value)
inline

The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

Definition at line 2231 of file ModifyDBInstanceRequest.h.

◆ WithDomain() [2/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithDomain ( const Aws::String value)
inline

The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

Definition at line 2220 of file ModifyDBInstanceRequest.h.

◆ WithDomain() [3/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithDomain ( const char *  value)
inline

The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

Definition at line 2242 of file ModifyDBInstanceRequest.h.

◆ WithDomainIAMRoleName() [1/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithDomainIAMRoleName ( Aws::String &&  value)
inline

The name of the IAM role to use when making API calls to the Directory Service.

Definition at line 2606 of file ModifyDBInstanceRequest.h.

◆ WithDomainIAMRoleName() [2/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithDomainIAMRoleName ( const Aws::String value)
inline

The name of the IAM role to use when making API calls to the Directory Service.

Definition at line 2600 of file ModifyDBInstanceRequest.h.

◆ WithDomainIAMRoleName() [3/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithDomainIAMRoleName ( const char *  value)
inline

The name of the IAM role to use when making API calls to the Directory Service.

Definition at line 2612 of file ModifyDBInstanceRequest.h.

◆ WithEnableCustomerOwnedIp()

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithEnableCustomerOwnedIp ( bool  value)
inline

A value that indicates whether to enable a customer-owned IP address (CoIP) 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.

Definition at line 3301 of file ModifyDBInstanceRequest.h.

◆ WithEnableIAMDatabaseAuthentication()

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithEnableIAMDatabaseAuthentication ( bool  value)
inline

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.

For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

Definition at line 2702 of file ModifyDBInstanceRequest.h.

◆ WithEnablePerformanceInsights()

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithEnablePerformanceInsights ( bool  value)
inline

A value that indicates whether to enable Performance Insights for the DB instance.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

Definition at line 2739 of file ModifyDBInstanceRequest.h.

◆ WithEngineVersion() [1/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithEngineVersion ( Aws::String &&  value)
inline

The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.

For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

If you specify only a major version, Amazon RDS will update the DB instance to the default minor version if the current minor version is lower. For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

Definition at line 1380 of file ModifyDBInstanceRequest.h.

◆ WithEngineVersion() [2/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithEngineVersion ( const Aws::String value)
inline

The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.

For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

If you specify only a major version, Amazon RDS will update the DB instance to the default minor version if the current minor version is lower. For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

Definition at line 1365 of file ModifyDBInstanceRequest.h.

◆ WithEngineVersion() [3/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithEngineVersion ( const char *  value)
inline

The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.

For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

If you specify only a major version, Amazon RDS will update the DB instance to the default minor version if the current minor version is lower. For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

Definition at line 1395 of file ModifyDBInstanceRequest.h.

◆ WithIops()

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithIops ( int  value)
inline

The new Provisioned IOPS (I/O operations per second) value for the RDS instance.

Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Default: Uses existing setting

Definition at line 1635 of file ModifyDBInstanceRequest.h.

◆ WithLicenseModel() [1/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithLicenseModel ( Aws::String &&  value)
inline

The license model for the DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

Definition at line 1523 of file ModifyDBInstanceRequest.h.

◆ WithLicenseModel() [2/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithLicenseModel ( const Aws::String value)
inline

The license model for the DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

Definition at line 1516 of file ModifyDBInstanceRequest.h.

◆ WithLicenseModel() [3/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithLicenseModel ( const char *  value)
inline

The license model for the DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

Definition at line 1530 of file ModifyDBInstanceRequest.h.

◆ WithMasterUserPassword() [1/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithMasterUserPassword ( Aws::String &&  value)
inline

The new password for the master user. The password can include any printable ASCII character except "/", """, or "".

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.

Definition at line 751 of file ModifyDBInstanceRequest.h.

◆ WithMasterUserPassword() [2/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithMasterUserPassword ( const Aws::String value)
inline

The new password for the master user. The password can include any printable ASCII character except "/", """, or "".

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.

Definition at line 729 of file ModifyDBInstanceRequest.h.

◆ WithMasterUserPassword() [3/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithMasterUserPassword ( const char *  value)
inline

The new password for the master user. The password can include any printable ASCII character except "/", """, or "".

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.

Definition at line 773 of file ModifyDBInstanceRequest.h.

◆ WithMaxAllocatedStorage()

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithMaxAllocatedStorage ( int  value)
inline

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.

Definition at line 3068 of file ModifyDBInstanceRequest.h.

◆ WithMonitoringInterval()

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithMonitoringInterval ( int  value)
inline

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

Definition at line 2316 of file ModifyDBInstanceRequest.h.

◆ WithMonitoringRoleArn() [1/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithMonitoringRoleArn ( Aws::String &&  value)
inline

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

Definition at line 2551 of file ModifyDBInstanceRequest.h.

◆ WithMonitoringRoleArn() [2/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithMonitoringRoleArn ( const Aws::String value)
inline

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

Definition at line 2539 of file ModifyDBInstanceRequest.h.

◆ WithMonitoringRoleArn() [3/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithMonitoringRoleArn ( const char *  value)
inline

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

Definition at line 2563 of file ModifyDBInstanceRequest.h.

◆ WithMultiAZ()

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithMultiAZ ( bool  value)
inline

A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.

Definition at line 1274 of file ModifyDBInstanceRequest.h.

◆ WithNewDBInstanceIdentifier() [1/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithNewDBInstanceIdentifier ( Aws::String &&  value)
inline

The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

Definition at line 1833 of file ModifyDBInstanceRequest.h.

◆ WithNewDBInstanceIdentifier() [2/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithNewDBInstanceIdentifier ( const Aws::String value)
inline

The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

Definition at line 1821 of file ModifyDBInstanceRequest.h.

◆ WithNewDBInstanceIdentifier() [3/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithNewDBInstanceIdentifier ( const char *  value)
inline

The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

Definition at line 1845 of file ModifyDBInstanceRequest.h.

◆ WithOptionGroupName() [1/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithOptionGroupName ( Aws::String &&  value)
inline

A value that indicates the DB instance should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

Definition at line 1734 of file ModifyDBInstanceRequest.h.

◆ WithOptionGroupName() [2/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithOptionGroupName ( const Aws::String value)
inline

A value that indicates the DB instance should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

Definition at line 1720 of file ModifyDBInstanceRequest.h.

◆ WithOptionGroupName() [3/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithOptionGroupName ( const char *  value)
inline

A value that indicates the DB instance should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

Definition at line 1748 of file ModifyDBInstanceRequest.h.

◆ WithPerformanceInsightsKMSKeyId() [1/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithPerformanceInsightsKMSKeyId ( Aws::String &&  value)
inline

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).

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default CMK. There is a default CMK for your Amazon Web Services account. Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region.

Definition at line 2824 of file ModifyDBInstanceRequest.h.

◆ WithPerformanceInsightsKMSKeyId() [2/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithPerformanceInsightsKMSKeyId ( const Aws::String value)
inline

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).

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default CMK. There is a default CMK for your Amazon Web Services account. Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region.

Definition at line 2812 of file ModifyDBInstanceRequest.h.

◆ WithPerformanceInsightsKMSKeyId() [3/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithPerformanceInsightsKMSKeyId ( const char *  value)
inline

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).

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default CMK. There is a default CMK for your Amazon Web Services account. Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region.

Definition at line 2836 of file ModifyDBInstanceRequest.h.

◆ WithPerformanceInsightsRetentionPeriod()

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithPerformanceInsightsRetentionPeriod ( int  value)
inline

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

Definition at line 2861 of file ModifyDBInstanceRequest.h.

◆ WithPreferredBackupWindow() [1/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithPreferredBackupWindow ( Aws::String &&  value)
inline

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

  • Must be in the format hh24:mi-hh24:mi

  • Must be in Universal Time Coordinated (UTC)

  • Must not conflict with the preferred maintenance window

  • Must be at least 30 minutes

Definition at line 1078 of file ModifyDBInstanceRequest.h.

◆ WithPreferredBackupWindow() [2/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithPreferredBackupWindow ( const Aws::String value)
inline

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

  • Must be in the format hh24:mi-hh24:mi

  • Must be in Universal Time Coordinated (UTC)

  • Must not conflict with the preferred maintenance window

  • Must be at least 30 minutes

Definition at line 1060 of file ModifyDBInstanceRequest.h.

◆ WithPreferredBackupWindow() [3/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithPreferredBackupWindow ( const char *  value)
inline

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

  • Must be in the format hh24:mi-hh24:mi

  • Must be in Universal Time Coordinated (UTC)

  • Must not conflict with the preferred maintenance window

  • Must be at least 30 minutes

Definition at line 1096 of file ModifyDBInstanceRequest.h.

◆ WithPreferredMaintenanceWindow() [1/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithPreferredMaintenanceWindow ( Aws::String &&  value)
inline

The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.

Default: Uses existing setting

Format: ddd:hh24:mi-ddd:hh24:mi

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

Definition at line 1223 of file ModifyDBInstanceRequest.h.

◆ WithPreferredMaintenanceWindow() [2/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithPreferredMaintenanceWindow ( const Aws::String value)
inline

The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.

Default: Uses existing setting

Format: ddd:hh24:mi-ddd:hh24:mi

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

Definition at line 1205 of file ModifyDBInstanceRequest.h.

◆ WithPreferredMaintenanceWindow() [3/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithPreferredMaintenanceWindow ( const char *  value)
inline

The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.

Default: Uses existing setting

Format: ddd:hh24:mi-ddd:hh24:mi

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

Definition at line 1241 of file ModifyDBInstanceRequest.h.

◆ WithProcessorFeatures() [1/2]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithProcessorFeatures ( Aws::Vector< ProcessorFeature > &&  value)
inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Definition at line 2953 of file ModifyDBInstanceRequest.h.

◆ WithProcessorFeatures() [2/2]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithProcessorFeatures ( const Aws::Vector< ProcessorFeature > &  value)
inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Definition at line 2947 of file ModifyDBInstanceRequest.h.

◆ WithPromotionTier()

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithPromotionTier ( int  value)
inline

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.

Default: 1

Valid Values: 0 - 15

Definition at line 2653 of file ModifyDBInstanceRequest.h.

◆ WithPubliclyAccessible()

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithPubliclyAccessible ( bool  value)
inline

A value that indicates whether the DB instance is publicly accessible.

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.

PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.

Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.

Definition at line 2466 of file ModifyDBInstanceRequest.h.

◆ WithReplicaMode() [1/2]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithReplicaMode ( const ReplicaMode value)
inline

A value that sets the open mode of a replica database to either mounted or read-only.

Currently, this parameter is only supported for Oracle DB instances.

Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

Definition at line 3225 of file ModifyDBInstanceRequest.h.

◆ WithReplicaMode() [2/2]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithReplicaMode ( ReplicaMode &&  value)
inline

A value that sets the open mode of a replica database to either mounted or read-only.

Currently, this parameter is only supported for Oracle DB instances.

Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

Definition at line 3240 of file ModifyDBInstanceRequest.h.

◆ WithStorageType() [1/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithStorageType ( Aws::String &&  value)
inline

Specifies the storage type to be associated with the DB instance.

If you specify Provisioned IOPS (io1), you must also include a value for the Iops parameter.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.

Valid values: standard | gp2 | io1

Default: io1 if the Iops parameter is specified, otherwise gp2

Definition at line 1993 of file ModifyDBInstanceRequest.h.

◆ WithStorageType() [2/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithStorageType ( const Aws::String value)
inline

Specifies the storage type to be associated with the DB instance.

If you specify Provisioned IOPS (io1), you must also include a value for the Iops parameter.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.

Valid values: standard | gp2 | io1

Default: io1 if the Iops parameter is specified, otherwise gp2

Definition at line 1972 of file ModifyDBInstanceRequest.h.

◆ WithStorageType() [3/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithStorageType ( const char *  value)
inline

Specifies the storage type to be associated with the DB instance.

If you specify Provisioned IOPS (io1), you must also include a value for the Iops parameter.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.

Valid values: standard | gp2 | io1

Default: io1 if the Iops parameter is specified, otherwise gp2

Definition at line 2014 of file ModifyDBInstanceRequest.h.

◆ WithTdeCredentialArn() [1/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithTdeCredentialArn ( Aws::String &&  value)
inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 2057 of file ModifyDBInstanceRequest.h.

◆ WithTdeCredentialArn() [2/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithTdeCredentialArn ( const Aws::String value)
inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 2051 of file ModifyDBInstanceRequest.h.

◆ WithTdeCredentialArn() [3/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithTdeCredentialArn ( const char *  value)
inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 2063 of file ModifyDBInstanceRequest.h.

◆ WithTdeCredentialPassword() [1/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithTdeCredentialPassword ( Aws::String &&  value)
inline

The password for the given ARN from the key store in order to access the device.

Definition at line 2106 of file ModifyDBInstanceRequest.h.

◆ WithTdeCredentialPassword() [2/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithTdeCredentialPassword ( const Aws::String value)
inline

The password for the given ARN from the key store in order to access the device.

Definition at line 2100 of file ModifyDBInstanceRequest.h.

◆ WithTdeCredentialPassword() [3/3]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithTdeCredentialPassword ( const char *  value)
inline

The password for the given ARN from the key store in order to access the device.

Definition at line 2112 of file ModifyDBInstanceRequest.h.

◆ WithUseDefaultProcessorFeatures()

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithUseDefaultProcessorFeatures ( bool  value)
inline

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

Definition at line 2990 of file ModifyDBInstanceRequest.h.

◆ WithVpcSecurityGroupIds() [1/2]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithVpcSecurityGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

  • If supplied, must match existing VpcSecurityGroupIds.

Definition at line 501 of file ModifyDBInstanceRequest.h.

◆ WithVpcSecurityGroupIds() [2/2]

ModifyDBInstanceRequest& Aws::RDS::Model::ModifyDBInstanceRequest::WithVpcSecurityGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

  • If supplied, must match existing VpcSecurityGroupIds.

Definition at line 491 of file ModifyDBInstanceRequest.h.


The documentation for this class was generated from the following file: