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.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:18.423Z")
 @Stability(value=Stable)
public interface CfnDatabaseProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::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.*;
 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

Modifier and Type	Method and Description
static CfnDatabaseProps.Builder	builder()
default String	getAvailabilityZone() `AWS::Lightsail::Database.AvailabilityZone`.
default Object	getBackupRetention() `AWS::Lightsail::Database.BackupRetention`.
default String	getCaCertificateIdentifier() `AWS::Lightsail::Database.CaCertificateIdentifier`.
String	getMasterDatabaseName() `AWS::Lightsail::Database.MasterDatabaseName`.
String	getMasterUsername() `AWS::Lightsail::Database.MasterUsername`.
default String	getMasterUserPassword() `AWS::Lightsail::Database.MasterUserPassword`.
default String	getPreferredBackupWindow() `AWS::Lightsail::Database.PreferredBackupWindow`.
default String	getPreferredMaintenanceWindow() `AWS::Lightsail::Database.PreferredMaintenanceWindow`.
default Object	getPubliclyAccessible() `AWS::Lightsail::Database.PubliclyAccessible`.
String	getRelationalDatabaseBlueprintId() `AWS::Lightsail::Database.RelationalDatabaseBlueprintId`.
String	getRelationalDatabaseBundleId() `AWS::Lightsail::Database.RelationalDatabaseBundleId`.
String	getRelationalDatabaseName() `AWS::Lightsail::Database.RelationalDatabaseName`.
default Object	getRelationalDatabaseParameters() `AWS::Lightsail::Database.RelationalDatabaseParameters`.
default Object	getRotateMasterUserPassword() `AWS::Lightsail::Database.RotateMasterUserPassword`.
default List<CfnTag>	getTags() `AWS::Lightsail::Database.Tags`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAvailabilityZone

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

`AWS::Lightsail::Database.AvailabilityZone`.

getBackupRetention

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

`AWS::Lightsail::Database.BackupRetention`.

getCaCertificateIdentifier

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

`AWS::Lightsail::Database.CaCertificateIdentifier`.

getMasterDatabaseName

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

`AWS::Lightsail::Database.MasterDatabaseName`.

getMasterUsername

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

`AWS::Lightsail::Database.MasterUsername`.

getMasterUserPassword

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

`AWS::Lightsail::Database.MasterUserPassword`.

getPreferredBackupWindow

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

`AWS::Lightsail::Database.PreferredBackupWindow`.

getPreferredMaintenanceWindow

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

`AWS::Lightsail::Database.PreferredMaintenanceWindow`.

getPubliclyAccessible

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

`AWS::Lightsail::Database.PubliclyAccessible`.

getRelationalDatabaseBlueprintId

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

`AWS::Lightsail::Database.RelationalDatabaseBlueprintId`.

getRelationalDatabaseBundleId

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

`AWS::Lightsail::Database.RelationalDatabaseBundleId`.

getRelationalDatabaseName

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

`AWS::Lightsail::Database.RelationalDatabaseName`.

getRelationalDatabaseParameters

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

`AWS::Lightsail::Database.RelationalDatabaseParameters`.

getRotateMasterUserPassword

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

`AWS::Lightsail::Database.RotateMasterUserPassword`.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

`AWS::Lightsail::Database.Tags`.

builder

@Stability(value=Stable)
static CfnDatabaseProps.Builder builder()

Returns:

a CfnDatabaseProps.Builder of CfnDatabaseProps