Skip to content

Latest commit

 

History

History
2049 lines (1307 loc) · 85.2 KB

File metadata and controls

2049 lines (1307 loc) · 85.2 KB

lightsailInstance Submodule

Constructs

LightsailInstance

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

Initializers

from cdktn_provider_aws import lightsail_instance

lightsailInstance.LightsailInstance(
  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,
  availability_zone: str,
  blueprint_id: str,
  bundle_id: str,
  name: str,
  add_on: LightsailInstanceAddOn = None,
  id: str = None,
  ip_address_type: str = None,
  key_pair_name: str = None,
  region: str = None,
  tags: typing.Mapping[str] = None,
  tags_all: typing.Mapping[str] = None,
  user_data: 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.
availability_zone str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#availability_zone LightsailInstance#availability_zone}.
blueprint_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#blueprint_id LightsailInstance#blueprint_id}.
bundle_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#bundle_id LightsailInstance#bundle_id}.
name str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#name LightsailInstance#name}.
add_on LightsailInstanceAddOn add_on block.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#id LightsailInstance#id}.
ip_address_type str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#ip_address_type LightsailInstance#ip_address_type}.
key_pair_name str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#key_pair_name LightsailInstance#key_pair_name}.
region str Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#tags LightsailInstance#tags}.
tags_all typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#tags_all LightsailInstance#tags_all}.
user_data str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#user_data LightsailInstance#user_data}.

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope


connectionOptional
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

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

depends_onOptional
  • Type: typing.List[cdktn.ITerraformDependable]

for_eachOptional
  • Type: cdktn.ITerraformIterator

lifecycleOptional
  • Type: cdktn.TerraformResourceLifecycle

providerOptional
  • Type: cdktn.TerraformProvider

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

availability_zoneRequired
  • Type: str

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


blueprint_idRequired
  • Type: str

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


bundle_idRequired
  • Type: str

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


nameRequired
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#name LightsailInstance#name}.


add_onOptional

add_on block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#add_on LightsailInstance#add_on}


idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#id LightsailInstance#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.


ip_address_typeOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#ip_address_type LightsailInstance#ip_address_type}.


key_pair_nameOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#key_pair_name LightsailInstance#key_pair_name}.


regionOptional
  • 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_instance#region LightsailInstance#region}


tagsOptional
  • Type: typing.Mapping[str]

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


tags_allOptional
  • Type: typing.Mapping[str]

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


user_dataOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#user_data LightsailInstance#user_data}.


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".
put_add_on No description.
reset_add_on No description.
reset_id No description.
reset_ip_address_type No description.
reset_key_pair_name No description.
reset_region No description.
reset_tags No description.
reset_tags_all No description.
reset_user_data 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.

mixinsRequired
  • Type: *constructs.IMixin

The mixins to apply.


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

valueRequired
  • 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_idRequired
  • 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_targetRequired
  • 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_attributeRequired
  • Type: str

get_boolean_attribute
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str

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

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

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

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

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

get_string_attribute
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str

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

has_resource_move
def has_resource_move() -> TerraformResourceMoveByTarget | TerraformResourceMoveById
import_from
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str

providerOptional
  • Type: cdktn.TerraformProvider

interpolation_for_attribute
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • 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.

idRequired
  • 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_targetRequired
  • Type: str

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


indexOptional
  • 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".

idRequired
  • Type: str

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


put_add_on
def put_add_on(
  snapshot_time: str,
  status: str,
  type: str
) -> None
snapshot_timeRequired
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#snapshot_time LightsailInstance#snapshot_time}.


statusRequired
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#status LightsailInstance#status}.


typeRequired
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#type LightsailInstance#type}.


reset_add_on
def reset_add_on() -> None
reset_id
def reset_id() -> None
reset_ip_address_type
def reset_ip_address_type() -> None
reset_key_pair_name
def reset_key_pair_name() -> None
reset_region
def reset_region() -> None
reset_tags
def reset_tags() -> None
reset_tags_all
def reset_tags_all() -> None
reset_user_data
def reset_user_data() -> 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 LightsailInstance resource upon running "cdktn plan ".

is_construct
from cdktn_provider_aws import lightsail_instance

lightsailInstance.LightsailInstance.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.

xRequired
  • Type: typing.Any

Any object.


is_terraform_element
from cdktn_provider_aws import lightsail_instance

lightsailInstance.LightsailInstance.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any

is_terraform_resource
from cdktn_provider_aws import lightsail_instance

lightsailInstance.LightsailInstance.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any

generate_config_for_import
from cdktn_provider_aws import lightsail_instance

lightsailInstance.LightsailInstance.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


import_to_idRequired
  • Type: str

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


import_from_idRequired
  • Type: str

The id of the existing LightsailInstance that should be imported.

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


providerOptional
  • Type: cdktn.TerraformProvider

? Optional instance of the provider where the LightsailInstance 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.
add_on LightsailInstanceAddOnOutputReference No description.
arn str No description.
cpu_count typing.Union[int, float] No description.
created_at str No description.
ipv6_addresses typing.List[str] No description.
is_static_ip cdktn.IResolvable No description.
private_ip_address str No description.
public_ip_address str No description.
ram_size typing.Union[int, float] No description.
username str No description.
add_on_input LightsailInstanceAddOn No description.
availability_zone_input str No description.
blueprint_id_input str No description.
bundle_id_input str No description.
id_input str No description.
ip_address_type_input str No description.
key_pair_name_input str No description.
name_input str No description.
region_input str No description.
tags_all_input typing.Mapping[str] No description.
tags_input typing.Mapping[str] No description.
user_data_input str No description.
availability_zone str No description.
blueprint_id str No description.
bundle_id str No description.
id str No description.
ip_address_type str No description.
key_pair_name str No description.
name str No description.
region str No description.
tags typing.Mapping[str] No description.
tags_all typing.Mapping[str] No description.
user_data str No description.

nodeRequired
node: Node
  • Type: constructs.Node

The tree node.


cdktf_stackRequired
cdktf_stack: TerraformStack
  • Type: cdktn.TerraformStack

fqnRequired
fqn: str
  • Type: str

friendly_unique_idRequired
friendly_unique_id: str
  • Type: str

terraform_meta_argumentsRequired
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]

terraform_resource_typeRequired
terraform_resource_type: str
  • Type: str

terraform_generator_metadataOptional
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktn.TerraformProviderGeneratorMetadata

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

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

depends_onOptional
depends_on: typing.List[str]
  • Type: typing.List[str]

for_eachOptional
for_each: ITerraformIterator
  • Type: cdktn.ITerraformIterator

lifecycleOptional
lifecycle: TerraformResourceLifecycle
  • Type: cdktn.TerraformResourceLifecycle

providerOptional
provider: TerraformProvider
  • Type: cdktn.TerraformProvider

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

add_onRequired
add_on: LightsailInstanceAddOnOutputReference

arnRequired
arn: str
  • Type: str

cpu_countRequired
cpu_count: typing.Union[int, float]
  • Type: typing.Union[int, float]

created_atRequired
created_at: str
  • Type: str

ipv6_addressesRequired
ipv6_addresses: typing.List[str]
  • Type: typing.List[str]

is_static_ipRequired
is_static_ip: IResolvable
  • Type: cdktn.IResolvable

private_ip_addressRequired
private_ip_address: str
  • Type: str

public_ip_addressRequired
public_ip_address: str
  • Type: str

ram_sizeRequired
ram_size: typing.Union[int, float]
  • Type: typing.Union[int, float]

usernameRequired
username: str
  • Type: str

add_on_inputOptional
add_on_input: LightsailInstanceAddOn

availability_zone_inputOptional
availability_zone_input: str
  • Type: str

blueprint_id_inputOptional
blueprint_id_input: str
  • Type: str

bundle_id_inputOptional
bundle_id_input: str
  • Type: str

id_inputOptional
id_input: str
  • Type: str

ip_address_type_inputOptional
ip_address_type_input: str
  • Type: str

key_pair_name_inputOptional
key_pair_name_input: str
  • Type: str

name_inputOptional
name_input: str
  • Type: str

region_inputOptional
region_input: str
  • Type: str

tags_all_inputOptional
tags_all_input: typing.Mapping[str]
  • Type: typing.Mapping[str]

tags_inputOptional
tags_input: typing.Mapping[str]
  • Type: typing.Mapping[str]

user_data_inputOptional
user_data_input: str
  • Type: str

availability_zoneRequired
availability_zone: str
  • Type: str

blueprint_idRequired
blueprint_id: str
  • Type: str

bundle_idRequired
bundle_id: str
  • Type: str

idRequired
id: str
  • Type: str

ip_address_typeRequired
ip_address_type: str
  • Type: str

key_pair_nameRequired
key_pair_name: str
  • Type: str

nameRequired
name: str
  • Type: str

regionRequired
region: str
  • Type: str

tagsRequired
tags: typing.Mapping[str]
  • Type: typing.Mapping[str]

tags_allRequired
tags_all: typing.Mapping[str]
  • Type: typing.Mapping[str]

user_dataRequired
user_data: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.

tfResourceTypeRequired
tfResourceType: str
  • Type: str

Structs

LightsailInstanceAddOn

Initializer

from cdktn_provider_aws import lightsail_instance

lightsailInstance.LightsailInstanceAddOn(
  snapshot_time: str,
  status: str,
  type: str
)

Properties

Name Type Description
snapshot_time str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#snapshot_time LightsailInstance#snapshot_time}.
status str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#status LightsailInstance#status}.
type str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#type LightsailInstance#type}.

snapshot_timeRequired
snapshot_time: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#snapshot_time LightsailInstance#snapshot_time}.


statusRequired
status: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#status LightsailInstance#status}.


typeRequired
type: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#type LightsailInstance#type}.


LightsailInstanceConfig

Initializer

from cdktn_provider_aws import lightsail_instance

lightsailInstance.LightsailInstanceConfig(
  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,
  availability_zone: str,
  blueprint_id: str,
  bundle_id: str,
  name: str,
  add_on: LightsailInstanceAddOn = None,
  id: str = None,
  ip_address_type: str = None,
  key_pair_name: str = None,
  region: str = None,
  tags: typing.Mapping[str] = None,
  tags_all: typing.Mapping[str] = None,
  user_data: 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.
availability_zone str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#availability_zone LightsailInstance#availability_zone}.
blueprint_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#blueprint_id LightsailInstance#blueprint_id}.
bundle_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#bundle_id LightsailInstance#bundle_id}.
name str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#name LightsailInstance#name}.
add_on LightsailInstanceAddOn add_on block.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#id LightsailInstance#id}.
ip_address_type str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#ip_address_type LightsailInstance#ip_address_type}.
key_pair_name str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#key_pair_name LightsailInstance#key_pair_name}.
region str Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#tags LightsailInstance#tags}.
tags_all typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#tags_all LightsailInstance#tags_all}.
user_data str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#user_data LightsailInstance#user_data}.

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

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

depends_onOptional
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktn.ITerraformDependable]

for_eachOptional
for_each: ITerraformIterator
  • Type: cdktn.ITerraformIterator

lifecycleOptional
lifecycle: TerraformResourceLifecycle
  • Type: cdktn.TerraformResourceLifecycle

providerOptional
provider: TerraformProvider
  • Type: cdktn.TerraformProvider

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

availability_zoneRequired
availability_zone: str
  • Type: str

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


blueprint_idRequired
blueprint_id: str
  • Type: str

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


bundle_idRequired
bundle_id: str
  • Type: str

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


nameRequired
name: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#name LightsailInstance#name}.


add_onOptional
add_on: LightsailInstanceAddOn

add_on block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#add_on LightsailInstance#add_on}


idOptional
id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#id LightsailInstance#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.


ip_address_typeOptional
ip_address_type: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#ip_address_type LightsailInstance#ip_address_type}.


key_pair_nameOptional
key_pair_name: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#key_pair_name LightsailInstance#key_pair_name}.


regionOptional
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_instance#region LightsailInstance#region}


tagsOptional
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_instance#tags LightsailInstance#tags}.


tags_allOptional
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_instance#tags_all LightsailInstance#tags_all}.


user_dataOptional
user_data: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/lightsail_instance#user_data LightsailInstance#user_data}.


Classes

LightsailInstanceAddOnOutputReference

Initializers

from cdktn_provider_aws import lightsail_instance

lightsailInstance.LightsailInstanceAddOnOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktn.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.

terraform_resourceRequired
  • Type: cdktn.IInterpolatingParent

The parent resource.


terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.


Methods

Name Description
compute_fqn No description.
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.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.

compute_fqn
def compute_fqn() -> str
get_any_map_attribute
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str

get_boolean_attribute
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str

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

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

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

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

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

get_string_attribute
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str

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

interpolation_for_attribute
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str

resolve
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktn.IResolveContext

to_string
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
snapshot_time_input str No description.
status_input str No description.
type_input str No description.
snapshot_time str No description.
status str No description.
type str No description.
internal_value LightsailInstanceAddOn No description.

creation_stackRequired
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
fqn: str
  • Type: str

snapshot_time_inputOptional
snapshot_time_input: str
  • Type: str

status_inputOptional
status_input: str
  • Type: str

type_inputOptional
type_input: str
  • Type: str

snapshot_timeRequired
snapshot_time: str
  • Type: str

statusRequired
status: str
  • Type: str

typeRequired
type: str
  • Type: str

internal_valueOptional
internal_value: LightsailInstanceAddOn