Package software.amazon.awscdk.services.lightsail

Class CfnDatabase.Builder

java.lang.Object

software.amazon.awscdk.services.lightsail.CfnDatabase.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDatabase>

Enclosing class:

CfnDatabase

@Stability(Stable)
public static final class CfnDatabase.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDatabase>

A fluent builder for CfnDatabase.

Method Summary

Modifier and Type	Method	Description
CfnDatabase.Builder	availabilityZone(String availabilityZone)	The Availability Zone for the database.
CfnDatabase.Builder	backupRetention(Boolean backupRetention)	A Boolean value indicating whether automated backup retention is enabled for the database.
CfnDatabase.Builder	backupRetention(IResolvable backupRetention)	A Boolean value indicating whether automated backup retention is enabled for the database.
CfnDatabase	build()
CfnDatabase.Builder	caCertificateIdentifier(String caCertificateIdentifier)	The certificate associated with the database.
static CfnDatabase.Builder	create(software.constructs.Construct scope, String id)
CfnDatabase.Builder	masterDatabaseName(String masterDatabaseName)	The meaning of this parameter differs according to the database engine you use.
CfnDatabase.Builder	masterUsername(String masterUsername)	The name for the primary user.
CfnDatabase.Builder	masterUserPassword(String masterUserPassword)	The password for the primary user of the database.
CfnDatabase.Builder	preferredBackupWindow(String preferredBackupWindow)	The daily time range during which automated backups are created for the database (for example, 16:00-16:30 ).
CfnDatabase.Builder	preferredMaintenanceWindow(String preferredMaintenanceWindow)	The weekly time range during which system maintenance can occur for the database, formatted as follows: ddd:hh24:mi-ddd:hh24:mi .
CfnDatabase.Builder	publiclyAccessible(Boolean publiclyAccessible)	A Boolean value indicating whether the database is accessible to anyone on the internet.
CfnDatabase.Builder	publiclyAccessible(IResolvable publiclyAccessible)	A Boolean value indicating whether the database is accessible to anyone on the internet.
CfnDatabase.Builder	relationalDatabaseBlueprintId(String relationalDatabaseBlueprintId)	The blueprint ID for the database (for example, mysql_8_0 ).
CfnDatabase.Builder	relationalDatabaseBundleId(String relationalDatabaseBundleId)	The bundle ID for the database (for example, medium_1_0 ).
CfnDatabase.Builder	relationalDatabaseName(String relationalDatabaseName)	The name of the instance.
CfnDatabase.Builder	relationalDatabaseParameters(List<? extends Object> relationalDatabaseParameters)	An array of parameters for the database.
CfnDatabase.Builder	relationalDatabaseParameters(IResolvable relationalDatabaseParameters)	An array of parameters for the database.
CfnDatabase.Builder	rotateMasterUserPassword(Boolean rotateMasterUserPassword)	A Boolean value indicating whether to change the primary user password to a new, strong password generated by Lightsail .
CfnDatabase.Builder	rotateMasterUserPassword(IResolvable rotateMasterUserPassword)	A Boolean value indicating whether to change the primary user password to a new, strong password generated by Lightsail .
CfnDatabase.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs to apply to this resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnDatabase.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnDatabase.Builder.

masterDatabaseName

@Stability(Stable)
public CfnDatabase.Builder masterDatabaseName(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-64 letters or numbers.
• Must begin with a letter. Subsequent characters can be letters, underscores, or numbers (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-63 letters or numbers.
• Must begin with a letter. Subsequent characters can be letters, underscores, or numbers (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 .

Parameters:

masterDatabaseName - The meaning of this parameter differs according to the database engine you use. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-masterdatabasename

masterUsername

@Stability(Stable)
public CfnDatabase.Builder masterUsername(String masterUsername)

The name for the primary user.

MySQL

Constraints:

• Required for MySQL.
• Must be 1-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-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 .

Parameters:

masterUsername - The name for the primary user. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-masterusername

relationalDatabaseBlueprintId

@Stability(Stable)
public CfnDatabase.Builder relationalDatabaseBlueprintId(String relationalDatabaseBlueprintId)

The blueprint ID for the database (for example, mysql_8_0 ).

Parameters:

relationalDatabaseBlueprintId - The blueprint ID for the database (for example, mysql_8_0 ). This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-relationaldatabaseblueprintid

relationalDatabaseBundleId

@Stability(Stable)
public CfnDatabase.Builder relationalDatabaseBundleId(String relationalDatabaseBundleId)

The bundle ID for the database (for example, medium_1_0 ).

Parameters:

relationalDatabaseBundleId - The bundle ID for the database (for example, medium_1_0 ). This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-relationaldatabasebundleid

relationalDatabaseName

@Stability(Stable)
public CfnDatabase.Builder relationalDatabaseName(String relationalDatabaseName)

The name of the instance.

Parameters:

relationalDatabaseName - The name of the instance. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-relationaldatabasename

availabilityZone

@Stability(Stable)
public CfnDatabase.Builder availabilityZone(String availabilityZone)

The Availability Zone for the database.

Parameters:

availabilityZone - The Availability Zone for the database. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-availabilityzone

backupRetention

@Stability(Stable)
public CfnDatabase.Builder backupRetention(Boolean backupRetention)

A Boolean value indicating whether automated backup retention is enabled for the database.

Data Import Mode is enabled when BackupRetention is set to false , and is disabled when BackupRetention is set to true .

Parameters:

backupRetention - A Boolean value indicating whether automated backup retention is enabled for the database. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-backupretention

backupRetention

@Stability(Stable)
public CfnDatabase.Builder backupRetention(IResolvable backupRetention)

A Boolean value indicating whether automated backup retention is enabled for the database.

Data Import Mode is enabled when BackupRetention is set to false , and is disabled when BackupRetention is set to true .

Parameters:

backupRetention - A Boolean value indicating whether automated backup retention is enabled for the database. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-backupretention

caCertificateIdentifier

@Stability(Stable)
public CfnDatabase.Builder caCertificateIdentifier(String caCertificateIdentifier)

The certificate associated with the database.

Parameters:

caCertificateIdentifier - The certificate associated with the database. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-cacertificateidentifier

masterUserPassword

@Stability(Stable)
public CfnDatabase.Builder masterUserPassword(String masterUserPassword)

The password for the primary user of the database.

The password can include any printable ASCII character except the following: /, ", or

Parameters:

masterUserPassword - The password for the primary user of the database. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-masteruserpassword

preferredBackupWindow

@Stability(Stable)
public CfnDatabase.Builder preferredBackupWindow(String preferredBackupWindow)

The daily time range during which automated backups are created for the database (for example, 16:00-16:30 ).

Parameters:

preferredBackupWindow - The daily time range during which automated backups are created for the database (for example, 16:00-16:30 ). This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-preferredbackupwindow

preferredMaintenanceWindow

@Stability(Stable)
public CfnDatabase.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)

The weekly time range during which system maintenance can occur for the database, formatted as follows: ddd:hh24:mi-ddd:hh24:mi .

For example, Tue:17:00-Tue:17:30 .

Parameters:

preferredMaintenanceWindow - The weekly time range during which system maintenance can occur for the database, formatted as follows: ddd:hh24:mi-ddd:hh24:mi . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-preferredmaintenancewindow

publiclyAccessible

@Stability(Stable)
public CfnDatabase.Builder publiclyAccessible(Boolean publiclyAccessible)

A Boolean value indicating whether the database is accessible to anyone on the internet.

Parameters:

publiclyAccessible - A Boolean value indicating whether the database is accessible to anyone on the internet. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-publiclyaccessible

publiclyAccessible

@Stability(Stable)
public CfnDatabase.Builder publiclyAccessible(IResolvable publiclyAccessible)

A Boolean value indicating whether the database is accessible to anyone on the internet.

Parameters:

publiclyAccessible - A Boolean value indicating whether the database is accessible to anyone on the internet. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-publiclyaccessible

relationalDatabaseParameters

@Stability(Stable)
public CfnDatabase.Builder relationalDatabaseParameters(IResolvable relationalDatabaseParameters)

An array of parameters for the database.

Parameters:

relationalDatabaseParameters - An array of parameters for the database. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-relationaldatabaseparameters

relationalDatabaseParameters

@Stability(Stable)
public CfnDatabase.Builder relationalDatabaseParameters(List<? extends Object> relationalDatabaseParameters)

An array of parameters for the database.

Parameters:

relationalDatabaseParameters - An array of parameters for the database. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-relationaldatabaseparameters

rotateMasterUserPassword

@Stability(Stable)
public CfnDatabase.Builder rotateMasterUserPassword(Boolean rotateMasterUserPassword)

A Boolean value indicating whether to change the primary user password to a new, strong password generated by Lightsail .

The RotateMasterUserPassword and MasterUserPassword parameters cannot be used together in the same template.

Parameters:

rotateMasterUserPassword - A Boolean value indicating whether to change the primary user password to a new, strong password generated by Lightsail . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-rotatemasteruserpassword

rotateMasterUserPassword

@Stability(Stable)
public CfnDatabase.Builder rotateMasterUserPassword(IResolvable rotateMasterUserPassword)

A Boolean value indicating whether to change the primary user password to a new, strong password generated by Lightsail .

The RotateMasterUserPassword and MasterUserPassword parameters cannot be used together in the same template.

Parameters:

rotateMasterUserPassword - A Boolean value indicating whether to change the primary user password to a new, strong password generated by Lightsail . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-rotatemasteruserpassword

tags

@Stability(Stable)
public CfnDatabase.Builder tags(List<? extends CfnTag> tags)

An array of key-value pairs to apply to this resource.

For more information, see Tag in the AWS CloudFormation User Guide .

The Value of Tags is optional for Lightsail resources.

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-tags

build

@Stability(Stable)
public CfnDatabase build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnDatabase>

Returns:

a newly built instance of CfnDatabase.