dms library
AWS Database Migration Service.
Classes
-
AppConstant<
T> -
A value the Stack hands to application code as a
static constin 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 constmembers 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. - AwsDmsCertificate
-
Factory wrapper for
aws_dms_certificate. - AwsDmsDataProvider
-
Factory wrapper for
aws_dms_data_provider. - AwsDmsEndpoint
-
Factory wrapper for
aws_dms_endpoint. - AwsDmsEventSubscription
-
Factory wrapper for
aws_dms_event_subscription. - AwsDmsInstanceProfile
-
Factory wrapper for
aws_dms_instance_profile. - AwsDmsMigrationProject
-
Factory wrapper for
aws_dms_migration_project. - AwsDmsReplicationConfig
-
Factory wrapper for
aws_dms_replication_config. - AwsDmsReplicationInstance
-
Factory wrapper for
aws_dms_replication_instance. - AwsDmsReplicationSubnetGroup
-
Factory wrapper for
aws_dms_replication_subnet_group. - AwsDmsReplicationTask
-
Factory wrapper for
aws_dms_replication_task. - AwsDmsS3Endpoint
-
Factory wrapper for
aws_dms_s3_endpoint. - DartDefineOutput
-
An
outputwhose value is the client build's--dart-definefile, registered withStack.addDartDefineOutput. - Data
-
Base of every user-instantiable Terraform
datablock. - DataAwsDmsCertificate
-
Factory wrapper for
aws_dms_certificate. - DataAwsDmsEndpoint
-
Factory wrapper for
aws_dms_endpoint. - DataAwsDmsReplicationInstance
-
Factory wrapper for
aws_dms_replication_instance. - DataAwsDmsReplicationSubnetGroup
-
Factory wrapper for
aws_dms_replication_subnet_group. - DataAwsDmsReplicationTask
-
Factory wrapper for
aws_dms_replication_task. -
DataRef<
T> -
Public for sealed pattern matching, but constructor is private — only
TfRef.data()may construct instances. - DmsCertificateContent
-
Exactly one of
certificate_pem,certificate_walletonaws_dms_certificate: the provider rejects none and more than one, so each variant sets one of them. - DmsCertificateContentCertificatePem
-
The DmsCertificateContent.certificatePem choice: sets
certificate_pem. - DmsCertificateContentCertificateWallet
-
The DmsCertificateContent.certificateWallet choice: sets
certificate_wallet. - DmsDataProviderDocDbSettings
-
Typed helper for the
settings.doc_db_settingsblock ofaws_dms_data_provider(derived from provider schema). - DmsDataProviderIbmDb2LuwSettings
-
Typed helper for the
settings.ibm_db2_luw_settingsblock ofaws_dms_data_provider(derived from provider schema). - DmsDataProviderIbmDb2ZosSettings
-
Typed helper for the
settings.ibm_db2_zos_settingsblock ofaws_dms_data_provider(derived from provider schema). - DmsDataProviderMariaDbSettings
-
Typed helper for the
settings.maria_db_settingsblock ofaws_dms_data_provider(derived from provider schema). - DmsDataProviderMicrosoftSqlServerSettings
-
Typed helper for the
settings.microsoft_sql_server_settingsblock ofaws_dms_data_provider(derived from provider schema). - DmsDataProviderMongoDbSettings
-
Typed helper for the
settings.mongo_db_settingsblock ofaws_dms_data_provider(derived from provider schema). - DmsDataProviderMysqlSettings
-
Typed helper for the
settings.mysql_settingsblock ofaws_dms_data_provider(derived from provider schema). - DmsDataProviderOracleSettings
-
Typed helper for the
settings.oracle_settingsblock ofaws_dms_data_provider(derived from provider schema). - DmsDataProviderPostgresqlSettings
-
Typed helper for the
settings.postgresql_settingsblock ofaws_dms_data_provider(derived from provider schema). - DmsDataProviderRedshiftSettings
-
Typed helper for the
settings.redshift_settingsblock ofaws_dms_data_provider(derived from provider schema). - DmsDataProviderSettings
-
Typed helper for the
settingsblock ofaws_dms_data_provider(derived from provider schema). - DmsDataProviderSybaseAseSettings
-
Typed helper for the
settings.sybase_ase_settingsblock ofaws_dms_data_provider(derived from provider schema). - DmsEndpointElasticsearchSettings
-
Typed helper for the
elasticsearch_settingsblock ofaws_dms_endpoint(derived from provider schema). - DmsEndpointKafkaSettings
-
Typed helper for the
kafka_settingsblock ofaws_dms_endpoint(derived from provider schema). - DmsEndpointKinesisSettings
-
Typed helper for the
kinesis_settingsblock ofaws_dms_endpoint(derived from provider schema). - DmsEndpointMongodbSettings
-
Typed helper for the
mongodb_settingsblock ofaws_dms_endpoint(derived from provider schema). - DmsEndpointMysqlSettings
-
Typed helper for the
mysql_settingsblock ofaws_dms_endpoint(derived from provider schema). - DmsEndpointOracleSettings
-
Typed helper for the
oracle_settingsblock ofaws_dms_endpoint(derived from provider schema). - DmsEndpointPostgresSettings
-
Typed helper for the
postgres_settingsblock ofaws_dms_endpoint(derived from provider schema). - DmsEndpointRedisSettings
-
Typed helper for the
redis_settingsblock ofaws_dms_endpoint(derived from provider schema). - DmsEndpointRedshiftSettings
-
Typed helper for the
redshift_settingsblock ofaws_dms_endpoint(derived from provider schema). - DmsMigrationProjectSchemaConversionApplicationAttributes
-
Typed helper for the
schema_conversion_application_attributesblock ofaws_dms_migration_project(derived from provider schema). - DmsMigrationProjectSourceDataProviderDescriptor
-
Typed helper for the
source_data_provider_descriptorblock ofaws_dms_migration_project(derived from provider schema). - DmsMigrationProjectTargetDataProviderDescriptor
-
Typed helper for the
target_data_provider_descriptorblock ofaws_dms_migration_project(derived from provider schema). - DmsReplicationConfigComputeConfig
-
Typed helper for the
compute_configblock ofaws_dms_replication_config(derived from provider schema). - DmsReplicationInstanceKerberosAuthenticationSettings
-
Typed helper for the
kerberos_authentication_settingsblock ofaws_dms_replication_instance(derived from provider schema). - DmsReplicationTaskCdcStart
-
At most one of
cdc_start_position,cdc_start_timeonaws_dms_replication_task: the provider rejects more than one, so each variant sets one of them and a null choice sets none. - DmsReplicationTaskCdcStartPosition
-
The DmsReplicationTaskCdcStart.cdcStartPosition choice: sets
cdc_start_position. - DmsReplicationTaskCdcStartTime
-
The DmsReplicationTaskCdcStart.cdcStartTime choice: sets
cdc_start_time. - EnvironmentConstant
- The AppConstant.fromEnvironment choice.
- GcsBackend
-
terraform { backend "gcs" { ... } }configuration. - IgnoreAllChanges
- IgnoreChanges.all.
- IgnoreAttributes
- IgnoreChanges.of.
- IgnoreChanges
-
What
ignore_changescovers: every attribute, or the listed ones. - InvalidDartDefineOutput
-
An output of
Stack.addDartDefineOutputthat 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
lifecycleblock Terraform rejects: a data source (or one of its attributes) inreplaceTriggeredBy,allinside IgnoreChanges.of, or a condition with an empty error message. - InvalidMoveTarget
-
A
movedblock whosetonames no resource of the Stack. - InvalidTimeout
-
A negative
timeoutsduration. - LifecycleCondition
-
A
preconditionorpostconditionblock: Terraform fails the plan (LifecycleCondition.pre) or the apply (LifecycleCondition.post) with errorMessage when condition is false. - LifecycleOptions
-
lifecycle { ... }block on a resource. - LocalBackend
-
terraform { backend "local" { ... } }configuration. - MissingProvider
-
A block needs a provider configuration the Stack does not register:
the provider its type implies (
googleforgoogle_pubsub_topic), the one itsprovidermeta-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.replaceTriggeredBylists: a resource of the Stack or an attribute getter of one.Resourceand TfRef implement it; synth reports a data source or a data-source attribute as anInvalidLifecycle. - 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, andLocalBackend; anything else implements this interface in the caller. TheStackonly stores the value and exposes a discriminator for synth'sterraform { backend ... }emitter. - StackProvider
-
Coordination interface between
Stack(in this package) and concrete providers (e.g.GoogleProviderinterradart_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(...)ormap(...). - 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 withStack.addOutput. - TfPrimitiveType
-
string,number,boolorany. -
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.variableorvar.<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.refwhose 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
resourceblock or adatablock in Terraform JSON.
Extension Types
- DmsDataProviderAuthMechanism
-
auth_mechanism— derived from the provider schema description. - DmsDataProviderAuthType
-
auth_type— derived from the provider schema description. - DmsDataProviderEngine
-
Dms Data Provider enum for
engine. - DmsEndpointAuthMechanism
-
auth_mechanism— derived from the provider schema description. - DmsEndpointCharLengthSemantics
-
char_length_semantics— derived from the provider schema description. - DmsEndpointDatabaseMode
-
database_mode— derived from the provider schema description. - DmsEndpointEncryptionMode
-
encryption_mode— derived from the provider schema description. - DmsEndpointEngineName
-
Dms Endpoint Engine enum for
engine_name. - DmsEndpointMapLongVarcharAs
-
map_long_varchar_as— derived from the provider schema description. - DmsEndpointMessageFormat
-
message_format— derived from the provider schema description. - DmsEndpointMongodbSettingsAuthType
-
auth_type— derived from the provider schema description. - DmsEndpointMysqlSettingsAuthenticationMethod
-
authentication_method— derived from the provider schema description. - DmsEndpointNestingLevel
-
nesting_level— derived from the provider schema description. - DmsEndpointOracleSettingsAuthenticationMethod
-
authentication_method— derived from the provider schema description. - DmsEndpointPluginName
-
plugin_name— derived from the provider schema description. - DmsEndpointRedisSettingsAuthType
-
auth_type— derived from the provider schema description. - DmsEndpointSaslMechanism
-
sasl_mechanism— derived from the provider schema description. - DmsEndpointSecurityProtocol
-
security_protocol— derived from the provider schema description. - DmsEndpointSslMode
-
Dms Endpoint Ssl enum for
ssl_mode. - DmsEndpointSslSecurityProtocol
-
ssl_security_protocol— derived from the provider schema description. - DmsEndpointTargetDbType
-
target_db_type— derived from the provider schema description. - DmsEndpointType
-
Dms Endpoint enum for
endpoint_type. - DmsEventSubscriptionSourceType
-
Dms Event Subscription Source enum for
source_type. - DmsInstanceProfileNetworkType
-
Dms Instance Profile Network enum for
network_type. - DmsReplicationConfigReplicationType
-
Dms Replication Config Replication enum for
replication_type. - DmsReplicationInstanceNetworkType
-
Dms Replication Instance Network enum for
network_type. - DmsReplicationTaskMigrationType
-
Dms Replication Task Migration enum for
migration_type. - DmsS3EndpointCannedAclForObjects
-
Dms S3 Endpoint Canned Acl For enum for
canned_acl_for_objects. - DmsS3EndpointCompressionType
-
Dms S3 Endpoint Compression enum for
compression_type. - DmsS3EndpointDataFormat
-
Dms S3 Endpoint Data enum for
data_format. - DmsS3EndpointDatePartitionDelimiter
-
Dms S3 Endpoint Date Partition enum for
date_partition_delimiter. - DmsS3EndpointDatePartitionSequence
-
Dms S3 Endpoint Date Partition enum for
date_partition_sequence. - DmsS3EndpointEncodingType
-
Dms S3 Endpoint Encoding enum for
encoding_type. - DmsS3EndpointEncryptionMode
-
Dms S3 Endpoint Encryption enum for
encryption_mode. - DmsS3EndpointParquetVersion
-
Dms S3 Endpoint Parquet enum for
parquet_version. - DmsS3EndpointSslMode
-
Dms S3 Endpoint Ssl enum for
ssl_mode. - DmsS3EndpointType
-
Dms S3 Endpoint enum for
endpoint_type. - OutputEnvironment
-
The environment
Stack.outputEnvironmentreturns: 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").
Constants
- terradartManifestVariable → const String
-
The environment variable the
terradartcommand sets to the file runStack and runEnvironments describe what they wrote in.
Functions
-
runEnvironments<
E extends Enum> (List< String> args, List<E> environments, Stack build(E env), {String dir(E env)?, String? workspace(E env)?, List<String> backendConfig(E env)?, E? defaultEnv}) → Future<void> -
The entry point of a project with one Stack per environment. The
environments are the members of an enum of the project's own — any
names, each carrying its values — so the Stack takes a typed
envand derives everything per environment from it, its backend included: -
runStack(
List< String> args, Stack build(), {String out = 'tf-out'}) → Future<void> -
The entry point of a project with one Stack: writes it to
out.
Exceptions / Errors
- DuplicateModuleError
-
A
ModuleCallregistered twice under one name. - DuplicateResourceError
-
Thrown by
Stack.addwhen an entry with the same(kind, terraformType, localName)triple is registered twice. - SynthException
-
Thrown by
Stack.synth()andStack.writeTo()when the Stack has one or more SynthIssues. Nothing is written.