Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. iam
  5. iam/v1
  6. getWorkforcePool

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.iam/v1.getWorkforcePool

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Gets an individual WorkforcePool.

    Using getWorkforcePool

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getWorkforcePool(args: GetWorkforcePoolArgs, opts?: InvokeOptions): Promise<GetWorkforcePoolResult>
function getWorkforcePoolOutput(args: GetWorkforcePoolOutputArgs, opts?: InvokeOptions): Output<GetWorkforcePoolResult>
    def get_workforce_pool(location: Optional[str] = None,
                       workforce_pool_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetWorkforcePoolResult
def get_workforce_pool_output(location: Optional[pulumi.Input[str]] = None,
                       workforce_pool_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetWorkforcePoolResult]
    func LookupWorkforcePool(ctx *Context, args *LookupWorkforcePoolArgs, opts ...InvokeOption) (*LookupWorkforcePoolResult, error)
func LookupWorkforcePoolOutput(ctx *Context, args *LookupWorkforcePoolOutputArgs, opts ...InvokeOption) LookupWorkforcePoolResultOutput

    > Note: This function is named LookupWorkforcePool in the Go SDK.

    public static class GetWorkforcePool 
{
    public static Task<GetWorkforcePoolResult> InvokeAsync(GetWorkforcePoolArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkforcePoolResult> Invoke(GetWorkforcePoolInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetWorkforcePoolResult> getWorkforcePool(GetWorkforcePoolArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:iam/v1:getWorkforcePool
  arguments:
    # arguments dictionary

    The following arguments are supported:

    getWorkforcePool Result

    The following output properties are available:

    AccessRestrictions Pulumi.GoogleNative.IAM.V1.Outputs.AccessRestrictionsResponse
    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 string
    A user-specified description of the pool. Cannot exceed 256 characters.
    Disabled 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.
    DisplayName string
    A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters.
    ExpireTime string
    Time after which the workforce pool will be permanently purged and cannot be recovered.
    Name string
    The resource name of the pool. Format: locations/{location}/workforcePools/{workforce_pool_id}
    Parent string
    Immutable. The resource name of the parent. Format: organizations/{org-id}.
    SessionDuration 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.
    State string
    The state of the pool.
    AccessRestrictions AccessRestrictionsResponse
    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 string
    A user-specified description of the pool. Cannot exceed 256 characters.
    Disabled 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.
    DisplayName string
    A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters.
    ExpireTime string
    Time after which the workforce pool will be permanently purged and cannot be recovered.
    Name string
    The resource name of the pool. Format: locations/{location}/workforcePools/{workforce_pool_id}
    Parent string
    Immutable. The resource name of the parent. Format: organizations/{org-id}.
    SessionDuration 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.
    State string
    The state of the pool.
    accessRestrictions AccessRestrictionsResponse
    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 String
    A user-specified description of the pool. Cannot exceed 256 characters.
    disabled Boolean
    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 String
    A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters.
    expireTime String
    Time after which the workforce pool will be permanently purged and cannot be recovered.
    name String
    The resource name of the pool. Format: locations/{location}/workforcePools/{workforce_pool_id}
    parent String
    Immutable. The resource name of the parent. Format: organizations/{org-id}.
    sessionDuration 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.
    state String
    The state of the pool.
    accessRestrictions AccessRestrictionsResponse
    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 string
    A user-specified description of the pool. Cannot exceed 256 characters.
    disabled boolean
    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 string
    A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters.
    expireTime string
    Time after which the workforce pool will be permanently purged and cannot be recovered.
    name string
    The resource name of the pool. Format: locations/{location}/workforcePools/{workforce_pool_id}
    parent string
    Immutable. The resource name of the parent. Format: organizations/{org-id}.
    sessionDuration 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.
    state string
    The state of the pool.
    access_restrictions AccessRestrictionsResponse
    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 str
    A user-specified description of the pool. Cannot exceed 256 characters.
    disabled 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.
    display_name str
    A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters.
    expire_time str
    Time after which the workforce pool will be permanently purged and cannot be recovered.
    name str
    The resource name of the pool. Format: locations/{location}/workforcePools/{workforce_pool_id}
    parent str
    Immutable. The resource name of the parent. Format: organizations/{org-id}.
    session_duration str
    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.
    state str
    The state of the pool.
    accessRestrictions Property Map
    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 String
    A user-specified description of the pool. Cannot exceed 256 characters.
    disabled Boolean
    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 String
    A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters.
    expireTime String
    Time after which the workforce pool will be permanently purged and cannot be recovered.
    name String
    The resource name of the pool. Format: locations/{location}/workforcePools/{workforce_pool_id}
    parent String
    Immutable. The resource name of the parent. Format: organizations/{org-id}.
    sessionDuration 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.
    state String
    The state of the pool.

    Supporting Types

    AccessRestrictionsResponse

    AllowedServices List<Pulumi.GoogleNative.IAM.V1.Inputs.ServiceConfigResponse>
    Optional. Immutable. Services allowed for web sign-in with the workforce pool. If not set by default there are no restrictions.
    DisableProgrammaticSignin bool
    Optional. Disable programmatic sign-in by disabling token issue via the Security Token API endpoint. See [Security Token Service API] (https://cloud.google.com/iam/docs/reference/sts/rest).
    AllowedServices []ServiceConfigResponse
    Optional. Immutable. Services allowed for web sign-in with the workforce pool. If not set by default there are no restrictions.
    DisableProgrammaticSignin bool
    Optional. Disable programmatic sign-in by disabling token issue via the Security Token API endpoint. See [Security Token Service API] (https://cloud.google.com/iam/docs/reference/sts/rest).
    allowedServices List<ServiceConfigResponse>
    Optional. Immutable. Services allowed for web sign-in with the workforce pool. If not set by default there are no restrictions.
    disableProgrammaticSignin Boolean
    Optional. Disable programmatic sign-in by disabling token issue via the Security Token API endpoint. See [Security Token Service API] (https://cloud.google.com/iam/docs/reference/sts/rest).
    allowedServices ServiceConfigResponse[]
    Optional. Immutable. Services allowed for web sign-in with the workforce pool. If not set by default there are no restrictions.
    disableProgrammaticSignin boolean
    Optional. Disable programmatic sign-in by disabling token issue via the Security Token API endpoint. See [Security Token Service API] (https://cloud.google.com/iam/docs/reference/sts/rest).
    allowed_services Sequence[ServiceConfigResponse]
    Optional. Immutable. Services allowed for web sign-in with the workforce pool. If not set by default there are no restrictions.
    disable_programmatic_signin bool
    Optional. Disable programmatic sign-in by disabling token issue via the Security Token API endpoint. See [Security Token Service API] (https://cloud.google.com/iam/docs/reference/sts/rest).
    allowedServices List<Property Map>
    Optional. Immutable. Services allowed for web sign-in with the workforce pool. If not set by default there are no restrictions.
    disableProgrammaticSignin Boolean
    Optional. Disable programmatic sign-in by disabling token issue via the Security Token API endpoint. See [Security Token Service API] (https://cloud.google.com/iam/docs/reference/sts/rest).

    ServiceConfigResponse

    Domain string
    Optional. Domain name of the service. Example: console.cloud.google
    Domain string
    Optional. Domain name of the service. Example: console.cloud.google
    domain String
    Optional. Domain name of the service. Example: console.cloud.google
    domain string
    Optional. Domain name of the service. Example: console.cloud.google
    domain str
    Optional. Domain name of the service. Example: console.cloud.google
    domain String
    Optional. Domain name of the service. Example: console.cloud.google

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native