GoogleIamWorkloadIdentityPoolProvider class final

Factory wrapper for google_iam_workload_identity_pool_provider.

A configuration for an external identity provider.

Configures a Workload Identity Federation provider inside an existing GoogleIamWorkloadIdentityPool — the trust binding that maps external identities (GitHub Actions OIDC, AWS, SAML, X.509) into GCP subjects.

Required identity:

  • localName: Terraform local name.
  • workloadIdentityPoolId: pool ID string or pool.name from GoogleIamWorkloadIdentityPool.
  • workloadIdentityPoolProviderId: provider ID (4–32 chars, [a-z0-9-]).
  • trustSource: exactly one trust binding — sealed so the API's exactly_one_of (oidc / aws / saml / x509) is enforced at compile time.

Example (GitHub Actions OIDC):

final pool = add(GoogleIamWorkloadIdentityPool(
  'pool',
  workloadIdentityPoolId: .literal('pool'),
));
final githubProvider = GoogleIamWorkloadIdentityPoolProvider(
  'github_provider',
  workloadIdentityPoolId: pool.ref,
  workloadIdentityPoolProviderId: .literal('github-actions'),
  displayName: .literal('GitHub Actions'),
  attributeCondition: .literal('assertion.repository_owner == "my-org"'),
  attributeMapping: .literal({
    'google.subject': 'assertion.repository',
    'attribute.repository_owner': 'assertion.repository_owner',
  }),
  trustSource: .oidc(
    .new(
      allowedAudiences: .literal(['https://github.com/my-org']),
      issuerUri: .literal('https://token.actions.githubusercontent.com'),
    ),
  ),
);
Inheritance

Constructors

GoogleIamWorkloadIdentityPoolProvider(String localName, {required RefTo<GoogleIamWorkloadIdentityPool> workloadIdentityPoolId, required TfArg<String> workloadIdentityPoolProviderId, TfArg<String>? displayName, TfArg<String>? description, TfArg<bool>? disabled, TfArg<String>? attributeCondition, TfArg<Map<String, String>>? attributeMapping, required IamWorkloadIdentityPoolProviderTrustSource trustSource, TfArg<String>? project, LifecycleOptions? lifecycle, List<TfAddressed>? dependsOn, StackProvider? provider, TfTimeouts? timeouts})

Properties

argMap → Map<String, TfArg?>
Argument-name → TfArg map. Keys are snake_case (Terraform JSON name). Synth emits these keys directly; the factory is responsible for the camelCase → snake_case translation at construction time.
finalinherited
attributeCondition → TfRef<String>
Reference to attribute_condition attribute.
no setter
attributeMapping → TfRef<Map<String, String>>
Reference to attribute_mapping attribute.
no setter
defaultProvider → String
The provider name a block without provider uses: by default the prefix of terraformType (google for google_pubsub_topic).
no setterinherited
deletionPolicy → TfRef<String>
Reference to deletion_policy attribute.
no setter
dependsOn → List<TfAddressed>?
Optional depends_on = [...]: the resources, data sources and module calls this block waits for, e.g. [api, ...apiDeps]. Terraform takes whole blocks only, so an entry is never an attribute.
finalinherited
description → TfRef<String>
Reference to description attribute.
no setter
disabled → TfRef<bool>
Reference to disabled attribute.
no setter
displayName → TfRef<String>
Reference to display_name attribute.
no setter
hashCode → int
The hash code for this object.
no setterinherited
id → TfRef<String>
Reference to id attribute.
no setter
kind → ResourceKind
Always ResourceKind.resource. Overridden by Data.
no setterinherited
lifecycle → LifecycleOptions?
Optional lifecycle { ... } block.
finalinherited
localName → String
User-supplied local name within a Stack.
finalinherited
name → TfRef<String>
Reference to name attribute.
no setter
project → TfRef<String>
Reference to project attribute.
no setter
provider → StackProvider?
Optional Terraform provider meta-argument: the provider configuration this block uses, e.g. a GoogleProvider with an alias the Stack registered with addProvider.
finalinherited
ref → RefTo<GoogleIamWorkloadIdentityPoolProvider>
A reference to this resource, for arguments typed RefTo<GoogleIamWorkloadIdentityPoolProvider>.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sensitiveFields → Set<String>
Field names that are @Sensitive per the IR-derived per-resource constant. Curated factories override with a baked-in static const Set<String> (file-private in v0.5+).
no setteroverride
state → TfRef<String>
Reference to state attribute.
no setter
supportsDeletionProtection → bool
Capability flag: true when this resource's underlying Terraform schema has a deletion_protection boolean attribute that the synth-time devMode flow can flip to false. Defaults to false; the codegen emitter overrides this to true for wrappers whose schema includes the attribute.
no setterinherited
terraformType → String
Terraform resource type, e.g. google_pubsub_topic.
finalinherited
tfAddress → String
Terraform address <terraformType>.<localName>, e.g. google_pubsub_topic.orders.
no setterinherited
timeouts → TfTimeouts?
Optional timeouts { ... } block: how long Terraform waits for each operation. Provider-neutral like lifecycle — synth copies the duration strings verbatim, and terraform validate decides whether this resource's schema declares the operations set here.
finalinherited
workloadIdentityPoolId → TfRef<String>
Reference to workload_identity_pool_id attribute.
no setter
workloadIdentityPoolProviderId → TfRef<String>
Reference to workload_identity_pool_provider_id attribute.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

tfType → const String