Aws::Lightsail::Model::UpdateRelationalDatabaseRequest Class Reference

#include <UpdateRelationalDatabaseRequest.h>

Inheritance diagram for Aws::Lightsail::Model::UpdateRelationalDatabaseRequest:

Public Member Functions
	UpdateRelationalDatabaseRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const override
const Aws::String &	GetRelationalDatabaseName () const
bool	RelationalDatabaseNameHasBeenSet () const
void	SetRelationalDatabaseName (const Aws::String &value)
void	SetRelationalDatabaseName (Aws::String &&value)
void	SetRelationalDatabaseName (const char *value)
UpdateRelationalDatabaseRequest &	WithRelationalDatabaseName (const Aws::String &value)
UpdateRelationalDatabaseRequest &	WithRelationalDatabaseName (Aws::String &&value)
UpdateRelationalDatabaseRequest &	WithRelationalDatabaseName (const char *value)
const Aws::String &	GetMasterUserPassword () const
bool	MasterUserPasswordHasBeenSet () const
void	SetMasterUserPassword (const Aws::String &value)
void	SetMasterUserPassword (Aws::String &&value)
void	SetMasterUserPassword (const char *value)
UpdateRelationalDatabaseRequest &	WithMasterUserPassword (const Aws::String &value)
UpdateRelationalDatabaseRequest &	WithMasterUserPassword (Aws::String &&value)
UpdateRelationalDatabaseRequest &	WithMasterUserPassword (const char *value)
bool	GetRotateMasterUserPassword () const
bool	RotateMasterUserPasswordHasBeenSet () const
void	SetRotateMasterUserPassword (bool value)
UpdateRelationalDatabaseRequest &	WithRotateMasterUserPassword (bool value)
const Aws::String &	GetPreferredBackupWindow () const
bool	PreferredBackupWindowHasBeenSet () const
void	SetPreferredBackupWindow (const Aws::String &value)
void	SetPreferredBackupWindow (Aws::String &&value)
void	SetPreferredBackupWindow (const char *value)
UpdateRelationalDatabaseRequest &	WithPreferredBackupWindow (const Aws::String &value)
UpdateRelationalDatabaseRequest &	WithPreferredBackupWindow (Aws::String &&value)
UpdateRelationalDatabaseRequest &	WithPreferredBackupWindow (const char *value)
const Aws::String &	GetPreferredMaintenanceWindow () const
bool	PreferredMaintenanceWindowHasBeenSet () const
void	SetPreferredMaintenanceWindow (const Aws::String &value)
void	SetPreferredMaintenanceWindow (Aws::String &&value)
void	SetPreferredMaintenanceWindow (const char *value)
UpdateRelationalDatabaseRequest &	WithPreferredMaintenanceWindow (const Aws::String &value)
UpdateRelationalDatabaseRequest &	WithPreferredMaintenanceWindow (Aws::String &&value)
UpdateRelationalDatabaseRequest &	WithPreferredMaintenanceWindow (const char *value)
bool	GetEnableBackupRetention () const
bool	EnableBackupRetentionHasBeenSet () const
void	SetEnableBackupRetention (bool value)
UpdateRelationalDatabaseRequest &	WithEnableBackupRetention (bool value)
bool	GetDisableBackupRetention () const
bool	DisableBackupRetentionHasBeenSet () const
void	SetDisableBackupRetention (bool value)
UpdateRelationalDatabaseRequest &	WithDisableBackupRetention (bool value)
bool	GetPubliclyAccessible () const
bool	PubliclyAccessibleHasBeenSet () const
void	SetPubliclyAccessible (bool value)
UpdateRelationalDatabaseRequest &	WithPubliclyAccessible (bool value)
bool	GetApplyImmediately () const
bool	ApplyImmediatelyHasBeenSet () const
void	SetApplyImmediately (bool value)
UpdateRelationalDatabaseRequest &	WithApplyImmediately (bool value)
const Aws::String &	GetCaCertificateIdentifier () const
bool	CaCertificateIdentifierHasBeenSet () const
void	SetCaCertificateIdentifier (const Aws::String &value)
void	SetCaCertificateIdentifier (Aws::String &&value)
void	SetCaCertificateIdentifier (const char *value)
UpdateRelationalDatabaseRequest &	WithCaCertificateIdentifier (const Aws::String &value)
UpdateRelationalDatabaseRequest &	WithCaCertificateIdentifier (Aws::String &&value)
UpdateRelationalDatabaseRequest &	WithCaCertificateIdentifier (const char *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::IOStream >	GetBody () 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 RequestSignedHandler &	GetRequestSignedHandler () const
const Aws::IOStreamFactory &	GetResponseStreamFactory () 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::DataReceivedEventHandler &	GetDataReceivedEventHandler () const
virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const
virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const
virtual const RequestRetryHandler &	GetRequestRetryHandler () 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 21 of file UpdateRelationalDatabaseRequest.h.

Constructor & Destructor Documentation

UpdateRelationalDatabaseRequest()

Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::UpdateRelationalDatabaseRequest

(

)

Member Function Documentation

ApplyImmediatelyHasBeenSet()

bool Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::ApplyImmediatelyHasBeenSet ( ) const

inline

When true, applies changes immediately. When false, applies changes during the preferred maintenance window. Some changes may cause an outage.

Default: false

Definition at line 469 of file UpdateRelationalDatabaseRequest.h.

CaCertificateIdentifierHasBeenSet()

bool Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::CaCertificateIdentifierHasBeenSet ( ) const

inline

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

Definition at line 494 of file UpdateRelationalDatabaseRequest.h.

DisableBackupRetentionHasBeenSet()

bool Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::DisableBackupRetentionHasBeenSet ( ) const

inline

When true, disables automated backup retention for your database.

Disabling backup retention deletes all automated database backups. Before disabling this, you may want to create a snapshot of your database using the create relational database snapshot operation.

Updates are applied during the next maintenance window because this can result in an outage.

Definition at line 397 of file UpdateRelationalDatabaseRequest.h.

EnableBackupRetentionHasBeenSet()

bool Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::EnableBackupRetentionHasBeenSet ( ) const

inline

When true, enables automated backup retention for your database.

Updates are applied during the next maintenance window because this can result in an outage.

Definition at line 362 of file UpdateRelationalDatabaseRequest.h.

GetApplyImmediately()

bool Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::GetApplyImmediately ( ) const

inline

When true, applies changes immediately. When false, applies changes during the preferred maintenance window. Some changes may cause an outage.

Default: false

Definition at line 462 of file UpdateRelationalDatabaseRequest.h.

GetCaCertificateIdentifier()

const Aws::String& Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::GetCaCertificateIdentifier ( ) const

inline

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

Definition at line 489 of file UpdateRelationalDatabaseRequest.h.

GetDisableBackupRetention()

bool Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::GetDisableBackupRetention ( ) const

inline

When true, disables automated backup retention for your database.

Disabling backup retention deletes all automated database backups. Before disabling this, you may want to create a snapshot of your database using the create relational database snapshot operation.

Updates are applied during the next maintenance window because this can result in an outage.

Definition at line 387 of file UpdateRelationalDatabaseRequest.h.

GetEnableBackupRetention()

bool Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::GetEnableBackupRetention ( ) const

inline

When true, enables automated backup retention for your database.

Updates are applied during the next maintenance window because this can result in an outage.

Definition at line 355 of file UpdateRelationalDatabaseRequest.h.

GetMasterUserPassword()

const Aws::String& Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::GetMasterUserPassword ( ) const

inline

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

MySQL

Constraints: Must contain from 8 to 41 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Definition at line 84 of file UpdateRelationalDatabaseRequest.h.

GetPreferredBackupWindow()

const Aws::String& Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::GetPreferredBackupWindow ( ) const

inline

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

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 180 of file UpdateRelationalDatabaseRequest.h.

GetPreferredMaintenanceWindow()

const Aws::String& Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::GetPreferredMaintenanceWindow ( ) const

inline

The weekly time range during which system maintenance can occur on your 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 263 of file UpdateRelationalDatabaseRequest.h.

GetPubliclyAccessible()

bool Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::GetPubliclyAccessible ( ) const

inline

Specifies the accessibility options for your 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 427 of file UpdateRelationalDatabaseRequest.h.

GetRelationalDatabaseName()

const Aws::String& Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::GetRelationalDatabaseName ( ) const

inline

The name of your Lightsail database resource to update.

Definition at line 40 of file UpdateRelationalDatabaseRequest.h.

GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::GetRequestSpecificHeaders ( ) const

overridevirtual

Reimplemented from Aws::Lightsail::LightsailRequest.

GetRotateMasterUserPassword()

bool Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::GetRotateMasterUserPassword ( ) const

inline

When true, the master user password is changed to a new strong password generated by Lightsail.

Use the get relational database master user password operation to get the new password.

Definition at line 148 of file UpdateRelationalDatabaseRequest.h.

GetServiceRequestName()

virtual const char* Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file UpdateRelationalDatabaseRequest.h.

MasterUserPasswordHasBeenSet()

bool Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::MasterUserPasswordHasBeenSet ( ) const

inline

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

MySQL

Constraints: Must contain from 8 to 41 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Definition at line 92 of file UpdateRelationalDatabaseRequest.h.

PreferredBackupWindowHasBeenSet()

bool Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::PreferredBackupWindowHasBeenSet ( ) const

inline

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

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 190 of file UpdateRelationalDatabaseRequest.h.

PreferredMaintenanceWindowHasBeenSet()

bool Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::PreferredMaintenanceWindowHasBeenSet ( ) const

inline

The weekly time range during which system maintenance can occur on your 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 275 of file UpdateRelationalDatabaseRequest.h.

PubliclyAccessibleHasBeenSet()

bool Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::PubliclyAccessibleHasBeenSet ( ) const

inline

Specifies the accessibility options for your 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 436 of file UpdateRelationalDatabaseRequest.h.

RelationalDatabaseNameHasBeenSet()

bool Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::RelationalDatabaseNameHasBeenSet ( ) const

inline

The name of your Lightsail database resource to update.

Definition at line 45 of file UpdateRelationalDatabaseRequest.h.

RotateMasterUserPasswordHasBeenSet()

bool Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::RotateMasterUserPasswordHasBeenSet ( ) const

inline

When true, the master user password is changed to a new strong password generated by Lightsail.

Use the get relational database master user password operation to get the new password.

Definition at line 155 of file UpdateRelationalDatabaseRequest.h.

SerializePayload()

Aws::String Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SetApplyImmediately()

void Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::SetApplyImmediately ( bool  value )

inline

When true, applies changes immediately. When false, applies changes during the preferred maintenance window. Some changes may cause an outage.

Default: false

Definition at line 476 of file UpdateRelationalDatabaseRequest.h.

SetCaCertificateIdentifier() [1/3]

void Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::SetCaCertificateIdentifier ( Aws::String &&  value )

inline

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

Definition at line 504 of file UpdateRelationalDatabaseRequest.h.

SetCaCertificateIdentifier() [2/3]

void Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::SetCaCertificateIdentifier ( const Aws::String &  value )

inline

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

Definition at line 499 of file UpdateRelationalDatabaseRequest.h.

SetCaCertificateIdentifier() [3/3]

void Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::SetCaCertificateIdentifier ( const char *  value )

inline

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

Definition at line 509 of file UpdateRelationalDatabaseRequest.h.

SetDisableBackupRetention()

void Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::SetDisableBackupRetention ( bool  value )

inline

When true, disables automated backup retention for your database.

Disabling backup retention deletes all automated database backups. Before disabling this, you may want to create a snapshot of your database using the create relational database snapshot operation.

Updates are applied during the next maintenance window because this can result in an outage.

Definition at line 407 of file UpdateRelationalDatabaseRequest.h.

SetEnableBackupRetention()

void Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::SetEnableBackupRetention ( bool  value )

inline

When true, enables automated backup retention for your database.

Updates are applied during the next maintenance window because this can result in an outage.

Definition at line 369 of file UpdateRelationalDatabaseRequest.h.

SetMasterUserPassword() [1/3]

void Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::SetMasterUserPassword ( Aws::String &&  value )

inline

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

MySQL

Constraints: Must contain from 8 to 41 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Definition at line 108 of file UpdateRelationalDatabaseRequest.h.

SetMasterUserPassword() [2/3]

void Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::SetMasterUserPassword ( const Aws::String &  value )

inline

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

MySQL

Constraints: Must contain from 8 to 41 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Definition at line 100 of file UpdateRelationalDatabaseRequest.h.

SetMasterUserPassword() [3/3]

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

inline

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

MySQL

Constraints: Must contain from 8 to 41 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Definition at line 116 of file UpdateRelationalDatabaseRequest.h.

SetPreferredBackupWindow() [1/3]

void Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::SetPreferredBackupWindow ( Aws::String &&  value )

inline

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

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 210 of file UpdateRelationalDatabaseRequest.h.

SetPreferredBackupWindow() [2/3]

void Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::SetPreferredBackupWindow ( const Aws::String &  value )

inline

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

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 200 of file UpdateRelationalDatabaseRequest.h.

SetPreferredBackupWindow() [3/3]

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

inline

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

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 220 of file UpdateRelationalDatabaseRequest.h.

SetPreferredMaintenanceWindow() [1/3]

void Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::SetPreferredMaintenanceWindow ( Aws::String &&  value )

inline

The weekly time range during which system maintenance can occur on your 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 299 of file UpdateRelationalDatabaseRequest.h.

SetPreferredMaintenanceWindow() [2/3]

void Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::SetPreferredMaintenanceWindow ( const Aws::String &  value )

inline

The weekly time range during which system maintenance can occur on your 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 287 of file UpdateRelationalDatabaseRequest.h.

SetPreferredMaintenanceWindow() [3/3]

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

inline

The weekly time range during which system maintenance can occur on your 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 311 of file UpdateRelationalDatabaseRequest.h.

SetPubliclyAccessible()

void Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::SetPubliclyAccessible ( bool  value )

inline

Specifies the accessibility options for your 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 445 of file UpdateRelationalDatabaseRequest.h.

SetRelationalDatabaseName() [1/3]

void Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::SetRelationalDatabaseName ( Aws::String &&  value )

inline

The name of your Lightsail database resource to update.

Definition at line 55 of file UpdateRelationalDatabaseRequest.h.

SetRelationalDatabaseName() [2/3]

void Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::SetRelationalDatabaseName ( const Aws::String &  value )

inline

The name of your Lightsail database resource to update.

Definition at line 50 of file UpdateRelationalDatabaseRequest.h.

SetRelationalDatabaseName() [3/3]

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

inline

The name of your Lightsail database resource to update.

Definition at line 60 of file UpdateRelationalDatabaseRequest.h.

SetRotateMasterUserPassword()

void Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::SetRotateMasterUserPassword ( bool  value )

inline

When true, the master user password is changed to a new strong password generated by Lightsail.

Use the get relational database master user password operation to get the new password.

Definition at line 162 of file UpdateRelationalDatabaseRequest.h.

WithApplyImmediately()

UpdateRelationalDatabaseRequest& Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::WithApplyImmediately ( bool  value )

inline

When true, applies changes immediately. When false, applies changes during the preferred maintenance window. Some changes may cause an outage.

Default: false

Definition at line 483 of file UpdateRelationalDatabaseRequest.h.

WithCaCertificateIdentifier() [1/3]

UpdateRelationalDatabaseRequest& Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::WithCaCertificateIdentifier ( Aws::String &&  value )

inline

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

Definition at line 519 of file UpdateRelationalDatabaseRequest.h.

WithCaCertificateIdentifier() [2/3]

UpdateRelationalDatabaseRequest& Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::WithCaCertificateIdentifier ( const Aws::String &  value )

inline

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

Definition at line 514 of file UpdateRelationalDatabaseRequest.h.

WithCaCertificateIdentifier() [3/3]

UpdateRelationalDatabaseRequest& Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::WithCaCertificateIdentifier ( const char *  value )

inline

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

Definition at line 524 of file UpdateRelationalDatabaseRequest.h.

WithDisableBackupRetention()

UpdateRelationalDatabaseRequest& Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::WithDisableBackupRetention ( bool  value )

inline

When true, disables automated backup retention for your database.

Disabling backup retention deletes all automated database backups. Before disabling this, you may want to create a snapshot of your database using the create relational database snapshot operation.

Updates are applied during the next maintenance window because this can result in an outage.

Definition at line 417 of file UpdateRelationalDatabaseRequest.h.

WithEnableBackupRetention()

UpdateRelationalDatabaseRequest& Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::WithEnableBackupRetention ( bool  value )

inline

When true, enables automated backup retention for your database.

Updates are applied during the next maintenance window because this can result in an outage.

Definition at line 376 of file UpdateRelationalDatabaseRequest.h.

WithMasterUserPassword() [1/3]

UpdateRelationalDatabaseRequest& Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::WithMasterUserPassword ( Aws::String &&  value )

inline

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

MySQL

Constraints: Must contain from 8 to 41 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Definition at line 132 of file UpdateRelationalDatabaseRequest.h.

WithMasterUserPassword() [2/3]

UpdateRelationalDatabaseRequest& Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::WithMasterUserPassword ( const Aws::String &  value )

inline

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

MySQL

Constraints: Must contain from 8 to 41 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Definition at line 124 of file UpdateRelationalDatabaseRequest.h.

WithMasterUserPassword() [3/3]

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

inline

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

MySQL

Constraints: Must contain from 8 to 41 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Definition at line 140 of file UpdateRelationalDatabaseRequest.h.

WithPreferredBackupWindow() [1/3]

UpdateRelationalDatabaseRequest& Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::WithPreferredBackupWindow ( Aws::String &&  value )

inline

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

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 240 of file UpdateRelationalDatabaseRequest.h.

WithPreferredBackupWindow() [2/3]

UpdateRelationalDatabaseRequest& Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::WithPreferredBackupWindow ( const Aws::String &  value )

inline

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

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 230 of file UpdateRelationalDatabaseRequest.h.

WithPreferredBackupWindow() [3/3]

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

inline

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

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

WithPreferredMaintenanceWindow() [1/3]

UpdateRelationalDatabaseRequest& Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::WithPreferredMaintenanceWindow ( Aws::String &&  value )

inline

The weekly time range during which system maintenance can occur on your 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 335 of file UpdateRelationalDatabaseRequest.h.

WithPreferredMaintenanceWindow() [2/3]

UpdateRelationalDatabaseRequest& Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::WithPreferredMaintenanceWindow ( const Aws::String &  value )

inline

The weekly time range during which system maintenance can occur on your 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 323 of file UpdateRelationalDatabaseRequest.h.

WithPreferredMaintenanceWindow() [3/3]

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

inline

The weekly time range during which system maintenance can occur on your 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 347 of file UpdateRelationalDatabaseRequest.h.

WithPubliclyAccessible()

UpdateRelationalDatabaseRequest& Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::WithPubliclyAccessible ( bool  value )

inline

Specifies the accessibility options for your 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 454 of file UpdateRelationalDatabaseRequest.h.

WithRelationalDatabaseName() [1/3]

UpdateRelationalDatabaseRequest& Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::WithRelationalDatabaseName ( Aws::String &&  value )

inline

The name of your Lightsail database resource to update.

Definition at line 70 of file UpdateRelationalDatabaseRequest.h.

WithRelationalDatabaseName() [2/3]

UpdateRelationalDatabaseRequest& Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::WithRelationalDatabaseName ( const Aws::String &  value )

inline

The name of your Lightsail database resource to update.

Definition at line 65 of file UpdateRelationalDatabaseRequest.h.

WithRelationalDatabaseName() [3/3]

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

inline

The name of your Lightsail database resource to update.

Definition at line 75 of file UpdateRelationalDatabaseRequest.h.

WithRotateMasterUserPassword()

UpdateRelationalDatabaseRequest& Aws::Lightsail::Model::UpdateRelationalDatabaseRequest::WithRotateMasterUserPassword ( bool  value )

inline

When true, the master user password is changed to a new strong password generated by Lightsail.

Use the get relational database master user password operation to get the new password.

Definition at line 169 of file UpdateRelationalDatabaseRequest.h.

---

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

• aws-cpp-sdk-lightsail/include/aws/lightsail/model/UpdateRelationalDatabaseRequest.h