WorkforcePoolArgs class

The set of arguments for WorkforcePool. The set of arguments for WorkforcePool.

Constructors

WorkforcePoolArgs({Input<AccessRestrictions>? accessRestrictions, Input<String>? description, Input<bool>? disabled, Input<String>? displayName, Input<String>? location, Input<String>? parent, Input<String>? sessionDuration, Input<String>? workforcePoolId})
Creates a new WorkforcePoolArgs. accessRestrictions Optional. Configure access restrictions on the workforce pool users. This is an optional field. If specified web sign-in can be restricted to given set of services or programmatic sign-in can be disabled for pool users. description A user-specified description of the pool. Cannot exceed 256 characters. disabled Disables the workforce pool. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again. displayName A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters. location Optional. parent Immutable. The resource name of the parent. Format: organizations/{org-id}. sessionDuration Duration that the Google Cloud access tokens, console sign-in sessions, and gcloud sign-in sessions from this pool are valid. Must be greater than 15 minutes (900s) and less than 12 hours (43200s). If session_duration is not configured, minted credentials have a default duration of one hour (3600s). For SAML providers, the lifetime of the token is the minimum of the session_duration and the SessionNotOnOrAfter claim in the SAML assertion. workforcePoolId 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.
const
WorkforcePoolArgs.fromMap(Map<String, dynamic> map)
factory

Properties

accessRestrictions → Input<AccessRestrictions>?
Optional. Configure access restrictions on the workforce pool users. This is an optional field. If specified web sign-in can be restricted to given set of services or programmatic sign-in can be disabled for pool users.
final
description → Input<String>?
A user-specified description of the pool. Cannot exceed 256 characters.
final
disabled → Input<bool>?
Disables the workforce pool. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again.
final
displayName → Input<String>?
A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters.
final
hashCode → int
The hash code for this object.
no setterinherited
location → Input<String>?
final
parent → Input<String>?
Immutable. The resource name of the parent. Format: organizations/{org-id}.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sessionDuration → Input<String>?
Duration that the Google Cloud access tokens, console sign-in sessions, and gcloud sign-in sessions from this pool are valid. Must be greater than 15 minutes (900s) and less than 12 hours (43200s). If session_duration is not configured, minted credentials have a default duration of one hour (3600s). For SAML providers, the lifetime of the token is the minimum of the session_duration and the SessionNotOnOrAfter claim in the SAML assertion.
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