pipes library

AWS EventBridge Pipes.

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.
AwsPipesPipe
Factory wrapper for aws_pipes_pipe.
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.
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.
PipesPipeActivemqBrokerParameters
Typed helper for the source_parameters.activemq_broker_parameters block of aws_pipes_pipe (derived from provider schema).
PipesPipeActivemqBrokerParametersCredentials
Typed helper for the source_parameters.activemq_broker_parameters.credentials block of aws_pipes_pipe (derived from provider schema). Shared by every block of this shape in the resource.
PipesPipeArrayProperties
Typed helper for the target_parameters.batch_job_parameters.array_properties block of aws_pipes_pipe (derived from provider schema).
PipesPipeAwsVpcConfiguration
Typed helper for the target_parameters.ecs_task_parameters.network_configuration.aws_vpc_configuration block of aws_pipes_pipe (derived from provider schema).
PipesPipeBatchJobParameters
Typed helper for the target_parameters.batch_job_parameters block of aws_pipes_pipe (derived from provider schema).
PipesPipeCapacityProviderStrategy
Typed helper for the target_parameters.ecs_task_parameters.capacity_provider_strategy block of aws_pipes_pipe (derived from provider schema).
PipesPipeCloudwatchLogsLogDestination
Typed helper for the log_configuration.cloudwatch_logs_log_destination block of aws_pipes_pipe (derived from provider schema).
PipesPipeCloudwatchLogsParameters
Typed helper for the target_parameters.cloudwatch_logs_parameters block of aws_pipes_pipe (derived from provider schema).
PipesPipeContainerOverride
Typed helper for the target_parameters.ecs_task_parameters.overrides.container_override block of aws_pipes_pipe (derived from provider schema).
PipesPipeContainerOverrideResourceRequirement
Typed helper for the target_parameters.ecs_task_parameters.overrides.container_override.resource_requirement block of aws_pipes_pipe (derived from provider schema).
PipesPipeContainerOverrides
Typed helper for the target_parameters.batch_job_parameters.container_overrides block of aws_pipes_pipe (derived from provider schema).
PipesPipeDeadLetterConfig
Typed helper for the source_parameters.dynamodb_stream_parameters.dead_letter_config block of aws_pipes_pipe (derived from provider schema). Shared by every block of this shape in the resource.
PipesPipeDependsOn
Typed helper for the target_parameters.batch_job_parameters.depends_on block of aws_pipes_pipe (derived from provider schema).
PipesPipeDynamodbStreamParameters
Typed helper for the source_parameters.dynamodb_stream_parameters block of aws_pipes_pipe (derived from provider schema).
PipesPipeEcsTaskParameters
Typed helper for the target_parameters.ecs_task_parameters block of aws_pipes_pipe (derived from provider schema).
PipesPipeEnrichmentParameters
Typed helper for the enrichment_parameters block of aws_pipes_pipe (derived from provider schema).
PipesPipeEnvironment
Typed helper for the target_parameters.batch_job_parameters.container_overrides.environment block of aws_pipes_pipe (derived from provider schema). Shared by every block of this shape in the resource.
PipesPipeEnvironmentFile
Typed helper for the target_parameters.ecs_task_parameters.overrides.container_override.environment_file block of aws_pipes_pipe (derived from provider schema).
PipesPipeEphemeralStorage
Typed helper for the target_parameters.ecs_task_parameters.overrides.ephemeral_storage block of aws_pipes_pipe (derived from provider schema).
PipesPipeEventbridgeEventBusParameters
Typed helper for the target_parameters.eventbridge_event_bus_parameters block of aws_pipes_pipe (derived from provider schema).
PipesPipeFilter
Typed helper for the source_parameters.filter_criteria.filter block of aws_pipes_pipe (derived from provider schema).
PipesPipeFilterCriteria
Typed helper for the source_parameters.filter_criteria block of aws_pipes_pipe (derived from provider schema).
PipesPipeFirehoseLogDestination
Typed helper for the log_configuration.firehose_log_destination block of aws_pipes_pipe (derived from provider schema).
PipesPipeHttpParameters
Typed helper for the enrichment_parameters.http_parameters block of aws_pipes_pipe (derived from provider schema). Shared by every block of this shape in the resource.
PipesPipeInferenceAcceleratorOverride
Typed helper for the target_parameters.ecs_task_parameters.overrides.inference_accelerator_override block of aws_pipes_pipe (derived from provider schema).
PipesPipeLambdaFunctionParameters
Typed helper for the target_parameters.lambda_function_parameters block of aws_pipes_pipe (derived from provider schema).
PipesPipeLogConfiguration
Typed helper for the log_configuration block of aws_pipes_pipe (derived from provider schema).
PipesPipeManagedStreamingKafkaParameters
Typed helper for the source_parameters.managed_streaming_kafka_parameters block of aws_pipes_pipe (derived from provider schema).
PipesPipeManagedStreamingKafkaParametersCredentials
Typed helper for the source_parameters.managed_streaming_kafka_parameters.credentials block of aws_pipes_pipe (derived from provider schema).
PipesPipeName
At most one of name, name_prefix on aws_pipes_pipe: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
PipesPipeNameChoice
The PipesPipeName.name choice: sets name.
PipesPipeNamePrefix
The PipesPipeName.namePrefix choice: sets name_prefix.
PipesPipeNetworkConfiguration
Typed helper for the target_parameters.ecs_task_parameters.network_configuration block of aws_pipes_pipe (derived from provider schema).
PipesPipeOverrides
Typed helper for the target_parameters.ecs_task_parameters.overrides block of aws_pipes_pipe (derived from provider schema).
PipesPipePipelineParameter
Typed helper for the target_parameters.sagemaker_pipeline_parameters.pipeline_parameter block of aws_pipes_pipe (derived from provider schema).
PipesPipePlacementConstraint
Typed helper for the target_parameters.ecs_task_parameters.placement_constraint block of aws_pipes_pipe (derived from provider schema).
PipesPipePlacementStrategy
Typed helper for the target_parameters.ecs_task_parameters.placement_strategy block of aws_pipes_pipe (derived from provider schema).
PipesPipeRabbitmqBrokerParameters
Typed helper for the source_parameters.rabbitmq_broker_parameters block of aws_pipes_pipe (derived from provider schema).
PipesPipeRedshiftDataParameters
Typed helper for the target_parameters.redshift_data_parameters block of aws_pipes_pipe (derived from provider schema).
PipesPipeResourceRequirement
Typed helper for the target_parameters.batch_job_parameters.container_overrides.resource_requirement block of aws_pipes_pipe (derived from provider schema).
PipesPipeRetryStrategy
Typed helper for the target_parameters.batch_job_parameters.retry_strategy block of aws_pipes_pipe (derived from provider schema).
PipesPipeS3LogDestination
Typed helper for the log_configuration.s3_log_destination block of aws_pipes_pipe (derived from provider schema).
PipesPipeSagemakerPipelineParameters
Typed helper for the target_parameters.sagemaker_pipeline_parameters block of aws_pipes_pipe (derived from provider schema).
PipesPipeSelfManagedKafkaParameters
Typed helper for the source_parameters.self_managed_kafka_parameters block of aws_pipes_pipe (derived from provider schema).
PipesPipeSelfManagedKafkaParametersCredentials
Typed helper for the source_parameters.self_managed_kafka_parameters.credentials block of aws_pipes_pipe (derived from provider schema).
PipesPipeSourceParameters
Typed helper for the source_parameters block of aws_pipes_pipe (derived from provider schema).
PipesPipeSourceParametersKinesisStreamParameters
Typed helper for the source_parameters.kinesis_stream_parameters block of aws_pipes_pipe (derived from provider schema).
PipesPipeSourceParametersService
At most one of activemq_broker_parameters, dynamodb_stream_parameters, kinesis_stream_parameters, managed_streaming_kafka_parameters, rabbitmq_broker_parameters, self_managed_kafka_parameters, sqs_queue_parameters on the source_parameters block of aws_pipes_pipe: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
PipesPipeSourceParametersServiceActivemqBrokerParameters
The PipesPipeSourceParametersService.activemqBrokerParameters choice: sets activemq_broker_parameters.
PipesPipeSourceParametersServiceDynamodbStreamParameters
The PipesPipeSourceParametersService.dynamodbStreamParameters choice: sets dynamodb_stream_parameters.
PipesPipeSourceParametersServiceKinesisStreamParameters
The PipesPipeSourceParametersService.kinesisStreamParameters choice: sets kinesis_stream_parameters.
PipesPipeSourceParametersServiceManagedStreamingKafkaParameters
The PipesPipeSourceParametersService.managedStreamingKafkaParameters choice: sets managed_streaming_kafka_parameters.
PipesPipeSourceParametersServiceRabbitmqBrokerParameters
The PipesPipeSourceParametersService.rabbitmqBrokerParameters choice: sets rabbitmq_broker_parameters.
PipesPipeSourceParametersServiceSelfManagedKafkaParameters
The PipesPipeSourceParametersService.selfManagedKafkaParameters choice: sets self_managed_kafka_parameters.
PipesPipeSourceParametersServiceSqsQueueParameters
The PipesPipeSourceParametersService.sqsQueueParameters choice: sets sqs_queue_parameters.
PipesPipeSourceParametersSqsQueueParameters
Typed helper for the source_parameters.sqs_queue_parameters block of aws_pipes_pipe (derived from provider schema).
PipesPipeStepFunctionStateMachineParameters
Typed helper for the target_parameters.step_function_state_machine_parameters block of aws_pipes_pipe (derived from provider schema).
PipesPipeTargetParameters
Typed helper for the target_parameters block of aws_pipes_pipe (derived from provider schema).
PipesPipeTargetParametersKinesisStreamParameters
Typed helper for the target_parameters.kinesis_stream_parameters block of aws_pipes_pipe (derived from provider schema).
PipesPipeTargetParametersService
At most one of batch_job_parameters, cloudwatch_logs_parameters, ecs_task_parameters, eventbridge_event_bus_parameters, http_parameters, kinesis_stream_parameters, lambda_function_parameters, redshift_data_parameters, sagemaker_pipeline_parameters, sqs_queue_parameters, step_function_state_machine_parameters on the target_parameters block of aws_pipes_pipe: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
PipesPipeTargetParametersServiceBatchJobParameters
The PipesPipeTargetParametersService.batchJobParameters choice: sets batch_job_parameters.
PipesPipeTargetParametersServiceCloudwatchLogsParameters
The PipesPipeTargetParametersService.cloudwatchLogsParameters choice: sets cloudwatch_logs_parameters.
PipesPipeTargetParametersServiceEcsTaskParameters
The PipesPipeTargetParametersService.ecsTaskParameters choice: sets ecs_task_parameters.
PipesPipeTargetParametersServiceEventbridgeEventBusParameters
The PipesPipeTargetParametersService.eventbridgeEventBusParameters choice: sets eventbridge_event_bus_parameters.
PipesPipeTargetParametersServiceHttpParameters
The PipesPipeTargetParametersService.httpParameters choice: sets http_parameters.
PipesPipeTargetParametersServiceKinesisStreamParameters
The PipesPipeTargetParametersService.kinesisStreamParameters choice: sets kinesis_stream_parameters.
PipesPipeTargetParametersServiceLambdaFunctionParameters
The PipesPipeTargetParametersService.lambdaFunctionParameters choice: sets lambda_function_parameters.
PipesPipeTargetParametersServiceRedshiftDataParameters
The PipesPipeTargetParametersService.redshiftDataParameters choice: sets redshift_data_parameters.
PipesPipeTargetParametersServiceSagemakerPipelineParameters
The PipesPipeTargetParametersService.sagemakerPipelineParameters choice: sets sagemaker_pipeline_parameters.
PipesPipeTargetParametersServiceSqsQueueParameters
The PipesPipeTargetParametersService.sqsQueueParameters choice: sets sqs_queue_parameters.
PipesPipeTargetParametersServiceStepFunctionStateMachineParameters
The PipesPipeTargetParametersService.stepFunctionStateMachineParameters choice: sets step_function_state_machine_parameters.
PipesPipeTargetParametersSqsQueueParameters
Typed helper for the target_parameters.sqs_queue_parameters block of aws_pipes_pipe (derived from provider schema).
PipesPipeVpc
Typed helper for the source_parameters.self_managed_kafka_parameters.vpc block of aws_pipes_pipe (derived from provider schema).
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

OutputEnvironment
The environment Stack.outputEnvironment returns: each variable and its value, in registration order.
PipesPipeAssignPublicIp
assign_public_ip — derived from the provider schema description.
PipesPipeContainerOverrideType
type — derived from the provider schema description.
PipesPipeDependsOnType
type — derived from the provider schema description.
PipesPipeDesiredState
Pipes Pipe Desired enum for desired_state.
PipesPipeDynamodbStreamParametersStartingPosition
starting_position — derived from the provider schema description.
PipesPipeEnvironmentFileType
type — derived from the provider schema description.
PipesPipeIncludeExecutionData
include_execution_data — derived from the provider schema description.
PipesPipeInvocationType
invocation_type — derived from the provider schema description.
PipesPipeKinesisStreamParametersStartingPosition
starting_position — derived from the provider schema description.
PipesPipeLaunchType
launch_type — derived from the provider schema description.
PipesPipeLevel
level — derived from the provider schema description.
PipesPipeOnPartialBatchItemFailure
on_partial_batch_item_failure — derived from the provider schema description.
PipesPipeOutputFormat
output_format — derived from the provider schema description.
PipesPipePlacementConstraintType
type — derived from the provider schema description.
PipesPipePlacementStrategyType
type — derived from the provider schema description.
PipesPipePropagateTags
propagate_tags — derived from the provider schema description.
PipesPipeResourceRequirementType
type — derived from the provider schema description.
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.