Skip to content

Latest commit

 

History

History
1896 lines (1192 loc) · 92.4 KB

File metadata and controls

1896 lines (1192 loc) · 92.4 KB

lightsailDatabase Submodule

Constructs

LightsailDatabase

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database aws_lightsail_database}.

Initializers

import io.cdktn.providers.aws.lightsail_database.LightsailDatabase;

LightsailDatabase.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection|WinrmProvisionerConnection)
//  .count(java.lang.Number|TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner>)
    .blueprintId(java.lang.String)
    .bundleId(java.lang.String)
    .masterDatabaseName(java.lang.String)
    .masterPassword(java.lang.String)
    .masterUsername(java.lang.String)
    .relationalDatabaseName(java.lang.String)
//  .applyImmediately(java.lang.Boolean|IResolvable)
//  .availabilityZone(java.lang.String)
//  .backupRetentionEnabled(java.lang.Boolean|IResolvable)
//  .finalSnapshotName(java.lang.String)
//  .id(java.lang.String)
//  .preferredBackupWindow(java.lang.String)
//  .preferredMaintenanceWindow(java.lang.String)
//  .publiclyAccessible(java.lang.Boolean|IResolvable)
//  .region(java.lang.String)
//  .skipFinalSnapshot(java.lang.Boolean|IResolvable)
//  .tags(java.util.Map<java.lang.String, java.lang.String>)
//  .tagsAll(java.util.Map<java.lang.String, java.lang.String>)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection No description.
count java.lang.Number|io.cdktn.cdktn.TerraformCount No description.
dependsOn java.util.List<io.cdktn.cdktn.ITerraformDependable> No description.
forEach io.cdktn.cdktn.ITerraformIterator No description.
lifecycle io.cdktn.cdktn.TerraformResourceLifecycle No description.
provider io.cdktn.cdktn.TerraformProvider No description.
provisioners java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner> No description.
blueprintId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#blueprint_id LightsailDatabase#blueprint_id}.
bundleId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#bundle_id LightsailDatabase#bundle_id}.
masterDatabaseName java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#master_database_name LightsailDatabase#master_database_name}.
masterPassword java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#master_password LightsailDatabase#master_password}.
masterUsername java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#master_username LightsailDatabase#master_username}.
relationalDatabaseName java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#relational_database_name LightsailDatabase#relational_database_name}.
applyImmediately java.lang.Boolean|io.cdktn.cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#apply_immediately LightsailDatabase#apply_immediately}.
availabilityZone java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#availability_zone LightsailDatabase#availability_zone}.
backupRetentionEnabled java.lang.Boolean|io.cdktn.cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#backup_retention_enabled LightsailDatabase#backup_retention_enabled}.
finalSnapshotName java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#final_snapshot_name LightsailDatabase#final_snapshot_name}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#id LightsailDatabase#id}.
preferredBackupWindow java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#preferred_backup_window LightsailDatabase#preferred_backup_window}.
preferredMaintenanceWindow java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#preferred_maintenance_window LightsailDatabase#preferred_maintenance_window}.
publiclyAccessible java.lang.Boolean|io.cdktn.cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#publicly_accessible LightsailDatabase#publicly_accessible}.
region java.lang.String Region where this resource will be managed. Defaults to the Region set in the provider configuration.
skipFinalSnapshot java.lang.Boolean|io.cdktn.cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#skip_final_snapshot LightsailDatabase#skip_final_snapshot}.
tags java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#tags LightsailDatabase#tags}.
tagsAll java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#tags_all LightsailDatabase#tags_all}.

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope


connectionOptional
  • Type: io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection

countOptional
  • Type: java.lang.Number|io.cdktn.cdktn.TerraformCount

dependsOnOptional
  • Type: java.util.List<io.cdktn.cdktn.ITerraformDependable>

forEachOptional
  • Type: io.cdktn.cdktn.ITerraformIterator

lifecycleOptional
  • Type: io.cdktn.cdktn.TerraformResourceLifecycle

providerOptional
  • Type: io.cdktn.cdktn.TerraformProvider

provisionersOptional
  • Type: java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner>

blueprintIdRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#blueprint_id LightsailDatabase#blueprint_id}.


bundleIdRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#bundle_id LightsailDatabase#bundle_id}.


masterDatabaseNameRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#master_database_name LightsailDatabase#master_database_name}.


masterPasswordRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#master_password LightsailDatabase#master_password}.


masterUsernameRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#master_username LightsailDatabase#master_username}.


relationalDatabaseNameRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#relational_database_name LightsailDatabase#relational_database_name}.


applyImmediatelyOptional
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#apply_immediately LightsailDatabase#apply_immediately}.


availabilityZoneOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#availability_zone LightsailDatabase#availability_zone}.


backupRetentionEnabledOptional
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#backup_retention_enabled LightsailDatabase#backup_retention_enabled}.


finalSnapshotNameOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#final_snapshot_name LightsailDatabase#final_snapshot_name}.


idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#id LightsailDatabase#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.


preferredBackupWindowOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#preferred_backup_window LightsailDatabase#preferred_backup_window}.


preferredMaintenanceWindowOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#preferred_maintenance_window LightsailDatabase#preferred_maintenance_window}.


publiclyAccessibleOptional
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#publicly_accessible LightsailDatabase#publicly_accessible}.


regionOptional
  • Type: java.lang.String

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#region LightsailDatabase#region}


skipFinalSnapshotOptional
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#skip_final_snapshot LightsailDatabase#skip_final_snapshot}.


tagsOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#tags LightsailDatabase#tags}.


tagsAllOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#tags_all LightsailDatabase#tags_all}.


Methods

Name Description
toString Returns a string representation of this construct.
with Applies one or more mixins to this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
resetApplyImmediately No description.
resetAvailabilityZone No description.
resetBackupRetentionEnabled No description.
resetFinalSnapshotName No description.
resetId No description.
resetPreferredBackupWindow No description.
resetPreferredMaintenanceWindow No description.
resetPubliclyAccessible No description.
resetRegion No description.
resetSkipFinalSnapshot No description.
resetTags No description.
resetTagsAll No description.

toString
public java.lang.String toString()

Returns a string representation of this construct.

with
public IConstruct with(IMixin... mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixinsRequired
  • Type: software.constructs.IMixin...

The mixins to apply.


addOverride
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String

valueRequired
  • Type: java.lang.Object

overrideLogicalId
public void overrideLogicalId(java.lang.String newLogicalId)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.


resetOverrideLogicalId
public void resetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform
public java.lang.Object toHclTerraform()
toMetadata
public java.lang.Object toMetadata()
toTerraform
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget
public void addMoveTarget(java.lang.String moveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.


getAnyMapAttribute
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanAttribute
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanMapAttribute
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getListAttribute
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberAttribute
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberListAttribute
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberMapAttribute
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringAttribute
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringMapAttribute
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

hasResourceMove
public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove()
importFrom
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String

providerOptional
  • Type: io.cdktn.cdktn.TerraformProvider

interpolationForAttribute
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

moveFromId
public void moveFromId(java.lang.String id)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: java.lang.String

Full id of resource being moved from, e.g. "aws_s3_bucket.example".


moveTo
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.


indexOptional
  • Type: java.lang.String|java.lang.Number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.


moveToId
public void moveToId(java.lang.String id)

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: java.lang.String

Full id of resource to move to, e.g. "aws_s3_bucket.example".


resetApplyImmediately
public void resetApplyImmediately()
resetAvailabilityZone
public void resetAvailabilityZone()
resetBackupRetentionEnabled
public void resetBackupRetentionEnabled()
resetFinalSnapshotName
public void resetFinalSnapshotName()
resetId
public void resetId()
resetPreferredBackupWindow
public void resetPreferredBackupWindow()
resetPreferredMaintenanceWindow
public void resetPreferredMaintenanceWindow()
resetPubliclyAccessible
public void resetPubliclyAccessible()
resetRegion
public void resetRegion()
resetSkipFinalSnapshot
public void resetSkipFinalSnapshot()
resetTags
public void resetTags()
resetTagsAll
public void resetTagsAll()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTN code for importing a LightsailDatabase resource upon running "cdktn plan ".

isConstruct
import io.cdktn.providers.aws.lightsail_database.LightsailDatabase;

LightsailDatabase.isConstruct(java.lang.Object x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: java.lang.Object

Any object.


isTerraformElement
import io.cdktn.providers.aws.lightsail_database.LightsailDatabase;

LightsailDatabase.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object

isTerraformResource
import io.cdktn.providers.aws.lightsail_database.LightsailDatabase;

LightsailDatabase.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object

generateConfigForImport
import io.cdktn.providers.aws.lightsail_database.LightsailDatabase;

LightsailDatabase.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),LightsailDatabase.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

Generates CDKTN code for importing a LightsailDatabase resource upon running "cdktn plan ".

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: java.lang.String

The construct id used in the generated config for the LightsailDatabase to import.


importFromIdRequired
  • Type: java.lang.String

The id of the existing LightsailDatabase that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#import import section} in the documentation of this resource for the id to use


providerOptional
  • Type: io.cdktn.cdktn.TerraformProvider

? Optional instance of the provider where the LightsailDatabase to import is found.


Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack io.cdktn.cdktn.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata io.cdktn.cdktn.TerraformProviderGeneratorMetadata No description.
connection io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection No description.
count java.lang.Number|io.cdktn.cdktn.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach io.cdktn.cdktn.ITerraformIterator No description.
lifecycle io.cdktn.cdktn.TerraformResourceLifecycle No description.
provider io.cdktn.cdktn.TerraformProvider No description.
provisioners java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner> No description.
arn java.lang.String No description.
caCertificateIdentifier java.lang.String No description.
cpuCount java.lang.Number No description.
createdAt java.lang.String No description.
diskSize java.lang.Number No description.
engine java.lang.String No description.
engineVersion java.lang.String No description.
masterEndpointAddress java.lang.String No description.
masterEndpointPort java.lang.Number No description.
ramSize java.lang.Number No description.
secondaryAvailabilityZone java.lang.String No description.
supportCode java.lang.String No description.
applyImmediatelyInput java.lang.Boolean|io.cdktn.cdktn.IResolvable No description.
availabilityZoneInput java.lang.String No description.
backupRetentionEnabledInput java.lang.Boolean|io.cdktn.cdktn.IResolvable No description.
blueprintIdInput java.lang.String No description.
bundleIdInput java.lang.String No description.
finalSnapshotNameInput java.lang.String No description.
idInput java.lang.String No description.
masterDatabaseNameInput java.lang.String No description.
masterPasswordInput java.lang.String No description.
masterUsernameInput java.lang.String No description.
preferredBackupWindowInput java.lang.String No description.
preferredMaintenanceWindowInput java.lang.String No description.
publiclyAccessibleInput java.lang.Boolean|io.cdktn.cdktn.IResolvable No description.
regionInput java.lang.String No description.
relationalDatabaseNameInput java.lang.String No description.
skipFinalSnapshotInput java.lang.Boolean|io.cdktn.cdktn.IResolvable No description.
tagsAllInput java.util.Map<java.lang.String, java.lang.String> No description.
tagsInput java.util.Map<java.lang.String, java.lang.String> No description.
applyImmediately java.lang.Boolean|io.cdktn.cdktn.IResolvable No description.
availabilityZone java.lang.String No description.
backupRetentionEnabled java.lang.Boolean|io.cdktn.cdktn.IResolvable No description.
blueprintId java.lang.String No description.
bundleId java.lang.String No description.
finalSnapshotName java.lang.String No description.
id java.lang.String No description.
masterDatabaseName java.lang.String No description.
masterPassword java.lang.String No description.
masterUsername java.lang.String No description.
preferredBackupWindow java.lang.String No description.
preferredMaintenanceWindow java.lang.String No description.
publiclyAccessible java.lang.Boolean|io.cdktn.cdktn.IResolvable No description.
region java.lang.String No description.
relationalDatabaseName java.lang.String No description.
skipFinalSnapshot java.lang.Boolean|io.cdktn.cdktn.IResolvable No description.
tags java.util.Map<java.lang.String, java.lang.String> No description.
tagsAll java.util.Map<java.lang.String, java.lang.String> No description.

nodeRequired
public Node getNode();
  • Type: software.constructs.Node

The tree node.


cdktfStackRequired
public TerraformStack getCdktfStack();
  • Type: io.cdktn.cdktn.TerraformStack

fqnRequired
public java.lang.String getFqn();
  • Type: java.lang.String

friendlyUniqueIdRequired
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String

terraformMetaArgumentsRequired
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>

terraformResourceTypeRequired
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String

terraformGeneratorMetadataOptional
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: io.cdktn.cdktn.TerraformProviderGeneratorMetadata

connectionOptional
public SSHProvisionerConnection|WinrmProvisionerConnection getConnection();
  • Type: io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection

countOptional
public java.lang.Number|TerraformCount getCount();
  • Type: java.lang.Number|io.cdktn.cdktn.TerraformCount

dependsOnOptional
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>

forEachOptional
public ITerraformIterator getForEach();
  • Type: io.cdktn.cdktn.ITerraformIterator

lifecycleOptional
public TerraformResourceLifecycle getLifecycle();
  • Type: io.cdktn.cdktn.TerraformResourceLifecycle

providerOptional
public TerraformProvider getProvider();
  • Type: io.cdktn.cdktn.TerraformProvider

provisionersOptional
public java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner> getProvisioners();
  • Type: java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner>

arnRequired
public java.lang.String getArn();
  • Type: java.lang.String

caCertificateIdentifierRequired
public java.lang.String getCaCertificateIdentifier();
  • Type: java.lang.String

cpuCountRequired
public java.lang.Number getCpuCount();
  • Type: java.lang.Number

createdAtRequired
public java.lang.String getCreatedAt();
  • Type: java.lang.String

diskSizeRequired
public java.lang.Number getDiskSize();
  • Type: java.lang.Number

engineRequired
public java.lang.String getEngine();
  • Type: java.lang.String

engineVersionRequired
public java.lang.String getEngineVersion();
  • Type: java.lang.String

masterEndpointAddressRequired
public java.lang.String getMasterEndpointAddress();
  • Type: java.lang.String

masterEndpointPortRequired
public java.lang.Number getMasterEndpointPort();
  • Type: java.lang.Number

ramSizeRequired
public java.lang.Number getRamSize();
  • Type: java.lang.Number

secondaryAvailabilityZoneRequired
public java.lang.String getSecondaryAvailabilityZone();
  • Type: java.lang.String

supportCodeRequired
public java.lang.String getSupportCode();
  • Type: java.lang.String

applyImmediatelyInputOptional
public java.lang.Boolean|IResolvable getApplyImmediatelyInput();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

availabilityZoneInputOptional
public java.lang.String getAvailabilityZoneInput();
  • Type: java.lang.String

backupRetentionEnabledInputOptional
public java.lang.Boolean|IResolvable getBackupRetentionEnabledInput();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

blueprintIdInputOptional
public java.lang.String getBlueprintIdInput();
  • Type: java.lang.String

bundleIdInputOptional
public java.lang.String getBundleIdInput();
  • Type: java.lang.String

finalSnapshotNameInputOptional
public java.lang.String getFinalSnapshotNameInput();
  • Type: java.lang.String

idInputOptional
public java.lang.String getIdInput();
  • Type: java.lang.String

masterDatabaseNameInputOptional
public java.lang.String getMasterDatabaseNameInput();
  • Type: java.lang.String

masterPasswordInputOptional
public java.lang.String getMasterPasswordInput();
  • Type: java.lang.String

masterUsernameInputOptional
public java.lang.String getMasterUsernameInput();
  • Type: java.lang.String

preferredBackupWindowInputOptional
public java.lang.String getPreferredBackupWindowInput();
  • Type: java.lang.String

preferredMaintenanceWindowInputOptional
public java.lang.String getPreferredMaintenanceWindowInput();
  • Type: java.lang.String

publiclyAccessibleInputOptional
public java.lang.Boolean|IResolvable getPubliclyAccessibleInput();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

regionInputOptional
public java.lang.String getRegionInput();
  • Type: java.lang.String

relationalDatabaseNameInputOptional
public java.lang.String getRelationalDatabaseNameInput();
  • Type: java.lang.String

skipFinalSnapshotInputOptional
public java.lang.Boolean|IResolvable getSkipFinalSnapshotInput();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

tagsAllInputOptional
public java.util.Map<java.lang.String, java.lang.String> getTagsAllInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>

tagsInputOptional
public java.util.Map<java.lang.String, java.lang.String> getTagsInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>

applyImmediatelyRequired
public java.lang.Boolean|IResolvable getApplyImmediately();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

availabilityZoneRequired
public java.lang.String getAvailabilityZone();
  • Type: java.lang.String

backupRetentionEnabledRequired
public java.lang.Boolean|IResolvable getBackupRetentionEnabled();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

blueprintIdRequired
public java.lang.String getBlueprintId();
  • Type: java.lang.String

bundleIdRequired
public java.lang.String getBundleId();
  • Type: java.lang.String

finalSnapshotNameRequired
public java.lang.String getFinalSnapshotName();
  • Type: java.lang.String

idRequired
public java.lang.String getId();
  • Type: java.lang.String

masterDatabaseNameRequired
public java.lang.String getMasterDatabaseName();
  • Type: java.lang.String

masterPasswordRequired
public java.lang.String getMasterPassword();
  • Type: java.lang.String

masterUsernameRequired
public java.lang.String getMasterUsername();
  • Type: java.lang.String

preferredBackupWindowRequired
public java.lang.String getPreferredBackupWindow();
  • Type: java.lang.String

preferredMaintenanceWindowRequired
public java.lang.String getPreferredMaintenanceWindow();
  • Type: java.lang.String

publiclyAccessibleRequired
public java.lang.Boolean|IResolvable getPubliclyAccessible();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

regionRequired
public java.lang.String getRegion();
  • Type: java.lang.String

relationalDatabaseNameRequired
public java.lang.String getRelationalDatabaseName();
  • Type: java.lang.String

skipFinalSnapshotRequired
public java.lang.Boolean|IResolvable getSkipFinalSnapshot();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

tagsRequired
public java.util.Map<java.lang.String, java.lang.String> getTags();
  • Type: java.util.Map<java.lang.String, java.lang.String>

tagsAllRequired
public java.util.Map<java.lang.String, java.lang.String> getTagsAll();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Constants

Name Type Description
tfResourceType java.lang.String No description.

tfResourceTypeRequired
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

LightsailDatabaseConfig

Initializer

import io.cdktn.providers.aws.lightsail_database.LightsailDatabaseConfig;

LightsailDatabaseConfig.builder()
//  .connection(SSHProvisionerConnection|WinrmProvisionerConnection)
//  .count(java.lang.Number|TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner>)
    .blueprintId(java.lang.String)
    .bundleId(java.lang.String)
    .masterDatabaseName(java.lang.String)
    .masterPassword(java.lang.String)
    .masterUsername(java.lang.String)
    .relationalDatabaseName(java.lang.String)
//  .applyImmediately(java.lang.Boolean|IResolvable)
//  .availabilityZone(java.lang.String)
//  .backupRetentionEnabled(java.lang.Boolean|IResolvable)
//  .finalSnapshotName(java.lang.String)
//  .id(java.lang.String)
//  .preferredBackupWindow(java.lang.String)
//  .preferredMaintenanceWindow(java.lang.String)
//  .publiclyAccessible(java.lang.Boolean|IResolvable)
//  .region(java.lang.String)
//  .skipFinalSnapshot(java.lang.Boolean|IResolvable)
//  .tags(java.util.Map<java.lang.String, java.lang.String>)
//  .tagsAll(java.util.Map<java.lang.String, java.lang.String>)
    .build();

Properties

Name Type Description
connection io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection No description.
count java.lang.Number|io.cdktn.cdktn.TerraformCount No description.
dependsOn java.util.List<io.cdktn.cdktn.ITerraformDependable> No description.
forEach io.cdktn.cdktn.ITerraformIterator No description.
lifecycle io.cdktn.cdktn.TerraformResourceLifecycle No description.
provider io.cdktn.cdktn.TerraformProvider No description.
provisioners java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner> No description.
blueprintId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#blueprint_id LightsailDatabase#blueprint_id}.
bundleId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#bundle_id LightsailDatabase#bundle_id}.
masterDatabaseName java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#master_database_name LightsailDatabase#master_database_name}.
masterPassword java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#master_password LightsailDatabase#master_password}.
masterUsername java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#master_username LightsailDatabase#master_username}.
relationalDatabaseName java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#relational_database_name LightsailDatabase#relational_database_name}.
applyImmediately java.lang.Boolean|io.cdktn.cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#apply_immediately LightsailDatabase#apply_immediately}.
availabilityZone java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#availability_zone LightsailDatabase#availability_zone}.
backupRetentionEnabled java.lang.Boolean|io.cdktn.cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#backup_retention_enabled LightsailDatabase#backup_retention_enabled}.
finalSnapshotName java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#final_snapshot_name LightsailDatabase#final_snapshot_name}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#id LightsailDatabase#id}.
preferredBackupWindow java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#preferred_backup_window LightsailDatabase#preferred_backup_window}.
preferredMaintenanceWindow java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#preferred_maintenance_window LightsailDatabase#preferred_maintenance_window}.
publiclyAccessible java.lang.Boolean|io.cdktn.cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#publicly_accessible LightsailDatabase#publicly_accessible}.
region java.lang.String Region where this resource will be managed. Defaults to the Region set in the provider configuration.
skipFinalSnapshot java.lang.Boolean|io.cdktn.cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#skip_final_snapshot LightsailDatabase#skip_final_snapshot}.
tags java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#tags LightsailDatabase#tags}.
tagsAll java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#tags_all LightsailDatabase#tags_all}.

connectionOptional
public SSHProvisionerConnection|WinrmProvisionerConnection getConnection();
  • Type: io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection

countOptional
public java.lang.Number|TerraformCount getCount();
  • Type: java.lang.Number|io.cdktn.cdktn.TerraformCount

dependsOnOptional
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<io.cdktn.cdktn.ITerraformDependable>

forEachOptional
public ITerraformIterator getForEach();
  • Type: io.cdktn.cdktn.ITerraformIterator

lifecycleOptional
public TerraformResourceLifecycle getLifecycle();
  • Type: io.cdktn.cdktn.TerraformResourceLifecycle

providerOptional
public TerraformProvider getProvider();
  • Type: io.cdktn.cdktn.TerraformProvider

provisionersOptional
public java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner> getProvisioners();
  • Type: java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner>

blueprintIdRequired
public java.lang.String getBlueprintId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#blueprint_id LightsailDatabase#blueprint_id}.


bundleIdRequired
public java.lang.String getBundleId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#bundle_id LightsailDatabase#bundle_id}.


masterDatabaseNameRequired
public java.lang.String getMasterDatabaseName();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#master_database_name LightsailDatabase#master_database_name}.


masterPasswordRequired
public java.lang.String getMasterPassword();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#master_password LightsailDatabase#master_password}.


masterUsernameRequired
public java.lang.String getMasterUsername();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#master_username LightsailDatabase#master_username}.


relationalDatabaseNameRequired
public java.lang.String getRelationalDatabaseName();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#relational_database_name LightsailDatabase#relational_database_name}.


applyImmediatelyOptional
public java.lang.Boolean|IResolvable getApplyImmediately();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#apply_immediately LightsailDatabase#apply_immediately}.


availabilityZoneOptional
public java.lang.String getAvailabilityZone();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#availability_zone LightsailDatabase#availability_zone}.


backupRetentionEnabledOptional
public java.lang.Boolean|IResolvable getBackupRetentionEnabled();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#backup_retention_enabled LightsailDatabase#backup_retention_enabled}.


finalSnapshotNameOptional
public java.lang.String getFinalSnapshotName();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#final_snapshot_name LightsailDatabase#final_snapshot_name}.


idOptional
public java.lang.String getId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#id LightsailDatabase#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.


preferredBackupWindowOptional
public java.lang.String getPreferredBackupWindow();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#preferred_backup_window LightsailDatabase#preferred_backup_window}.


preferredMaintenanceWindowOptional
public java.lang.String getPreferredMaintenanceWindow();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#preferred_maintenance_window LightsailDatabase#preferred_maintenance_window}.


publiclyAccessibleOptional
public java.lang.Boolean|IResolvable getPubliclyAccessible();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#publicly_accessible LightsailDatabase#publicly_accessible}.


regionOptional
public java.lang.String getRegion();
  • Type: java.lang.String

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#region LightsailDatabase#region}


skipFinalSnapshotOptional
public java.lang.Boolean|IResolvable getSkipFinalSnapshot();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#skip_final_snapshot LightsailDatabase#skip_final_snapshot}.


tagsOptional
public java.util.Map<java.lang.String, java.lang.String> getTags();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#tags LightsailDatabase#tags}.


tagsAllOptional
public java.util.Map<java.lang.String, java.lang.String> getTagsAll();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#tags_all LightsailDatabase#tags_all}.