AWS SDK for C++  1.9.2
AWS SDK for C++
Public Member Functions | List of all members
Aws::Lightsail::Model::CreateRelationalDatabaseRequest Class Reference

#include <CreateRelationalDatabaseRequest.h>

+ Inheritance diagram for Aws::Lightsail::Model::CreateRelationalDatabaseRequest:

Public Member Functions

 CreateRelationalDatabaseRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetRelationalDatabaseName () const
 
bool RelationalDatabaseNameHasBeenSet () const
 
void SetRelationalDatabaseName (const Aws::String &value)
 
void SetRelationalDatabaseName (Aws::String &&value)
 
void SetRelationalDatabaseName (const char *value)
 
CreateRelationalDatabaseRequestWithRelationalDatabaseName (const Aws::String &value)
 
CreateRelationalDatabaseRequestWithRelationalDatabaseName (Aws::String &&value)
 
CreateRelationalDatabaseRequestWithRelationalDatabaseName (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)
 
CreateRelationalDatabaseRequestWithAvailabilityZone (const Aws::String &value)
 
CreateRelationalDatabaseRequestWithAvailabilityZone (Aws::String &&value)
 
CreateRelationalDatabaseRequestWithAvailabilityZone (const char *value)
 
const Aws::StringGetRelationalDatabaseBlueprintId () const
 
bool RelationalDatabaseBlueprintIdHasBeenSet () const
 
void SetRelationalDatabaseBlueprintId (const Aws::String &value)
 
void SetRelationalDatabaseBlueprintId (Aws::String &&value)
 
void SetRelationalDatabaseBlueprintId (const char *value)
 
CreateRelationalDatabaseRequestWithRelationalDatabaseBlueprintId (const Aws::String &value)
 
CreateRelationalDatabaseRequestWithRelationalDatabaseBlueprintId (Aws::String &&value)
 
CreateRelationalDatabaseRequestWithRelationalDatabaseBlueprintId (const char *value)
 
const Aws::StringGetRelationalDatabaseBundleId () const
 
bool RelationalDatabaseBundleIdHasBeenSet () const
 
void SetRelationalDatabaseBundleId (const Aws::String &value)
 
void SetRelationalDatabaseBundleId (Aws::String &&value)
 
void SetRelationalDatabaseBundleId (const char *value)
 
CreateRelationalDatabaseRequestWithRelationalDatabaseBundleId (const Aws::String &value)
 
CreateRelationalDatabaseRequestWithRelationalDatabaseBundleId (Aws::String &&value)
 
CreateRelationalDatabaseRequestWithRelationalDatabaseBundleId (const char *value)
 
const Aws::StringGetMasterDatabaseName () const
 
bool MasterDatabaseNameHasBeenSet () const
 
void SetMasterDatabaseName (const Aws::String &value)
 
void SetMasterDatabaseName (Aws::String &&value)
 
void SetMasterDatabaseName (const char *value)
 
CreateRelationalDatabaseRequestWithMasterDatabaseName (const Aws::String &value)
 
CreateRelationalDatabaseRequestWithMasterDatabaseName (Aws::String &&value)
 
CreateRelationalDatabaseRequestWithMasterDatabaseName (const char *value)
 
const Aws::StringGetMasterUsername () const
 
bool MasterUsernameHasBeenSet () const
 
void SetMasterUsername (const Aws::String &value)
 
void SetMasterUsername (Aws::String &&value)
 
void SetMasterUsername (const char *value)
 
CreateRelationalDatabaseRequestWithMasterUsername (const Aws::String &value)
 
CreateRelationalDatabaseRequestWithMasterUsername (Aws::String &&value)
 
CreateRelationalDatabaseRequestWithMasterUsername (const char *value)
 
const Aws::StringGetMasterUserPassword () const
 
bool MasterUserPasswordHasBeenSet () const
 
void SetMasterUserPassword (const Aws::String &value)
 
void SetMasterUserPassword (Aws::String &&value)
 
void SetMasterUserPassword (const char *value)
 
CreateRelationalDatabaseRequestWithMasterUserPassword (const Aws::String &value)
 
CreateRelationalDatabaseRequestWithMasterUserPassword (Aws::String &&value)
 
CreateRelationalDatabaseRequestWithMasterUserPassword (const char *value)
 
const Aws::StringGetPreferredBackupWindow () const
 
bool PreferredBackupWindowHasBeenSet () const
 
void SetPreferredBackupWindow (const Aws::String &value)
 
void SetPreferredBackupWindow (Aws::String &&value)
 
void SetPreferredBackupWindow (const char *value)
 
CreateRelationalDatabaseRequestWithPreferredBackupWindow (const Aws::String &value)
 
CreateRelationalDatabaseRequestWithPreferredBackupWindow (Aws::String &&value)
 
CreateRelationalDatabaseRequestWithPreferredBackupWindow (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)
 
CreateRelationalDatabaseRequestWithPreferredMaintenanceWindow (const Aws::String &value)
 
CreateRelationalDatabaseRequestWithPreferredMaintenanceWindow (Aws::String &&value)
 
CreateRelationalDatabaseRequestWithPreferredMaintenanceWindow (const char *value)
 
bool GetPubliclyAccessible () const
 
bool PubliclyAccessibleHasBeenSet () const
 
void SetPubliclyAccessible (bool value)
 
CreateRelationalDatabaseRequestWithPubliclyAccessible (bool value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateRelationalDatabaseRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateRelationalDatabaseRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateRelationalDatabaseRequestAddTags (const Tag &value)
 
CreateRelationalDatabaseRequestAddTags (Tag &&value)
 
- Public Member Functions inherited from Aws::Lightsail::LightsailRequest
virtual ~LightsailRequest ()
 
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
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 23 of file CreateRelationalDatabaseRequest.h.

Constructor & Destructor Documentation

◆ CreateRelationalDatabaseRequest()

Aws::Lightsail::Model::CreateRelationalDatabaseRequest::CreateRelationalDatabaseRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::AddTags ( const Tag value)
inline

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

Definition at line 1156 of file CreateRelationalDatabaseRequest.h.

◆ AddTags() [2/2]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::AddTags ( Tag &&  value)
inline

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

Definition at line 1163 of file CreateRelationalDatabaseRequest.h.

◆ AvailabilityZoneHasBeenSet()

bool Aws::Lightsail::Model::CreateRelationalDatabaseRequest::AvailabilityZoneHasBeenSet ( ) const
inline

The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.

You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request.

Definition at line 120 of file CreateRelationalDatabaseRequest.h.

◆ GetAvailabilityZone()

const Aws::String& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::GetAvailabilityZone ( ) const
inline

The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.

You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request.

Definition at line 111 of file CreateRelationalDatabaseRequest.h.

◆ GetMasterDatabaseName()

const Aws::String& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::GetMasterDatabaseName ( ) const
inline

The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, no database is created in the database resource.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).

  • Can't be a word reserved by the specified database engine.

    For more information about reserved words in MySQL, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, and MySQL 8.0.

PostgreSQL

The name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, a database named postgres is created in the database resource.

Constraints:

  • Must contain 1 to 63 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).

  • Can't be a word reserved by the specified database engine.

    For more information about reserved words in PostgreSQL, see the SQL Key Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.

Definition at line 322 of file CreateRelationalDatabaseRequest.h.

◆ GetMasterUsername()

const Aws::String& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::GetMasterUsername ( ) const
inline

The name for the master user.

MySQL

Constraints:

  • Required for MySQL.

  • Must be 1 to 16 letters or numbers. Can contain underscores.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

    For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, or MySQL 8.0.

PostgreSQL

Constraints:

  • Required for PostgreSQL.

  • Must be 1 to 63 letters or numbers. Can contain underscores.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

    For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.

Definition at line 581 of file CreateRelationalDatabaseRequest.h.

◆ GetMasterUserPassword()

const Aws::String& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::GetMasterUserPassword ( ) const
inline

The password for the master user. The password can include any printable ASCII character except "/", """, or "". It cannot contain spaces.

MySQL

Constraints: Must contain from 8 to 41 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Definition at line 780 of file CreateRelationalDatabaseRequest.h.

◆ GetPreferredBackupWindow()

const Aws::String& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::GetPreferredBackupWindow ( ) const
inline

The daily time range during which automated backups are created for your new database if automated backups are enabled.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information about the preferred backup window time blocks for each region, see the Working With Backups guide in the Amazon Relational Database Service (Amazon RDS) documentation.

Constraints:

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

    Example: 16:00-16:30

  • Specified in Coordinated Universal Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 860 of file CreateRelationalDatabaseRequest.h.

◆ GetPreferredMaintenanceWindow()

const Aws::String& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::GetPreferredMaintenanceWindow ( ) const
inline

The weekly time range during which system maintenance can occur on your new database.

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.

Constraints:

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

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

  • Must be at least 30 minutes.

  • Specified in Coordinated Universal Time (UTC).

  • Example: Tue:17:00-Tue:17:30

Definition at line 985 of file CreateRelationalDatabaseRequest.h.

◆ GetPubliclyAccessible()

bool Aws::Lightsail::Model::CreateRelationalDatabaseRequest::GetPubliclyAccessible ( ) const
inline

Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.

Definition at line 1079 of file CreateRelationalDatabaseRequest.h.

◆ GetRelationalDatabaseBlueprintId()

const Aws::String& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::GetRelationalDatabaseBlueprintId ( ) const
inline

The blueprint ID for your new database. A blueprint describes the major engine version of a database.

You can get a list of database blueprints IDs by using the get relational database blueprints operation.

Definition at line 182 of file CreateRelationalDatabaseRequest.h.

◆ GetRelationalDatabaseBundleId()

const Aws::String& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::GetRelationalDatabaseBundleId ( ) const
inline

The bundle ID for your new database. A bundle describes the performance specifications for your database.

You can get a list of database bundle IDs by using the get relational database bundles operation.

Definition at line 239 of file CreateRelationalDatabaseRequest.h.

◆ GetRelationalDatabaseName()

const Aws::String& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::GetRelationalDatabaseName ( ) const
inline

The name to use for your new Lightsail database resource.

Constraints:

  • Must contain from 2 to 255 alphanumeric characters, or hyphens.

  • The first and last character must be a letter or number.

Definition at line 45 of file CreateRelationalDatabaseRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Lightsail::Model::CreateRelationalDatabaseRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::Lightsail::LightsailRequest.

◆ GetServiceRequestName()

virtual const char* Aws::Lightsail::Model::CreateRelationalDatabaseRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file CreateRelationalDatabaseRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::GetTags ( ) const
inline

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

Definition at line 1114 of file CreateRelationalDatabaseRequest.h.

◆ MasterDatabaseNameHasBeenSet()

bool Aws::Lightsail::Model::CreateRelationalDatabaseRequest::MasterDatabaseNameHasBeenSet ( ) const
inline

The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, no database is created in the database resource.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).

  • Can't be a word reserved by the specified database engine.

    For more information about reserved words in MySQL, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, and MySQL 8.0.

PostgreSQL

The name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, a database named postgres is created in the database resource.

Constraints:

  • Must contain 1 to 63 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).

  • Can't be a word reserved by the specified database engine.

    For more information about reserved words in PostgreSQL, see the SQL Key Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.

Definition at line 355 of file CreateRelationalDatabaseRequest.h.

◆ MasterUsernameHasBeenSet()

bool Aws::Lightsail::Model::CreateRelationalDatabaseRequest::MasterUsernameHasBeenSet ( ) const
inline

The name for the master user.

MySQL

Constraints:

  • Required for MySQL.

  • Must be 1 to 16 letters or numbers. Can contain underscores.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

    For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, or MySQL 8.0.

PostgreSQL

Constraints:

  • Required for PostgreSQL.

  • Must be 1 to 63 letters or numbers. Can contain underscores.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

    For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.

Definition at line 608 of file CreateRelationalDatabaseRequest.h.

◆ MasterUserPasswordHasBeenSet()

bool Aws::Lightsail::Model::CreateRelationalDatabaseRequest::MasterUserPasswordHasBeenSet ( ) const
inline

The password for the master user. The password can include any printable ASCII character except "/", """, or "". It cannot contain spaces.

MySQL

Constraints: Must contain from 8 to 41 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Definition at line 789 of file CreateRelationalDatabaseRequest.h.

◆ PreferredBackupWindowHasBeenSet()

bool Aws::Lightsail::Model::CreateRelationalDatabaseRequest::PreferredBackupWindowHasBeenSet ( ) const
inline

The daily time range during which automated backups are created for your new database if automated backups are enabled.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information about the preferred backup window time blocks for each region, see the Working With Backups guide in the Amazon Relational Database Service (Amazon RDS) documentation.

Constraints:

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

    Example: 16:00-16:30

  • Specified in Coordinated Universal Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 876 of file CreateRelationalDatabaseRequest.h.

◆ PreferredMaintenanceWindowHasBeenSet()

bool Aws::Lightsail::Model::CreateRelationalDatabaseRequest::PreferredMaintenanceWindowHasBeenSet ( ) const
inline

The weekly time range during which system maintenance can occur on your new database.

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.

Constraints:

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

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

  • Must be at least 30 minutes.

  • Specified in Coordinated Universal Time (UTC).

  • Example: Tue:17:00-Tue:17:30

Definition at line 997 of file CreateRelationalDatabaseRequest.h.

◆ PubliclyAccessibleHasBeenSet()

bool Aws::Lightsail::Model::CreateRelationalDatabaseRequest::PubliclyAccessibleHasBeenSet ( ) const
inline

Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.

Definition at line 1088 of file CreateRelationalDatabaseRequest.h.

◆ RelationalDatabaseBlueprintIdHasBeenSet()

bool Aws::Lightsail::Model::CreateRelationalDatabaseRequest::RelationalDatabaseBlueprintIdHasBeenSet ( ) const
inline

The blueprint ID for your new database. A blueprint describes the major engine version of a database.

You can get a list of database blueprints IDs by using the get relational database blueprints operation.

Definition at line 189 of file CreateRelationalDatabaseRequest.h.

◆ RelationalDatabaseBundleIdHasBeenSet()

bool Aws::Lightsail::Model::CreateRelationalDatabaseRequest::RelationalDatabaseBundleIdHasBeenSet ( ) const
inline

The bundle ID for your new database. A bundle describes the performance specifications for your database.

You can get a list of database bundle IDs by using the get relational database bundles operation.

Definition at line 246 of file CreateRelationalDatabaseRequest.h.

◆ RelationalDatabaseNameHasBeenSet()

bool Aws::Lightsail::Model::CreateRelationalDatabaseRequest::RelationalDatabaseNameHasBeenSet ( ) const
inline

The name to use for your new Lightsail database resource.

Constraints:

  • Must contain from 2 to 255 alphanumeric characters, or hyphens.

  • The first and last character must be a letter or number.

Definition at line 53 of file CreateRelationalDatabaseRequest.h.

◆ SerializePayload()

Aws::String Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAvailabilityZone() [1/3]

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetAvailabilityZone ( Aws::String &&  value)
inline

The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.

You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request.

Definition at line 138 of file CreateRelationalDatabaseRequest.h.

◆ SetAvailabilityZone() [2/3]

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetAvailabilityZone ( const Aws::String value)
inline

The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.

You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request.

Definition at line 129 of file CreateRelationalDatabaseRequest.h.

◆ SetAvailabilityZone() [3/3]

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetAvailabilityZone ( const char *  value)
inline

The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.

You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request.

Definition at line 147 of file CreateRelationalDatabaseRequest.h.

◆ SetMasterDatabaseName() [1/3]

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetMasterDatabaseName ( Aws::String &&  value)
inline

The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, no database is created in the database resource.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).

  • Can't be a word reserved by the specified database engine.

    For more information about reserved words in MySQL, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, and MySQL 8.0.

PostgreSQL

The name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, a database named postgres is created in the database resource.

Constraints:

  • Must contain 1 to 63 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).

  • Can't be a word reserved by the specified database engine.

    For more information about reserved words in PostgreSQL, see the SQL Key Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.

Definition at line 421 of file CreateRelationalDatabaseRequest.h.

◆ SetMasterDatabaseName() [2/3]

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetMasterDatabaseName ( const Aws::String value)
inline

The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, no database is created in the database resource.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).

  • Can't be a word reserved by the specified database engine.

    For more information about reserved words in MySQL, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, and MySQL 8.0.

PostgreSQL

The name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, a database named postgres is created in the database resource.

Constraints:

  • Must contain 1 to 63 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).

  • Can't be a word reserved by the specified database engine.

    For more information about reserved words in PostgreSQL, see the SQL Key Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.

Definition at line 388 of file CreateRelationalDatabaseRequest.h.

◆ SetMasterDatabaseName() [3/3]

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetMasterDatabaseName ( const char *  value)
inline

The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, no database is created in the database resource.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).

  • Can't be a word reserved by the specified database engine.

    For more information about reserved words in MySQL, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, and MySQL 8.0.

PostgreSQL

The name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, a database named postgres is created in the database resource.

Constraints:

  • Must contain 1 to 63 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).

  • Can't be a word reserved by the specified database engine.

    For more information about reserved words in PostgreSQL, see the SQL Key Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.

Definition at line 454 of file CreateRelationalDatabaseRequest.h.

◆ SetMasterUsername() [1/3]

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetMasterUsername ( Aws::String &&  value)
inline

The name for the master user.

MySQL

Constraints:

  • Required for MySQL.

  • Must be 1 to 16 letters or numbers. Can contain underscores.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

    For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, or MySQL 8.0.

PostgreSQL

Constraints:

  • Required for PostgreSQL.

  • Must be 1 to 63 letters or numbers. Can contain underscores.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

    For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.

Definition at line 662 of file CreateRelationalDatabaseRequest.h.

◆ SetMasterUsername() [2/3]

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetMasterUsername ( const Aws::String value)
inline

The name for the master user.

MySQL

Constraints:

  • Required for MySQL.

  • Must be 1 to 16 letters or numbers. Can contain underscores.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

    For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, or MySQL 8.0.

PostgreSQL

Constraints:

  • Required for PostgreSQL.

  • Must be 1 to 63 letters or numbers. Can contain underscores.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

    For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.

Definition at line 635 of file CreateRelationalDatabaseRequest.h.

◆ SetMasterUsername() [3/3]

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetMasterUsername ( const char *  value)
inline

The name for the master user.

MySQL

Constraints:

  • Required for MySQL.

  • Must be 1 to 16 letters or numbers. Can contain underscores.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

    For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, or MySQL 8.0.

PostgreSQL

Constraints:

  • Required for PostgreSQL.

  • Must be 1 to 63 letters or numbers. Can contain underscores.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

    For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.

Definition at line 689 of file CreateRelationalDatabaseRequest.h.

◆ SetMasterUserPassword() [1/3]

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetMasterUserPassword ( Aws::String &&  value)
inline

The password for the master user. The password can include any printable ASCII character except "/", """, or "". It cannot contain spaces.

MySQL

Constraints: Must contain from 8 to 41 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Definition at line 807 of file CreateRelationalDatabaseRequest.h.

◆ SetMasterUserPassword() [2/3]

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetMasterUserPassword ( const Aws::String value)
inline

The password for the master user. The password can include any printable ASCII character except "/", """, or "". It cannot contain spaces.

MySQL

Constraints: Must contain from 8 to 41 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Definition at line 798 of file CreateRelationalDatabaseRequest.h.

◆ SetMasterUserPassword() [3/3]

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetMasterUserPassword ( const char *  value)
inline

The password for the master user. The password can include any printable ASCII character except "/", """, or "". It cannot contain spaces.

MySQL

Constraints: Must contain from 8 to 41 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Definition at line 816 of file CreateRelationalDatabaseRequest.h.

◆ SetPreferredBackupWindow() [1/3]

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetPreferredBackupWindow ( Aws::String &&  value)
inline

The daily time range during which automated backups are created for your new database if automated backups are enabled.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information about the preferred backup window time blocks for each region, see the Working With Backups guide in the Amazon Relational Database Service (Amazon RDS) documentation.

Constraints:

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

    Example: 16:00-16:30

  • Specified in Coordinated Universal Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 908 of file CreateRelationalDatabaseRequest.h.

◆ SetPreferredBackupWindow() [2/3]

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetPreferredBackupWindow ( const Aws::String value)
inline

The daily time range during which automated backups are created for your new database if automated backups are enabled.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information about the preferred backup window time blocks for each region, see the Working With Backups guide in the Amazon Relational Database Service (Amazon RDS) documentation.

Constraints:

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

    Example: 16:00-16:30

  • Specified in Coordinated Universal Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 892 of file CreateRelationalDatabaseRequest.h.

◆ SetPreferredBackupWindow() [3/3]

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetPreferredBackupWindow ( const char *  value)
inline

The daily time range during which automated backups are created for your new database if automated backups are enabled.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information about the preferred backup window time blocks for each region, see the Working With Backups guide in the Amazon Relational Database Service (Amazon RDS) documentation.

Constraints:

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

    Example: 16:00-16:30

  • Specified in Coordinated Universal Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 924 of file CreateRelationalDatabaseRequest.h.

◆ SetPreferredMaintenanceWindow() [1/3]

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetPreferredMaintenanceWindow ( Aws::String &&  value)
inline

The weekly time range during which system maintenance can occur on your new database.

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.

Constraints:

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

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

  • Must be at least 30 minutes.

  • Specified in Coordinated Universal Time (UTC).

  • Example: Tue:17:00-Tue:17:30

Definition at line 1021 of file CreateRelationalDatabaseRequest.h.

◆ SetPreferredMaintenanceWindow() [2/3]

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetPreferredMaintenanceWindow ( const Aws::String value)
inline

The weekly time range during which system maintenance can occur on your new database.

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.

Constraints:

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

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

  • Must be at least 30 minutes.

  • Specified in Coordinated Universal Time (UTC).

  • Example: Tue:17:00-Tue:17:30

Definition at line 1009 of file CreateRelationalDatabaseRequest.h.

◆ SetPreferredMaintenanceWindow() [3/3]

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetPreferredMaintenanceWindow ( const char *  value)
inline

The weekly time range during which system maintenance can occur on your new database.

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.

Constraints:

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

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

  • Must be at least 30 minutes.

  • Specified in Coordinated Universal Time (UTC).

  • Example: Tue:17:00-Tue:17:30

Definition at line 1033 of file CreateRelationalDatabaseRequest.h.

◆ SetPubliclyAccessible()

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetPubliclyAccessible ( bool  value)
inline

Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.

Definition at line 1097 of file CreateRelationalDatabaseRequest.h.

◆ SetRelationalDatabaseBlueprintId() [1/3]

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetRelationalDatabaseBlueprintId ( Aws::String &&  value)
inline

The blueprint ID for your new database. A blueprint describes the major engine version of a database.

You can get a list of database blueprints IDs by using the get relational database blueprints operation.

Definition at line 203 of file CreateRelationalDatabaseRequest.h.

◆ SetRelationalDatabaseBlueprintId() [2/3]

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetRelationalDatabaseBlueprintId ( const Aws::String value)
inline

The blueprint ID for your new database. A blueprint describes the major engine version of a database.

You can get a list of database blueprints IDs by using the get relational database blueprints operation.

Definition at line 196 of file CreateRelationalDatabaseRequest.h.

◆ SetRelationalDatabaseBlueprintId() [3/3]

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetRelationalDatabaseBlueprintId ( const char *  value)
inline

The blueprint ID for your new database. A blueprint describes the major engine version of a database.

You can get a list of database blueprints IDs by using the get relational database blueprints operation.

Definition at line 210 of file CreateRelationalDatabaseRequest.h.

◆ SetRelationalDatabaseBundleId() [1/3]

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetRelationalDatabaseBundleId ( Aws::String &&  value)
inline

The bundle ID for your new database. A bundle describes the performance specifications for your database.

You can get a list of database bundle IDs by using the get relational database bundles operation.

Definition at line 260 of file CreateRelationalDatabaseRequest.h.

◆ SetRelationalDatabaseBundleId() [2/3]

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetRelationalDatabaseBundleId ( const Aws::String value)
inline

The bundle ID for your new database. A bundle describes the performance specifications for your database.

You can get a list of database bundle IDs by using the get relational database bundles operation.

Definition at line 253 of file CreateRelationalDatabaseRequest.h.

◆ SetRelationalDatabaseBundleId() [3/3]

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetRelationalDatabaseBundleId ( const char *  value)
inline

The bundle ID for your new database. A bundle describes the performance specifications for your database.

You can get a list of database bundle IDs by using the get relational database bundles operation.

Definition at line 267 of file CreateRelationalDatabaseRequest.h.

◆ SetRelationalDatabaseName() [1/3]

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetRelationalDatabaseName ( Aws::String &&  value)
inline

The name to use for your new Lightsail database resource.

Constraints:

  • Must contain from 2 to 255 alphanumeric characters, or hyphens.

  • The first and last character must be a letter or number.

Definition at line 69 of file CreateRelationalDatabaseRequest.h.

◆ SetRelationalDatabaseName() [2/3]

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetRelationalDatabaseName ( const Aws::String value)
inline

The name to use for your new Lightsail database resource.

Constraints:

  • Must contain from 2 to 255 alphanumeric characters, or hyphens.

  • The first and last character must be a letter or number.

Definition at line 61 of file CreateRelationalDatabaseRequest.h.

◆ SetRelationalDatabaseName() [3/3]

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetRelationalDatabaseName ( const char *  value)
inline

The name to use for your new Lightsail database resource.

Constraints:

  • Must contain from 2 to 255 alphanumeric characters, or hyphens.

  • The first and last character must be a letter or number.

Definition at line 77 of file CreateRelationalDatabaseRequest.h.

◆ SetTags() [1/2]

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

Definition at line 1135 of file CreateRelationalDatabaseRequest.h.

◆ SetTags() [2/2]

void Aws::Lightsail::Model::CreateRelationalDatabaseRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

Definition at line 1128 of file CreateRelationalDatabaseRequest.h.

◆ TagsHasBeenSet()

bool Aws::Lightsail::Model::CreateRelationalDatabaseRequest::TagsHasBeenSet ( ) const
inline

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

Definition at line 1121 of file CreateRelationalDatabaseRequest.h.

◆ WithAvailabilityZone() [1/3]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithAvailabilityZone ( Aws::String &&  value)
inline

The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.

You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request.

Definition at line 165 of file CreateRelationalDatabaseRequest.h.

◆ WithAvailabilityZone() [2/3]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithAvailabilityZone ( const Aws::String value)
inline

The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.

You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request.

Definition at line 156 of file CreateRelationalDatabaseRequest.h.

◆ WithAvailabilityZone() [3/3]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithAvailabilityZone ( const char *  value)
inline

The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.

You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request.

Definition at line 174 of file CreateRelationalDatabaseRequest.h.

◆ WithMasterDatabaseName() [1/3]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithMasterDatabaseName ( Aws::String &&  value)
inline

The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, no database is created in the database resource.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).

  • Can't be a word reserved by the specified database engine.

    For more information about reserved words in MySQL, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, and MySQL 8.0.

PostgreSQL

The name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, a database named postgres is created in the database resource.

Constraints:

  • Must contain 1 to 63 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).

  • Can't be a word reserved by the specified database engine.

    For more information about reserved words in PostgreSQL, see the SQL Key Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.

Definition at line 520 of file CreateRelationalDatabaseRequest.h.

◆ WithMasterDatabaseName() [2/3]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithMasterDatabaseName ( const Aws::String value)
inline

The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, no database is created in the database resource.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).

  • Can't be a word reserved by the specified database engine.

    For more information about reserved words in MySQL, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, and MySQL 8.0.

PostgreSQL

The name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, a database named postgres is created in the database resource.

Constraints:

  • Must contain 1 to 63 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).

  • Can't be a word reserved by the specified database engine.

    For more information about reserved words in PostgreSQL, see the SQL Key Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.

Definition at line 487 of file CreateRelationalDatabaseRequest.h.

◆ WithMasterDatabaseName() [3/3]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithMasterDatabaseName ( const char *  value)
inline

The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, no database is created in the database resource.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).

  • Can't be a word reserved by the specified database engine.

    For more information about reserved words in MySQL, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, and MySQL 8.0.

PostgreSQL

The name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, a database named postgres is created in the database resource.

Constraints:

  • Must contain 1 to 63 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).

  • Can't be a word reserved by the specified database engine.

    For more information about reserved words in PostgreSQL, see the SQL Key Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.

Definition at line 553 of file CreateRelationalDatabaseRequest.h.

◆ WithMasterUsername() [1/3]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithMasterUsername ( Aws::String &&  value)
inline

The name for the master user.

MySQL

Constraints:

  • Required for MySQL.

  • Must be 1 to 16 letters or numbers. Can contain underscores.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

    For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, or MySQL 8.0.

PostgreSQL

Constraints:

  • Required for PostgreSQL.

  • Must be 1 to 63 letters or numbers. Can contain underscores.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

    For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.

Definition at line 743 of file CreateRelationalDatabaseRequest.h.

◆ WithMasterUsername() [2/3]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithMasterUsername ( const Aws::String value)
inline

The name for the master user.

MySQL

Constraints:

  • Required for MySQL.

  • Must be 1 to 16 letters or numbers. Can contain underscores.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

    For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, or MySQL 8.0.

PostgreSQL

Constraints:

  • Required for PostgreSQL.

  • Must be 1 to 63 letters or numbers. Can contain underscores.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

    For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.

Definition at line 716 of file CreateRelationalDatabaseRequest.h.

◆ WithMasterUsername() [3/3]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithMasterUsername ( const char *  value)
inline

The name for the master user.

MySQL

Constraints:

  • Required for MySQL.

  • Must be 1 to 16 letters or numbers. Can contain underscores.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

    For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, or MySQL 8.0.

PostgreSQL

Constraints:

  • Required for PostgreSQL.

  • Must be 1 to 63 letters or numbers. Can contain underscores.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

    For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.

Definition at line 770 of file CreateRelationalDatabaseRequest.h.

◆ WithMasterUserPassword() [1/3]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithMasterUserPassword ( Aws::String &&  value)
inline

The password for the master user. The password can include any printable ASCII character except "/", """, or "". It cannot contain spaces.

MySQL

Constraints: Must contain from 8 to 41 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Definition at line 834 of file CreateRelationalDatabaseRequest.h.

◆ WithMasterUserPassword() [2/3]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithMasterUserPassword ( const Aws::String value)
inline

The password for the master user. The password can include any printable ASCII character except "/", """, or "". It cannot contain spaces.

MySQL

Constraints: Must contain from 8 to 41 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Definition at line 825 of file CreateRelationalDatabaseRequest.h.

◆ WithMasterUserPassword() [3/3]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithMasterUserPassword ( const char *  value)
inline

The password for the master user. The password can include any printable ASCII character except "/", """, or "". It cannot contain spaces.

MySQL

Constraints: Must contain from 8 to 41 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Definition at line 843 of file CreateRelationalDatabaseRequest.h.

◆ WithPreferredBackupWindow() [1/3]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithPreferredBackupWindow ( Aws::String &&  value)
inline

The daily time range during which automated backups are created for your new database if automated backups are enabled.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information about the preferred backup window time blocks for each region, see the Working With Backups guide in the Amazon Relational Database Service (Amazon RDS) documentation.

Constraints:

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

    Example: 16:00-16:30

  • Specified in Coordinated Universal Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 956 of file CreateRelationalDatabaseRequest.h.

◆ WithPreferredBackupWindow() [2/3]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithPreferredBackupWindow ( const Aws::String value)
inline

The daily time range during which automated backups are created for your new database if automated backups are enabled.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information about the preferred backup window time blocks for each region, see the Working With Backups guide in the Amazon Relational Database Service (Amazon RDS) documentation.

Constraints:

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

    Example: 16:00-16:30

  • Specified in Coordinated Universal Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 940 of file CreateRelationalDatabaseRequest.h.

◆ WithPreferredBackupWindow() [3/3]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithPreferredBackupWindow ( const char *  value)
inline

The daily time range during which automated backups are created for your new database if automated backups are enabled.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information about the preferred backup window time blocks for each region, see the Working With Backups guide in the Amazon Relational Database Service (Amazon RDS) documentation.

Constraints:

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

    Example: 16:00-16:30

  • Specified in Coordinated Universal Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 972 of file CreateRelationalDatabaseRequest.h.

◆ WithPreferredMaintenanceWindow() [1/3]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithPreferredMaintenanceWindow ( Aws::String &&  value)
inline

The weekly time range during which system maintenance can occur on your new database.

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.

Constraints:

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

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

  • Must be at least 30 minutes.

  • Specified in Coordinated Universal Time (UTC).

  • Example: Tue:17:00-Tue:17:30

Definition at line 1057 of file CreateRelationalDatabaseRequest.h.

◆ WithPreferredMaintenanceWindow() [2/3]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithPreferredMaintenanceWindow ( const Aws::String value)
inline

The weekly time range during which system maintenance can occur on your new database.

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.

Constraints:

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

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

  • Must be at least 30 minutes.

  • Specified in Coordinated Universal Time (UTC).

  • Example: Tue:17:00-Tue:17:30

Definition at line 1045 of file CreateRelationalDatabaseRequest.h.

◆ WithPreferredMaintenanceWindow() [3/3]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithPreferredMaintenanceWindow ( const char *  value)
inline

The weekly time range during which system maintenance can occur on your new database.

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.

Constraints:

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

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

  • Must be at least 30 minutes.

  • Specified in Coordinated Universal Time (UTC).

  • Example: Tue:17:00-Tue:17:30

Definition at line 1069 of file CreateRelationalDatabaseRequest.h.

◆ WithPubliclyAccessible()

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithPubliclyAccessible ( bool  value)
inline

Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.

Definition at line 1106 of file CreateRelationalDatabaseRequest.h.

◆ WithRelationalDatabaseBlueprintId() [1/3]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithRelationalDatabaseBlueprintId ( Aws::String &&  value)
inline

The blueprint ID for your new database. A blueprint describes the major engine version of a database.

You can get a list of database blueprints IDs by using the get relational database blueprints operation.

Definition at line 224 of file CreateRelationalDatabaseRequest.h.

◆ WithRelationalDatabaseBlueprintId() [2/3]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithRelationalDatabaseBlueprintId ( const Aws::String value)
inline

The blueprint ID for your new database. A blueprint describes the major engine version of a database.

You can get a list of database blueprints IDs by using the get relational database blueprints operation.

Definition at line 217 of file CreateRelationalDatabaseRequest.h.

◆ WithRelationalDatabaseBlueprintId() [3/3]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithRelationalDatabaseBlueprintId ( const char *  value)
inline

The blueprint ID for your new database. A blueprint describes the major engine version of a database.

You can get a list of database blueprints IDs by using the get relational database blueprints operation.

Definition at line 231 of file CreateRelationalDatabaseRequest.h.

◆ WithRelationalDatabaseBundleId() [1/3]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithRelationalDatabaseBundleId ( Aws::String &&  value)
inline

The bundle ID for your new database. A bundle describes the performance specifications for your database.

You can get a list of database bundle IDs by using the get relational database bundles operation.

Definition at line 281 of file CreateRelationalDatabaseRequest.h.

◆ WithRelationalDatabaseBundleId() [2/3]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithRelationalDatabaseBundleId ( const Aws::String value)
inline

The bundle ID for your new database. A bundle describes the performance specifications for your database.

You can get a list of database bundle IDs by using the get relational database bundles operation.

Definition at line 274 of file CreateRelationalDatabaseRequest.h.

◆ WithRelationalDatabaseBundleId() [3/3]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithRelationalDatabaseBundleId ( const char *  value)
inline

The bundle ID for your new database. A bundle describes the performance specifications for your database.

You can get a list of database bundle IDs by using the get relational database bundles operation.

Definition at line 288 of file CreateRelationalDatabaseRequest.h.

◆ WithRelationalDatabaseName() [1/3]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithRelationalDatabaseName ( Aws::String &&  value)
inline

The name to use for your new Lightsail database resource.

Constraints:

  • Must contain from 2 to 255 alphanumeric characters, or hyphens.

  • The first and last character must be a letter or number.

Definition at line 93 of file CreateRelationalDatabaseRequest.h.

◆ WithRelationalDatabaseName() [2/3]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithRelationalDatabaseName ( const Aws::String value)
inline

The name to use for your new Lightsail database resource.

Constraints:

  • Must contain from 2 to 255 alphanumeric characters, or hyphens.

  • The first and last character must be a letter or number.

Definition at line 85 of file CreateRelationalDatabaseRequest.h.

◆ WithRelationalDatabaseName() [3/3]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithRelationalDatabaseName ( const char *  value)
inline

The name to use for your new Lightsail database resource.

Constraints:

  • Must contain from 2 to 255 alphanumeric characters, or hyphens.

  • The first and last character must be a letter or number.

Definition at line 101 of file CreateRelationalDatabaseRequest.h.

◆ WithTags() [1/2]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

Definition at line 1149 of file CreateRelationalDatabaseRequest.h.

◆ WithTags() [2/2]

CreateRelationalDatabaseRequest& Aws::Lightsail::Model::CreateRelationalDatabaseRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

Definition at line 1142 of file CreateRelationalDatabaseRequest.h.


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