software.amazon.awssdk.services.lightsail.model

Class CreateRelationalDatabaseRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.lightsail.model.LightsailRequest

software.amazon.awssdk.services.lightsail.model.CreateRelationalDatabaseRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateRelationalDatabaseRequest.Builder,CreateRelationalDatabaseRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateRelationalDatabaseRequest
extends LightsailRequest
implements ToCopyableBuilder<CreateRelationalDatabaseRequest.Builder,CreateRelationalDatabaseRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateRelationalDatabaseRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	availabilityZone() The Availability Zone in which to create your new database.
static CreateRelationalDatabaseRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	masterDatabaseName() The name of the master database created when the Lightsail database resource is created.
String	masterUsername() The master user name for your new database.
String	masterUserPassword() The password for the master user of your new database.
String	preferredBackupWindow() The daily time range during which automated backups are created for your new database if automated backups are enabled.
String	preferredMaintenanceWindow() The weekly time range during which system maintenance can occur on your new database.
Boolean	publiclyAccessible() Specifies the accessibility options for your new database.
String	relationalDatabaseBlueprintId() The blueprint ID for your new database.
String	relationalDatabaseBundleId() The bundle ID for your new database.
String	relationalDatabaseName() The name to use for your new database.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateRelationalDatabaseRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() The tag keys and optional values to add to the resource during create.
CreateRelationalDatabaseRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

relationalDatabaseName

public String relationalDatabaseName()

The name to use for your new database.

Constraints:

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

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

Returns:

The name to use for your new database.

Constraints:

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

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

availabilityZone

public String availabilityZone()

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.

Returns:

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.

relationalDatabaseBlueprintId

public String relationalDatabaseBlueprintId()

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.

Returns:

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.

relationalDatabaseBundleId

public String relationalDatabaseBundleId()

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.

Returns:

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.

masterDatabaseName

public String masterDatabaseName()

The name of the master database created when the Lightsail database resource is created.

Constraints:

• Must contain from 1 to 64 alphanumeric characters.

• Cannot be a word reserved by the specified database engine

Returns:

The name of the master database created when the Lightsail database resource is created.

Constraints:

• Must contain from 1 to 64 alphanumeric characters.

• Cannot be a word reserved by the specified database engine

masterUsername

public String masterUsername()

The master user name for your new database.

Constraints:

• Master user name is required.

• Must contain from 1 to 16 alphanumeric characters.

• The first character must be a letter.

• Cannot be a reserved word for the database engine you choose.

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

Returns:

The master user name for your new database.

Constraints:

• Master user name is required.

• Must contain from 1 to 16 alphanumeric characters.

• The first character must be a letter.

• Cannot be a reserved word for the database engine you choose.

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

masterUserPassword

public String masterUserPassword()

The password for the master user of your new database. The password can include any printable ASCII character except "/", """, or "@".

Constraints: Must contain 8 to 41 characters.

Returns:

The password for the master user of your new database. The password can include any printable ASCII character except "/", """, or "@".

Constraints: Must contain 8 to 41 characters.

preferredBackupWindow

public String preferredBackupWindow()

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 Universal Coordinated 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 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 Universal Coordinated Time (UTC).

• Must not conflict with the preferred maintenance window.

• Must be at least 30 minutes.

preferredMaintenanceWindow

public String preferredMaintenanceWindow()

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 Universal Coordinated Time (UTC).

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

Returns:

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 Universal Coordinated Time (UTC).

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

publiclyAccessible

public Boolean publiclyAccessible()

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.

Returns:

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.

tags

public List<Tag> tags()

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

To tag a resource after it has been created, see the tag resource operation.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

To tag a resource after it has been created, see the tag resource operation.

toBuilder

public CreateRelationalDatabaseRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateRelationalDatabaseRequest.Builder,CreateRelationalDatabaseRequest>

Specified by:

toBuilder in class LightsailRequest

Returns:

a builder for type T

builder

public static CreateRelationalDatabaseRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateRelationalDatabaseRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.