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 orpool.namefrom GoogleIamWorkloadIdentityPool.workloadIdentityPoolProviderId: provider ID (4–32 chars,[a-z0-9-]).trustSource: exactly one trust binding — sealed so the API'sexactly_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'),
),
),
);
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< ? attributeMapping, required IamWorkloadIdentityPoolProviderTrustSource trustSource, TfArg<String, String> >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_conditionattribute.no setter -
attributeMapping
→ TfRef<
Map< String, String> > -
Reference to
attribute_mappingattribute.no setter - defaultProvider → String
-
The provider name a block without provider uses: by default the
prefix of terraformType (
googleforgoogle_pubsub_topic).no setterinherited -
deletionPolicy
→ TfRef<
String> -
Reference to
deletion_policyattribute.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
descriptionattribute.no setter -
disabled
→ TfRef<
bool> -
Reference to
disabledattribute.no setter -
displayName
→ TfRef<
String> -
Reference to
display_nameattribute.no setter - hashCode → int
-
The hash code for this object.
no setterinherited
-
id
→ TfRef<
String> -
Reference to
idattribute.no setter - kind → ResourceKind
-
Always
ResourceKind.resource. Overridden byData.no setterinherited - lifecycle → LifecycleOptions?
-
Optional
lifecycle { ... }block.finalinherited - localName → String
-
User-supplied local name within a Stack.
finalinherited
-
name
→ TfRef<
String> -
Reference to
nameattribute.no setter -
project
→ TfRef<
String> -
Reference to
projectattribute.no setter - provider → StackProvider?
-
Optional Terraform
providermeta-argument: the provider configuration this block uses, e.g. aGoogleProviderwith analiasthe Stack registered withaddProvider.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
@Sensitiveper the IR-derived per-resource constant. Curated factories override with a baked-instatic const Set<String>(file-private in v0.5+).no setteroverride -
state
→ TfRef<
String> -
Reference to
stateattribute.no setter - supportsDeletionProtection → bool
-
Capability flag: true when this resource's underlying Terraform
schema has a
deletion_protectionboolean attribute that the synth-time devMode flow can flip tofalse. Defaults to false; the codegen emitter overrides this totruefor 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, andterraform validatedecides whether this resource's schema declares the operations set here.finalinherited -
workloadIdentityPoolId
→ TfRef<
String> -
Reference to
workload_identity_pool_idattribute.no setter -
workloadIdentityPoolProviderId
→ TfRef<
String> -
Reference to
workload_identity_pool_provider_idattribute.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