Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. iam
  5. WorkloadIdentityPoolIamPolicy
Google Cloud v8.32.1 published on Thursday, May 22, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.iam.WorkloadIdentityPoolIamPolicy

Explore with Pulumi AI

gcp logo
Google Cloud v8.32.1 published on Thursday, May 22, 2025 by Pulumi
pulumi/pulumi-gcp

    Import

    For all import syntaxes, the “resource in question” can take any of the following forms:

    • projects/{{project}}/locations/global/workloadIdentityPools/{{workload_identity_pool_id}}

    • {{project}}/{{workload_identity_pool_id}}

    • {{workload_identity_pool_id}}

    Any variables not passed in the import command will be taken from the provider configuration.

    Cloud IAM workloadidentitypool 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.

    $ pulumi import gcp:iam/workloadIdentityPoolIamPolicy:WorkloadIdentityPoolIamPolicy editor "projects/{{project}}/locations/global/workloadIdentityPools/{{workload_identity_pool_id}} roles/iam.workloadIdentityPoolViewer user:jane@example.com"

    IAM binding imports use space-delimited identifiers: the resource in question and the role, e.g.

    $ pulumi import gcp:iam/workloadIdentityPoolIamPolicy:WorkloadIdentityPoolIamPolicy editor "projects/{{project}}/locations/global/workloadIdentityPools/{{workload_identity_pool_id}} roles/iam.workloadIdentityPoolViewer"

    IAM policy imports use the identifier of the resource in question, e.g.

    $ pulumi import gcp:iam/workloadIdentityPoolIamPolicy:WorkloadIdentityPoolIamPolicy editor projects/{{project}}/locations/global/workloadIdentityPools/{{workload_identity_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.

    Create WorkloadIdentityPoolIamPolicy Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new WorkloadIdentityPoolIamPolicy(name: string, args: WorkloadIdentityPoolIamPolicyArgs, opts?: CustomResourceOptions);
    @overload
def WorkloadIdentityPoolIamPolicy(resource_name: str,
                                  args: WorkloadIdentityPoolIamPolicyArgs,
                                  opts: Optional[ResourceOptions] = None)

@overload
def WorkloadIdentityPoolIamPolicy(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  policy_data: Optional[str] = None,
                                  workload_identity_pool_id: Optional[str] = None,
                                  project: Optional[str] = None)
    func NewWorkloadIdentityPoolIamPolicy(ctx *Context, name string, args WorkloadIdentityPoolIamPolicyArgs, opts ...ResourceOption) (*WorkloadIdentityPoolIamPolicy, error)
    public WorkloadIdentityPoolIamPolicy(string name, WorkloadIdentityPoolIamPolicyArgs args, CustomResourceOptions? opts = null)
    public WorkloadIdentityPoolIamPolicy(String name, WorkloadIdentityPoolIamPolicyArgs args)
public WorkloadIdentityPoolIamPolicy(String name, WorkloadIdentityPoolIamPolicyArgs args, CustomResourceOptions options)

    type: gcp:iam:WorkloadIdentityPoolIamPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args WorkloadIdentityPoolIamPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args WorkloadIdentityPoolIamPolicyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args WorkloadIdentityPoolIamPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkloadIdentityPoolIamPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkloadIdentityPoolIamPolicyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var workloadIdentityPoolIamPolicyResource = new Gcp.Iam.WorkloadIdentityPoolIamPolicy("workloadIdentityPoolIamPolicyResource", new()
{
    PolicyData = "string",
    WorkloadIdentityPoolId = "string",
    Project = "string",
});

    example, err := iam.NewWorkloadIdentityPoolIamPolicy(ctx, "workloadIdentityPoolIamPolicyResource", &iam.WorkloadIdentityPoolIamPolicyArgs{
	PolicyData:             pulumi.String("string"),
	WorkloadIdentityPoolId: pulumi.String("string"),
	Project:                pulumi.String("string"),
})

    var workloadIdentityPoolIamPolicyResource = new WorkloadIdentityPoolIamPolicy("workloadIdentityPoolIamPolicyResource", WorkloadIdentityPoolIamPolicyArgs.builder()
    .policyData("string")
    .workloadIdentityPoolId("string")
    .project("string")
    .build());

    workload_identity_pool_iam_policy_resource = gcp.iam.WorkloadIdentityPoolIamPolicy("workloadIdentityPoolIamPolicyResource",
    policy_data="string",
    workload_identity_pool_id="string",
    project="string")

    const workloadIdentityPoolIamPolicyResource = new gcp.iam.WorkloadIdentityPoolIamPolicy("workloadIdentityPoolIamPolicyResource", {
    policyData: "string",
    workloadIdentityPoolId: "string",
    project: "string",
});

    type: gcp:iam:WorkloadIdentityPoolIamPolicy
properties:
    policyData: string
    project: string
    workloadIdentityPoolId: string

    WorkloadIdentityPoolIamPolicy Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The WorkloadIdentityPoolIamPolicy resource accepts the following input properties:

    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    WorkloadIdentityPoolId string
    Used to find the parent resource to bind the IAM policy to
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    WorkloadIdentityPoolId string
    Used to find the parent resource to bind the IAM policy to
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    workloadIdentityPoolId String
    Used to find the parent resource to bind the IAM policy to
    project String
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    policyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    workloadIdentityPoolId string
    Used to find the parent resource to bind the IAM policy to
    project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    policy_data str
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    workload_identity_pool_id str
    Used to find the parent resource to bind the IAM policy to
    project str
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    workloadIdentityPoolId String
    Used to find the parent resource to bind the IAM policy to
    project String
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WorkloadIdentityPoolIamPolicy resource produces the following output properties:

    Etag string
    (Computed) The etag of the IAM policy.
    Id string
    The provider-assigned unique ID for this managed resource.
    Etag string
    (Computed) The etag of the IAM policy.
    Id string
    The provider-assigned unique ID for this managed resource.
    etag String
    (Computed) The etag of the IAM policy.
    id String
    The provider-assigned unique ID for this managed resource.
    etag string
    (Computed) The etag of the IAM policy.
    id string
    The provider-assigned unique ID for this managed resource.
    etag str
    (Computed) The etag of the IAM policy.
    id str
    The provider-assigned unique ID for this managed resource.
    etag String
    (Computed) The etag of the IAM policy.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing WorkloadIdentityPoolIamPolicy Resource

    Get an existing WorkloadIdentityPoolIamPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: WorkloadIdentityPoolIamPolicyState, opts?: CustomResourceOptions): WorkloadIdentityPoolIamPolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        etag: Optional[str] = None,
        policy_data: Optional[str] = None,
        project: Optional[str] = None,
        workload_identity_pool_id: Optional[str] = None) -> WorkloadIdentityPoolIamPolicy
    func GetWorkloadIdentityPoolIamPolicy(ctx *Context, name string, id IDInput, state *WorkloadIdentityPoolIamPolicyState, opts ...ResourceOption) (*WorkloadIdentityPoolIamPolicy, error)
    public static WorkloadIdentityPoolIamPolicy Get(string name, Input<string> id, WorkloadIdentityPoolIamPolicyState? state, CustomResourceOptions? opts = null)
    public static WorkloadIdentityPoolIamPolicy get(String name, Output<String> id, WorkloadIdentityPoolIamPolicyState state, CustomResourceOptions options)
    resources:  _:    type: gcp:iam:WorkloadIdentityPoolIamPolicy    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Etag string
    (Computed) The etag of the IAM policy.
    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    WorkloadIdentityPoolId string
    Used to find the parent resource to bind the IAM policy to
    Etag string
    (Computed) The etag of the IAM policy.
    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    WorkloadIdentityPoolId string
    Used to find the parent resource to bind the IAM policy to
    etag String
    (Computed) The etag of the IAM policy.
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    workloadIdentityPoolId String
    Used to find the parent resource to bind the IAM policy to
    etag string
    (Computed) The etag of the IAM policy.
    policyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    workloadIdentityPoolId string
    Used to find the parent resource to bind the IAM policy to
    etag str
    (Computed) The etag of the IAM policy.
    policy_data str
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    workload_identity_pool_id str
    Used to find the parent resource to bind the IAM policy to
    etag String
    (Computed) The etag of the IAM policy.
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    workloadIdentityPoolId String
    Used to find the parent resource to bind the IAM policy to

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud v8.32.1 published on Thursday, May 22, 2025 by Pulumi
    pulumi/pulumi-gcp