software.amazon.awssdk.services.lightsail.model

Interface CreateRelationalDatabaseRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateRelationalDatabaseRequest.Builder,CreateRelationalDatabaseRequest>, LightsailRequest.Builder, SdkBuilder<CreateRelationalDatabaseRequest.Builder,CreateRelationalDatabaseRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateRelationalDatabaseRequest

public static interface CreateRelationalDatabaseRequest.Builder
extends LightsailRequest.Builder, SdkPojo, CopyableBuilder<CreateRelationalDatabaseRequest.Builder,CreateRelationalDatabaseRequest>

Method Summary

Modifier and Type	Method and Description
CreateRelationalDatabaseRequest.Builder	availabilityZone(String availabilityZone) The Availability Zone in which to create your new database.
CreateRelationalDatabaseRequest.Builder	masterDatabaseName(String masterDatabaseName) The name of the master database created when the Lightsail database resource is created.
CreateRelationalDatabaseRequest.Builder	masterUsername(String masterUsername) The master user name for your new database.
CreateRelationalDatabaseRequest.Builder	masterUserPassword(String masterUserPassword) The password for the master user of your new database.
CreateRelationalDatabaseRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateRelationalDatabaseRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateRelationalDatabaseRequest.Builder	preferredBackupWindow(String preferredBackupWindow) The daily time range during which automated backups are created for your new database if automated backups are enabled.
CreateRelationalDatabaseRequest.Builder	preferredMaintenanceWindow(String preferredMaintenanceWindow) The weekly time range during which system maintenance can occur on your new database.
CreateRelationalDatabaseRequest.Builder	publiclyAccessible(Boolean publiclyAccessible) Specifies the accessibility options for your new database.
CreateRelationalDatabaseRequest.Builder	relationalDatabaseBlueprintId(String relationalDatabaseBlueprintId) The blueprint ID for your new database.
CreateRelationalDatabaseRequest.Builder	relationalDatabaseBundleId(String relationalDatabaseBundleId) The bundle ID for your new database.
CreateRelationalDatabaseRequest.Builder	relationalDatabaseName(String relationalDatabaseName) The name to use for your new database.
CreateRelationalDatabaseRequest.Builder	tags(Collection<Tag> tags) The tag keys and optional values to add to the resource during create.
CreateRelationalDatabaseRequest.Builder	tags(Consumer<Tag.Builder>... tags) The tag keys and optional values to add to the resource during create.
CreateRelationalDatabaseRequest.Builder	tags(Tag... tags) The tag keys and optional values to add to the resource during create.

Methods inherited from interface software.amazon.awssdk.services.lightsail.model.LightsailRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

relationalDatabaseName

CreateRelationalDatabaseRequest.Builder relationalDatabaseName(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.

Parameters:

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:

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

availabilityZone

CreateRelationalDatabaseRequest.Builder availabilityZone(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.

Parameters:

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:

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

relationalDatabaseBlueprintId

CreateRelationalDatabaseRequest.Builder relationalDatabaseBlueprintId(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.

Parameters:

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:

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

relationalDatabaseBundleId

CreateRelationalDatabaseRequest.Builder relationalDatabaseBundleId(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.

Parameters:

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:

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

masterDatabaseName

CreateRelationalDatabaseRequest.Builder masterDatabaseName(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

Parameters:

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:

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

masterUsername

CreateRelationalDatabaseRequest.Builder masterUsername(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.

Parameters:

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:

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

masterUserPassword

CreateRelationalDatabaseRequest.Builder masterUserPassword(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.

Parameters:

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:

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

preferredBackupWindow

CreateRelationalDatabaseRequest.Builder preferredBackupWindow(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.

Parameters:

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:

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

preferredMaintenanceWindow

CreateRelationalDatabaseRequest.Builder preferredMaintenanceWindow(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

Parameters:

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:

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

publiclyAccessible

CreateRelationalDatabaseRequest.Builder publiclyAccessible(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.

Parameters:

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:

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

tags

CreateRelationalDatabaseRequest.Builder tags(Collection<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.

Parameters:

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.

Returns:

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

tags

CreateRelationalDatabaseRequest.Builder tags(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.

Parameters:

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.

Returns:

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

tags

CreateRelationalDatabaseRequest.Builder tags(Consumer<Tag.Builder>... 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.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#tags(List)

overrideConfiguration

CreateRelationalDatabaseRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateRelationalDatabaseRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.