CfnDatabaseProps (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnDatabaseProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.642Z")
 @Stability(value=Stable)
public interface CfnDatabaseProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnDatabase`.

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.*;
 CfnDatabaseProps cfnDatabaseProps = CfnDatabaseProps.builder()
         .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	Interface and Description
`static class`	`CfnDatabaseProps.Builder` A builder for `CfnDatabaseProps`
`static class`	`CfnDatabaseProps.Jsii$Proxy` An implementation for `CfnDatabaseProps`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static CfnDatabaseProps.Builder`	`builder()`
`default String`	`getAvailabilityZone()` The Availability Zone for the database.
`default Object`	`getBackupRetention()` A Boolean value indicating whether automated backup retention is enabled for the database.
`default String`	`getCaCertificateIdentifier()` The certificate associated with the database.
`String`	`getMasterDatabaseName()` The meaning of this parameter differs according to the database engine you use.
`String`	`getMasterUsername()` The name for the primary user.
`default String`	`getMasterUserPassword()` The password for the primary user of the database.
`default String`	`getPreferredBackupWindow()` The daily time range during which automated backups are created for the database (for example, `16:00-16:30` ).
`default String`	`getPreferredMaintenanceWindow()` The weekly time range during which system maintenance can occur for the database, formatted as follows: `ddd:hh24:mi-ddd:hh24:mi` .
`default 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.
`default Object`	`getRelationalDatabaseParameters()` An array of parameters for the database.
`default Object`	`getRotateMasterUserPassword()` A Boolean value indicating whether to change the primary user password to a new, strong password generated by Lightsail .
`default List<CfnTag>`	`getTags()` An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getMasterDatabaseName
```
@Stability(value=Stable)
 @NotNull
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 .
  - getMasterUsername
```
@Stability(value=Stable)
 @NotNull
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 .
  - getRelationalDatabaseBlueprintId
```
@Stability(value=Stable)
 @NotNull
String getRelationalDatabaseBlueprintId()
```
    The blueprint ID for the database (for example, `mysql_8_0` ).
  - getRelationalDatabaseBundleId
```
@Stability(value=Stable)
 @NotNull
String getRelationalDatabaseBundleId()
```
    The bundle ID for the database (for example, `medium_1_0` ).
  - getRelationalDatabaseName
```
@Stability(value=Stable)
 @NotNull
String getRelationalDatabaseName()
```
    The name of the instance.
  - getAvailabilityZone
```
@Stability(value=Stable)
 @Nullable
default String getAvailabilityZone()
```
    The Availability Zone for the database.
  - getBackupRetention
```
@Stability(value=Stable)
 @Nullable
default Object getBackupRetention()
```
    A Boolean value indicating whether automated backup retention is enabled for the database.
  - getCaCertificateIdentifier
```
@Stability(value=Stable)
 @Nullable
default String getCaCertificateIdentifier()
```
    The certificate associated with the database.
  - getMasterUserPassword
```
@Stability(value=Stable)
 @Nullable
default 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.
  - getPreferredBackupWindow
```
@Stability(value=Stable)
 @Nullable
default String getPreferredBackupWindow()
```
    The daily time range during which automated backups are created for the database (for example, `16:00-16:30` ).
  - getPreferredMaintenanceWindow
```
@Stability(value=Stable)
 @Nullable
default 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 .
  - getPubliclyAccessible
```
@Stability(value=Stable)
 @Nullable
default Object getPubliclyAccessible()
```
    A Boolean value indicating whether the database is accessible to anyone on the internet.
  - getRelationalDatabaseParameters
```
@Stability(value=Stable)
 @Nullable
default Object getRelationalDatabaseParameters()
```
    An array of parameters for the database.
  - getRotateMasterUserPassword
```
@Stability(value=Stable)
 @Nullable
default 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.
  - getTags
```
@Stability(value=Stable)
 @Nullable
default List<CfnTag> 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.
  - builder
```
@Stability(value=Stable)
static CfnDatabaseProps.Builder builder()
```
    Returns:
    
    a CfnDatabaseProps.Builder of CfnDatabaseProps

Interface CfnDatabaseProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getMasterDatabaseName

getMasterUsername

getRelationalDatabaseBlueprintId

getRelationalDatabaseBundleId

getRelationalDatabaseName

getAvailabilityZone

getBackupRetention

getCaCertificateIdentifier

getMasterUserPassword

getPreferredBackupWindow

getPreferredMaintenanceWindow

getPubliclyAccessible

getRelationalDatabaseParameters

getRotateMasterUserPassword

getTags

builder