AuthProviderArgs class

The set of arguments for AuthProvider. The set of arguments for AuthProvider.

Constructors

AuthProviderArgs({Input<List<String>?>? allowedScopes, required Input<String> authProviderId, required Input<AuthProviderAuthProviderTypeParams> authProviderTypeParams, Input<List<String>?>? blockedScopes, Input<String?>? deletionPolicy, Input<String?>? description, Input<Map<String, String>?>? labels, required Input<String> location, Input<String?>? project, Input<List<String>?>? workloadIds})
Creates a new AuthProviderArgs. allowedScopes List of scopes that are allowed to be requested for this auth_provider. authProviderId The ID to use for the AuthProvider, which will become the final segment authProviderTypeParams AuthProvider type specific parameters. blockedScopes List of scopes that are blocked from being requested for this deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. description Description of the resource. labels Labels as key value pairs location Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. project The ID of the project in which the resource belongs. workloadIds Input only. Represents the workload identity in IAM principal:// format of the
const
AuthProviderArgs.fromMap(Map<String, dynamic> map)
factory

Properties

allowedScopes → Input<List<String>?>?
List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in blockedScopes are disallowed even if they appear in allowedScopes. The number of allowed scopes is limited to 200.
final
authProviderId → Input<String>
The ID to use for the AuthProvider, which will become the final segment of the AuthProvider's resource name. This value should be 1-63 characters, and valid characters are /a-z-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or a number.
final
authProviderTypeParams → Input<AuthProviderAuthProviderTypeParams>
AuthProvider type specific parameters. Required when creating an auth_provider. Structure is documented below.
final
blockedScopes → Input<List<String>?>?
List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in allowedScopes. blockedScopes takes precedence over allowedScopes. The number of blocked scopes is limited to 200.
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?>?
Description of the resource. Must be less than 256 characters.
final
hashCode → int
The hash code for this object.
no setterinherited
labels → Input<Map<String, String>?>?
Labels as key value pairs Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
final
location → Input<String>
Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
workloadIds → Input<List<String>?>?
Input only. Represents the workload identity in IAM principal:// format of the agent(s) that will use this AuthProvider. Example: principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}
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