connect library

AWS Connect.

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.
AwsConnectBotAssociation
Factory wrapper for aws_connect_bot_association.
AwsConnectContactFlow
Factory wrapper for aws_connect_contact_flow.
AwsConnectContactFlowModule
Factory wrapper for aws_connect_contact_flow_module.
AwsConnectHoursOfOperation
Factory wrapper for aws_connect_hours_of_operation.
AwsConnectInstance
Factory wrapper for aws_connect_instance.
AwsConnectInstanceStorageConfig
Factory wrapper for aws_connect_instance_storage_config.
AwsConnectLambdaFunctionAssociation
Factory wrapper for aws_connect_lambda_function_association.
AwsConnectPhoneNumber
Factory wrapper for aws_connect_phone_number.
AwsConnectPhoneNumberContactFlowAssociation
Factory wrapper for aws_connect_phone_number_contact_flow_association.
AwsConnectQueue
Factory wrapper for aws_connect_queue.
AwsConnectQuickConnect
Factory wrapper for aws_connect_quick_connect.
AwsConnectRoutingProfile
Factory wrapper for aws_connect_routing_profile.
AwsConnectSecurityProfile
Factory wrapper for aws_connect_security_profile.
AwsConnectUser
Factory wrapper for aws_connect_user.
AwsConnectUserHierarchyGroup
Factory wrapper for aws_connect_user_hierarchy_group.
AwsConnectUserHierarchyStructure
Factory wrapper for aws_connect_user_hierarchy_structure.
AwsConnectVocabulary
Factory wrapper for aws_connect_vocabulary.
ConnectBotAssociationLexBot
Typed helper for the lex_bot block of aws_connect_bot_association (derived from provider schema).
ConnectContactFlowContent
At most one of content, filename on aws_connect_contact_flow: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
ConnectContactFlowContentChoice
The ConnectContactFlowContent.content choice: sets content.
ConnectContactFlowContentFilename
The ConnectContactFlowContent.filename choice: sets filename.
ConnectContactFlowModuleContent
At most one of content, filename on aws_connect_contact_flow_module: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
ConnectContactFlowModuleContentChoice
The ConnectContactFlowModuleContent.content choice: sets content.
ConnectContactFlowModuleContentFilename
The ConnectContactFlowModuleContent.filename choice: sets filename.
ConnectHoursOfOperationConfig
Typed helper for the config block of aws_connect_hours_of_operation (derived from provider schema).
ConnectHoursOfOperationEndTime
Typed helper for the config.end_time block of aws_connect_hours_of_operation (derived from provider schema).
ConnectHoursOfOperationStartTime
Typed helper for the config.start_time block of aws_connect_hours_of_operation (derived from provider schema).
ConnectInstanceStorageConfig
Typed helper for the storage_config block of aws_connect_instance_storage_config (derived from provider schema).
ConnectInstanceStorageConfigEncryptionConfig
Typed helper for the storage_config.kinesis_video_stream_config.encryption_config block of aws_connect_instance_storage_config (derived from provider schema). Shared by every block of this shape in the resource.
ConnectInstanceStorageConfigKinesisFirehoseConfig
Typed helper for the storage_config.kinesis_firehose_config block of aws_connect_instance_storage_config (derived from provider schema).
ConnectInstanceStorageConfigKinesisStreamConfig
Typed helper for the storage_config.kinesis_stream_config block of aws_connect_instance_storage_config (derived from provider schema).
ConnectInstanceStorageConfigKinesisVideoStreamConfig
Typed helper for the storage_config.kinesis_video_stream_config block of aws_connect_instance_storage_config (derived from provider schema).
ConnectInstanceStorageConfigS3Config
Typed helper for the storage_config.s3_config block of aws_connect_instance_storage_config (derived from provider schema).
ConnectQueueOutboundCallerConfig
Typed helper for the outbound_caller_config block of aws_connect_queue (derived from provider schema).
ConnectQuickConnectConfig
Typed helper for the quick_connect_config block of aws_connect_quick_connect (derived from provider schema).
ConnectQuickConnectPhoneConfig
Typed helper for the quick_connect_config.phone_config block of aws_connect_quick_connect (derived from provider schema).
ConnectQuickConnectQueueConfig
Typed helper for the quick_connect_config.queue_config block of aws_connect_quick_connect (derived from provider schema).
ConnectQuickConnectUserConfig
Typed helper for the quick_connect_config.user_config block of aws_connect_quick_connect (derived from provider schema).
ConnectRoutingProfileCrossChannelBehavior
Typed helper for the media_concurrencies.cross_channel_behavior block of aws_connect_routing_profile (derived from provider schema).
ConnectRoutingProfileMediaConcurrencies
Typed helper for the media_concurrencies block of aws_connect_routing_profile (derived from provider schema).
ConnectRoutingProfileQueueConfigs
Typed helper for the queue_configs block of aws_connect_routing_profile (derived from provider schema).
ConnectUserHierarchyStructure
Typed helper for the hierarchy_structure block of aws_connect_user_hierarchy_structure (derived from provider schema).
ConnectUserHierarchyStructureLevelFive
Typed helper for the hierarchy_structure.level_five block of aws_connect_user_hierarchy_structure (derived from provider schema).
ConnectUserHierarchyStructureLevelFour
Typed helper for the hierarchy_structure.level_four block of aws_connect_user_hierarchy_structure (derived from provider schema).
ConnectUserHierarchyStructureLevelOne
Typed helper for the hierarchy_structure.level_one block of aws_connect_user_hierarchy_structure (derived from provider schema).
ConnectUserHierarchyStructureLevelThree
Typed helper for the hierarchy_structure.level_three block of aws_connect_user_hierarchy_structure (derived from provider schema).
ConnectUserHierarchyStructureLevelTwo
Typed helper for the hierarchy_structure.level_two block of aws_connect_user_hierarchy_structure (derived from provider schema).
ConnectUserIdentityInfo
Typed helper for the identity_info block of aws_connect_user (derived from provider schema).
ConnectUserPhoneConfig
Typed helper for the phone_config block of aws_connect_user (derived from provider schema).
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.
DataAwsConnectBotAssociation
Factory wrapper for aws_connect_bot_association.
DataAwsConnectContactFlow
Factory wrapper for aws_connect_contact_flow.
DataAwsConnectContactFlowModule
Factory wrapper for aws_connect_contact_flow_module.
DataAwsConnectHoursOfOperation
Factory wrapper for aws_connect_hours_of_operation.
DataAwsConnectInstance
Factory wrapper for aws_connect_instance.
DataAwsConnectInstanceStorageConfig
Factory wrapper for aws_connect_instance_storage_config.
DataAwsConnectLambdaFunctionAssociation
Factory wrapper for aws_connect_lambda_function_association.
DataAwsConnectPrompt
Factory wrapper for aws_connect_prompt.
DataAwsConnectQueue
Factory wrapper for aws_connect_queue.
DataAwsConnectQuickConnect
Factory wrapper for aws_connect_quick_connect.
DataAwsConnectRoutingProfile
Factory wrapper for aws_connect_routing_profile.
DataAwsConnectSecurityProfile
Factory wrapper for aws_connect_security_profile.
DataAwsConnectUser
Factory wrapper for aws_connect_user.
DataAwsConnectUserHierarchyGroup
Factory wrapper for aws_connect_user_hierarchy_group.
DataAwsConnectUserHierarchyStructure
Factory wrapper for aws_connect_user_hierarchy_structure.
DataAwsConnectVocabulary
Factory wrapper for aws_connect_vocabulary.
DataConnectBotAssociationLexBot
Typed helper for the lex_bot block of aws_connect_bot_association (derived from provider schema).
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.
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

ConnectContactFlowType
Connect Contact Flow enum for type.
ConnectHoursOfOperationDay
day — derived from the provider schema description.
ConnectInstanceIdentityManagementType
Connect Instance Identity Management enum for identity_management_type.
ConnectInstanceStorageConfigEncryptionType
encryption_type — derived from the provider schema description.
ConnectInstanceStorageConfigResourceType
Connect Instance Storage Config Resource enum for resource_type.
ConnectInstanceStorageConfigStorageType
storage_type — derived from the provider schema description.
ConnectPhoneNumberCountryCode
Connect Phone Number Country enum for country_code.
ConnectPhoneNumberType
Connect Phone Number enum for type.
ConnectQueueStatus
Connect Queue enum for status.
ConnectQuickConnectType
quick_connect_type — derived from the provider schema description.
ConnectRoutingProfileBehaviorType
behavior_type — derived from the provider schema description.
ConnectRoutingProfileChannel
channel — derived from the provider schema description.
ConnectUserPhoneType
phone_type — derived from the provider schema description.
ConnectVocabularyLanguageCode
Connect Vocabulary Language enum for language_code.
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.