Google Cloud v8.27.0, Apr 17 25

Google Cloud v8.27.0 published on Thursday, Apr 17, 2025 by Pulumi

gcp.apigateway.ApiIamPolicy

Explore with Pulumi AI

Google Cloud v8.27.0 published on Thursday, Apr 17, 2025 by Pulumi

pulumi/pulumi-gcp

gcp.apigateway.ApiIamPolicy: Authoritative. Sets the IAM policy for the api and replaces any existing policy already attached.
gcp.apigateway.ApiIamBinding: 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 api are preserved.
gcp.apigateway.ApiIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the api are preserved.

A data source can be used to retrieve policy data in advent you do not need creation

gcp.apigateway.ApiIamPolicy: Retrieves the IAM policy for the api

Note: gcp.apigateway.ApiIamPolicy cannot be used in conjunction with gcp.apigateway.ApiIamBinding and gcp.apigateway.ApiIamMember or they will fight over what your policy should be.

Note: gcp.apigateway.ApiIamBinding resources can be used in conjunction with gcp.apigateway.ApiIamMember resources only if they do not grant privilege to the same role.

google_api_gateway_api_iam_policy

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

const admin = gcp.organizations.getIAMPolicy({
    bindings: [{
        role: "roles/apigateway.viewer",
        members: ["user:jane@example.com"],
    }],
});
const policy = new gcp.apigateway.ApiIamPolicy("policy", {
    project: api.project,
    api: api.apiId,
    policyData: admin.then(admin => admin.policyData),
});

import pulumi
import pulumi_gcp as gcp

admin = gcp.organizations.get_iam_policy(bindings=[{
    "role": "roles/apigateway.viewer",
    "members": ["user:jane@example.com"],
}])
policy = gcp.apigateway.ApiIamPolicy("policy",
    project=api["project"],
    api=api["apiId"],
    policy_data=admin.policy_data)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		admin, err := organizations.LookupIAMPolicy(ctx, &organizations.LookupIAMPolicyArgs{
			Bindings: []organizations.GetIAMPolicyBinding{
				{
					Role: "roles/apigateway.viewer",
					Members: []string{
						"user:jane@example.com",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = apigateway.NewApiIamPolicy(ctx, "policy", &apigateway.ApiIamPolicyArgs{
			Project:    pulumi.Any(api.Project),
			Api:        pulumi.Any(api.ApiId),
			PolicyData: pulumi.String(admin.PolicyData),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var admin = Gcp.Organizations.GetIAMPolicy.Invoke(new()
    {
        Bindings = new[]
        {
            new Gcp.Organizations.Inputs.GetIAMPolicyBindingInputArgs
            {
                Role = "roles/apigateway.viewer",
                Members = new[]
                {
                    "user:jane@example.com",
                },
            },
        },
    });

    var policy = new Gcp.ApiGateway.ApiIamPolicy("policy", new()
    {
        Project = api.Project,
        Api = api.ApiId,
        PolicyData = admin.Apply(getIAMPolicyResult => getIAMPolicyResult.PolicyData),
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetIAMPolicyArgs;
import com.pulumi.gcp.apigateway.ApiIamPolicy;
import com.pulumi.gcp.apigateway.ApiIamPolicyArgs;
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 admin = OrganizationsFunctions.getIAMPolicy(GetIAMPolicyArgs.builder()
            .bindings(GetIAMPolicyBindingArgs.builder()
                .role("roles/apigateway.viewer")
                .members("user:jane@example.com")
                .build())
            .build());

        var policy = new ApiIamPolicy("policy", ApiIamPolicyArgs.builder()
            .project(api.project())
            .api(api.apiId())
            .policyData(admin.policyData())
            .build());

    }
}

resources:
  policy:
    type: gcp:apigateway:ApiIamPolicy
    properties:
      project: ${api.project}
      api: ${api.apiId}
      policyData: ${admin.policyData}
variables:
  admin:
    fn::invoke:
      function: gcp:organizations:getIAMPolicy
      arguments:
        bindings:
          - role: roles/apigateway.viewer
            members:
              - user:jane@example.com

gcp.apigateway.ApiIamBinding

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

const binding = new gcp.apigateway.ApiIamBinding("binding", {
    project: api.project,
    api: api.apiId,
    role: "roles/apigateway.viewer",
    members: ["user:jane@example.com"],
});

import pulumi
import pulumi_gcp as gcp

binding = gcp.apigateway.ApiIamBinding("binding",
    project=api["project"],
    api=api["apiId"],
    role="roles/apigateway.viewer",
    members=["user:jane@example.com"])

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigateway.NewApiIamBinding(ctx, "binding", &apigateway.ApiIamBindingArgs{
			Project: pulumi.Any(api.Project),
			Api:     pulumi.Any(api.ApiId),
			Role:    pulumi.String("roles/apigateway.viewer"),
			Members: pulumi.StringArray{
				pulumi.String("user:jane@example.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var binding = new Gcp.ApiGateway.ApiIamBinding("binding", new()
    {
        Project = api.Project,
        Api = api.ApiId,
        Role = "roles/apigateway.viewer",
        Members = new[]
        {
            "user:jane@example.com",
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.apigateway.ApiIamBinding;
import com.pulumi.gcp.apigateway.ApiIamBindingArgs;
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 binding = new ApiIamBinding("binding", ApiIamBindingArgs.builder()
            .project(api.project())
            .api(api.apiId())
            .role("roles/apigateway.viewer")
            .members("user:jane@example.com")
            .build());

    }
}

resources:
  binding:
    type: gcp:apigateway:ApiIamBinding
    properties:
      project: ${api.project}
      api: ${api.apiId}
      role: roles/apigateway.viewer
      members:
        - user:jane@example.com

gcp.apigateway.ApiIamMember

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

const member = new gcp.apigateway.ApiIamMember("member", {
    project: api.project,
    api: api.apiId,
    role: "roles/apigateway.viewer",
    member: "user:jane@example.com",
});

import pulumi
import pulumi_gcp as gcp

member = gcp.apigateway.ApiIamMember("member",
    project=api["project"],
    api=api["apiId"],
    role="roles/apigateway.viewer",
    member="user:jane@example.com")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigateway.NewApiIamMember(ctx, "member", &apigateway.ApiIamMemberArgs{
			Project: pulumi.Any(api.Project),
			Api:     pulumi.Any(api.ApiId),
			Role:    pulumi.String("roles/apigateway.viewer"),
			Member:  pulumi.String("user:jane@example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var member = new Gcp.ApiGateway.ApiIamMember("member", new()
    {
        Project = api.Project,
        Api = api.ApiId,
        Role = "roles/apigateway.viewer",
        Member = "user:jane@example.com",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.apigateway.ApiIamMember;
import com.pulumi.gcp.apigateway.ApiIamMemberArgs;
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 member = new ApiIamMember("member", ApiIamMemberArgs.builder()
            .project(api.project())
            .api(api.apiId())
            .role("roles/apigateway.viewer")
            .member("user:jane@example.com")
            .build());

    }
}

resources:
  member:
    type: gcp:apigateway:ApiIamMember
    properties:
      project: ${api.project}
      api: ${api.apiId}
      role: roles/apigateway.viewer
      member: user:jane@example.com

This resource supports User Project Overrides.

IAM policy for API Gateway Api

Three different resources help you manage your IAM policy for API Gateway Api. Each of these resources serves a different use case:

gcp.apigateway.ApiIamPolicy: Authoritative. Sets the IAM policy for the api and replaces any existing policy already attached.
gcp.apigateway.ApiIamBinding: 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 api are preserved.
gcp.apigateway.ApiIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the api are preserved.

A data source can be used to retrieve policy data in advent you do not need creation

gcp.apigateway.ApiIamPolicy: Retrieves the IAM policy for the api

Note: gcp.apigateway.ApiIamPolicy cannot be used in conjunction with gcp.apigateway.ApiIamBinding and gcp.apigateway.ApiIamMember or they will fight over what your policy should be.

Note: gcp.apigateway.ApiIamBinding resources can be used in conjunction with gcp.apigateway.ApiIamMember resources only if they do not grant privilege to the same role.

google_api_gateway_api_iam_policy

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

const admin = gcp.organizations.getIAMPolicy({
    bindings: [{
        role: "roles/apigateway.viewer",
        members: ["user:jane@example.com"],
    }],
});
const policy = new gcp.apigateway.ApiIamPolicy("policy", {
    project: api.project,
    api: api.apiId,
    policyData: admin.then(admin => admin.policyData),
});

import pulumi
import pulumi_gcp as gcp

admin = gcp.organizations.get_iam_policy(bindings=[{
    "role": "roles/apigateway.viewer",
    "members": ["user:jane@example.com"],
}])
policy = gcp.apigateway.ApiIamPolicy("policy",
    project=api["project"],
    api=api["apiId"],
    policy_data=admin.policy_data)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		admin, err := organizations.LookupIAMPolicy(ctx, &organizations.LookupIAMPolicyArgs{
			Bindings: []organizations.GetIAMPolicyBinding{
				{
					Role: "roles/apigateway.viewer",
					Members: []string{
						"user:jane@example.com",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = apigateway.NewApiIamPolicy(ctx, "policy", &apigateway.ApiIamPolicyArgs{
			Project:    pulumi.Any(api.Project),
			Api:        pulumi.Any(api.ApiId),
			PolicyData: pulumi.String(admin.PolicyData),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var admin = Gcp.Organizations.GetIAMPolicy.Invoke(new()
    {
        Bindings = new[]
        {
            new Gcp.Organizations.Inputs.GetIAMPolicyBindingInputArgs
            {
                Role = "roles/apigateway.viewer",
                Members = new[]
                {
                    "user:jane@example.com",
                },
            },
        },
    });

    var policy = new Gcp.ApiGateway.ApiIamPolicy("policy", new()
    {
        Project = api.Project,
        Api = api.ApiId,
        PolicyData = admin.Apply(getIAMPolicyResult => getIAMPolicyResult.PolicyData),
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetIAMPolicyArgs;
import com.pulumi.gcp.apigateway.ApiIamPolicy;
import com.pulumi.gcp.apigateway.ApiIamPolicyArgs;
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 admin = OrganizationsFunctions.getIAMPolicy(GetIAMPolicyArgs.builder()
            .bindings(GetIAMPolicyBindingArgs.builder()
                .role("roles/apigateway.viewer")
                .members("user:jane@example.com")
                .build())
            .build());

        var policy = new ApiIamPolicy("policy", ApiIamPolicyArgs.builder()
            .project(api.project())
            .api(api.apiId())
            .policyData(admin.policyData())
            .build());

    }
}

resources:
  policy:
    type: gcp:apigateway:ApiIamPolicy
    properties:
      project: ${api.project}
      api: ${api.apiId}
      policyData: ${admin.policyData}
variables:
  admin:
    fn::invoke:
      function: gcp:organizations:getIAMPolicy
      arguments:
        bindings:
          - role: roles/apigateway.viewer
            members:
              - user:jane@example.com

gcp.apigateway.ApiIamBinding

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

const binding = new gcp.apigateway.ApiIamBinding("binding", {
    project: api.project,
    api: api.apiId,
    role: "roles/apigateway.viewer",
    members: ["user:jane@example.com"],
});

import pulumi
import pulumi_gcp as gcp

binding = gcp.apigateway.ApiIamBinding("binding",
    project=api["project"],
    api=api["apiId"],
    role="roles/apigateway.viewer",
    members=["user:jane@example.com"])

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigateway.NewApiIamBinding(ctx, "binding", &apigateway.ApiIamBindingArgs{
			Project: pulumi.Any(api.Project),
			Api:     pulumi.Any(api.ApiId),
			Role:    pulumi.String("roles/apigateway.viewer"),
			Members: pulumi.StringArray{
				pulumi.String("user:jane@example.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var binding = new Gcp.ApiGateway.ApiIamBinding("binding", new()
    {
        Project = api.Project,
        Api = api.ApiId,
        Role = "roles/apigateway.viewer",
        Members = new[]
        {
            "user:jane@example.com",
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.apigateway.ApiIamBinding;
import com.pulumi.gcp.apigateway.ApiIamBindingArgs;
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 binding = new ApiIamBinding("binding", ApiIamBindingArgs.builder()
            .project(api.project())
            .api(api.apiId())
            .role("roles/apigateway.viewer")
            .members("user:jane@example.com")
            .build());

    }
}

resources:
  binding:
    type: gcp:apigateway:ApiIamBinding
    properties:
      project: ${api.project}
      api: ${api.apiId}
      role: roles/apigateway.viewer
      members:
        - user:jane@example.com

gcp.apigateway.ApiIamMember

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

const member = new gcp.apigateway.ApiIamMember("member", {
    project: api.project,
    api: api.apiId,
    role: "roles/apigateway.viewer",
    member: "user:jane@example.com",
});

import pulumi
import pulumi_gcp as gcp

member = gcp.apigateway.ApiIamMember("member",
    project=api["project"],
    api=api["apiId"],
    role="roles/apigateway.viewer",
    member="user:jane@example.com")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigateway.NewApiIamMember(ctx, "member", &apigateway.ApiIamMemberArgs{
			Project: pulumi.Any(api.Project),
			Api:     pulumi.Any(api.ApiId),
			Role:    pulumi.String("roles/apigateway.viewer"),
			Member:  pulumi.String("user:jane@example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var member = new Gcp.ApiGateway.ApiIamMember("member", new()
    {
        Project = api.Project,
        Api = api.ApiId,
        Role = "roles/apigateway.viewer",
        Member = "user:jane@example.com",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.apigateway.ApiIamMember;
import com.pulumi.gcp.apigateway.ApiIamMemberArgs;
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 member = new ApiIamMember("member", ApiIamMemberArgs.builder()
            .project(api.project())
            .api(api.apiId())
            .role("roles/apigateway.viewer")
            .member("user:jane@example.com")
            .build());

    }
}

resources:
  member:
    type: gcp:apigateway:ApiIamMember
    properties:
      project: ${api.project}
      api: ${api.apiId}
      role: roles/apigateway.viewer
      member: user:jane@example.com

Create ApiIamPolicy Resource

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

Constructor syntax

new ApiIamPolicy(name: string, args: ApiIamPolicyArgs, opts?: CustomResourceOptions);

@overload
def ApiIamPolicy(resource_name: str,
                 args: ApiIamPolicyArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def ApiIamPolicy(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 api: Optional[str] = None,
                 policy_data: Optional[str] = None,
                 project: Optional[str] = None)

func NewApiIamPolicy(ctx *Context, name string, args ApiIamPolicyArgs, opts ...ResourceOption) (*ApiIamPolicy, error)

public ApiIamPolicy(string name, ApiIamPolicyArgs args, CustomResourceOptions? opts = null)

public ApiIamPolicy(String name, ApiIamPolicyArgs args)
public ApiIamPolicy(String name, ApiIamPolicyArgs args, CustomResourceOptions options)

type: gcp:apigateway:ApiIamPolicy
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 ApiIamPolicyArgs: 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 ApiIamPolicyArgs: 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 ApiIamPolicyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ApiIamPolicyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ApiIamPolicyArgs: 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 apiIamPolicyResource = new Gcp.ApiGateway.ApiIamPolicy("apiIamPolicyResource", new()
{
    Api = "string",
    PolicyData = "string",
    Project = "string",
});

example, err := apigateway.NewApiIamPolicy(ctx, "apiIamPolicyResource", &apigateway.ApiIamPolicyArgs{
	Api:        pulumi.String("string"),
	PolicyData: pulumi.String("string"),
	Project:    pulumi.String("string"),
})

var apiIamPolicyResource = new ApiIamPolicy("apiIamPolicyResource", ApiIamPolicyArgs.builder()
    .api("string")
    .policyData("string")
    .project("string")
    .build());

api_iam_policy_resource = gcp.apigateway.ApiIamPolicy("apiIamPolicyResource",
    api="string",
    policy_data="string",
    project="string")

const apiIamPolicyResource = new gcp.apigateway.ApiIamPolicy("apiIamPolicyResource", {
    api: "string",
    policyData: "string",
    project: "string",
});

type: gcp:apigateway:ApiIamPolicy
properties:
    api: string
    policyData: string
    project: string

ApiIamPolicy 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 ApiIamPolicy resource accepts the following input properties:

Api string
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.

Api string
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.

api String
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.

api string
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.

api str
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.

api String
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.

Outputs

All input properties are implicitly available as output properties. Additionally, the ApiIamPolicy 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 ApiIamPolicy Resource

Get an existing ApiIamPolicy 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?: ApiIamPolicyState, opts?: CustomResourceOptions): ApiIamPolicy

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api: Optional[str] = None,
        etag: Optional[str] = None,
        policy_data: Optional[str] = None,
        project: Optional[str] = None) -> ApiIamPolicy

func GetApiIamPolicy(ctx *Context, name string, id IDInput, state *ApiIamPolicyState, opts ...ResourceOption) (*ApiIamPolicy, error)

public static ApiIamPolicy Get(string name, Input<string> id, ApiIamPolicyState? state, CustomResourceOptions? opts = null)

public static ApiIamPolicy get(String name, Output<String> id, ApiIamPolicyState state, CustomResourceOptions options)

resources:  _:    type: gcp:apigateway:ApiIamPolicy    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:

Api string
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.

Api string
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.

api String
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.

api string
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.

api str
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.

api String
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.

Import

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

projects/{{project}}/locations/global/apis/{{api}}
{{project}}/{{api}}
{{api}}

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

API Gateway api 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:apigateway/apiIamPolicy:ApiIamPolicy editor "projects/{{project}}/locations/global/apis/{{api}} roles/apigateway.viewer user:jane@example.com"

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

$ pulumi import gcp:apigateway/apiIamPolicy:ApiIamPolicy editor "projects/{{project}}/locations/global/apis/{{api}} roles/apigateway.viewer"

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

$ pulumi import gcp:apigateway/apiIamPolicy:ApiIamPolicy editor projects/{{project}}/locations/global/apis/{{api}}

-> 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.

To learn more about importing existing cloud resources, see Importing resources.

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.27.0 published on Thursday, Apr 17, 2025 by Pulumi

pulumi/pulumi-gcp

gcp.apigateway.ApiIamPolicy

On this page

On this page

google_api_gateway_api_iam_policy

gcp.apigateway.ApiIamBinding

gcp.apigateway.ApiIamMember

This resource supports User Project Overrides.

IAM policy for API Gateway Api

google_api_gateway_api_iam_policy

gcp.apigateway.ApiIamBinding

gcp.apigateway.ApiIamMember

Create ApiIamPolicy Resource

Constructor syntax

Parameters

Constructor example

ApiIamPolicy Resource Properties

Inputs

Outputs

Look up Existing ApiIamPolicy Resource

Import

Package Details

On this page

On this page