1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. apigateway
  5. GatewayIamMember
Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi

gcp.apigateway.GatewayIamMember

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi

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

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

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

    • gcp.apigateway.GatewayIamPolicy: Retrieves the IAM policy for the gateway

    Note: gcp.apigateway.GatewayIamPolicy cannot be used in conjunction with gcp.apigateway.GatewayIamBinding and gcp.apigateway.GatewayIamMember or they will fight over what your policy should be.

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

    google_api_gateway_gateway_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.GatewayIamPolicy("policy", {
        project: apiGw.project,
        region: apiGw.region,
        gateway: apiGw.gatewayId,
        policyData: admin.then(admin => admin.policyData),
    });
    
    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.GatewayIamPolicy("policy",
        project=api_gw["project"],
        region=api_gw["region"],
        gateway=api_gw["gatewayId"],
        policy_data=admin.policy_data)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/apigateway"
    	"github.com/pulumi/pulumi-gcp/sdk/v7/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.NewGatewayIamPolicy(ctx, "policy", &apigateway.GatewayIamPolicyArgs{
    			Project:    pulumi.Any(apiGw.Project),
    			Region:     pulumi.Any(apiGw.Region),
    			Gateway:    pulumi.Any(apiGw.GatewayId),
    			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.GatewayIamPolicy("policy", new()
        {
            Project = apiGw.Project,
            Region = apiGw.Region,
            Gateway = apiGw.GatewayId,
            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.GatewayIamPolicy;
    import com.pulumi.gcp.apigateway.GatewayIamPolicyArgs;
    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 GatewayIamPolicy("policy", GatewayIamPolicyArgs.builder()
                .project(apiGw.project())
                .region(apiGw.region())
                .gateway(apiGw.gatewayId())
                .policyData(admin.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
                .build());
    
        }
    }
    
    resources:
      policy:
        type: gcp:apigateway:GatewayIamPolicy
        properties:
          project: ${apiGw.project}
          region: ${apiGw.region}
          gateway: ${apiGw.gatewayId}
          policyData: ${admin.policyData}
    variables:
      admin:
        fn::invoke:
          Function: gcp:organizations:getIAMPolicy
          Arguments:
            bindings:
              - role: roles/apigateway.viewer
                members:
                  - user:jane@example.com
    

    gcp.apigateway.GatewayIamBinding

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const binding = new gcp.apigateway.GatewayIamBinding("binding", {
        project: apiGw.project,
        region: apiGw.region,
        gateway: apiGw.gatewayId,
        role: "roles/apigateway.viewer",
        members: ["user:jane@example.com"],
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    binding = gcp.apigateway.GatewayIamBinding("binding",
        project=api_gw["project"],
        region=api_gw["region"],
        gateway=api_gw["gatewayId"],
        role="roles/apigateway.viewer",
        members=["user:jane@example.com"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/apigateway"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := apigateway.NewGatewayIamBinding(ctx, "binding", &apigateway.GatewayIamBindingArgs{
    			Project: pulumi.Any(apiGw.Project),
    			Region:  pulumi.Any(apiGw.Region),
    			Gateway: pulumi.Any(apiGw.GatewayId),
    			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.GatewayIamBinding("binding", new()
        {
            Project = apiGw.Project,
            Region = apiGw.Region,
            Gateway = apiGw.GatewayId,
            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.GatewayIamBinding;
    import com.pulumi.gcp.apigateway.GatewayIamBindingArgs;
    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 GatewayIamBinding("binding", GatewayIamBindingArgs.builder()
                .project(apiGw.project())
                .region(apiGw.region())
                .gateway(apiGw.gatewayId())
                .role("roles/apigateway.viewer")
                .members("user:jane@example.com")
                .build());
    
        }
    }
    
    resources:
      binding:
        type: gcp:apigateway:GatewayIamBinding
        properties:
          project: ${apiGw.project}
          region: ${apiGw.region}
          gateway: ${apiGw.gatewayId}
          role: roles/apigateway.viewer
          members:
            - user:jane@example.com
    

    gcp.apigateway.GatewayIamMember

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const member = new gcp.apigateway.GatewayIamMember("member", {
        project: apiGw.project,
        region: apiGw.region,
        gateway: apiGw.gatewayId,
        role: "roles/apigateway.viewer",
        member: "user:jane@example.com",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    member = gcp.apigateway.GatewayIamMember("member",
        project=api_gw["project"],
        region=api_gw["region"],
        gateway=api_gw["gatewayId"],
        role="roles/apigateway.viewer",
        member="user:jane@example.com")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/apigateway"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := apigateway.NewGatewayIamMember(ctx, "member", &apigateway.GatewayIamMemberArgs{
    			Project: pulumi.Any(apiGw.Project),
    			Region:  pulumi.Any(apiGw.Region),
    			Gateway: pulumi.Any(apiGw.GatewayId),
    			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.GatewayIamMember("member", new()
        {
            Project = apiGw.Project,
            Region = apiGw.Region,
            Gateway = apiGw.GatewayId,
            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.GatewayIamMember;
    import com.pulumi.gcp.apigateway.GatewayIamMemberArgs;
    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 GatewayIamMember("member", GatewayIamMemberArgs.builder()
                .project(apiGw.project())
                .region(apiGw.region())
                .gateway(apiGw.gatewayId())
                .role("roles/apigateway.viewer")
                .member("user:jane@example.com")
                .build());
    
        }
    }
    
    resources:
      member:
        type: gcp:apigateway:GatewayIamMember
        properties:
          project: ${apiGw.project}
          region: ${apiGw.region}
          gateway: ${apiGw.gatewayId}
          role: roles/apigateway.viewer
          member: user:jane@example.com
    

    google_api_gateway_gateway_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.GatewayIamPolicy("policy", {
        project: apiGw.project,
        region: apiGw.region,
        gateway: apiGw.gatewayId,
        policyData: admin.then(admin => admin.policyData),
    });
    
    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.GatewayIamPolicy("policy",
        project=api_gw["project"],
        region=api_gw["region"],
        gateway=api_gw["gatewayId"],
        policy_data=admin.policy_data)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/apigateway"
    	"github.com/pulumi/pulumi-gcp/sdk/v7/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.NewGatewayIamPolicy(ctx, "policy", &apigateway.GatewayIamPolicyArgs{
    			Project:    pulumi.Any(apiGw.Project),
    			Region:     pulumi.Any(apiGw.Region),
    			Gateway:    pulumi.Any(apiGw.GatewayId),
    			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.GatewayIamPolicy("policy", new()
        {
            Project = apiGw.Project,
            Region = apiGw.Region,
            Gateway = apiGw.GatewayId,
            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.GatewayIamPolicy;
    import com.pulumi.gcp.apigateway.GatewayIamPolicyArgs;
    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 GatewayIamPolicy("policy", GatewayIamPolicyArgs.builder()
                .project(apiGw.project())
                .region(apiGw.region())
                .gateway(apiGw.gatewayId())
                .policyData(admin.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
                .build());
    
        }
    }
    
    resources:
      policy:
        type: gcp:apigateway:GatewayIamPolicy
        properties:
          project: ${apiGw.project}
          region: ${apiGw.region}
          gateway: ${apiGw.gatewayId}
          policyData: ${admin.policyData}
    variables:
      admin:
        fn::invoke:
          Function: gcp:organizations:getIAMPolicy
          Arguments:
            bindings:
              - role: roles/apigateway.viewer
                members:
                  - user:jane@example.com
    

    gcp.apigateway.GatewayIamBinding

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const binding = new gcp.apigateway.GatewayIamBinding("binding", {
        project: apiGw.project,
        region: apiGw.region,
        gateway: apiGw.gatewayId,
        role: "roles/apigateway.viewer",
        members: ["user:jane@example.com"],
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    binding = gcp.apigateway.GatewayIamBinding("binding",
        project=api_gw["project"],
        region=api_gw["region"],
        gateway=api_gw["gatewayId"],
        role="roles/apigateway.viewer",
        members=["user:jane@example.com"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/apigateway"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := apigateway.NewGatewayIamBinding(ctx, "binding", &apigateway.GatewayIamBindingArgs{
    			Project: pulumi.Any(apiGw.Project),
    			Region:  pulumi.Any(apiGw.Region),
    			Gateway: pulumi.Any(apiGw.GatewayId),
    			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.GatewayIamBinding("binding", new()
        {
            Project = apiGw.Project,
            Region = apiGw.Region,
            Gateway = apiGw.GatewayId,
            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.GatewayIamBinding;
    import com.pulumi.gcp.apigateway.GatewayIamBindingArgs;
    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 GatewayIamBinding("binding", GatewayIamBindingArgs.builder()
                .project(apiGw.project())
                .region(apiGw.region())
                .gateway(apiGw.gatewayId())
                .role("roles/apigateway.viewer")
                .members("user:jane@example.com")
                .build());
    
        }
    }
    
    resources:
      binding:
        type: gcp:apigateway:GatewayIamBinding
        properties:
          project: ${apiGw.project}
          region: ${apiGw.region}
          gateway: ${apiGw.gatewayId}
          role: roles/apigateway.viewer
          members:
            - user:jane@example.com
    

    gcp.apigateway.GatewayIamMember

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const member = new gcp.apigateway.GatewayIamMember("member", {
        project: apiGw.project,
        region: apiGw.region,
        gateway: apiGw.gatewayId,
        role: "roles/apigateway.viewer",
        member: "user:jane@example.com",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    member = gcp.apigateway.GatewayIamMember("member",
        project=api_gw["project"],
        region=api_gw["region"],
        gateway=api_gw["gatewayId"],
        role="roles/apigateway.viewer",
        member="user:jane@example.com")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/apigateway"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := apigateway.NewGatewayIamMember(ctx, "member", &apigateway.GatewayIamMemberArgs{
    			Project: pulumi.Any(apiGw.Project),
    			Region:  pulumi.Any(apiGw.Region),
    			Gateway: pulumi.Any(apiGw.GatewayId),
    			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.GatewayIamMember("member", new()
        {
            Project = apiGw.Project,
            Region = apiGw.Region,
            Gateway = apiGw.GatewayId,
            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.GatewayIamMember;
    import com.pulumi.gcp.apigateway.GatewayIamMemberArgs;
    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 GatewayIamMember("member", GatewayIamMemberArgs.builder()
                .project(apiGw.project())
                .region(apiGw.region())
                .gateway(apiGw.gatewayId())
                .role("roles/apigateway.viewer")
                .member("user:jane@example.com")
                .build());
    
        }
    }
    
    resources:
      member:
        type: gcp:apigateway:GatewayIamMember
        properties:
          project: ${apiGw.project}
          region: ${apiGw.region}
          gateway: ${apiGw.gatewayId}
          role: roles/apigateway.viewer
          member: user:jane@example.com
    

    Create GatewayIamMember Resource

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

    Constructor syntax

    new GatewayIamMember(name: string, args: GatewayIamMemberArgs, opts?: CustomResourceOptions);
    @overload
    def GatewayIamMember(resource_name: str,
                         args: GatewayIamMemberArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def GatewayIamMember(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         gateway: Optional[str] = None,
                         member: Optional[str] = None,
                         role: Optional[str] = None,
                         condition: Optional[GatewayIamMemberConditionArgs] = None,
                         project: Optional[str] = None,
                         region: Optional[str] = None)
    func NewGatewayIamMember(ctx *Context, name string, args GatewayIamMemberArgs, opts ...ResourceOption) (*GatewayIamMember, error)
    public GatewayIamMember(string name, GatewayIamMemberArgs args, CustomResourceOptions? opts = null)
    public GatewayIamMember(String name, GatewayIamMemberArgs args)
    public GatewayIamMember(String name, GatewayIamMemberArgs args, CustomResourceOptions options)
    
    type: gcp:apigateway:GatewayIamMember
    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 GatewayIamMemberArgs
    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 GatewayIamMemberArgs
    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 GatewayIamMemberArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayIamMemberArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayIamMemberArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var gatewayIamMemberResource = new Gcp.ApiGateway.GatewayIamMember("gatewayIamMemberResource", new()
    {
        Gateway = "string",
        Member = "string",
        Role = "string",
        Condition = new Gcp.ApiGateway.Inputs.GatewayIamMemberConditionArgs
        {
            Expression = "string",
            Title = "string",
            Description = "string",
        },
        Project = "string",
        Region = "string",
    });
    
    example, err := apigateway.NewGatewayIamMember(ctx, "gatewayIamMemberResource", &apigateway.GatewayIamMemberArgs{
    	Gateway: pulumi.String("string"),
    	Member:  pulumi.String("string"),
    	Role:    pulumi.String("string"),
    	Condition: &apigateway.GatewayIamMemberConditionArgs{
    		Expression:  pulumi.String("string"),
    		Title:       pulumi.String("string"),
    		Description: pulumi.String("string"),
    	},
    	Project: pulumi.String("string"),
    	Region:  pulumi.String("string"),
    })
    
    var gatewayIamMemberResource = new GatewayIamMember("gatewayIamMemberResource", GatewayIamMemberArgs.builder()
        .gateway("string")
        .member("string")
        .role("string")
        .condition(GatewayIamMemberConditionArgs.builder()
            .expression("string")
            .title("string")
            .description("string")
            .build())
        .project("string")
        .region("string")
        .build());
    
    gateway_iam_member_resource = gcp.apigateway.GatewayIamMember("gatewayIamMemberResource",
        gateway="string",
        member="string",
        role="string",
        condition=gcp.apigateway.GatewayIamMemberConditionArgs(
            expression="string",
            title="string",
            description="string",
        ),
        project="string",
        region="string")
    
    const gatewayIamMemberResource = new gcp.apigateway.GatewayIamMember("gatewayIamMemberResource", {
        gateway: "string",
        member: "string",
        role: "string",
        condition: {
            expression: "string",
            title: "string",
            description: "string",
        },
        project: "string",
        region: "string",
    });
    
    type: gcp:apigateway:GatewayIamMember
    properties:
        condition:
            description: string
            expression: string
            title: string
        gateway: string
        member: string
        project: string
        region: string
        role: string
    

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

    Gateway string
    Member 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.GatewayIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
    Condition GatewayIamMemberCondition
    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.
    Region string
    The region of the gateway for the API. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.
    Gateway string
    Member 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.GatewayIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
    Condition GatewayIamMemberConditionArgs
    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.
    Region string
    The region of the gateway for the API. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.
    gateway String
    member 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.GatewayIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
    condition GatewayIamMemberCondition
    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.
    region String
    The region of the gateway for the API. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.
    gateway string
    member 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.GatewayIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
    condition GatewayIamMemberCondition
    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.
    region string
    The region of the gateway for the API. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.
    gateway str
    member 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.GatewayIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
    condition GatewayIamMemberConditionArgs
    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.
    region str
    The region of the gateway for the API. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.
    gateway String
    member 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.GatewayIamBinding 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.
    region String
    The region of the gateway for the API. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.

    Outputs

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

    Get an existing GatewayIamMember 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?: GatewayIamMemberState, opts?: CustomResourceOptions): GatewayIamMember
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            condition: Optional[GatewayIamMemberConditionArgs] = None,
            etag: Optional[str] = None,
            gateway: Optional[str] = None,
            member: Optional[str] = None,
            project: Optional[str] = None,
            region: Optional[str] = None,
            role: Optional[str] = None) -> GatewayIamMember
    func GetGatewayIamMember(ctx *Context, name string, id IDInput, state *GatewayIamMemberState, opts ...ResourceOption) (*GatewayIamMember, error)
    public static GatewayIamMember Get(string name, Input<string> id, GatewayIamMemberState? state, CustomResourceOptions? opts = null)
    public static GatewayIamMember get(String name, Output<String> id, GatewayIamMemberState 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:
    Condition GatewayIamMemberCondition
    Etag string
    (Computed) The etag of the IAM policy.
    Gateway string
    Member 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
    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.
    Region string
    The region of the gateway for the API. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.
    Role string
    The role that should be applied. Only one gcp.apigateway.GatewayIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
    Condition GatewayIamMemberConditionArgs
    Etag string
    (Computed) The etag of the IAM policy.
    Gateway string
    Member 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
    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.
    Region string
    The region of the gateway for the API. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.
    Role string
    The role that should be applied. Only one gcp.apigateway.GatewayIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
    condition GatewayIamMemberCondition
    etag String
    (Computed) The etag of the IAM policy.
    gateway String
    member 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
    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.
    region String
    The region of the gateway for the API. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.
    role String
    The role that should be applied. Only one gcp.apigateway.GatewayIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
    condition GatewayIamMemberCondition
    etag string
    (Computed) The etag of the IAM policy.
    gateway string
    member 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
    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.
    region string
    The region of the gateway for the API. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.
    role string
    The role that should be applied. Only one gcp.apigateway.GatewayIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
    condition GatewayIamMemberConditionArgs
    etag str
    (Computed) The etag of the IAM policy.
    gateway str
    member 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
    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.
    region str
    The region of the gateway for the API. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.
    role str
    The role that should be applied. Only one gcp.apigateway.GatewayIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
    condition Property Map
    etag String
    (Computed) The etag of the IAM policy.
    gateway String
    member 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
    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.
    region String
    The region of the gateway for the API. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.
    role String
    The role that should be applied. Only one gcp.apigateway.GatewayIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

    Supporting Types

    GatewayIamMemberCondition, GatewayIamMemberConditionArgs

    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/{{region}}/gateways/{{gateway}}

    • {{project}}/{{region}}/{{gateway}}

    • {{region}}/{{gateway}}

    • {{gateway}}

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

    API Gateway gateway 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/gatewayIamMember:GatewayIamMember editor "projects/{{project}}/locations/{{region}}/gateways/{{gateway}} 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/gatewayIamMember:GatewayIamMember editor "projects/{{project}}/locations/{{region}}/gateways/{{gateway}} roles/apigateway.viewer"
    

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

    $ pulumi import gcp:apigateway/gatewayIamMember:GatewayIamMember editor projects/{{project}}/locations/{{region}}/gateways/{{gateway}}
    

    -> 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.
    gcp logo
    Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi