pulumi-gcp-kotlin/com.pulumi.gcp.iam.kotlin/WorkforcePool

WorkforcePool

class WorkforcePool : KotlinCustomResource

Represents a collection of external workforces. Provides namespaces for federated users that can be referenced in IAM policies. To get more information about WorkforcePool, see:

API documentation
How-to Guides

Manage pools

Note: Ask your Google Cloud account team to request access to workforce identity federation for your billing/quota project. The account team notifies you when the project is granted access.

Example Usage

Iam Workforce Pool Basic

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.iam.WorkforcePool;
import com.pulumi.gcp.iam.WorkforcePoolArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new WorkforcePool("example", WorkforcePoolArgs.builder()
            .location("global")
            .parent("organizations/123456789")
            .workforcePoolId("example-pool")
            .build());
    }
}

Iam Workforce Pool Full

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.iam.WorkforcePool;
import com.pulumi.gcp.iam.WorkforcePoolArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new WorkforcePool("example", WorkforcePoolArgs.builder()
            .description("A sample workforce pool.")
            .disabled(false)
            .displayName("Display name")
            .location("global")
            .parent("organizations/123456789")
            .sessionDuration("7200s")
            .workforcePoolId("example-pool")
            .build());
    }
}

Import

WorkforcePool can be imported using any of these accepted formats

$ pulumi import gcp:iam/workforcePool:WorkforcePool default locations/{{location}}/workforcePools/{{workforce_pool_id}}

$ pulumi import gcp:iam/workforcePool:WorkforcePool default {{location}}/{{workforce_pool_id}}

Properties

description

val description: Output<String>?

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

disabled

val disabled: Output<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

val displayName: Output<String>?

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

val id: Output<String>

location

val location: Output<String>

The location for the resource.

name

val name: Output<String>

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

parent

val parent: Output<String>

Immutable. The resource name of the parent. Format: organizations/{org-id}.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

sessionDuration

val sessionDuration: Output<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".

state

val state: Output<String>

Output only. The state of the pool.

urn

val urn: Output<String>

workforcePoolId

val workforcePoolId: Output<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.