import * as pulumi from "@pulumi/pulumi"; /** * Three different resources help you manage your IAM policy for Cloud IAM WorkforcePool. Each of these resources serves a different use case: * * * `gcp.iam.WorkforcePoolIamPolicy`: Authoritative. Sets the IAM policy for the workforcepool and replaces any existing policy already attached. * * `gcp.iam.WorkforcePoolIamBinding`: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the workforcepool are preserved. * * `gcp.iam.WorkforcePoolIamMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the workforcepool are preserved. * * A data source can be used to retrieve policy data in advent you do not need creation * * * `gcp.iam.WorkforcePoolIamPolicy`: Retrieves the IAM policy for the workforcepool * * > **Note:** `gcp.iam.WorkforcePoolIamPolicy` **cannot** be used in conjunction with `gcp.iam.WorkforcePoolIamBinding` and `gcp.iam.WorkforcePoolIamMember` or they will fight over what your policy should be. * * > **Note:** `gcp.iam.WorkforcePoolIamBinding` resources **can be** used in conjunction with `gcp.iam.WorkforcePoolIamMember` resources **only if** they do not grant privilege to the same role. * * ## gcp.iam.WorkforcePoolIamPolicy * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const admin = gcp.organizations.getIAMPolicy({ * bindings: [{ * role: "roles/iam.workforcePoolAdmin", * members: ["user:jane@example.com"], * }], * }); * const policy = new gcp.iam.WorkforcePoolIamPolicy("policy", { * location: example.location, * workforcePoolId: example.workforcePoolId, * policyData: admin.then(admin => admin.policyData), * }); * ``` * * ## gcp.iam.WorkforcePoolIamBinding * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const binding = new gcp.iam.WorkforcePoolIamBinding("binding", { * location: example.location, * workforcePoolId: example.workforcePoolId, * role: "roles/iam.workforcePoolAdmin", * members: ["user:jane@example.com"], * }); * ``` * * ## gcp.iam.WorkforcePoolIamMember * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const member = new gcp.iam.WorkforcePoolIamMember("member", { * location: example.location, * workforcePoolId: example.workforcePoolId, * role: "roles/iam.workforcePoolAdmin", * member: "user:jane@example.com", * }); * ``` * * ## > **Custom Roles** If you're importing a IAM resource with a custom role, make sure to use the * * full name of the custom role, e.g. `[projects/my-project|organizations/my-org]/roles/my-custom-role`. * --- * * # IAM policy for Cloud IAM WorkforcePool * * Three different resources help you manage your IAM policy for Cloud IAM WorkforcePool. Each of these resources serves a different use case: * * * `gcp.iam.WorkforcePoolIamPolicy`: Authoritative. Sets the IAM policy for the workforcepool and replaces any existing policy already attached. * * `gcp.iam.WorkforcePoolIamBinding`: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the workforcepool are preserved. * * `gcp.iam.WorkforcePoolIamMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the workforcepool are preserved. * * A data source can be used to retrieve policy data in advent you do not need creation * * * `gcp.iam.WorkforcePoolIamPolicy`: Retrieves the IAM policy for the workforcepool * * > **Note:** `gcp.iam.WorkforcePoolIamPolicy` **cannot** be used in conjunction with `gcp.iam.WorkforcePoolIamBinding` and `gcp.iam.WorkforcePoolIamMember` or they will fight over what your policy should be. * * > **Note:** `gcp.iam.WorkforcePoolIamBinding` resources **can be** used in conjunction with `gcp.iam.WorkforcePoolIamMember` resources **only if** they do not grant privilege to the same role. * * ## gcp.iam.WorkforcePoolIamPolicy * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const admin = gcp.organizations.getIAMPolicy({ * bindings: [{ * role: "roles/iam.workforcePoolAdmin", * members: ["user:jane@example.com"], * }], * }); * const policy = new gcp.iam.WorkforcePoolIamPolicy("policy", { * location: example.location, * workforcePoolId: example.workforcePoolId, * policyData: admin.then(admin => admin.policyData), * }); * ``` * * ## gcp.iam.WorkforcePoolIamBinding * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const binding = new gcp.iam.WorkforcePoolIamBinding("binding", { * location: example.location, * workforcePoolId: example.workforcePoolId, * role: "roles/iam.workforcePoolAdmin", * members: ["user:jane@example.com"], * }); * ``` * * ## gcp.iam.WorkforcePoolIamMember * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const member = new gcp.iam.WorkforcePoolIamMember("member", { * location: example.location, * workforcePoolId: example.workforcePoolId, * role: "roles/iam.workforcePoolAdmin", * member: "user:jane@example.com", * }); * ``` * * ## Import * * For all import syntaxes, the "resource in question" can take any of the following forms: * * * locations/{{location}}/workforcePools/{{workforce_pool_id}} * * {{location}}/{{workforce_pool_id}} * * {{workforce_pool_id}} * * Any variables not passed in the import command will be taken from the provider configuration. * * Cloud IAM workforcepool IAM resources can be imported using the resource identifiers, role, and member. * * IAM member imports use space-delimited identifiers: the resource in question, the role, and the member identity, e.g. * ```sh * $ terraform import google_iam_workforce_pool_iam_member.editor "locations/{{location}}/workforcePools/{{workforce_pool_id}} roles/iam.workforcePoolViewer user:jane@example.com" * ``` * * IAM binding imports use space-delimited identifiers: the resource in question and the role, e.g. * ```sh * $ terraform import google_iam_workforce_pool_iam_binding.editor "locations/{{location}}/workforcePools/{{workforce_pool_id}} roles/iam.workforcePoolViewer" * ``` * * IAM policy imports use the identifier of the resource in question, e.g. * ```sh * $ pulumi import gcp:iam/workforcePoolIamPolicy:WorkforcePoolIamPolicy editor locations/{{location}}/workforcePools/{{workforce_pool_id}} * ``` * * > **Custom Roles** If you're importing a IAM resource with a custom role, make sure to use the * full name of the custom role, e.g. `[projects/my-project|organizations/my-org]/roles/my-custom-role`. */ export declare class WorkforcePoolIamPolicy extends pulumi.CustomResource { /** * Get an existing WorkforcePoolIamPolicy 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?: WorkforcePoolIamPolicyState, opts?: pulumi.CustomResourceOptions): WorkforcePoolIamPolicy; /** * Returns true if the given object is an instance of WorkforcePoolIamPolicy. 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 WorkforcePoolIamPolicy; /** * (Computed) The etag of the IAM policy. */ readonly etag: pulumi.Output; /** * The location for the resource. Used to find the parent resource to bind the IAM policy to. If not specified, * the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no * location is specified, it is taken from the provider configuration. */ readonly location: pulumi.Output; /** * The policy data generated by * a `gcp.organizations.getIAMPolicy` data source. */ readonly policyData: pulumi.Output; /** * Used to find the parent resource to bind the IAM policy to */ readonly workforcePoolId: pulumi.Output; /** * Create a WorkforcePoolIamPolicy 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: WorkforcePoolIamPolicyArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering WorkforcePoolIamPolicy resources. */ export interface WorkforcePoolIamPolicyState { /** * (Computed) The etag of the IAM policy. */ etag?: pulumi.Input; /** * The location for the resource. Used to find the parent resource to bind the IAM policy to. If not specified, * the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no * location is specified, it is taken from the provider configuration. */ location?: pulumi.Input; /** * The policy data generated by * a `gcp.organizations.getIAMPolicy` data source. */ policyData?: pulumi.Input; /** * Used to find the parent resource to bind the IAM policy to */ workforcePoolId?: pulumi.Input; } /** * The set of arguments for constructing a WorkforcePoolIamPolicy resource. */ export interface WorkforcePoolIamPolicyArgs { /** * The location for the resource. Used to find the parent resource to bind the IAM policy to. If not specified, * the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no * location is specified, it is taken from the provider configuration. */ location?: pulumi.Input; /** * The policy data generated by * a `gcp.organizations.getIAMPolicy` data source. */ policyData: pulumi.Input; /** * Used to find the parent resource to bind the IAM policy to */ workforcePoolId: pulumi.Input; } //# sourceMappingURL=workforcePoolIamPolicy.d.ts.map