1. Pulumi Registry
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. apigateway
  5. ApiIamBinding
gcp logo
Google Cloud Classic v6.52.0, Mar 22 23

gcp.apigateway.ApiIamBinding

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.

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: google_api_gateway_api.api.project,
    api: google_api_gateway_api.api.api_id,
    policyData: admin.then(admin => admin.policyData),
}, {
    provider: google_beta,
});

import pulumi
import pulumi_gcp as gcp

admin = gcp.organizations.get_iam_policy(bindings=[gcp.organizations.GetIAMPolicyBindingArgs(
    role="roles/apigateway.viewer",
    members=["user:jane@example.com"],
)])
policy = gcp.apigateway.ApiIamPolicy("policy",
    project=google_api_gateway_api["api"]["project"],
    api=google_api_gateway_api["api"]["api_id"],
    policy_data=admin.policy_data,
    opts=pulumi.ResourceOptions(provider=google_beta))

using System.Collections.Generic;
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 = google_api_gateway_api.Api.Project,
        Api = google_api_gateway_api.Api.Api_id,
        PolicyData = admin.Apply(getIAMPolicyResult => getIAMPolicyResult.PolicyData),
    }, new CustomResourceOptions
    {
        Provider = google_beta,
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/apigateway"
	"github.com/pulumi/pulumi-gcp/sdk/v6/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(google_api_gateway_api.Api.Project),
			Api:        pulumi.Any(google_api_gateway_api.Api.Api_id),
			PolicyData: *pulumi.String(admin.PolicyData),
		}, pulumi.Provider(google_beta))
		if err != nil {
			return err
		}
		return nil
	})
}

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 com.pulumi.resources.CustomResourceOptions;
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(google_api_gateway_api.api().project())
            .api(google_api_gateway_api.api().api_id())
            .policyData(admin.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
            .build(), CustomResourceOptions.builder()
                .provider(google_beta)
                .build());

    }
}

resources:
  policy:
    type: gcp:apigateway:ApiIamPolicy
    properties:
      project: ${google_api_gateway_api.api.project}
      api: ${google_api_gateway_api.api.api_id}
      policyData: ${admin.policyData}
    options:
      provider: ${["google-beta"]}
variables:
  admin:
    fn::invoke:
      Function: gcp:organizations:getIAMPolicy
      Arguments:
        bindings:
          - role: roles/apigateway.viewer
            members:
              - user:jane@example.com

google_api_gateway_api_iam_binding

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

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

import pulumi
import pulumi_gcp as gcp

binding = gcp.apigateway.ApiIamBinding("binding",
    project=google_api_gateway_api["api"]["project"],
    api=google_api_gateway_api["api"]["api_id"],
    role="roles/apigateway.viewer",
    members=["user:jane@example.com"],
    opts=pulumi.ResourceOptions(provider=google_beta))

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

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

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/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(google_api_gateway_api.Api.Project),
			Api:     pulumi.Any(google_api_gateway_api.Api.Api_id),
			Role:    pulumi.String("roles/apigateway.viewer"),
			Members: pulumi.StringArray{
				pulumi.String("user:jane@example.com"),
			},
		}, pulumi.Provider(google_beta))
		if err != nil {
			return err
		}
		return nil
	})
}

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 com.pulumi.resources.CustomResourceOptions;
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(google_api_gateway_api.api().project())
            .api(google_api_gateway_api.api().api_id())
            .role("roles/apigateway.viewer")
            .members("user:jane@example.com")
            .build(), CustomResourceOptions.builder()
                .provider(google_beta)
                .build());

    }
}

resources:
  binding:
    type: gcp:apigateway:ApiIamBinding
    properties:
      project: ${google_api_gateway_api.api.project}
      api: ${google_api_gateway_api.api.api_id}
      role: roles/apigateway.viewer
      members:
        - user:jane@example.com
    options:
      provider: ${["google-beta"]}

google_api_gateway_api_iam_member

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

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

import pulumi
import pulumi_gcp as gcp

member = gcp.apigateway.ApiIamMember("member",
    project=google_api_gateway_api["api"]["project"],
    api=google_api_gateway_api["api"]["api_id"],
    role="roles/apigateway.viewer",
    member="user:jane@example.com",
    opts=pulumi.ResourceOptions(provider=google_beta))

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

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

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/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(google_api_gateway_api.Api.Project),
			Api:     pulumi.Any(google_api_gateway_api.Api.Api_id),
			Role:    pulumi.String("roles/apigateway.viewer"),
			Member:  pulumi.String("user:jane@example.com"),
		}, pulumi.Provider(google_beta))
		if err != nil {
			return err
		}
		return nil
	})
}

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 com.pulumi.resources.CustomResourceOptions;
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(google_api_gateway_api.api().project())
            .api(google_api_gateway_api.api().api_id())
            .role("roles/apigateway.viewer")
            .member("user:jane@example.com")
            .build(), CustomResourceOptions.builder()
                .provider(google_beta)
                .build());

    }
}

resources:
  member:
    type: gcp:apigateway:ApiIamMember
    properties:
      project: ${google_api_gateway_api.api.project}
      api: ${google_api_gateway_api.api.api_id}
      role: roles/apigateway.viewer
      member: user:jane@example.com
    options:
      provider: ${["google-beta"]}

Create ApiIamBinding Resource

new ApiIamBinding(name: string, args: ApiIamBindingArgs, opts?: CustomResourceOptions);
@overload
def ApiIamBinding(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  api: Optional[str] = None,
                  condition: Optional[ApiIamBindingConditionArgs] = None,
                  members: Optional[Sequence[str]] = None,
                  project: Optional[str] = None,
                  role: Optional[str] = None)
@overload
def ApiIamBinding(resource_name: str,
                  args: ApiIamBindingArgs,
                  opts: Optional[ResourceOptions] = None)
func NewApiIamBinding(ctx *Context, name string, args ApiIamBindingArgs, opts ...ResourceOption) (*ApiIamBinding, error)
public ApiIamBinding(string name, ApiIamBindingArgs args, CustomResourceOptions? opts = null)
public ApiIamBinding(String name, ApiIamBindingArgs args)
public ApiIamBinding(String name, ApiIamBindingArgs args, CustomResourceOptions options)

type: gcp:apigateway:ApiIamBinding
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ApiIamBindingArgs
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 ApiIamBindingArgs
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 ApiIamBindingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ApiIamBindingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ApiIamBindingArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

ApiIamBinding Resource Properties

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

Inputs

The ApiIamBinding resource accepts the following input properties:

Api string
Members List<string>
Role string

The role that should be applied. Only one gcp.apigateway.ApiIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

Condition ApiIamBindingConditionArgs
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
Members []string
Role string

The role that should be applied. Only one gcp.apigateway.ApiIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

Condition ApiIamBindingConditionArgs
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
members List<String>
role String

The role that should be applied. Only one gcp.apigateway.ApiIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

condition ApiIamBindingConditionArgs
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
members string[]
role string

The role that should be applied. Only one gcp.apigateway.ApiIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

condition ApiIamBindingConditionArgs
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
members Sequence[str]
role str

The role that should be applied. Only one gcp.apigateway.ApiIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

condition ApiIamBindingConditionArgs
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
members List<String>
role String

The role that should be applied. Only one gcp.apigateway.ApiIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

condition Property Map
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 ApiIamBinding 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 ApiIamBinding Resource

Get an existing ApiIamBinding 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?: ApiIamBindingState, opts?: CustomResourceOptions): ApiIamBinding
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api: Optional[str] = None,
        condition: Optional[ApiIamBindingConditionArgs] = None,
        etag: Optional[str] = None,
        members: Optional[Sequence[str]] = None,
        project: Optional[str] = None,
        role: Optional[str] = None) -> ApiIamBinding
func GetApiIamBinding(ctx *Context, name string, id IDInput, state *ApiIamBindingState, opts ...ResourceOption) (*ApiIamBinding, error)
public static ApiIamBinding Get(string name, Input<string> id, ApiIamBindingState? state, CustomResourceOptions? opts = null)
public static ApiIamBinding get(String name, Output<String> id, ApiIamBindingState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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
Condition ApiIamBindingConditionArgs
Etag string

(Computed) The etag of the IAM policy.

Members List<string>
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.

Role string

The role that should be applied. Only one gcp.apigateway.ApiIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

Api string
Condition ApiIamBindingConditionArgs
Etag string

(Computed) The etag of the IAM policy.

Members []string
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.

Role string

The role that should be applied. Only one gcp.apigateway.ApiIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

api String
condition ApiIamBindingConditionArgs
etag String

(Computed) The etag of the IAM policy.

members List<String>
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.

role String

The role that should be applied. Only one gcp.apigateway.ApiIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

api string
condition ApiIamBindingConditionArgs
etag string

(Computed) The etag of the IAM policy.

members string[]
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.

role string

The role that should be applied. Only one gcp.apigateway.ApiIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

api str
condition ApiIamBindingConditionArgs
etag str

(Computed) The etag of the IAM policy.

members Sequence[str]
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.

role str

The role that should be applied. Only one gcp.apigateway.ApiIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

api String
condition Property Map
etag String

(Computed) The etag of the IAM policy.

members List<String>
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.

role String

The role that should be applied. Only one gcp.apigateway.ApiIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

Supporting Types

ApiIamBindingCondition

Expression string
Title string
Description string
Expression string
Title string
Description string
expression String
title String
description String
expression string
title string
description string
expression String
title String
description String

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 identifiersthe resource in question, the role, and the member identity, e.g.

 $ pulumi import gcp:apigateway/apiIamBinding:ApiIamBinding editor "projects/{{project}}/locations/global/apis/{{api}} roles/apigateway.viewer user:jane@example.com"

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

 $ pulumi import gcp:apigateway/apiIamBinding:ApiIamBinding 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/apiIamBinding:ApiIamBinding editor projects/{{project}}/locations/global/apis/{{api}}

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

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.