Google Cloud Classic v8.9.3, Nov 18 24

Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi

gcp.apigateway.ApiIamBinding

Explore with Pulumi AI

Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 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.applyValue(getIAMPolicyResult -> getIAMPolicyResult.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.applyValue(getIAMPolicyResult -> getIAMPolicyResult.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 ApiIamBinding Resource

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

Constructor syntax

new ApiIamBinding(name: string, args: ApiIamBindingArgs, opts?: CustomResourceOptions);

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

@overload
def ApiIamBinding(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  api: Optional[str] = None,
                  members: Optional[Sequence[str]] = None,
                  role: Optional[str] = None,
                  condition: Optional[ApiIamBindingConditionArgs] = None,
                  project: Optional[str] = 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.

Parameters

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.

Constructor example

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

var apiIamBindingResource = new Gcp.ApiGateway.ApiIamBinding("apiIamBindingResource", new()
{
    Api = "string",
    Members = new[]
    {
        "string",
    },
    Role = "string",
    Condition = new Gcp.ApiGateway.Inputs.ApiIamBindingConditionArgs
    {
        Expression = "string",
        Title = "string",
        Description = "string",
    },
    Project = "string",
});

example, err := apigateway.NewApiIamBinding(ctx, "apiIamBindingResource", &apigateway.ApiIamBindingArgs{
	Api: pulumi.String("string"),
	Members: pulumi.StringArray{
		pulumi.String("string"),
	},
	Role: pulumi.String("string"),
	Condition: &apigateway.ApiIamBindingConditionArgs{
		Expression:  pulumi.String("string"),
		Title:       pulumi.String("string"),
		Description: pulumi.String("string"),
	},
	Project: pulumi.String("string"),
})

var apiIamBindingResource = new ApiIamBinding("apiIamBindingResource", ApiIamBindingArgs.builder()
    .api("string")
    .members("string")
    .role("string")
    .condition(ApiIamBindingConditionArgs.builder()
        .expression("string")
        .title("string")
        .description("string")
        .build())
    .project("string")
    .build());

api_iam_binding_resource = gcp.apigateway.ApiIamBinding("apiIamBindingResource",
    api="string",
    members=["string"],
    role="string",
    condition={
        "expression": "string",
        "title": "string",
        "description": "string",
    },
    project="string")

const apiIamBindingResource = new gcp.apigateway.ApiIamBinding("apiIamBindingResource", {
    api: "string",
    members: ["string"],
    role: "string",
    condition: {
        expression: "string",
        title: "string",
        description: "string",
    },
    project: "string",
});

type: gcp:apigateway:ApiIamBinding
properties:
    api: string
    condition:
        description: string
        expression: string
        title: string
    members:
        - string
    project: string
    role: string

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

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

The ApiIamBinding resource accepts the following input properties:

Api string

Members List<string>

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

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 ApiIamBindingCondition

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

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

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

api String

members List<String>

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

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 ApiIamBindingCondition

project String

api string

members string[]

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

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 ApiIamBindingCondition

project string

api str

members Sequence[str]

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

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

api String

members List<String>

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

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

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 ApiIamBindingCondition

Etag string

(Computed) The etag of the IAM policy.

Members List<string>

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

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

Api string

Condition ApiIamBindingConditionArgs

Etag string

(Computed) The etag of the IAM policy.

Members []string

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

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

api String

condition ApiIamBindingCondition

etag String

(Computed) The etag of the IAM policy.

members List<String>

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

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

api string

condition ApiIamBindingCondition

etag string

(Computed) The etag of the IAM policy.

members string[]

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

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

api str

condition ApiIamBindingConditionArgs

etag str

(Computed) The etag of the IAM policy.

members Sequence[str]

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

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

api String

condition Property Map

etag String

(Computed) The etag of the IAM policy.

members List<String>

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

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

Supporting Types

ApiIamBindingCondition, ApiIamBindingConditionArgs

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 str
title str
description str

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 identifiers: the 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 identifiers: the 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 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 Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-gcp

gcp.apigateway.ApiIamBinding

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 ApiIamBinding Resource

Constructor syntax

Parameters

Constructor example

ApiIamBinding Resource Properties

Inputs

Outputs

Look up Existing ApiIamBinding Resource

Supporting Types

ApiIamBindingCondition, ApiIamBindingConditionArgs

Import

Package Details

On this page

On this page