Package software.amazon.awscdk.services.lightsail

Interface CfnDatabaseProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDatabaseProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:59.726Z") @Stability(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();

  • Method Details

    • getMasterDatabaseName

      @Stability(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(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(Stable) @NotNull String getRelationalDatabaseBlueprintId()
      The blueprint ID for the database (for example, mysql_8_0 ).

    • getRelationalDatabaseBundleId

      @Stability(Stable) @NotNull String getRelationalDatabaseBundleId()
      The bundle ID for the database (for example, medium_1_0 ).

    • getRelationalDatabaseName

      @Stability(Stable) @NotNull String getRelationalDatabaseName()
      The name of the instance.

    • getAvailabilityZone

      @Stability(Stable) @Nullable default String getAvailabilityZone()
      The Availability Zone for the database.

    • getBackupRetention

      @Stability(Stable) @Nullable default Object getBackupRetention()
      A Boolean value indicating whether automated backup retention is enabled for the database.

    • getCaCertificateIdentifier

      @Stability(Stable) @Nullable default String getCaCertificateIdentifier()
      The certificate associated with the database.

    • getMasterUserPassword

      @Stability(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(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(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(Stable) @Nullable default Object getPubliclyAccessible()
      A Boolean value indicating whether the database is accessible to anyone on the internet.

    • getRelationalDatabaseParameters

      @Stability(Stable) @Nullable default Object getRelationalDatabaseParameters()
      An array of parameters for the database.

    • getRotateMasterUserPassword

      @Stability(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(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(Stable) static CfnDatabaseProps.Builder builder()
      Returns:
      a CfnDatabaseProps.Builder of CfnDatabaseProps