WorkforcePoolProviderArgs class

The set of arguments for WorkforcePoolProvider. The set of arguments for WorkforcePoolProvider.

Constructors

WorkforcePoolProviderArgs({Input<String?>? attributeCondition, Input<Map<String, String>?>? attributeMapping, Input<String?>? deletionPolicy, Input<String?>? description, Input<bool?>? detailedAuditLogging, Input<bool?>? disabled, Input<String?>? displayName, Input<WorkforcePoolProviderExtendedAttributesOauth2Client?>? extendedAttributesOauth2Client, Input<WorkforcePoolProviderExtraAttributesOauth2Client?>? extraAttributesOauth2Client, required Input<String> location, Input<WorkforcePoolProviderOidc?>? oidc, required Input<String> providerId, Input<WorkforcePoolProviderSaml?>? saml, Input<String?>? scimUsage, required Input<String> workforcePoolId})
Creates a new WorkforcePoolProviderArgs. attributeCondition A Common Expression Language expression, in attributeMapping Maps attributes from the authentication credentials issued by an external identity provider deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. description A user-specified description of the provider. Cannot exceed 256 characters. detailedAuditLogging If true, populates additional debug information in Cloud Audit Logs for this provider. Logged attribute mappings and values can be found in sts.googleapis.com data access logs. Default value is false. disabled Whether the provider is disabled. You cannot use a disabled provider to exchange tokens. displayName A user-specified display name for the provider. Cannot exceed 32 characters. extendedAttributesOauth2Client (Optional, Deprecated) extraAttributesOauth2Client The configuration for OAuth 2.0 client used to get the additional user location The location for the resource. oidc Represents an OpenId Connect 1.0 identity provider. providerId The ID for the provider, which becomes the final component of the resource name. saml Represents a SAML identity provider. scimUsage Agentspace only. Specifies whether the workforce identity pool workforcePoolId The ID to use for the pool, which becomes the final component of the resource name.
const
WorkforcePoolProviderArgs.fromMap(Map<String, dynamic> map)
factory

Properties

attributeCondition → Input<String?>?
A Common Expression Language expression, in plain text, to restrict what otherwise valid authentication credentials issued by the provider should not be accepted. The expression must output a boolean representing whether to allow the federation. The following keywords may be referenced in the expressions:
final
attributeMapping → Input<Map<String, String>?>?
Maps attributes from the authentication credentials issued by an external identity provider to Google Cloud attributes, such as subject and segment. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported:
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
description → Input<String?>?
A user-specified description of the provider. Cannot exceed 256 characters.
final
detailedAuditLogging → Input<bool?>?
If true, populates additional debug information in Cloud Audit Logs for this provider. Logged attribute mappings and values can be found in sts.googleapis.com data access logs. Default value is false.
final
disabled → Input<bool?>?
Whether the provider is disabled. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access.
final
displayName → Input<String?>?
A user-specified display name for the provider. Cannot exceed 32 characters.
final
extendedAttributesOauth2Client → Input<WorkforcePoolProviderExtendedAttributesOauth2Client?>?
(Optional, Deprecated) The configuration for OAuth 2.0 client used to get the extended group memberships for user identities. Only the AZURE_AD_GROUPS_ID attribute type is supported. Extended groups supports a subset of Google Cloud services. When the user accesses these services, extended group memberships override the mapped google.groups attribute. Extended group memberships cannot be used in attribute mapping or attribute condition expressions. To keep extended group memberships up to date, extended groups are retrieved when the user signs in and at regular intervals during the user's active session. Each user identity in the workforce identity pool must map to a unique Microsoft Entra ID user. Structure is documented below.
final
extraAttributesOauth2Client → Input<WorkforcePoolProviderExtraAttributesOauth2Client?>?
The configuration for OAuth 2.0 client used to get the additional user attributes. This should be used when users can't get the desired claims in authentication credentials. Currently this configuration is only supported with SAML and OIDC protocol. Structure is documented below.
final
hashCode → int
The hash code for this object.
no setterinherited
location → Input<String>
The location for the resource.
final
oidc → Input<WorkforcePoolProviderOidc?>?
Represents an OpenId Connect 1.0 identity provider. Structure is documented below.
final
providerId → Input<String>
The ID for the provider, which becomes the final component of the resource name. This value must be 4-32 characters, and may contain the characters a-z0-9-. The prefix gcp- is reserved for use by Google, and may not be specified.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
saml → Input<WorkforcePoolProviderSaml?>?
Represents a SAML identity provider. Structure is documented below.
final
scimUsage → Input<String?>?
Agentspace only. Specifies whether the workforce identity pool provider uses SCIM-managed groups instead of the google.groups attribute mapping for authorization checks. The scimUsage and extendedAttributesOauth2Client fields are mutually exclusive. A request that enables both fields on the same workforce identity pool provider will produce an error.
final
workforcePoolId → Input<String>
The ID to use for the pool, which becomes the final component of the resource name. The IDs must be a globally unique string of 6 to 63 lowercase letters, digits, or hyphens. It must start with a letter, and cannot have a trailing hyphen. The prefix gcp- is reserved for use by Google, and may not be specified.
final

Methods

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

Operators

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