import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * 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](https://cloud.google.com/iam/docs/reference/rest/v1/locations.workforcePools) * * How-to Guides * * [Manage pools](https://cloud.google.com/iam/docs/manage-workforce-identity-pools-providers#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 * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const example = new gcp.iam.WorkforcePool("example", { * workforcePoolId: "example-pool", * parent: "organizations/123456789", * location: "global", * }); * ``` * ### Iam Workforce Pool Full * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const example = new gcp.iam.WorkforcePool("example", { * workforcePoolId: "example-pool", * parent: "organizations/123456789", * location: "global", * displayName: "Display name", * description: "A sample workforce pool.", * disabled: false, * sessionDuration: "7200s", * accessRestrictions: { * allowedServices: [{ * domain: "backstory.chronicle.security", * }], * disableProgrammaticSignin: false, * }, * }); * ``` * * ## Import * * WorkforcePool can be imported using any of these accepted formats: * * * `locations/{{location}}/workforcePools/{{workforce_pool_id}}` * * `{{location}}/{{workforce_pool_id}}` * * When using the `pulumi import` command, WorkforcePool can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:iam/workforcePool:WorkforcePool default locations/{{location}}/workforcePools/{{workforce_pool_id}} * $ pulumi import gcp:iam/workforcePool:WorkforcePool default {{location}}/{{workforce_pool_id}} * ``` */ export declare class WorkforcePool extends pulumi.CustomResource { /** * Get an existing WorkforcePool resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: WorkforcePoolState, opts?: pulumi.CustomResourceOptions): WorkforcePool; /** * Returns true if the given object is an instance of WorkforcePool. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is WorkforcePool; /** * 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. */ readonly accessRestrictions: pulumi.Output; /** * 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. */ readonly deletionPolicy: pulumi.Output; /** * A user-specified description of the pool. Cannot exceed 256 characters. */ readonly description: pulumi.Output; /** * 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. */ readonly disabled: pulumi.Output; /** * A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters. */ readonly displayName: pulumi.Output; /** * The location for the resource. */ readonly location: pulumi.Output; /** * Output only. The resource name of the pool. * Format: `locations/{location}/workforcePools/{workforcePoolId}` */ readonly name: pulumi.Output; /** * Immutable. The resource name of the parent. Format: `organizations/{org-id}`. */ readonly parent: pulumi.Output; /** * 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`". */ readonly sessionDuration: pulumi.Output; /** * Output only. The state of the pool. * * STATE_UNSPECIFIED: State unspecified. * * ACTIVE: The pool is active, and may be used in Google Cloud policies. * * DELETED: The pool is soft-deleted. Soft-deleted pools are permanently deleted * after approximately 30 days. You can restore a soft-deleted pool using * [workforcePools.undelete](https://cloud.google.com/iam/docs/reference/rest/v1/locations.workforcePools/undelete#google.iam.admin.v1.WorkforcePools.UndeleteWorkforcePool). * You cannot reuse the ID of a soft-deleted pool until it is permanently deleted. * While a pool is deleted, you cannot use it to exchange tokens, or use * existing tokens to access resources. If the pool is undeleted, existing * tokens grant access again. */ readonly state: pulumi.Output; /** * 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. */ readonly workforcePoolId: pulumi.Output; /** * Create a WorkforcePool resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: WorkforcePoolArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering WorkforcePool resources. */ export interface WorkforcePoolState { /** * 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. */ accessRestrictions?: pulumi.Input; /** * 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. */ deletionPolicy?: pulumi.Input; /** * A user-specified description of the pool. Cannot exceed 256 characters. */ description?: pulumi.Input; /** * 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. */ disabled?: pulumi.Input; /** * A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters. */ displayName?: pulumi.Input; /** * The location for the resource. */ location?: pulumi.Input; /** * Output only. The resource name of the pool. * Format: `locations/{location}/workforcePools/{workforcePoolId}` */ name?: pulumi.Input; /** * Immutable. The resource name of the parent. Format: `organizations/{org-id}`. */ parent?: pulumi.Input; /** * 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`". */ sessionDuration?: pulumi.Input; /** * Output only. The state of the pool. * * STATE_UNSPECIFIED: State unspecified. * * ACTIVE: The pool is active, and may be used in Google Cloud policies. * * DELETED: The pool is soft-deleted. Soft-deleted pools are permanently deleted * after approximately 30 days. You can restore a soft-deleted pool using * [workforcePools.undelete](https://cloud.google.com/iam/docs/reference/rest/v1/locations.workforcePools/undelete#google.iam.admin.v1.WorkforcePools.UndeleteWorkforcePool). * You cannot reuse the ID of a soft-deleted pool until it is permanently deleted. * While a pool is deleted, you cannot use it to exchange tokens, or use * existing tokens to access resources. If the pool is undeleted, existing * tokens grant access again. */ state?: pulumi.Input; /** * 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. */ workforcePoolId?: pulumi.Input; } /** * The set of arguments for constructing a WorkforcePool resource. */ export interface WorkforcePoolArgs { /** * 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. */ accessRestrictions?: pulumi.Input; /** * 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. */ deletionPolicy?: pulumi.Input; /** * A user-specified description of the pool. Cannot exceed 256 characters. */ description?: pulumi.Input; /** * 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. */ disabled?: pulumi.Input; /** * A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters. */ displayName?: pulumi.Input; /** * The location for the resource. */ location: pulumi.Input; /** * Immutable. The resource name of the parent. Format: `organizations/{org-id}`. */ parent: pulumi.Input; /** * 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`". */ sessionDuration?: pulumi.Input; /** * 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. */ workforcePoolId: pulumi.Input; } //# sourceMappingURL=workforcePool.d.ts.map