WorkforcePoolState class - iam library

Constructors

WorkforcePoolState({Input<WorkforcePoolAccessRestrictions?>? accessRestrictions, Input<String?>? deletionPolicy, Input<String?>? description, Input<bool?>? disabled, Input<String?>? displayName, Input<String?>? location, Input<String?>? name, Input<String?>? parent, Input<String?>? sessionDuration, Input<String?>? state, Input<String?>? workforcePoolId}): Creates a new WorkforcePoolState. accessRestrictions Configure access restrictions on the workforce pool users. This is an optional field. If specified web deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. description A user-specified description of the pool. Cannot exceed 256 characters. disabled Whether the pool is disabled. You cannot use a disabled pool to exchange tokens, displayName A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters. location The location for the resource. name Output only. The resource name of the pool. parent Immutable. The resource name of the parent. Format: organizations/{org-id}. sessionDuration Duration that the Google Cloud access tokens, console sign-in sessions, state Output only. The state of the pool. workforcePoolId The name of the pool. The ID must be a globally unique string of 6 to 63 lowercase letters,
const
WorkforcePoolState.fromMap(Map<String, dynamic> map): factory

Properties

accessRestrictions → Input<WorkforcePoolAccessRestrictions?>?: 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. Structure is documented below.
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 pool. Cannot exceed 256 characters.
final
disabled → Input<bool?>?: Whether the pool is disabled. 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?>?: The location for the resource.
final
name → Input<String?>?: Output only. The resource name of the pool. Format: locations/{location}/workforcePools/{workforcePoolId}
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 sessionDuration is not configured, minted credentials have a default duration of one hour (3600s). A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
final
state → Input<String?>?: Output only. The state of the pool.
final
workforcePoolId → Input<String?>?: The name of the pool. The ID 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