elasticache library

AWS ElastiCache.

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.
AwsElasticacheCluster
Factory wrapper for aws_elasticache_cluster.
AwsElasticacheGlobalReplicationGroup
Factory wrapper for aws_elasticache_global_replication_group.
AwsElasticacheParameterGroup
Factory wrapper for aws_elasticache_parameter_group.
AwsElasticacheReplicationGroup
Factory wrapper for aws_elasticache_replication_group.
AwsElasticacheReservedCacheNode
Factory wrapper for aws_elasticache_reserved_cache_node.
AwsElasticacheServerlessCache
Factory wrapper for aws_elasticache_serverless_cache.
AwsElasticacheSubnetGroup
Factory wrapper for aws_elasticache_subnet_group.
AwsElasticacheUser
Factory wrapper for aws_elasticache_user.
AwsElasticacheUserGroup
Factory wrapper for aws_elasticache_user_group.
AwsElasticacheUserGroupAssociation
Factory wrapper for aws_elasticache_user_group_association.
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.
DataAwsElasticacheCluster
Factory wrapper for aws_elasticache_cluster.
DataAwsElasticacheReplicationGroup
Factory wrapper for aws_elasticache_replication_group.
DataAwsElasticacheReservedCacheNodeOffering
Factory wrapper for aws_elasticache_reserved_cache_node_offering.
DataAwsElasticacheServerlessCache
Factory wrapper for aws_elasticache_serverless_cache.
DataAwsElasticacheServiceUpdateActions
Factory wrapper for aws_elasticache_service_update_actions.
DataAwsElasticacheServiceUpdates
Factory wrapper for aws_elasticache_service_updates.
DataAwsElasticacheSubnetGroup
Factory wrapper for aws_elasticache_subnet_group.
DataAwsElasticacheUser
Factory wrapper for aws_elasticache_user.
DataElasticacheUserAuthenticationMode
Typed helper for the authentication_mode block of aws_elasticache_user (derived from provider schema).
DataRef<T>
Public for sealed pattern matching, but constructor is private — only TfRef.data() may construct instances.
ElasticacheClusterLogDeliveryConfiguration
Typed helper for the log_delivery_configuration block of aws_elasticache_cluster (derived from provider schema).
ElasticacheClusterSource
Exactly one of engine, replication_group_id on aws_elasticache_cluster: the provider rejects none and more than one, so each variant sets one of them.
ElasticacheClusterSourceEngine
The ElasticacheClusterSource.engine choice: sets engine.
ElasticacheClusterSourceReplicationGroupId
The ElasticacheClusterSource.replicationGroupId choice: sets replication_group_id.
ElasticacheParameterGroupParameter
Typed helper for the parameter block of aws_elasticache_parameter_group (derived from provider schema).
ElasticacheReplicationGroupAuth
At most one of auth_token, auth_token_wo, user_group_ids on aws_elasticache_replication_group: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
ElasticacheReplicationGroupAuthToken
The ElasticacheReplicationGroupAuth.authToken choice: sets auth_token.
ElasticacheReplicationGroupAuthTokenWo
The ElasticacheReplicationGroupAuth.authTokenWo choice: sets auth_token_wo.
ElasticacheReplicationGroupAuthUserGroupIds
The ElasticacheReplicationGroupAuth.userGroupIds choice: sets user_group_ids.
ElasticacheReplicationGroupLogDeliveryConfiguration
Typed helper for the log_delivery_configuration block of aws_elasticache_replication_group (derived from provider schema).
ElasticacheReplicationGroupNodeGroupConfiguration
Typed helper for the node_group_configuration block of aws_elasticache_replication_group (derived from provider schema).
ElasticacheReplicationGroupTopology
At most one of node_group_configuration, preferred_cache_cluster_azs on aws_elasticache_replication_group: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
ElasticacheReplicationGroupTopologyNodeGroupConfiguration
The ElasticacheReplicationGroupTopology.nodeGroupConfiguration choice: sets node_group_configuration.
ElasticacheReplicationGroupTopologyPreferredCacheClusterAzs
The ElasticacheReplicationGroupTopology.preferredCacheClusterAzs choice: sets preferred_cache_cluster_azs.
ElasticacheServerlessCacheDataStorage
Typed helper for the cache_usage_limits.data_storage block of aws_elasticache_serverless_cache (derived from provider schema).
ElasticacheServerlessCacheEcpuPerSecond
Typed helper for the cache_usage_limits.ecpu_per_second block of aws_elasticache_serverless_cache (derived from provider schema).
ElasticacheServerlessCacheUsageLimits
Typed helper for the cache_usage_limits block of aws_elasticache_serverless_cache (derived from provider schema).
ElasticacheUserAuthenticationMode
Typed helper for the authentication_mode block of aws_elasticache_user (derived from provider schema).
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

ElasticacheClusterAzMode
Elasticache Cluster Az enum for az_mode.
ElasticacheClusterDestinationType
destination_type — derived from the provider schema description.
ElasticacheClusterEngine
Elasticache Cluster enum for engine.
ElasticacheClusterIpDiscovery
Elasticache Cluster Ip enum for ip_discovery.
ElasticacheClusterLogFormat
log_format — derived from the provider schema description.
ElasticacheClusterLogType
log_type — derived from the provider schema description.
ElasticacheClusterNetworkType
Elasticache Cluster Network enum for network_type.
ElasticacheClusterOutpostMode
Elasticache Cluster Outpost enum for outpost_mode.
ElasticacheGlobalReplicationGroupEngine
Elasticache Global Replication Group enum for engine.
ElasticacheReplicationGroupAuthTokenUpdateStrategy
Elasticache Replication Group Auth Token Update enum for auth_token_update_strategy.
ElasticacheReplicationGroupClusterMode
Elasticache Replication Group Cluster enum for cluster_mode.
ElasticacheReplicationGroupDestinationType
destination_type — derived from the provider schema description.
ElasticacheReplicationGroupDurability
Elasticache Replication Group enum for durability.
ElasticacheReplicationGroupEngine
Elasticache Replication Group enum for engine.
ElasticacheReplicationGroupIpDiscovery
Elasticache Replication Group Ip enum for ip_discovery.
ElasticacheReplicationGroupLogFormat
log_format — derived from the provider schema description.
ElasticacheReplicationGroupLogType
log_type — derived from the provider schema description.
ElasticacheReplicationGroupNetworkType
Elasticache Replication Group Network enum for network_type.
ElasticacheReplicationGroupTransitEncryptionMode
Elasticache Replication Group Transit Encryption enum for transit_encryption_mode.
ElasticacheServerlessCacheNetworkType
Elasticache Serverless Cache Network enum for network_type.
ElasticacheServerlessCacheUnit
unit — derived from the provider schema description.
ElasticacheUserEngine
Elasticache User enum for engine.
ElasticacheUserGroupEngine
Elasticache User Group enum for engine.
ElasticacheUserType
type — derived from the provider schema description.
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.