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

#include <CreateDBInstanceRequest.h>

+ Inheritance diagram for Aws::DocDB::Model::CreateDBInstanceRequest:

Public Member Functions

 CreateDBInstanceRequest ()
 
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)
 
CreateDBInstanceRequestWithDBInstanceIdentifier (const Aws::String &value)
 
CreateDBInstanceRequestWithDBInstanceIdentifier (Aws::String &&value)
 
CreateDBInstanceRequestWithDBInstanceIdentifier (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)
 
CreateDBInstanceRequestWithDBInstanceClass (const Aws::String &value)
 
CreateDBInstanceRequestWithDBInstanceClass (Aws::String &&value)
 
CreateDBInstanceRequestWithDBInstanceClass (const char *value)
 
const Aws::StringGetEngine () const
 
bool EngineHasBeenSet () const
 
void SetEngine (const Aws::String &value)
 
void SetEngine (Aws::String &&value)
 
void SetEngine (const char *value)
 
CreateDBInstanceRequestWithEngine (const Aws::String &value)
 
CreateDBInstanceRequestWithEngine (Aws::String &&value)
 
CreateDBInstanceRequestWithEngine (const char *value)
 
const Aws::StringGetAvailabilityZone () const
 
bool AvailabilityZoneHasBeenSet () const
 
void SetAvailabilityZone (const Aws::String &value)
 
void SetAvailabilityZone (Aws::String &&value)
 
void SetAvailabilityZone (const char *value)
 
CreateDBInstanceRequestWithAvailabilityZone (const Aws::String &value)
 
CreateDBInstanceRequestWithAvailabilityZone (Aws::String &&value)
 
CreateDBInstanceRequestWithAvailabilityZone (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)
 
CreateDBInstanceRequestWithPreferredMaintenanceWindow (const Aws::String &value)
 
CreateDBInstanceRequestWithPreferredMaintenanceWindow (Aws::String &&value)
 
CreateDBInstanceRequestWithPreferredMaintenanceWindow (const char *value)
 
bool GetAutoMinorVersionUpgrade () const
 
bool AutoMinorVersionUpgradeHasBeenSet () const
 
void SetAutoMinorVersionUpgrade (bool value)
 
CreateDBInstanceRequestWithAutoMinorVersionUpgrade (bool value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateDBInstanceRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateDBInstanceRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateDBInstanceRequestAddTags (const Tag &value)
 
CreateDBInstanceRequestAddTags (Tag &&value)
 
const Aws::StringGetDBClusterIdentifier () const
 
bool DBClusterIdentifierHasBeenSet () const
 
void SetDBClusterIdentifier (const Aws::String &value)
 
void SetDBClusterIdentifier (Aws::String &&value)
 
void SetDBClusterIdentifier (const char *value)
 
CreateDBInstanceRequestWithDBClusterIdentifier (const Aws::String &value)
 
CreateDBInstanceRequestWithDBClusterIdentifier (Aws::String &&value)
 
CreateDBInstanceRequestWithDBClusterIdentifier (const char *value)
 
int GetPromotionTier () const
 
bool PromotionTierHasBeenSet () const
 
void SetPromotionTier (int value)
 
CreateDBInstanceRequestWithPromotionTier (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 CreateDBInstance.

See Also:

AWS API Reference

Definition at line 27 of file CreateDBInstanceRequest.h.

Constructor & Destructor Documentation

◆ CreateDBInstanceRequest()

Aws::DocDB::Model::CreateDBInstanceRequest::CreateDBInstanceRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

CreateDBInstanceRequest& Aws::DocDB::Model::CreateDBInstanceRequest::AddTags ( const Tag value)
inline

The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

Definition at line 419 of file CreateDBInstanceRequest.h.

◆ AddTags() [2/2]

CreateDBInstanceRequest& Aws::DocDB::Model::CreateDBInstanceRequest::AddTags ( Tag &&  value)
inline

The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

Definition at line 425 of file CreateDBInstanceRequest.h.

◆ AutoMinorVersionUpgradeHasBeenSet()

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

Indicates that minor engine upgrades are applied automatically to the instance during the maintenance window.

Default: true

Definition at line 364 of file CreateDBInstanceRequest.h.

◆ AvailabilityZoneHasBeenSet()

bool Aws::DocDB::Model::CreateDBInstanceRequest::AvailabilityZoneHasBeenSet ( ) const
inline

The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

Example: us-east-1d

Definition at line 228 of file CreateDBInstanceRequest.h.

◆ DBClusterIdentifierHasBeenSet()

bool Aws::DocDB::Model::CreateDBInstanceRequest::DBClusterIdentifierHasBeenSet ( ) const
inline

The identifier of the cluster that the instance will belong to.

Definition at line 436 of file CreateDBInstanceRequest.h.

◆ DBInstanceClassHasBeenSet()

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

The compute and memory capacity of the instance; for example, db.r5.large.

Definition at line 128 of file CreateDBInstanceRequest.h.

◆ DBInstanceIdentifierHasBeenSet()

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

The instance identifier. This parameter 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 61 of file CreateDBInstanceRequest.h.

◆ DumpBodyToUrl()

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

◆ EngineHasBeenSet()

bool Aws::DocDB::Model::CreateDBInstanceRequest::EngineHasBeenSet ( ) const
inline

The name of the database engine to be used for this instance.

Valid value: docdb

Definition at line 177 of file CreateDBInstanceRequest.h.

◆ GetAutoMinorVersionUpgrade()

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

Indicates that minor engine upgrades are applied automatically to the instance during the maintenance window.

Default: true

Definition at line 358 of file CreateDBInstanceRequest.h.

◆ GetAvailabilityZone()

const Aws::String& Aws::DocDB::Model::CreateDBInstanceRequest::GetAvailabilityZone ( ) const
inline

The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

Example: us-east-1d

Definition at line 221 of file CreateDBInstanceRequest.h.

◆ GetDBClusterIdentifier()

const Aws::String& Aws::DocDB::Model::CreateDBInstanceRequest::GetDBClusterIdentifier ( ) const
inline

The identifier of the cluster that the instance will belong to.

Definition at line 431 of file CreateDBInstanceRequest.h.

◆ GetDBInstanceClass()

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

The compute and memory capacity of the instance; for example, db.r5.large.

Definition at line 122 of file CreateDBInstanceRequest.h.

◆ GetDBInstanceIdentifier()

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

The instance identifier. This parameter 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 52 of file CreateDBInstanceRequest.h.

◆ GetEngine()

const Aws::String& Aws::DocDB::Model::CreateDBInstanceRequest::GetEngine ( ) const
inline

The name of the database engine to be used for this instance.

Valid value: docdb

Definition at line 171 of file CreateDBInstanceRequest.h.

◆ GetPreferredMaintenanceWindow()

const Aws::String& Aws::DocDB::Model::CreateDBInstanceRequest::GetPreferredMaintenanceWindow ( ) const
inline

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

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

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

Definition at line 281 of file CreateDBInstanceRequest.h.

◆ GetPromotionTier()

int Aws::DocDB::Model::CreateDBInstanceRequest::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 474 of file CreateDBInstanceRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file CreateDBInstanceRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::DocDB::Model::CreateDBInstanceRequest::GetTags ( ) const
inline

The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

Definition at line 383 of file CreateDBInstanceRequest.h.

◆ PreferredMaintenanceWindowHasBeenSet()

bool Aws::DocDB::Model::CreateDBInstanceRequest::PreferredMaintenanceWindowHasBeenSet ( ) const
inline

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

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

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

Definition at line 291 of file CreateDBInstanceRequest.h.

◆ PromotionTierHasBeenSet()

bool Aws::DocDB::Model::CreateDBInstanceRequest::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 481 of file CreateDBInstanceRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAutoMinorVersionUpgrade()

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

Indicates that minor engine upgrades are applied automatically to the instance during the maintenance window.

Default: true

Definition at line 370 of file CreateDBInstanceRequest.h.

◆ SetAvailabilityZone() [1/3]

void Aws::DocDB::Model::CreateDBInstanceRequest::SetAvailabilityZone ( const Aws::String value)
inline

The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

Example: us-east-1d

Definition at line 235 of file CreateDBInstanceRequest.h.

◆ SetAvailabilityZone() [2/3]

void Aws::DocDB::Model::CreateDBInstanceRequest::SetAvailabilityZone ( Aws::String &&  value)
inline

The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

Example: us-east-1d

Definition at line 242 of file CreateDBInstanceRequest.h.

◆ SetAvailabilityZone() [3/3]

void Aws::DocDB::Model::CreateDBInstanceRequest::SetAvailabilityZone ( const char *  value)
inline

The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

Example: us-east-1d

Definition at line 249 of file CreateDBInstanceRequest.h.

◆ SetDBClusterIdentifier() [1/3]

void Aws::DocDB::Model::CreateDBInstanceRequest::SetDBClusterIdentifier ( const Aws::String value)
inline

The identifier of the cluster that the instance will belong to.

Definition at line 441 of file CreateDBInstanceRequest.h.

◆ SetDBClusterIdentifier() [2/3]

void Aws::DocDB::Model::CreateDBInstanceRequest::SetDBClusterIdentifier ( Aws::String &&  value)
inline

The identifier of the cluster that the instance will belong to.

Definition at line 446 of file CreateDBInstanceRequest.h.

◆ SetDBClusterIdentifier() [3/3]

void Aws::DocDB::Model::CreateDBInstanceRequest::SetDBClusterIdentifier ( const char *  value)
inline

The identifier of the cluster that the instance will belong to.

Definition at line 451 of file CreateDBInstanceRequest.h.

◆ SetDBInstanceClass() [1/3]

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

The compute and memory capacity of the instance; for example, db.r5.large.

Definition at line 134 of file CreateDBInstanceRequest.h.

◆ SetDBInstanceClass() [2/3]

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

The compute and memory capacity of the instance; for example, db.r5.large.

Definition at line 140 of file CreateDBInstanceRequest.h.

◆ SetDBInstanceClass() [3/3]

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

The compute and memory capacity of the instance; for example, db.r5.large.

Definition at line 146 of file CreateDBInstanceRequest.h.

◆ SetDBInstanceIdentifier() [1/3]

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

The instance identifier. This parameter 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 70 of file CreateDBInstanceRequest.h.

◆ SetDBInstanceIdentifier() [2/3]

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

The instance identifier. This parameter 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 79 of file CreateDBInstanceRequest.h.

◆ SetDBInstanceIdentifier() [3/3]

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

The instance identifier. This parameter 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 88 of file CreateDBInstanceRequest.h.

◆ SetEngine() [1/3]

void Aws::DocDB::Model::CreateDBInstanceRequest::SetEngine ( const Aws::String value)
inline

The name of the database engine to be used for this instance.

Valid value: docdb

Definition at line 183 of file CreateDBInstanceRequest.h.

◆ SetEngine() [2/3]

void Aws::DocDB::Model::CreateDBInstanceRequest::SetEngine ( Aws::String &&  value)
inline

The name of the database engine to be used for this instance.

Valid value: docdb

Definition at line 189 of file CreateDBInstanceRequest.h.

◆ SetEngine() [3/3]

void Aws::DocDB::Model::CreateDBInstanceRequest::SetEngine ( const char *  value)
inline

The name of the database engine to be used for this instance.

Valid value: docdb

Definition at line 195 of file CreateDBInstanceRequest.h.

◆ SetPreferredMaintenanceWindow() [1/3]

void Aws::DocDB::Model::CreateDBInstanceRequest::SetPreferredMaintenanceWindow ( const Aws::String value)
inline

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

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

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

Definition at line 301 of file CreateDBInstanceRequest.h.

◆ SetPreferredMaintenanceWindow() [2/3]

void Aws::DocDB::Model::CreateDBInstanceRequest::SetPreferredMaintenanceWindow ( Aws::String &&  value)
inline

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

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

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

Definition at line 311 of file CreateDBInstanceRequest.h.

◆ SetPreferredMaintenanceWindow() [3/3]

void Aws::DocDB::Model::CreateDBInstanceRequest::SetPreferredMaintenanceWindow ( const char *  value)
inline

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

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

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

Definition at line 321 of file CreateDBInstanceRequest.h.

◆ SetPromotionTier()

void Aws::DocDB::Model::CreateDBInstanceRequest::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 488 of file CreateDBInstanceRequest.h.

◆ SetTags() [1/2]

void Aws::DocDB::Model::CreateDBInstanceRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

Definition at line 395 of file CreateDBInstanceRequest.h.

◆ SetTags() [2/2]

void Aws::DocDB::Model::CreateDBInstanceRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

Definition at line 401 of file CreateDBInstanceRequest.h.

◆ TagsHasBeenSet()

bool Aws::DocDB::Model::CreateDBInstanceRequest::TagsHasBeenSet ( ) const
inline

The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

Definition at line 389 of file CreateDBInstanceRequest.h.

◆ WithAutoMinorVersionUpgrade()

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

Indicates that minor engine upgrades are applied automatically to the instance during the maintenance window.

Default: true

Definition at line 376 of file CreateDBInstanceRequest.h.

◆ WithAvailabilityZone() [1/3]

CreateDBInstanceRequest& Aws::DocDB::Model::CreateDBInstanceRequest::WithAvailabilityZone ( const Aws::String value)
inline

The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

Example: us-east-1d

Definition at line 256 of file CreateDBInstanceRequest.h.

◆ WithAvailabilityZone() [2/3]

CreateDBInstanceRequest& Aws::DocDB::Model::CreateDBInstanceRequest::WithAvailabilityZone ( Aws::String &&  value)
inline

The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

Example: us-east-1d

Definition at line 263 of file CreateDBInstanceRequest.h.

◆ WithAvailabilityZone() [3/3]

CreateDBInstanceRequest& Aws::DocDB::Model::CreateDBInstanceRequest::WithAvailabilityZone ( const char *  value)
inline

The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

Example: us-east-1d

Definition at line 270 of file CreateDBInstanceRequest.h.

◆ WithDBClusterIdentifier() [1/3]

CreateDBInstanceRequest& Aws::DocDB::Model::CreateDBInstanceRequest::WithDBClusterIdentifier ( const Aws::String value)
inline

The identifier of the cluster that the instance will belong to.

Definition at line 456 of file CreateDBInstanceRequest.h.

◆ WithDBClusterIdentifier() [2/3]

CreateDBInstanceRequest& Aws::DocDB::Model::CreateDBInstanceRequest::WithDBClusterIdentifier ( Aws::String &&  value)
inline

The identifier of the cluster that the instance will belong to.

Definition at line 461 of file CreateDBInstanceRequest.h.

◆ WithDBClusterIdentifier() [3/3]

CreateDBInstanceRequest& Aws::DocDB::Model::CreateDBInstanceRequest::WithDBClusterIdentifier ( const char *  value)
inline

The identifier of the cluster that the instance will belong to.

Definition at line 466 of file CreateDBInstanceRequest.h.

◆ WithDBInstanceClass() [1/3]

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

The compute and memory capacity of the instance; for example, db.r5.large.

Definition at line 152 of file CreateDBInstanceRequest.h.

◆ WithDBInstanceClass() [2/3]

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

The compute and memory capacity of the instance; for example, db.r5.large.

Definition at line 158 of file CreateDBInstanceRequest.h.

◆ WithDBInstanceClass() [3/3]

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

The compute and memory capacity of the instance; for example, db.r5.large.

Definition at line 164 of file CreateDBInstanceRequest.h.

◆ WithDBInstanceIdentifier() [1/3]

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

The instance identifier. This parameter 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 97 of file CreateDBInstanceRequest.h.

◆ WithDBInstanceIdentifier() [2/3]

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

The instance identifier. This parameter 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 106 of file CreateDBInstanceRequest.h.

◆ WithDBInstanceIdentifier() [3/3]

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

The instance identifier. This parameter 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 115 of file CreateDBInstanceRequest.h.

◆ WithEngine() [1/3]

CreateDBInstanceRequest& Aws::DocDB::Model::CreateDBInstanceRequest::WithEngine ( const Aws::String value)
inline

The name of the database engine to be used for this instance.

Valid value: docdb

Definition at line 201 of file CreateDBInstanceRequest.h.

◆ WithEngine() [2/3]

CreateDBInstanceRequest& Aws::DocDB::Model::CreateDBInstanceRequest::WithEngine ( Aws::String &&  value)
inline

The name of the database engine to be used for this instance.

Valid value: docdb

Definition at line 207 of file CreateDBInstanceRequest.h.

◆ WithEngine() [3/3]

CreateDBInstanceRequest& Aws::DocDB::Model::CreateDBInstanceRequest::WithEngine ( const char *  value)
inline

The name of the database engine to be used for this instance.

Valid value: docdb

Definition at line 213 of file CreateDBInstanceRequest.h.

◆ WithPreferredMaintenanceWindow() [1/3]

CreateDBInstanceRequest& Aws::DocDB::Model::CreateDBInstanceRequest::WithPreferredMaintenanceWindow ( const Aws::String value)
inline

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

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

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

Definition at line 331 of file CreateDBInstanceRequest.h.

◆ WithPreferredMaintenanceWindow() [2/3]

CreateDBInstanceRequest& Aws::DocDB::Model::CreateDBInstanceRequest::WithPreferredMaintenanceWindow ( Aws::String &&  value)
inline

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

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

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

Definition at line 341 of file CreateDBInstanceRequest.h.

◆ WithPreferredMaintenanceWindow() [3/3]

CreateDBInstanceRequest& Aws::DocDB::Model::CreateDBInstanceRequest::WithPreferredMaintenanceWindow ( const char *  value)
inline

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

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

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

Definition at line 351 of file CreateDBInstanceRequest.h.

◆ WithPromotionTier()

CreateDBInstanceRequest& Aws::DocDB::Model::CreateDBInstanceRequest::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 495 of file CreateDBInstanceRequest.h.

◆ WithTags() [1/2]

CreateDBInstanceRequest& Aws::DocDB::Model::CreateDBInstanceRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

Definition at line 407 of file CreateDBInstanceRequest.h.

◆ WithTags() [2/2]

CreateDBInstanceRequest& Aws::DocDB::Model::CreateDBInstanceRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

Definition at line 413 of file CreateDBInstanceRequest.h.


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