1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. folder
  5. getIamPolicy
Google Cloud v8.25.1 published on Wednesday, Apr 9, 2025 by Pulumi

gcp.folder.getIamPolicy

Explore with Pulumi AI

Google Cloud v8.25.1 published on Wednesday, Apr 9, 2025 by Pulumi

Retrieves the current IAM policy data for a folder.

example

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const test = gcp.folder.getIamPolicy({
    folder: permissiontest.name,
});
Copy
import pulumi
import pulumi_gcp as gcp

test = gcp.folder.get_iam_policy(folder=permissiontest["name"])
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/folder"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := folder.GetIamPolicy(ctx, &folder.GetIamPolicyArgs{
			Folder: permissiontest.Name,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var test = Gcp.Folder.GetIamPolicy.Invoke(new()
    {
        Folder = permissiontest.Name,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.folder.FolderFunctions;
import com.pulumi.gcp.folder.inputs.GetIamPolicyArgs;
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) {
        final var test = FolderFunctions.getIamPolicy(GetIamPolicyArgs.builder()
            .folder(permissiontest.name())
            .build());

    }
}
Copy
variables:
  test:
    fn::invoke:
      function: gcp:folder:getIamPolicy
      arguments:
        folder: ${permissiontest.name}
Copy

Using getIamPolicy

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 getIamPolicy(args: GetIamPolicyArgs, opts?: InvokeOptions): Promise<GetIamPolicyResult>
function getIamPolicyOutput(args: GetIamPolicyOutputArgs, opts?: InvokeOptions): Output<GetIamPolicyResult>
Copy
def get_iam_policy(folder: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetIamPolicyResult
def get_iam_policy_output(folder: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetIamPolicyResult]
Copy
func GetIamPolicy(ctx *Context, args *GetIamPolicyArgs, opts ...InvokeOption) (*GetIamPolicyResult, error)
func GetIamPolicyOutput(ctx *Context, args *GetIamPolicyOutputArgs, opts ...InvokeOption) GetIamPolicyResultOutput
Copy

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

public static class GetIamPolicy 
{
    public static Task<GetIamPolicyResult> InvokeAsync(GetIamPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetIamPolicyResult> Invoke(GetIamPolicyInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetIamPolicyResult> getIamPolicy(GetIamPolicyArgs args, InvokeOptions options)
public static Output<GetIamPolicyResult> getIamPolicy(GetIamPolicyArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: gcp:folder/getIamPolicy:getIamPolicy
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Folder
This property is required.
Changes to this property will trigger replacement.
string
The resource name of the folder the policy is attached to. Its format is folders/{folder_id}.
Folder
This property is required.
Changes to this property will trigger replacement.
string
The resource name of the folder the policy is attached to. Its format is folders/{folder_id}.
folder
This property is required.
Changes to this property will trigger replacement.
String
The resource name of the folder the policy is attached to. Its format is folders/{folder_id}.
folder
This property is required.
Changes to this property will trigger replacement.
string
The resource name of the folder the policy is attached to. Its format is folders/{folder_id}.
folder
This property is required.
Changes to this property will trigger replacement.
str
The resource name of the folder the policy is attached to. Its format is folders/{folder_id}.
folder
This property is required.
Changes to this property will trigger replacement.
String
The resource name of the folder the policy is attached to. Its format is folders/{folder_id}.

getIamPolicy Result

The following output properties are available:

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

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.
Google Cloud v8.25.1 published on Wednesday, Apr 9, 2025 by Pulumi