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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	masterDatabaseName() The meaning of this parameter differs according to the database engine you use.
String	masterUsername() The name for the master user.
String	masterUserPassword() The password for the master user.
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 Lightsail database resource.
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()
String	toString() Returns a string representation of this object.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

relationalDatabaseName

public final String relationalDatabaseName()

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.

Returns:

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.

availabilityZone

public final 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 final 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 final 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 final String masterDatabaseName()

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.

Returns:

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.

masterUsername

public final String masterUsername()

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.

Returns:

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.

masterUserPassword

public final String masterUserPassword()

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.

Returns:

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.

preferredBackupWindow

public final 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 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.

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

preferredMaintenanceWindow

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

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

publiclyAccessible

public final 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.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

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.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

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.

toBuilder

public CreateRelationalDatabaseRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateRelationalDatabaseRequest.Builder,CreateRelationalDatabaseRequest>

Specified by:

toBuilder in class LightsailRequest

builder

public static CreateRelationalDatabaseRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo