`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

from cdktn_provider_aws import lightsail_database

lightsailDatabase.LightsailDatabase(
  scope: Construct,
  id: str,
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  blueprint_id: str,
  bundle_id: str,
  master_database_name: str,
  master_password: str,
  master_username: str,
  relational_database_name: str,
  apply_immediately: bool | IResolvable = None,
  availability_zone: str = None,
  backup_retention_enabled: bool | IResolvable = None,
  final_snapshot_name: str = None,
  id: str = None,
  preferred_backup_window: str = None,
  preferred_maintenance_window: str = None,
  publicly_accessible: bool | IResolvable = None,
  region: str = None,
  skip_final_snapshot: bool | IResolvable = None,
  tags: typing.Mapping[str] = None,
  tags_all: typing.Mapping[str] = None
)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`str`	The scoped construct ID.
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktn.TerraformCount`	No description.
`depends_on`	`typing.List[cdktn.ITerraformDependable]`	No description.
`for_each`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner]`	No description.
`blueprint_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#blueprint_id LightsailDatabase#blueprint_id}.
`bundle_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#bundle_id LightsailDatabase#bundle_id}.
`master_database_name`	`str`	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}.
`master_password`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#master_password LightsailDatabase#master_password}.
`master_username`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#master_username LightsailDatabase#master_username}.
`relational_database_name`	`str`	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}.
`apply_immediately`	`bool \| 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}.
`availability_zone`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#availability_zone LightsailDatabase#availability_zone}.
`backup_retention_enabled`	`bool \| 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}.
`final_snapshot_name`	`str`	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`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#id LightsailDatabase#id}.
`preferred_backup_window`	`str`	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}.
`preferred_maintenance_window`	`str`	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}.
`publicly_accessible`	`bool \| 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`	`str`	Region where this resource will be managed. Defaults to the Region set in the provider configuration.
`skip_final_snapshot`	`bool \| 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`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#tags LightsailDatabase#tags}.
`tags_all`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#tags_all LightsailDatabase#tags_all}.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

`connection`^Optional

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

Type: typing.Union[int, float] | cdktn.TerraformCount

`depends_on`^Optional

Type: typing.List[cdktn.ITerraformDependable]

`for_each`^Optional

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

Type: cdktn.TerraformProvider

`provisioners`^Optional

Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

`blueprint_id`^Required

Type: str

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

`bundle_id`^Required

Type: str

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

`master_database_name`^Required

Type: str

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}.

`master_password`^Required

Type: str

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

`master_username`^Required

Type: str

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

`relational_database_name`^Required

Type: str

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}.

`apply_immediately`^Optional

Type: bool | 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}.

`availability_zone`^Optional

Type: str

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

`backup_retention_enabled`^Optional

Type: bool | 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}.

`final_snapshot_name`^Optional

Type: str

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`^Optional

Type: str

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.

`preferred_backup_window`^Optional

Type: str

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}.

`preferred_maintenance_window`^Optional

Type: str

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}.

`publicly_accessible`^Optional

Type: bool | 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`^Optional

Type: str

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}

`skip_final_snapshot`^Optional

Type: bool | 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`^Optional

Type: typing.Mapping[str]

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

`tags_all`^Optional

Type: typing.Mapping[str]

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
`to_string`	Returns a string representation of this construct.
`with`	Applies one or more mixins to this construct.
`add_override`	No description.
`override_logical_id`	Overrides the auto-generated logical ID with a specific ID.
`reset_override_logical_id`	Resets a previously passed logical Id to use the auto-generated logical id again.
`to_hcl_terraform`	No description.
`to_metadata`	No description.
`to_terraform`	Adds this resource to the terraform JSON output.
`add_move_target`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`get_any_map_attribute`	No description.
`get_boolean_attribute`	No description.
`get_boolean_map_attribute`	No description.
`get_list_attribute`	No description.
`get_number_attribute`	No description.
`get_number_list_attribute`	No description.
`get_number_map_attribute`	No description.
`get_string_attribute`	No description.
`get_string_map_attribute`	No description.
`has_resource_move`	No description.
`import_from`	No description.
`interpolation_for_attribute`	No description.
`move_from_id`	Move the resource corresponding to "id" to this resource.
`move_to`	Moves this resource to the target resource given by moveTarget.
`move_to_id`	Moves this resource to the resource corresponding to "id".
`reset_apply_immediately`	No description.
`reset_availability_zone`	No description.
`reset_backup_retention_enabled`	No description.
`reset_final_snapshot_name`	No description.
`reset_id`	No description.
`reset_preferred_backup_window`	No description.
`reset_preferred_maintenance_window`	No description.
`reset_publicly_accessible`	No description.
`reset_region`	No description.
`reset_skip_final_snapshot`	No description.
`reset_tags`	No description.
`reset_tags_all`	No description.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

`with`

def with(
  mixins: *IMixin
) -> IConstruct

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.

`mixins`^Required

Type: *constructs.IMixin

The mixins to apply.

`add_override`

def add_override(
  path: str,
  value: typing.Any
) -> None

`path`^Required

Type: str

`value`^Required

Type: typing.Any

`override_logical_id`

def override_logical_id(
  new_logical_id: str
) -> None

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

`new_logical_id`^Required

Type: str

The new logical ID to use for this stack element.

`reset_override_logical_id`

def reset_override_logical_id() -> None

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

`to_hcl_terraform`

def to_hcl_terraform() -> typing.Any

`to_metadata`

def to_metadata() -> typing.Any

`to_terraform`

def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

`add_move_target`

def add_move_target(
  move_target: str
) -> None

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

`move_target`^Required

Type: str

The string move target that will correspond to this resource.

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`has_resource_move`

def has_resource_move() -> TerraformResourceMoveByTarget | TerraformResourceMoveById

`import_from`

def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None

`id`^Required

Type: str

`provider`^Optional

Type: cdktn.TerraformProvider

`interpolation_for_attribute`

def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`move_from_id`

def move_from_id(
  id: str
) -> None

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.

`id`^Required

Type: str

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

`move_to`

def move_to(
  move_target: str,
  index: str | typing.Union[int, float] = None
) -> None

Moves this resource to the target resource given by moveTarget.

`move_target`^Required

Type: str

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

`index`^Optional

Type: str | typing.Union[int, float]

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

`move_to_id`

def move_to_id(
  id: str
) -> None

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

`id`^Required

Type: str

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

`reset_apply_immediately`

def reset_apply_immediately() -> None

`reset_availability_zone`

def reset_availability_zone() -> None

`reset_backup_retention_enabled`

def reset_backup_retention_enabled() -> None

`reset_final_snapshot_name`

def reset_final_snapshot_name() -> None

`reset_id`

def reset_id() -> None

`reset_preferred_backup_window`

def reset_preferred_backup_window() -> None

`reset_preferred_maintenance_window`

def reset_preferred_maintenance_window() -> None

`reset_publicly_accessible`

def reset_publicly_accessible() -> None

`reset_region`

def reset_region() -> None

`reset_skip_final_snapshot`

def reset_skip_final_snapshot() -> None

`reset_tags`

def reset_tags() -> None

`reset_tags_all`

def reset_tags_all() -> None

Static Functions

Name	Description
`is_construct`	Checks if `x` is a construct.
`is_terraform_element`	No description.
`is_terraform_resource`	No description.
`generate_config_for_import`	Generates CDKTN code for importing a LightsailDatabase resource upon running "cdktn plan ".

`is_construct`

from cdktn_provider_aws import lightsail_database

lightsailDatabase.LightsailDatabase.is_construct(
  x: typing.Any
)

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.

`x`^Required

Type: typing.Any

Any object.

`is_terraform_element`

from cdktn_provider_aws import lightsail_database

lightsailDatabase.LightsailDatabase.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_terraform_resource`

from cdktn_provider_aws import lightsail_database

lightsailDatabase.LightsailDatabase.is_terraform_resource(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`generate_config_for_import`

from cdktn_provider_aws import lightsail_database

lightsailDatabase.LightsailDatabase.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`import_to_id`^Required

Type: str

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

`import_from_id`^Required

Type: str

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

`provider`^Optional

Type: cdktn.TerraformProvider

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

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktf_stack`	`cdktn.TerraformStack`	No description.
`fqn`	`str`	No description.
`friendly_unique_id`	`str`	No description.
`terraform_meta_arguments`	`typing.Mapping[typing.Any]`	No description.
`terraform_resource_type`	`str`	No description.
`terraform_generator_metadata`	`cdktn.TerraformProviderGeneratorMetadata`	No description.
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktn.TerraformCount`	No description.
`depends_on`	`typing.List[str]`	No description.
`for_each`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner]`	No description.
`arn`	`str`	No description.
`ca_certificate_identifier`	`str`	No description.
`cpu_count`	`typing.Union[int, float]`	No description.
`created_at`	`str`	No description.
`disk_size`	`typing.Union[int, float]`	No description.
`engine`	`str`	No description.
`engine_version`	`str`	No description.
`master_endpoint_address`	`str`	No description.
`master_endpoint_port`	`typing.Union[int, float]`	No description.
`ram_size`	`typing.Union[int, float]`	No description.
`secondary_availability_zone`	`str`	No description.
`support_code`	`str`	No description.
`apply_immediately_input`	`bool \| cdktn.IResolvable`	No description.
`availability_zone_input`	`str`	No description.
`backup_retention_enabled_input`	`bool \| cdktn.IResolvable`	No description.
`blueprint_id_input`	`str`	No description.
`bundle_id_input`	`str`	No description.
`final_snapshot_name_input`	`str`	No description.
`id_input`	`str`	No description.
`master_database_name_input`	`str`	No description.
`master_password_input`	`str`	No description.
`master_username_input`	`str`	No description.
`preferred_backup_window_input`	`str`	No description.
`preferred_maintenance_window_input`	`str`	No description.
`publicly_accessible_input`	`bool \| cdktn.IResolvable`	No description.
`region_input`	`str`	No description.
`relational_database_name_input`	`str`	No description.
`skip_final_snapshot_input`	`bool \| cdktn.IResolvable`	No description.
`tags_all_input`	`typing.Mapping[str]`	No description.
`tags_input`	`typing.Mapping[str]`	No description.
`apply_immediately`	`bool \| cdktn.IResolvable`	No description.
`availability_zone`	`str`	No description.
`backup_retention_enabled`	`bool \| cdktn.IResolvable`	No description.
`blueprint_id`	`str`	No description.
`bundle_id`	`str`	No description.
`final_snapshot_name`	`str`	No description.
`id`	`str`	No description.
`master_database_name`	`str`	No description.
`master_password`	`str`	No description.
`master_username`	`str`	No description.
`preferred_backup_window`	`str`	No description.
`preferred_maintenance_window`	`str`	No description.
`publicly_accessible`	`bool \| cdktn.IResolvable`	No description.
`region`	`str`	No description.
`relational_database_name`	`str`	No description.
`skip_final_snapshot`	`bool \| cdktn.IResolvable`	No description.
`tags`	`typing.Mapping[str]`	No description.
`tags_all`	`typing.Mapping[str]`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`cdktf_stack`^Required

cdktf_stack: TerraformStack

Type: cdktn.TerraformStack

`fqn`^Required

fqn: str

Type: str

`friendly_unique_id`^Required

friendly_unique_id: str

Type: str

`terraform_meta_arguments`^Required

terraform_meta_arguments: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.Any]

`terraform_resource_type`^Required

terraform_resource_type: str

Type: str

`terraform_generator_metadata`^Optional

terraform_generator_metadata: TerraformProviderGeneratorMetadata

Type: cdktn.TerraformProviderGeneratorMetadata

`connection`^Optional

connection: SSHProvisionerConnection | WinrmProvisionerConnection

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

count: typing.Union[int, float] | TerraformCount

Type: typing.Union[int, float] | cdktn.TerraformCount

`depends_on`^Optional

depends_on: typing.List[str]

Type: typing.List[str]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktn.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]

Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

`arn`^Required

arn: str

Type: str

`ca_certificate_identifier`^Required

ca_certificate_identifier: str

Type: str

`cpu_count`^Required

cpu_count: typing.Union[int, float]

Type: typing.Union[int, float]

`created_at`^Required

created_at: str

Type: str

`disk_size`^Required

disk_size: typing.Union[int, float]

Type: typing.Union[int, float]

`engine`^Required

engine: str

Type: str

`engine_version`^Required

engine_version: str

Type: str

`master_endpoint_address`^Required

master_endpoint_address: str

Type: str

`master_endpoint_port`^Required

master_endpoint_port: typing.Union[int, float]

Type: typing.Union[int, float]

`ram_size`^Required

ram_size: typing.Union[int, float]

Type: typing.Union[int, float]

`secondary_availability_zone`^Required

secondary_availability_zone: str

Type: str

`support_code`^Required

support_code: str

Type: str

`apply_immediately_input`^Optional

apply_immediately_input: bool | IResolvable

Type: bool | cdktn.IResolvable

`availability_zone_input`^Optional

availability_zone_input: str

Type: str

`backup_retention_enabled_input`^Optional

backup_retention_enabled_input: bool | IResolvable

Type: bool | cdktn.IResolvable

`blueprint_id_input`^Optional

blueprint_id_input: str

Type: str

`bundle_id_input`^Optional

bundle_id_input: str

Type: str

`final_snapshot_name_input`^Optional

final_snapshot_name_input: str

Type: str

`id_input`^Optional

id_input: str

Type: str

`master_database_name_input`^Optional

master_database_name_input: str

Type: str

`master_password_input`^Optional

master_password_input: str

Type: str

`master_username_input`^Optional

master_username_input: str

Type: str

`preferred_backup_window_input`^Optional

preferred_backup_window_input: str

Type: str

`preferred_maintenance_window_input`^Optional

preferred_maintenance_window_input: str

Type: str

`publicly_accessible_input`^Optional

publicly_accessible_input: bool | IResolvable

Type: bool | cdktn.IResolvable

`region_input`^Optional

region_input: str

Type: str

`relational_database_name_input`^Optional

relational_database_name_input: str

Type: str

`skip_final_snapshot_input`^Optional

skip_final_snapshot_input: bool | IResolvable

Type: bool | cdktn.IResolvable

`tags_all_input`^Optional

tags_all_input: typing.Mapping[str]

Type: typing.Mapping[str]

`tags_input`^Optional

tags_input: typing.Mapping[str]

Type: typing.Mapping[str]

`apply_immediately`^Required

apply_immediately: bool | IResolvable

Type: bool | cdktn.IResolvable

`availability_zone`^Required

availability_zone: str

Type: str

`backup_retention_enabled`^Required

backup_retention_enabled: bool | IResolvable

Type: bool | cdktn.IResolvable

`blueprint_id`^Required

blueprint_id: str

Type: str

`bundle_id`^Required

bundle_id: str

Type: str

`final_snapshot_name`^Required

final_snapshot_name: str

Type: str

`id`^Required

id: str

Type: str

`master_database_name`^Required

master_database_name: str

Type: str

`master_password`^Required

master_password: str

Type: str

`master_username`^Required

master_username: str

Type: str

`preferred_backup_window`^Required

preferred_backup_window: str

Type: str

`preferred_maintenance_window`^Required

preferred_maintenance_window: str

Type: str

`publicly_accessible`^Required

publicly_accessible: bool | IResolvable

Type: bool | cdktn.IResolvable

`region`^Required

region: str

Type: str

`relational_database_name`^Required

relational_database_name: str

Type: str

`skip_final_snapshot`^Required

skip_final_snapshot: bool | IResolvable

Type: bool | cdktn.IResolvable

`tags`^Required

tags: typing.Mapping[str]

Type: typing.Mapping[str]

`tags_all`^Required

tags_all: typing.Mapping[str]

Type: typing.Mapping[str]

Constants

Name	Type	Description
`tfResourceType`	`str`	No description.

`tfResourceType`^Required

tfResourceType: str

Type: str

Structs

LightsailDatabaseConfig

Initializer

from cdktn_provider_aws import lightsail_database

lightsailDatabase.LightsailDatabaseConfig(
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  blueprint_id: str,
  bundle_id: str,
  master_database_name: str,
  master_password: str,
  master_username: str,
  relational_database_name: str,
  apply_immediately: bool | IResolvable = None,
  availability_zone: str = None,
  backup_retention_enabled: bool | IResolvable = None,
  final_snapshot_name: str = None,
  id: str = None,
  preferred_backup_window: str = None,
  preferred_maintenance_window: str = None,
  publicly_accessible: bool | IResolvable = None,
  region: str = None,
  skip_final_snapshot: bool | IResolvable = None,
  tags: typing.Mapping[str] = None,
  tags_all: typing.Mapping[str] = None
)

Properties

Name	Type	Description
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktn.TerraformCount`	No description.
`depends_on`	`typing.List[cdktn.ITerraformDependable]`	No description.
`for_each`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner]`	No description.
`blueprint_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#blueprint_id LightsailDatabase#blueprint_id}.
`bundle_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#bundle_id LightsailDatabase#bundle_id}.
`master_database_name`	`str`	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}.
`master_password`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#master_password LightsailDatabase#master_password}.
`master_username`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#master_username LightsailDatabase#master_username}.
`relational_database_name`	`str`	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}.
`apply_immediately`	`bool \| 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}.
`availability_zone`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#availability_zone LightsailDatabase#availability_zone}.
`backup_retention_enabled`	`bool \| 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}.
`final_snapshot_name`	`str`	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`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#id LightsailDatabase#id}.
`preferred_backup_window`	`str`	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}.
`preferred_maintenance_window`	`str`	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}.
`publicly_accessible`	`bool \| 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`	`str`	Region where this resource will be managed. Defaults to the Region set in the provider configuration.
`skip_final_snapshot`	`bool \| 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`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#tags LightsailDatabase#tags}.
`tags_all`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_database#tags_all LightsailDatabase#tags_all}.

`connection`^Optional

connection: SSHProvisionerConnection | WinrmProvisionerConnection

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

count: typing.Union[int, float] | TerraformCount

Type: typing.Union[int, float] | cdktn.TerraformCount

`depends_on`^Optional

depends_on: typing.List[ITerraformDependable]

Type: typing.List[cdktn.ITerraformDependable]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktn.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]

Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

`blueprint_id`^Required

blueprint_id: str

Type: str

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

`bundle_id`^Required

bundle_id: str

Type: str

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

`master_database_name`^Required

master_database_name: str

Type: str

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}.

`master_password`^Required

master_password: str

Type: str

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

`master_username`^Required

master_username: str

Type: str

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

`relational_database_name`^Required

relational_database_name: str

Type: str

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}.

`apply_immediately`^Optional

apply_immediately: bool | IResolvable

Type: bool | 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}.

`availability_zone`^Optional

availability_zone: str

Type: str

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

`backup_retention_enabled`^Optional

backup_retention_enabled: bool | IResolvable

Type: bool | 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}.

`final_snapshot_name`^Optional

final_snapshot_name: str

Type: str

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`^Optional

id: str

Type: str

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

`preferred_backup_window`^Optional

preferred_backup_window: str

Type: str

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}.

`preferred_maintenance_window`^Optional

preferred_maintenance_window: str

Type: str

`publicly_accessible`^Optional

publicly_accessible: bool | IResolvable

Type: bool | 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`^Optional

region: str

Type: str

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}

`skip_final_snapshot`^Optional

skip_final_snapshot: bool | IResolvable

Type: bool | 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`^Optional

tags: typing.Mapping[str]

Type: typing.Mapping[str]

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

`tags_all`^Optional

tags_all: typing.Mapping[str]

Type: typing.Mapping[str]

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

FilesExpand file tree

lightsailDatabase.python.md

Latest commit

History

lightsailDatabase.python.md

File metadata and controls

lightsailDatabase Submodule

Constructs