com.amazonaws.services.lightsail.model

Class UpdateRelationalDatabaseRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.lightsail.model.UpdateRelationalDatabaseRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateRelationalDatabaseRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateRelationalDatabaseRequest()

Method Summary

Modifier and Type	Method and Description
UpdateRelationalDatabaseRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getApplyImmediately() When true, applies changes immediately.
String	getCaCertificateIdentifier() Indicates the certificate that needs to be associated with the database.
Boolean	getDisableBackupRetention() When true, disables automated backup retention for your database.
Boolean	getEnableBackupRetention() When true, enables automated backup retention for your database.
String	getMasterUserPassword() The password for the master user.
String	getPreferredBackupWindow() The daily time range during which automated backups are created for your database if automated backups are enabled.
String	getPreferredMaintenanceWindow() The weekly time range during which system maintenance can occur on your database.
Boolean	getPubliclyAccessible() Specifies the accessibility options for your database.
String	getRelationalDatabaseName() The name of your Lightsail database resource to update.
Boolean	getRotateMasterUserPassword() When true, the master user password is changed to a new strong password generated by Lightsail.
int	hashCode()
Boolean	isApplyImmediately() When true, applies changes immediately.
Boolean	isDisableBackupRetention() When true, disables automated backup retention for your database.
Boolean	isEnableBackupRetention() When true, enables automated backup retention for your database.
Boolean	isPubliclyAccessible() Specifies the accessibility options for your database.
Boolean	isRotateMasterUserPassword() When true, the master user password is changed to a new strong password generated by Lightsail.
void	setApplyImmediately(Boolean applyImmediately) When true, applies changes immediately.
void	setCaCertificateIdentifier(String caCertificateIdentifier) Indicates the certificate that needs to be associated with the database.
void	setDisableBackupRetention(Boolean disableBackupRetention) When true, disables automated backup retention for your database.
void	setEnableBackupRetention(Boolean enableBackupRetention) When true, enables automated backup retention for your database.
void	setMasterUserPassword(String masterUserPassword) The password for the master user.
void	setPreferredBackupWindow(String preferredBackupWindow) The daily time range during which automated backups are created for your database if automated backups are enabled.
void	setPreferredMaintenanceWindow(String preferredMaintenanceWindow) The weekly time range during which system maintenance can occur on your database.
void	setPubliclyAccessible(Boolean publiclyAccessible) Specifies the accessibility options for your database.
void	setRelationalDatabaseName(String relationalDatabaseName) The name of your Lightsail database resource to update.
void	setRotateMasterUserPassword(Boolean rotateMasterUserPassword) When true, the master user password is changed to a new strong password generated by Lightsail.
String	toString() Returns a string representation of this object.
UpdateRelationalDatabaseRequest	withApplyImmediately(Boolean applyImmediately) When true, applies changes immediately.
UpdateRelationalDatabaseRequest	withCaCertificateIdentifier(String caCertificateIdentifier) Indicates the certificate that needs to be associated with the database.
UpdateRelationalDatabaseRequest	withDisableBackupRetention(Boolean disableBackupRetention) When true, disables automated backup retention for your database.
UpdateRelationalDatabaseRequest	withEnableBackupRetention(Boolean enableBackupRetention) When true, enables automated backup retention for your database.
UpdateRelationalDatabaseRequest	withMasterUserPassword(String masterUserPassword) The password for the master user.
UpdateRelationalDatabaseRequest	withPreferredBackupWindow(String preferredBackupWindow) The daily time range during which automated backups are created for your database if automated backups are enabled.
UpdateRelationalDatabaseRequest	withPreferredMaintenanceWindow(String preferredMaintenanceWindow) The weekly time range during which system maintenance can occur on your database.
UpdateRelationalDatabaseRequest	withPubliclyAccessible(Boolean publiclyAccessible) Specifies the accessibility options for your database.
UpdateRelationalDatabaseRequest	withRelationalDatabaseName(String relationalDatabaseName) The name of your Lightsail database resource to update.
UpdateRelationalDatabaseRequest	withRotateMasterUserPassword(Boolean rotateMasterUserPassword) When true, the master user password is changed to a new strong password generated by Lightsail.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateRelationalDatabaseRequest

public UpdateRelationalDatabaseRequest()

Method Detail

setRelationalDatabaseName

public void setRelationalDatabaseName(String relationalDatabaseName)

The name of your Lightsail database resource to update.

Parameters:

relationalDatabaseName - The name of your Lightsail database resource to update.

getRelationalDatabaseName

public String getRelationalDatabaseName()

The name of your Lightsail database resource to update.

Returns:

The name of your Lightsail database resource to update.

withRelationalDatabaseName

public UpdateRelationalDatabaseRequest withRelationalDatabaseName(String relationalDatabaseName)

The name of your Lightsail database resource to update.

Parameters:

relationalDatabaseName - The name of your Lightsail database resource to update.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMasterUserPassword

public void setMasterUserPassword(String masterUserPassword)

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.

Parameters:

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

getMasterUserPassword

public String getMasterUserPassword()

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.

Returns:

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.

withMasterUserPassword

public UpdateRelationalDatabaseRequest withMasterUserPassword(String masterUserPassword)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setRotateMasterUserPassword

public void setRotateMasterUserPassword(Boolean rotateMasterUserPassword)

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.

Parameters:

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

getRotateMasterUserPassword

public Boolean getRotateMasterUserPassword()

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.

Returns:

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.

withRotateMasterUserPassword

public UpdateRelationalDatabaseRequest withRotateMasterUserPassword(Boolean rotateMasterUserPassword)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

isRotateMasterUserPassword

public Boolean isRotateMasterUserPassword()

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.

Returns:

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.

setPreferredBackupWindow

public void setPreferredBackupWindow(String preferredBackupWindow)

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.

Parameters:

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

getPreferredBackupWindow

public String getPreferredBackupWindow()

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.

Returns:

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.

withPreferredBackupWindow

public UpdateRelationalDatabaseRequest withPreferredBackupWindow(String preferredBackupWindow)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setPreferredMaintenanceWindow

public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)

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

Parameters:

preferredMaintenanceWindow - 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

getPreferredMaintenanceWindow

public String getPreferredMaintenanceWindow()

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

Returns:

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

withPreferredMaintenanceWindow

public UpdateRelationalDatabaseRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)

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

Parameters:

preferredMaintenanceWindow - 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

Returns:

Returns a reference to this object so that method calls can be chained together.

setEnableBackupRetention

public void setEnableBackupRetention(Boolean enableBackupRetention)

When true, enables automated backup retention for your database.

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

Parameters:

enableBackupRetention - When true, enables automated backup retention for your database.

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

getEnableBackupRetention

public Boolean getEnableBackupRetention()

When true, enables automated backup retention for your database.

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

Returns:

When true, enables automated backup retention for your database.

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

withEnableBackupRetention

public UpdateRelationalDatabaseRequest withEnableBackupRetention(Boolean enableBackupRetention)

When true, enables automated backup retention for your database.

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

Parameters:

enableBackupRetention - When true, enables automated backup retention for your database.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

isEnableBackupRetention

public Boolean isEnableBackupRetention()

When true, enables automated backup retention for your database.

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

Returns:

When true, enables automated backup retention for your database.

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

setDisableBackupRetention

public void setDisableBackupRetention(Boolean disableBackupRetention)

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.

Parameters:

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

getDisableBackupRetention

public Boolean getDisableBackupRetention()

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.

Returns:

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.

withDisableBackupRetention

public UpdateRelationalDatabaseRequest withDisableBackupRetention(Boolean disableBackupRetention)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

isDisableBackupRetention

public Boolean isDisableBackupRetention()

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.

Returns:

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.

setPubliclyAccessible

public void setPubliclyAccessible(Boolean publiclyAccessible)

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.

Parameters:

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

getPubliclyAccessible

public Boolean getPubliclyAccessible()

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.

Returns:

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.

withPubliclyAccessible

public UpdateRelationalDatabaseRequest withPubliclyAccessible(Boolean publiclyAccessible)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

isPubliclyAccessible

public Boolean isPubliclyAccessible()

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.

Returns:

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.

setApplyImmediately

public void setApplyImmediately(Boolean applyImmediately)

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

Default: false

Parameters:

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

Default: false

getApplyImmediately

public Boolean getApplyImmediately()

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

Default: false

Returns:

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

Default: false

withApplyImmediately

public UpdateRelationalDatabaseRequest withApplyImmediately(Boolean applyImmediately)

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

Default: false

Parameters:

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

Default: false

Returns:

Returns a reference to this object so that method calls can be chained together.

isApplyImmediately

public Boolean isApplyImmediately()

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

Default: false

Returns:

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

Default: false

setCaCertificateIdentifier

public void setCaCertificateIdentifier(String caCertificateIdentifier)

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

Parameters:

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

getCaCertificateIdentifier

public String getCaCertificateIdentifier()

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

Returns:

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

withCaCertificateIdentifier

public UpdateRelationalDatabaseRequest withCaCertificateIdentifier(String caCertificateIdentifier)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateRelationalDatabaseRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()