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

#include <ModifyDBInstanceRequest.h>

+ Inheritance diagram for Aws::DocDB::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)
 
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)
 
bool GetApplyImmediately () const
 
bool ApplyImmediatelyHasBeenSet () const
 
void SetApplyImmediately (bool value)
 
ModifyDBInstanceRequestWithApplyImmediately (bool 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 GetAutoMinorVersionUpgrade () const
 
bool AutoMinorVersionUpgradeHasBeenSet () const
 
void SetAutoMinorVersionUpgrade (bool value)
 
ModifyDBInstanceRequestWithAutoMinorVersionUpgrade (bool 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::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)
 
int GetPromotionTier () const
 
bool PromotionTierHasBeenSet () const
 
void SetPromotionTier (int value)
 
ModifyDBInstanceRequestWithPromotionTier (int value)
 
- Public Member Functions inherited from Aws::DocDB::DocDBRequest
virtual ~DocDBRequest ()
 
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::DocDB::DocDBRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Represents the input to ModifyDBInstance.

See Also:

AWS API Reference

Definition at line 25 of file ModifyDBInstanceRequest.h.

Constructor & Destructor Documentation

◆ ModifyDBInstanceRequest()

Aws::DocDB::Model::ModifyDBInstanceRequest::ModifyDBInstanceRequest ( )

Member Function Documentation

◆ ApplyImmediatelyHasBeenSet()

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

Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the instance.

If this parameter is set to false, changes to the instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.

Default: false

Definition at line 199 of file ModifyDBInstanceRequest.h.

◆ AutoMinorVersionUpgradeHasBeenSet()

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

Indicates that minor version upgrades are applied automatically to the 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 set to true during the maintenance window, and a newer minor version is available, and Amazon DocumentDB has enabled automatic patching for that engine version.

Definition at line 363 of file ModifyDBInstanceRequest.h.

◆ CACertificateIdentifierHasBeenSet()

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

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

Definition at line 501 of file ModifyDBInstanceRequest.h.

◆ DBInstanceClassHasBeenSet()

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

The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all AWS Regions.

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

Default: Uses existing setting.

Definition at line 118 of file ModifyDBInstanceRequest.h.

◆ DBInstanceIdentifierHasBeenSet()

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

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

Constraints:

  • Must match the identifier of an existing DBInstance.

Definition at line 55 of file ModifyDBInstanceRequest.h.

◆ DumpBodyToUrl()

void Aws::DocDB::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.

◆ GetApplyImmediately()

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

Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the instance.

If this parameter is set to false, changes to the instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.

Default: false

Definition at line 189 of file ModifyDBInstanceRequest.h.

◆ GetAutoMinorVersionUpgrade()

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

Indicates that minor version upgrades are applied automatically to the 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 set to true during the maintenance window, and a newer minor version is available, and Amazon DocumentDB has enabled automatic patching for that engine version.

Definition at line 352 of file ModifyDBInstanceRequest.h.

◆ GetCACertificateIdentifier()

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

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

Definition at line 496 of file ModifyDBInstanceRequest.h.

◆ GetDBInstanceClass()

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

The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all AWS Regions.

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

Default: Uses existing setting.

Definition at line 108 of file ModifyDBInstanceRequest.h.

◆ GetDBInstanceIdentifier()

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

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

Constraints:

  • Must match the identifier of an existing DBInstance.

Definition at line 48 of file ModifyDBInstanceRequest.h.

◆ GetNewDBInstanceIdentifier()

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

The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set Apply Immediately to false. 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.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

Definition at line 399 of file ModifyDBInstanceRequest.h.

◆ GetPreferredMaintenanceWindow()

const Aws::String& Aws::DocDB::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, changing this parameter causes a reboot of the instance. If you are 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 that pending changes are applied.

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 235 of file ModifyDBInstanceRequest.h.

◆ GetPromotionTier()

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

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

Definition at line 539 of file ModifyDBInstanceRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file ModifyDBInstanceRequest.h.

◆ NewDBInstanceIdentifierHasBeenSet()

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

The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set Apply Immediately to false. 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.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

Definition at line 412 of file ModifyDBInstanceRequest.h.

◆ PreferredMaintenanceWindowHasBeenSet()

bool Aws::DocDB::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, changing this parameter causes a reboot of the instance. If you are 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 that pending changes are applied.

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 250 of file ModifyDBInstanceRequest.h.

◆ PromotionTierHasBeenSet()

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

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

Definition at line 546 of file ModifyDBInstanceRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetApplyImmediately()

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

Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the instance.

If this parameter is set to false, changes to the instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.

Default: false

Definition at line 209 of file ModifyDBInstanceRequest.h.

◆ SetAutoMinorVersionUpgrade()

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

Indicates that minor version upgrades are applied automatically to the 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 set to true during the maintenance window, and a newer minor version is available, and Amazon DocumentDB has enabled automatic patching for that engine version.

Definition at line 374 of file ModifyDBInstanceRequest.h.

◆ SetCACertificateIdentifier() [1/3]

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

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

Definition at line 506 of file ModifyDBInstanceRequest.h.

◆ SetCACertificateIdentifier() [2/3]

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

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

Definition at line 511 of file ModifyDBInstanceRequest.h.

◆ SetCACertificateIdentifier() [3/3]

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

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

Definition at line 516 of file ModifyDBInstanceRequest.h.

◆ SetDBInstanceClass() [1/3]

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

The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all AWS Regions.

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

Default: Uses existing setting.

Definition at line 128 of file ModifyDBInstanceRequest.h.

◆ SetDBInstanceClass() [2/3]

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

The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all AWS Regions.

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

Default: Uses existing setting.

Definition at line 138 of file ModifyDBInstanceRequest.h.

◆ SetDBInstanceClass() [3/3]

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

The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all AWS Regions.

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

Default: Uses existing setting.

Definition at line 148 of file ModifyDBInstanceRequest.h.

◆ SetDBInstanceIdentifier() [1/3]

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

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

Constraints:

  • Must match the identifier of an existing DBInstance.

Definition at line 62 of file ModifyDBInstanceRequest.h.

◆ SetDBInstanceIdentifier() [2/3]

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

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

Constraints:

  • Must match the identifier of an existing DBInstance.

Definition at line 69 of file ModifyDBInstanceRequest.h.

◆ SetDBInstanceIdentifier() [3/3]

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

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

Constraints:

  • Must match the identifier of an existing DBInstance.

Definition at line 76 of file ModifyDBInstanceRequest.h.

◆ SetNewDBInstanceIdentifier() [1/3]

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

The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set Apply Immediately to false. 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.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

Definition at line 425 of file ModifyDBInstanceRequest.h.

◆ SetNewDBInstanceIdentifier() [2/3]

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

The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set Apply Immediately to false. 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.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

Definition at line 438 of file ModifyDBInstanceRequest.h.

◆ SetNewDBInstanceIdentifier() [3/3]

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

The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set Apply Immediately to false. 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.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

Definition at line 451 of file ModifyDBInstanceRequest.h.

◆ SetPreferredMaintenanceWindow() [1/3]

void Aws::DocDB::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, changing this parameter causes a reboot of the instance. If you are 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 that pending changes are applied.

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 265 of file ModifyDBInstanceRequest.h.

◆ SetPreferredMaintenanceWindow() [2/3]

void Aws::DocDB::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, changing this parameter causes a reboot of the instance. If you are 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 that pending changes are applied.

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 280 of file ModifyDBInstanceRequest.h.

◆ SetPreferredMaintenanceWindow() [3/3]

void Aws::DocDB::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, changing this parameter causes a reboot of the instance. If you are 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 that pending changes are applied.

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 295 of file ModifyDBInstanceRequest.h.

◆ SetPromotionTier()

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

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

Definition at line 553 of file ModifyDBInstanceRequest.h.

◆ WithApplyImmediately()

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

Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the instance.

If this parameter is set to false, changes to the instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.

Default: false

Definition at line 219 of file ModifyDBInstanceRequest.h.

◆ WithAutoMinorVersionUpgrade()

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

Indicates that minor version upgrades are applied automatically to the 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 set to true during the maintenance window, and a newer minor version is available, and Amazon DocumentDB has enabled automatic patching for that engine version.

Definition at line 385 of file ModifyDBInstanceRequest.h.

◆ WithCACertificateIdentifier() [1/3]

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

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

Definition at line 521 of file ModifyDBInstanceRequest.h.

◆ WithCACertificateIdentifier() [2/3]

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

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

Definition at line 526 of file ModifyDBInstanceRequest.h.

◆ WithCACertificateIdentifier() [3/3]

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

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

Definition at line 531 of file ModifyDBInstanceRequest.h.

◆ WithDBInstanceClass() [1/3]

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

The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all AWS Regions.

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

Default: Uses existing setting.

Definition at line 158 of file ModifyDBInstanceRequest.h.

◆ WithDBInstanceClass() [2/3]

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

The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all AWS Regions.

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

Default: Uses existing setting.

Definition at line 168 of file ModifyDBInstanceRequest.h.

◆ WithDBInstanceClass() [3/3]

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

The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all AWS Regions.

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

Default: Uses existing setting.

Definition at line 178 of file ModifyDBInstanceRequest.h.

◆ WithDBInstanceIdentifier() [1/3]

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

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

Constraints:

  • Must match the identifier of an existing DBInstance.

Definition at line 83 of file ModifyDBInstanceRequest.h.

◆ WithDBInstanceIdentifier() [2/3]

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

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

Constraints:

  • Must match the identifier of an existing DBInstance.

Definition at line 90 of file ModifyDBInstanceRequest.h.

◆ WithDBInstanceIdentifier() [3/3]

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

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

Constraints:

  • Must match the identifier of an existing DBInstance.

Definition at line 97 of file ModifyDBInstanceRequest.h.

◆ WithNewDBInstanceIdentifier() [1/3]

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

The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set Apply Immediately to false. 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.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

Definition at line 464 of file ModifyDBInstanceRequest.h.

◆ WithNewDBInstanceIdentifier() [2/3]

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

The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set Apply Immediately to false. 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.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

Definition at line 477 of file ModifyDBInstanceRequest.h.

◆ WithNewDBInstanceIdentifier() [3/3]

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

The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set Apply Immediately to false. 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.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

Definition at line 490 of file ModifyDBInstanceRequest.h.

◆ WithPreferredMaintenanceWindow() [1/3]

ModifyDBInstanceRequest& Aws::DocDB::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, changing this parameter causes a reboot of the instance. If you are 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 that pending changes are applied.

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 310 of file ModifyDBInstanceRequest.h.

◆ WithPreferredMaintenanceWindow() [2/3]

ModifyDBInstanceRequest& Aws::DocDB::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, changing this parameter causes a reboot of the instance. If you are 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 that pending changes are applied.

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 325 of file ModifyDBInstanceRequest.h.

◆ WithPreferredMaintenanceWindow() [3/3]

ModifyDBInstanceRequest& Aws::DocDB::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, changing this parameter causes a reboot of the instance. If you are 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 that pending changes are applied.

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 340 of file ModifyDBInstanceRequest.h.

◆ WithPromotionTier()

ModifyDBInstanceRequest& Aws::DocDB::Model::ModifyDBInstanceRequest::WithPromotionTier ( int  value)
inline

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

Definition at line 560 of file ModifyDBInstanceRequest.h.


The documentation for this class was generated from the following file: