lightsail library

AWS Lightsail.

Classes

AppConstant<T>
A value the Stack hands to application code as a static const in the generated AppExports file — known when synth runs, so the app compiles against it.
AppExports
Where synth writes the Dart file application code imports: the Stack's constants, as the static const members of <name>Constants, and a typed reader of its Terraform outputs, <name>Outputs.
AttributeRef<T>
Public for sealed pattern matching, but constructor is private — only TfRef.attribute() may construct instances.
AwsLightsailBucket
Factory wrapper for aws_lightsail_bucket.
AwsLightsailBucketAccessKey
Factory wrapper for aws_lightsail_bucket_access_key.
AwsLightsailBucketResourceAccess
Factory wrapper for aws_lightsail_bucket_resource_access.
AwsLightsailCertificate
Factory wrapper for aws_lightsail_certificate.
AwsLightsailContainerService
Factory wrapper for aws_lightsail_container_service.
AwsLightsailContainerServiceDeploymentVersion
Factory wrapper for aws_lightsail_container_service_deployment_version.
AwsLightsailDatabase
Factory wrapper for aws_lightsail_database.
AwsLightsailDisk
Factory wrapper for aws_lightsail_disk.
AwsLightsailDiskAttachment
Factory wrapper for aws_lightsail_disk_attachment.
AwsLightsailDistribution
Factory wrapper for aws_lightsail_distribution.
AwsLightsailDomain
Factory wrapper for aws_lightsail_domain.
AwsLightsailDomainEntry
Factory wrapper for aws_lightsail_domain_entry.
AwsLightsailInstance
Factory wrapper for aws_lightsail_instance.
AwsLightsailInstancePublicPorts
Factory wrapper for aws_lightsail_instance_public_ports.
AwsLightsailKeyPair
Factory wrapper for aws_lightsail_key_pair.
AwsLightsailLb
Factory wrapper for aws_lightsail_lb.
AwsLightsailLbAttachment
Factory wrapper for aws_lightsail_lb_attachment.
AwsLightsailLbCertificate
Factory wrapper for aws_lightsail_lb_certificate.
AwsLightsailLbCertificateAttachment
Factory wrapper for aws_lightsail_lb_certificate_attachment.
AwsLightsailLbHttpsRedirectionPolicy
Factory wrapper for aws_lightsail_lb_https_redirection_policy.
AwsLightsailLbStickinessPolicy
Factory wrapper for aws_lightsail_lb_stickiness_policy.
AwsLightsailStaticIp
Factory wrapper for aws_lightsail_static_ip.
AwsLightsailStaticIpAttachment
Factory wrapper for aws_lightsail_static_ip_attachment.
DartDefineOutput
An output whose value is the client build's --dart-define file, registered with Stack.addDartDefineOutput.
Data
Base of every user-instantiable Terraform data block.
DataRef<T>
Public for sealed pattern matching, but constructor is private — only TfRef.data() may construct instances.
EnvironmentConstant
The AppConstant.fromEnvironment choice.
GcsBackend
terraform { backend "gcs" { ... } } configuration.
IgnoreAllChanges
IgnoreChanges.all.
IgnoreAttributes
IgnoreChanges.of.
IgnoreChanges
What ignore_changes covers: every attribute, or the listed ones.
InvalidDartDefineOutput
An output of Stack.addDartDefineOutput that cannot carry what it names: an output that is not registered, is sensitive or has no environment value, two outputs read from one variable, or no output at all.
InvalidLifecycle
A lifecycle block Terraform rejects: a data source (or one of its attributes) in replaceTriggeredBy, all inside IgnoreChanges.of, or a condition with an empty error message.
InvalidMoveTarget
A moved block whose to names no resource of the Stack.
InvalidTimeout
A negative timeouts duration.
LifecycleCondition
A precondition or postcondition block: Terraform fails the plan (LifecycleCondition.pre) or the apply (LifecycleCondition.post) with errorMessage when condition is false.
LifecycleOptions
lifecycle { ... } block on a resource.
LightsailContainerServiceCertificate
Typed helper for the public_domain_names.certificate block of aws_lightsail_container_service (derived from provider schema).
LightsailContainerServiceDeploymentVersionContainer
Typed helper for the container block of aws_lightsail_container_service_deployment_version (derived from provider schema).
LightsailContainerServiceDeploymentVersionHealthCheck
Typed helper for the public_endpoint.health_check block of aws_lightsail_container_service_deployment_version (derived from provider schema).
LightsailContainerServiceDeploymentVersionPublicEndpoint
Typed helper for the public_endpoint block of aws_lightsail_container_service_deployment_version (derived from provider schema).
LightsailContainerServiceEcrImagePullerRole
Typed helper for the private_registry_access.ecr_image_puller_role block of aws_lightsail_container_service (derived from provider schema).
LightsailContainerServicePrivateRegistryAccess
Typed helper for the private_registry_access block of aws_lightsail_container_service (derived from provider schema).
LightsailContainerServicePublicDomainNames
Typed helper for the public_domain_names block of aws_lightsail_container_service (derived from provider schema).
LightsailDistributionCacheBehavior
Typed helper for the cache_behavior block of aws_lightsail_distribution (derived from provider schema).
LightsailDistributionCacheBehaviorSettings
Typed helper for the cache_behavior_settings block of aws_lightsail_distribution (derived from provider schema).
LightsailDistributionDefaultCacheBehavior
Typed helper for the default_cache_behavior block of aws_lightsail_distribution (derived from provider schema).
LightsailDistributionForwardedCookies
Typed helper for the cache_behavior_settings.forwarded_cookies block of aws_lightsail_distribution (derived from provider schema).
LightsailDistributionForwardedHeaders
Typed helper for the cache_behavior_settings.forwarded_headers block of aws_lightsail_distribution (derived from provider schema).
LightsailDistributionForwardedQueryStrings
Typed helper for the cache_behavior_settings.forwarded_query_strings block of aws_lightsail_distribution (derived from provider schema).
LightsailDistributionOrigin
Typed helper for the origin block of aws_lightsail_distribution (derived from provider schema).
LightsailInstanceAddOn
Typed helper for the add_on block of aws_lightsail_instance (derived from provider schema).
LightsailInstancePublicPortsPortInfo
Typed helper for the port_info block of aws_lightsail_instance_public_ports (derived from provider schema).
LightsailKeyPairName
At most one of name, name_prefix on aws_lightsail_key_pair: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
LightsailKeyPairNameChoice
The LightsailKeyPairName.name choice: sets name.
LightsailKeyPairNamePrefix
The LightsailKeyPairName.namePrefix choice: sets name_prefix.
LocalBackend
terraform { backend "local" { ... } } configuration.
MissingProvider
A block needs a provider configuration the Stack does not register: the provider its type implies (google for google_pubsub_topic), the one its provider meta-argument names, or one a module call passes on.
ModuleCall
A module "<localName>" { ... } call as a Dart value.
NoProviders
The Stack registers no provider, but declares resources or data sources.
ProviderConflict
Two provider registrations Terraform rejects together: two defaults of one name, a repeated alias, an alias that is not an identifier, or configurations of one name with different source / version constraints.
RefConstant<T>
The AppConstant.ref choice.
ReplaceTrigger
What lifecycle.replaceTriggeredBy lists: a resource of the Stack or an attribute getter of one. Resource and TfRef implement it; synth reports a data source or a data-source attribute as an InvalidLifecycle.
Resource
Base of every user-instantiable Terraform resource.
ResourceRef
Public for sealed pattern matching, but constructor is private — only TfRef.resource() may construct instances.
S3Backend
terraform { backend "s3" { ... } } configuration.
Sensitive<T>
What an argument Terraform marks sensitive takes: a variable, an expression or an attribute getter — a value Terraform resolves, never a Dart literal that would be written into main.tf.json.
SensitiveLiteral
A sensitive field is set to a literal, which would write the secret in plain text into main.tf.json.
Stack
User-extended IaC composition root.
StackBackend
Lightweight backend hook. Core ships GcsBackend, S3Backend, and LocalBackend; anything else implements this interface in the caller. The Stack only stores the value and exposes a discriminator for synth's terraform { backend ... } emitter.
StackProvider
Coordination interface between Stack (in this package) and concrete providers (e.g. GoogleProvider in terradart_google). Concrete providers implement every getter using their baked-in constants from Stage 2 codegen.
SynthIssue
One reason a Stack cannot be synthesized.
SynthResult
Bundle returned by StackSynth.synth.
TfAddressed
Anything that exposes a Terraform address, e.g. google_pubsub_topic.orders.
TfArg<T>
A Terraform argument: a Dart-side literal, a reference to another block's attribute (TfRef), a variable or a raw expression.
TfArgExpression<T>
A raw Terraform expression — the tf.json template string, verbatim.
TfArgLiteral<T>
TfArgVariable<T>
TfCollectionType
list(...), set(...) or map(...).
TfMoved
One moved { from = ... to = ... } block: the state object at from now belongs to the resource at to, so a rename does not become a destroy-and-create.
TfObjectType
object({ ... }).
TfOptionalType
optional(<type>[, <default>]).
TfOutput<T>
An output "<name>" { value = ... } block, registered with Stack.addOutput.
TfPrimitiveType
string, number, bool or any.
TfRef<T>
A Terraform-side reference: an attribute of a resource (AttributeRef) or a data source (DataRef), or a whole resource (ResourceRef).
TfTimeouts
timeouts { ... } on a resource or data source: how long Terraform waits for each operation before giving up.
TfTupleType
tuple([...]).
TfType
A Terraform type constraint: string, list(number), object({ name = string }).
TfVariable
One variable "<name>" { ... } declaration.
UndeclaredVariable
A TfArg.variable or var.<name> in an expression names a variable the Stack does not declare.
UnregisteredReference
A block references another block that was never registered on the Stack: built, but not passed to add(...) / addModule(...).
UnresolvableConstant
An AppConstant.ref whose value is not known at synth: the attribute is not set to a literal, is sensitive, does not match the constant's type, or belongs to a block that is not registered.
ValueConstant<T>
The AppConstant.value choice.

Enums

ResourceKind
Whether a Stack entry is a resource block or a data block in Terraform JSON.

Extension Types

LightsailDistributionOption
option — derived from the provider schema description.
LightsailDomainEntryType
Lightsail Domain Entry enum for type.
LightsailInstanceStatus
status — derived from the provider schema description.
LightsailLbIpAddressType
Lightsail Lb Ip Address enum for ip_address_type.
OutputEnvironment
The environment Stack.outputEnvironment returns: each variable and its value, in registration order.
RefTo
A reference to a resource of type R, for an argument that names another resource (network, vpc_id, role_arn, ...).

Extensions

RefToList on TfArg<List<RefTo<R>>>
A list-valued reference argument (security_group_ids, subnet_ids): a literal list of RefTos, or one value that is the whole list (TfArg.variable('subnet_ids'), TfArg.expression(...)).
TerraformDurationExt on Duration
Converts a Dart Duration into a Terraform duration string ("604800s").

Exceptions / Errors

DuplicateModuleError
A ModuleCall registered twice under one name.
DuplicateResourceError
Thrown by Stack.add when an entry with the same (kind, terraformType, localName) triple is registered twice.
SynthException
Thrown by Stack.synth() and Stack.writeTo() when the Stack has one or more SynthIssues. Nothing is written.