software.amazon.awscdk.services.lightsail

Class CfnDatabase

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.lightsail.CfnDatabase

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.639Z")
 @Stability(value=Stable)
public class CfnDatabase
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Lightsail::Database`.

The AWS::Lightsail::Database resource specifies an Amazon Lightsail database.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lightsail.*;
 CfnDatabase cfnDatabase = CfnDatabase.Builder.create(this, "MyCfnDatabase")
         .masterDatabaseName("masterDatabaseName")
         .masterUsername("masterUsername")
         .relationalDatabaseBlueprintId("relationalDatabaseBlueprintId")
         .relationalDatabaseBundleId("relationalDatabaseBundleId")
         .relationalDatabaseName("relationalDatabaseName")
         // the properties below are optional
         .availabilityZone("availabilityZone")
         .backupRetention(false)
         .caCertificateIdentifier("caCertificateIdentifier")
         .masterUserPassword("masterUserPassword")
         .preferredBackupWindow("preferredBackupWindow")
         .preferredMaintenanceWindow("preferredMaintenanceWindow")
         .publiclyAccessible(false)
         .relationalDatabaseParameters(List.of(RelationalDatabaseParameterProperty.builder()
                 .allowedValues("allowedValues")
                 .applyMethod("applyMethod")
                 .applyType("applyType")
                 .dataType("dataType")
                 .description("description")
                 .isModifiable(false)
                 .parameterName("parameterName")
                 .parameterValue("parameterValue")
                 .build()))
         .rotateMasterUserPassword(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDatabase.Builder A fluent builder for CfnDatabase.
static interface	CfnDatabase.RelationalDatabaseParameterProperty `RelationalDatabaseParameter` is a property of the [AWS::Lightsail::Database](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html) resource.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDatabase(software.constructs.Construct scope, String id, CfnDatabaseProps props) Create a new `AWS::Lightsail::Database`.
protected	CfnDatabase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDatabase(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrDatabaseArn() The Amazon Resource Name (ARN) of the database (for example, `arn:aws:lightsail:us-east-2:123456789101:RelationalDatabase/244ad76f-8aad-4741-809f-12345EXAMPLE` ).
String	getAvailabilityZone() The Availability Zone for the database.
Object	getBackupRetention() A Boolean value indicating whether automated backup retention is enabled for the database.
String	getCaCertificateIdentifier() The certificate associated with the database.
protected Map<String,Object>	getCfnProperties()
String	getMasterDatabaseName() The meaning of this parameter differs according to the database engine you use.
String	getMasterUsername() The name for the primary user.
String	getMasterUserPassword() The password for the primary user of the database.
String	getPreferredBackupWindow() The daily time range during which automated backups are created for the database (for example, `16:00-16:30` ).
String	getPreferredMaintenanceWindow() The weekly time range during which system maintenance can occur for the database, formatted as follows: `ddd:hh24:mi-ddd:hh24:mi` .
Object	getPubliclyAccessible() A Boolean value indicating whether the database is accessible to anyone on the internet.
String	getRelationalDatabaseBlueprintId() The blueprint ID for the database (for example, `mysql_8_0` ).
String	getRelationalDatabaseBundleId() The bundle ID for the database (for example, `medium_1_0` ).
String	getRelationalDatabaseName() The name of the instance.
Object	getRelationalDatabaseParameters() An array of parameters for the database.
Object	getRotateMasterUserPassword() A Boolean value indicating whether to change the primary user password to a new, strong password generated by Lightsail .
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAvailabilityZone(String value) The Availability Zone for the database.
void	setBackupRetention(Boolean value) A Boolean value indicating whether automated backup retention is enabled for the database.
void	setBackupRetention(IResolvable value) A Boolean value indicating whether automated backup retention is enabled for the database.
void	setCaCertificateIdentifier(String value) The certificate associated with the database.
void	setMasterDatabaseName(String value) The meaning of this parameter differs according to the database engine you use.
void	setMasterUsername(String value) The name for the primary user.
void	setMasterUserPassword(String value) The password for the primary user of the database.
void	setPreferredBackupWindow(String value) The daily time range during which automated backups are created for the database (for example, `16:00-16:30` ).
void	setPreferredMaintenanceWindow(String value) The weekly time range during which system maintenance can occur for the database, formatted as follows: `ddd:hh24:mi-ddd:hh24:mi` .
void	setPubliclyAccessible(Boolean value) A Boolean value indicating whether the database is accessible to anyone on the internet.
void	setPubliclyAccessible(IResolvable value) A Boolean value indicating whether the database is accessible to anyone on the internet.
void	setRelationalDatabaseBlueprintId(String value) The blueprint ID for the database (for example, `mysql_8_0` ).
void	setRelationalDatabaseBundleId(String value) The bundle ID for the database (for example, `medium_1_0` ).
void	setRelationalDatabaseName(String value) The name of the instance.
void	setRelationalDatabaseParameters(IResolvable value) An array of parameters for the database.
void	setRelationalDatabaseParameters(List<Object> value) An array of parameters for the database.
void	setRotateMasterUserPassword(Boolean value) A Boolean value indicating whether to change the primary user password to a new, strong password generated by Lightsail .
void	setRotateMasterUserPassword(IResolvable value) A Boolean value indicating whether to change the primary user password to a new, strong password generated by Lightsail .

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDatabase

protected CfnDatabase(software.amazon.jsii.JsiiObjectRef objRef)

CfnDatabase

protected CfnDatabase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDatabase

@Stability(value=Stable)
public CfnDatabase(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            CfnDatabaseProps props)

Create a new `AWS::Lightsail::Database`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrDatabaseArn

@Stability(value=Stable)
 @NotNull
public String getAttrDatabaseArn()

The Amazon Resource Name (ARN) of the database (for example, `arn:aws:lightsail:us-east-2:123456789101:RelationalDatabase/244ad76f-8aad-4741-809f-12345EXAMPLE` ).

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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.

getMasterDatabaseName

@Stability(value=Stable)
 @NotNull
public String getMasterDatabaseName()

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 .

setMasterDatabaseName

@Stability(value=Stable)
public void setMasterDatabaseName(@NotNull
                                                           String value)

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 .

getMasterUsername

@Stability(value=Stable)
 @NotNull
public String getMasterUsername()

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 .

setMasterUsername

@Stability(value=Stable)
public void setMasterUsername(@NotNull
                                                       String value)

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 .

getRelationalDatabaseBlueprintId

@Stability(value=Stable)
 @NotNull
public String getRelationalDatabaseBlueprintId()

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

setRelationalDatabaseBlueprintId

@Stability(value=Stable)
public void setRelationalDatabaseBlueprintId(@NotNull
                                                                      String value)

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

getRelationalDatabaseBundleId

@Stability(value=Stable)
 @NotNull
public String getRelationalDatabaseBundleId()

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

setRelationalDatabaseBundleId

@Stability(value=Stable)
public void setRelationalDatabaseBundleId(@NotNull
                                                                   String value)

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

getRelationalDatabaseName

@Stability(value=Stable)
 @NotNull
public String getRelationalDatabaseName()

The name of the instance.

setRelationalDatabaseName

@Stability(value=Stable)
public void setRelationalDatabaseName(@NotNull
                                                               String value)

The name of the instance.

getAvailabilityZone

@Stability(value=Stable)
 @Nullable
public String getAvailabilityZone()

The Availability Zone for the database.

setAvailabilityZone

@Stability(value=Stable)
public void setAvailabilityZone(@Nullable
                                                         String value)

The Availability Zone for the database.

getBackupRetention

@Stability(value=Stable)
 @Nullable
public Object getBackupRetention()

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

setBackupRetention

@Stability(value=Stable)
public void setBackupRetention(@Nullable
                                                        Boolean value)

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

setBackupRetention

@Stability(value=Stable)
public void setBackupRetention(@Nullable
                                                        IResolvable value)

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

getCaCertificateIdentifier

@Stability(value=Stable)
 @Nullable
public String getCaCertificateIdentifier()

The certificate associated with the database.

setCaCertificateIdentifier

@Stability(value=Stable)
public void setCaCertificateIdentifier(@Nullable
                                                                String value)

The certificate associated with the database.

getMasterUserPassword

@Stability(value=Stable)
 @Nullable
public String getMasterUserPassword()

The password for the primary user of the database.

The password can include any printable ASCII character except the following: /, ", or @. It cannot contain spaces.

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

MySQL

Constraints: Must contain 8-41 characters.

PostgreSQL

Constraints: Must contain 8-128 characters.

setMasterUserPassword

@Stability(value=Stable)
public void setMasterUserPassword(@Nullable
                                                           String value)

The password for the primary user of the database.

The password can include any printable ASCII character except the following: /, ", or @. It cannot contain spaces.

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

MySQL

Constraints: Must contain 8-41 characters.

PostgreSQL

Constraints: Must contain 8-128 characters.

getPreferredBackupWindow

@Stability(value=Stable)
 @Nullable
public String getPreferredBackupWindow()

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

setPreferredBackupWindow

@Stability(value=Stable)
public void setPreferredBackupWindow(@Nullable
                                                              String value)

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

getPreferredMaintenanceWindow

@Stability(value=Stable)
 @Nullable
public String getPreferredMaintenanceWindow()

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 .

setPreferredMaintenanceWindow

@Stability(value=Stable)
public void setPreferredMaintenanceWindow(@Nullable
                                                                   String value)

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 .

getPubliclyAccessible

@Stability(value=Stable)
 @Nullable
public Object getPubliclyAccessible()

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

setPubliclyAccessible

@Stability(value=Stable)
public void setPubliclyAccessible(@Nullable
                                                           Boolean value)

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

setPubliclyAccessible

@Stability(value=Stable)
public void setPubliclyAccessible(@Nullable
                                                           IResolvable value)

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

getRelationalDatabaseParameters

@Stability(value=Stable)
 @Nullable
public Object getRelationalDatabaseParameters()

An array of parameters for the database.

setRelationalDatabaseParameters

@Stability(value=Stable)
public void setRelationalDatabaseParameters(@Nullable
                                                                     IResolvable value)

An array of parameters for the database.

setRelationalDatabaseParameters

@Stability(value=Stable)
public void setRelationalDatabaseParameters(@Nullable
                                                                     List<Object> value)

An array of parameters for the database.

getRotateMasterUserPassword

@Stability(value=Stable)
 @Nullable
public Object getRotateMasterUserPassword()

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.

setRotateMasterUserPassword

@Stability(value=Stable)
public void setRotateMasterUserPassword(@Nullable
                                                                 Boolean value)

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.

setRotateMasterUserPassword

@Stability(value=Stable)
public void setRotateMasterUserPassword(@Nullable
                                                                 IResolvable value)

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.