redshift library

AWS Redshift.

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.
AwsRedshiftAuthenticationProfile
Factory wrapper for aws_redshift_authentication_profile.
AwsRedshiftCluster
Factory wrapper for aws_redshift_cluster.
AwsRedshiftClusterIamRoles
Factory wrapper for aws_redshift_cluster_iam_roles.
AwsRedshiftClusterSnapshot
Factory wrapper for aws_redshift_cluster_snapshot.
AwsRedshiftDataShareAuthorization
Factory wrapper for aws_redshift_data_share_authorization.
AwsRedshiftDataShareConsumerAssociation
Factory wrapper for aws_redshift_data_share_consumer_association.
AwsRedshiftEndpointAccess
Factory wrapper for aws_redshift_endpoint_access.
AwsRedshiftEndpointAuthorization
Factory wrapper for aws_redshift_endpoint_authorization.
AwsRedshiftEventSubscription
Factory wrapper for aws_redshift_event_subscription.
AwsRedshiftHsmClientCertificate
Factory wrapper for aws_redshift_hsm_client_certificate.
AwsRedshiftHsmConfiguration
Factory wrapper for aws_redshift_hsm_configuration.
AwsRedshiftIdcApplication
Factory wrapper for aws_redshift_idc_application.
AwsRedshiftIntegration
Factory wrapper for aws_redshift_integration.
AwsRedshiftLogging
Factory wrapper for aws_redshift_logging.
AwsRedshiftNamespaceRegistration
Factory wrapper for aws_redshift_namespace_registration.
AwsRedshiftParameterGroup
Factory wrapper for aws_redshift_parameter_group.
AwsRedshiftPartner
Factory wrapper for aws_redshift_partner.
AwsRedshiftResourcePolicy
Factory wrapper for aws_redshift_resource_policy.
AwsRedshiftScheduledAction
Factory wrapper for aws_redshift_scheduled_action.
AwsRedshiftSnapshotCopy
Factory wrapper for aws_redshift_snapshot_copy.
AwsRedshiftSnapshotCopyGrant
Factory wrapper for aws_redshift_snapshot_copy_grant.
AwsRedshiftSnapshotSchedule
Factory wrapper for aws_redshift_snapshot_schedule.
AwsRedshiftSnapshotScheduleAssociation
Factory wrapper for aws_redshift_snapshot_schedule_association.
AwsRedshiftSubnetGroup
Factory wrapper for aws_redshift_subnet_group.
AwsRedshiftUsageLimit
Factory wrapper for aws_redshift_usage_limit.
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.
DataAwsRedshiftCluster
Factory wrapper for aws_redshift_cluster.
DataAwsRedshiftClusterCredentials
Factory wrapper for aws_redshift_cluster_credentials.
DataAwsRedshiftDataShares
Factory wrapper for aws_redshift_data_shares.
DataAwsRedshiftOrderableCluster
Factory wrapper for aws_redshift_orderable_cluster.
DataAwsRedshiftProducerDataShares
Factory wrapper for aws_redshift_producer_data_shares.
DataAwsRedshiftSubnetGroup
Factory wrapper for aws_redshift_subnet_group.
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.
RedshiftClusterManageMasterPassword
The RedshiftClusterMasterPassword.manageMasterPassword choice: sets manage_master_password.
RedshiftClusterMasterPassword
At most one of manage_master_password, master_password, master_password_wo on aws_redshift_cluster: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
RedshiftClusterMasterPasswordChoice
The RedshiftClusterMasterPassword.masterPassword choice: sets master_password.
RedshiftClusterMasterPasswordWo
The RedshiftClusterMasterPassword.masterPasswordWo choice: sets master_password_wo.
RedshiftClusterSnapshot
At most one of snapshot_arn, snapshot_identifier on aws_redshift_cluster: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
RedshiftClusterSnapshotArn
The RedshiftClusterSnapshot.snapshotArn choice: sets snapshot_arn.
RedshiftClusterSnapshotIdentifier
The RedshiftClusterSnapshot.snapshotIdentifier choice: sets snapshot_identifier.
RedshiftDataShareConsumerAssociationConsumer
Exactly one of associate_entire_account, consumer_arn, consumer_region on aws_redshift_data_share_consumer_association: the provider rejects none and more than one, so each variant sets one of them.
RedshiftDataShareConsumerAssociationConsumerArn
The RedshiftDataShareConsumerAssociationConsumer.consumerArn choice: sets consumer_arn.
RedshiftDataShareConsumerAssociationConsumerAssociateEntireAccount
The RedshiftDataShareConsumerAssociationConsumer.associateEntireAccount choice: sets associate_entire_account.
RedshiftDataShareConsumerAssociationConsumerRegion
The RedshiftDataShareConsumerAssociationConsumer.consumerRegion choice: sets consumer_region.
RedshiftIdcApplicationAuthorizedTokenIssuer
Typed helper for the authorized_token_issuer block of aws_redshift_idc_application (derived from provider schema).
RedshiftIdcApplicationConnect
Typed helper for the service_integration.redshift.connect block of aws_redshift_idc_application (derived from provider schema).
RedshiftIdcApplicationLakeFormation
Typed helper for the service_integration.lake_formation block of aws_redshift_idc_application (derived from provider schema).
RedshiftIdcApplicationLakeFormationQuery
Typed helper for the service_integration.lake_formation.lake_formation_query block of aws_redshift_idc_application (derived from provider schema).
RedshiftIdcApplicationReadWriteAccess
Typed helper for the service_integration.s3_access_grants.read_write_access block of aws_redshift_idc_application (derived from provider schema).
RedshiftIdcApplicationRedshift
Typed helper for the service_integration.redshift block of aws_redshift_idc_application (derived from provider schema).
RedshiftIdcApplicationS3AccessGrants
Typed helper for the service_integration.s3_access_grants block of aws_redshift_idc_application (derived from provider schema).
RedshiftIdcApplicationServiceIntegration
Typed helper for the service_integration block of aws_redshift_idc_application (derived from provider schema).
RedshiftParameterGroupParameter
Typed helper for the parameter block of aws_redshift_parameter_group (derived from provider schema).
RedshiftScheduledActionPauseCluster
Typed helper for the target_action.pause_cluster block of aws_redshift_scheduled_action (derived from provider schema).
RedshiftScheduledActionResizeCluster
Typed helper for the target_action.resize_cluster block of aws_redshift_scheduled_action (derived from provider schema).
RedshiftScheduledActionResumeCluster
Typed helper for the target_action.resume_cluster block of aws_redshift_scheduled_action (derived from provider schema).
RedshiftScheduledActionTargetAction
Exactly one of pause_cluster, resize_cluster, resume_cluster on the target_action block of aws_redshift_scheduled_action: the provider rejects none and more than one, so each variant sets one of them.
RedshiftScheduledActionTargetActionPauseCluster
The RedshiftScheduledActionTargetAction.pauseCluster choice: sets pause_cluster.
RedshiftScheduledActionTargetActionResizeCluster
The RedshiftScheduledActionTargetAction.resizeCluster choice: sets resize_cluster.
RedshiftScheduledActionTargetActionResumeCluster
The RedshiftScheduledActionTargetAction.resumeCluster choice: sets resume_cluster.
RedshiftSnapshotScheduleIdentifier
At most one of identifier, identifier_prefix on aws_redshift_snapshot_schedule: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
RedshiftSnapshotScheduleIdentifierChoice
The RedshiftSnapshotScheduleIdentifier.identifier choice: sets identifier.
RedshiftSnapshotScheduleIdentifierPrefix
The RedshiftSnapshotScheduleIdentifier.identifierPrefix choice: sets identifier_prefix.
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.
RedshiftClusterAquaConfigurationStatus
Redshift Cluster Aqua Configuration enum for aqua_configuration_status.
RedshiftEventSubscriptionEventCategories
Redshift Event Subscription Event enum for event_categories.
RedshiftEventSubscriptionSeverity
Redshift Event Subscription enum for severity.
RedshiftEventSubscriptionSourceType
Redshift Event Subscription Source enum for source_type.
RedshiftIdcApplicationAuthorization
authorization — derived from the provider schema description.
RedshiftIdcApplicationType
Redshift Idc Application enum for application_type.
RedshiftLoggingLogDestinationType
Redshift Logging Log Destination enum for log_destination_type.
RedshiftLoggingLogExports
Redshift Logging Log enum for log_exports.
RedshiftUsageLimitBreachAction
Redshift Usage Limit Breach enum for breach_action.
RedshiftUsageLimitFeatureType
Redshift Usage Limit Feature enum for feature_type.
RedshiftUsageLimitPeriod
Redshift Usage Limit enum for period.
RedshiftUsageLimitType
Redshift Usage Limit enum for limit_type.
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 terradart command 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 env and 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 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.