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.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:18.422Z")
 @Stability(value=Stable)
public class CfnDatabase
extends CfnResource
implements IInspectable

A CloudFormation `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.*;
 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 Example:

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()
String	getAvailabilityZone() `AWS::Lightsail::Database.AvailabilityZone`.
Object	getBackupRetention() `AWS::Lightsail::Database.BackupRetention`.
String	getCaCertificateIdentifier() `AWS::Lightsail::Database.CaCertificateIdentifier`.
protected Map<String,Object>	getCfnProperties()
String	getMasterDatabaseName() `AWS::Lightsail::Database.MasterDatabaseName`.
String	getMasterUsername() `AWS::Lightsail::Database.MasterUsername`.
String	getMasterUserPassword() `AWS::Lightsail::Database.MasterUserPassword`.
String	getPreferredBackupWindow() `AWS::Lightsail::Database.PreferredBackupWindow`.
String	getPreferredMaintenanceWindow() `AWS::Lightsail::Database.PreferredMaintenanceWindow`.
Object	getPubliclyAccessible() `AWS::Lightsail::Database.PubliclyAccessible`.
String	getRelationalDatabaseBlueprintId() `AWS::Lightsail::Database.RelationalDatabaseBlueprintId`.
String	getRelationalDatabaseBundleId() `AWS::Lightsail::Database.RelationalDatabaseBundleId`.
String	getRelationalDatabaseName() `AWS::Lightsail::Database.RelationalDatabaseName`.
Object	getRelationalDatabaseParameters() `AWS::Lightsail::Database.RelationalDatabaseParameters`.
Object	getRotateMasterUserPassword() `AWS::Lightsail::Database.RotateMasterUserPassword`.
TagManager	getTags() `AWS::Lightsail::Database.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAvailabilityZone(String value) `AWS::Lightsail::Database.AvailabilityZone`.
void	setBackupRetention(Boolean value) `AWS::Lightsail::Database.BackupRetention`.
void	setBackupRetention(IResolvable value) `AWS::Lightsail::Database.BackupRetention`.
void	setCaCertificateIdentifier(String value) `AWS::Lightsail::Database.CaCertificateIdentifier`.
void	setMasterDatabaseName(String value) `AWS::Lightsail::Database.MasterDatabaseName`.
void	setMasterUsername(String value) `AWS::Lightsail::Database.MasterUsername`.
void	setMasterUserPassword(String value) `AWS::Lightsail::Database.MasterUserPassword`.
void	setPreferredBackupWindow(String value) `AWS::Lightsail::Database.PreferredBackupWindow`.
void	setPreferredMaintenanceWindow(String value) `AWS::Lightsail::Database.PreferredMaintenanceWindow`.
void	setPubliclyAccessible(Boolean value) `AWS::Lightsail::Database.PubliclyAccessible`.
void	setPubliclyAccessible(IResolvable value) `AWS::Lightsail::Database.PubliclyAccessible`.
void	setRelationalDatabaseBlueprintId(String value) `AWS::Lightsail::Database.RelationalDatabaseBlueprintId`.
void	setRelationalDatabaseBundleId(String value) `AWS::Lightsail::Database.RelationalDatabaseBundleId`.
void	setRelationalDatabaseName(String value) `AWS::Lightsail::Database.RelationalDatabaseName`.
void	setRelationalDatabaseParameters(IResolvable value) `AWS::Lightsail::Database.RelationalDatabaseParameters`.
void	setRelationalDatabaseParameters(List<Object> value) `AWS::Lightsail::Database.RelationalDatabaseParameters`.
void	setRotateMasterUserPassword(Boolean value) `AWS::Lightsail::Database.RotateMasterUserPassword`.
void	setRotateMasterUserPassword(IResolvable value) `AWS::Lightsail::Database.RotateMasterUserPassword`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, 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()

getAvailabilityZone

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

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

setAvailabilityZone

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

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

getBackupRetention

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

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

setBackupRetention

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

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

setBackupRetention

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

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

getCaCertificateIdentifier

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

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

setCaCertificateIdentifier

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

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getMasterDatabaseName

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

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

setMasterDatabaseName

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

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

getMasterUsername

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

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

setMasterUsername

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

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

getMasterUserPassword

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

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

setMasterUserPassword

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

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

getPreferredBackupWindow

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

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

setPreferredBackupWindow

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

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

getPreferredMaintenanceWindow

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

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

setPreferredMaintenanceWindow

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

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

getPubliclyAccessible

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

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

setPubliclyAccessible

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

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

setPubliclyAccessible

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

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

getRelationalDatabaseBlueprintId

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

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

setRelationalDatabaseBlueprintId

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

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

getRelationalDatabaseBundleId

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

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

setRelationalDatabaseBundleId

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

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

getRelationalDatabaseName

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

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

setRelationalDatabaseName

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

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

getRelationalDatabaseParameters

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

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

setRelationalDatabaseParameters

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

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

setRelationalDatabaseParameters

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

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

getRotateMasterUserPassword

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

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

setRotateMasterUserPassword

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

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

setRotateMasterUserPassword

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

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

getTags

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

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