IAMWorkforcePool

Stay organized with collections Save and categorize content based on your preferences.
Property Value
Google Cloud Service Name IAM
Google Cloud Service Documentation /iam/docs/
Google Cloud REST Resource Name v1.locations.workforcePools
Google Cloud REST Resource Documentation /iam/docs/reference/rest/v1/locations.workforcePools
Config Connector Resource Short Names gcpiamworkforcepool
gcpiamworkforcepools
iamworkforcepool
Config Connector Service Name iam.googleapis.com
Config Connector Resource Fully Qualified Name iamworkforcepools.iam.cnrm.cloud.google.com
Can Be Referenced by IAMPolicy/IAMPolicyMember Yes
IAMPolicy/IAMPartialPolicy Supports Conditions Yes
IAMPolicyMember Supports Conditions No
Supports IAM Audit Configs No
IAM External Reference Format

locations/{{location}}/workforcePools/{{name}}

Custom Resource Definition Properties

Annotations

Fields
cnrm.cloud.google.com/state-into-spec

Spec

Schema

description: string
disabled: boolean
displayName: string
location: string
organizationRef:
  external: string
  name: string
  namespace: string
resourceID: string
sessionDuration: string
Fields

description

Optional

string

A user-specified description of the pool. Cannot exceed 256 characters.

disabled

Optional

boolean

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.

displayName

Optional

string

A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters.

location

Required

string

Immutable. The location for the resource

organizationRef

Required

object

Immutable. The Organization that this resource belongs to. Only one of [organizationRef] may be specified.

organizationRef.external

Optional

string

Allowed value: The Google Cloud resource name of a Google Cloud Organization (format: `organizations/{{name}}`).

organizationRef.name

Optional

string

[WARNING] Organization not yet supported in Config Connector, use 'external' field to reference existing resources. Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

organizationRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceID

Optional

string

Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default.

sessionDuration

Optional

string

How long 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 will have a default duration of one hour (3600s).

Status

Schema

conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
observedGeneration: integer
selfLink: string
state: string
Fields
conditions

list (object)

Conditions represent the latest available observation of the resource's current state.

conditions[]

object

conditions[].lastTransitionTime

string

Last time the condition transitioned from one status to another.

conditions[].message

string

Human-readable message indicating details about last transition.

conditions[].reason

string

Unique, one-word, CamelCase reason for the condition's last transition.

conditions[].status

string

Status is the status of the condition. Can be True, False, Unknown.

conditions[].type

string

Type is the type of the condition.

observedGeneration

integer

ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.

selfLink

string

Output only. The resource name of the pool. Format: `locations/{location}/workforcePools/{workforce_pool_id}`

state

string

Output only. The state of the pool. Possible values: STATE_UNSPECIFIED, ACTIVE, DELETED

Sample YAML(s)

Typical Use Case

# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: iam.cnrm.cloud.google.com/v1beta1
kind: IAMWorkforcePool
metadata:
  name: iamworkforcepool-sample
spec:
  organizationRef:
    # Replace "${ORG_ID?}" with the numeric ID for your organization
    external: "organizations/${ORG_ID?}"
  location: "global"
  displayName: "Display name"
  description: "A sample workforce pool."
  state: "ACTIVE"
  disabled: false
  sessionDuration: "7200s"