gcp.apigateway.ApiConfigIamBinding
Explore with Pulumi AI
Three different resources help you manage your IAM policy for API Gateway ApiConfig. Each of these resources serves a different use case:
gcp.apigateway.ApiConfigIamPolicy
: Authoritative. Sets the IAM policy for the apiconfig and replaces any existing policy already attached.gcp.apigateway.ApiConfigIamBinding
: 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 apiconfig are preserved.gcp.apigateway.ApiConfigIamMember
: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the apiconfig are preserved.
A data source can be used to retrieve policy data in advent you do not need creation
gcp.apigateway.ApiConfigIamPolicy
: Retrieves the IAM policy for the apiconfig
Note:
gcp.apigateway.ApiConfigIamPolicy
cannot be used in conjunction withgcp.apigateway.ApiConfigIamBinding
andgcp.apigateway.ApiConfigIamMember
or they will fight over what your policy should be.
Note:
gcp.apigateway.ApiConfigIamBinding
resources can be used in conjunction withgcp.apigateway.ApiConfigIamMember
resources only if they do not grant privilege to the same role.
google_api_gateway_api_config_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.ApiConfigIamPolicy("policy", {
api: apiCfg.api,
apiConfig: apiCfg.apiConfigId,
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.ApiConfigIamPolicy("policy",
api=api_cfg["api"],
api_config=api_cfg["apiConfigId"],
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.NewApiConfigIamPolicy(ctx, "policy", &apigateway.ApiConfigIamPolicyArgs{
Api: pulumi.Any(apiCfg.Api),
ApiConfig: pulumi.Any(apiCfg.ApiConfigId),
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.ApiConfigIamPolicy("policy", new()
{
Api = apiCfg.Api,
ApiConfig = apiCfg.ApiConfigId,
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.ApiConfigIamPolicy;
import com.pulumi.gcp.apigateway.ApiConfigIamPolicyArgs;
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 ApiConfigIamPolicy("policy", ApiConfigIamPolicyArgs.builder()
.api(apiCfg.api())
.apiConfig(apiCfg.apiConfigId())
.policyData(admin.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
.build());
}
}
resources:
policy:
type: gcp:apigateway:ApiConfigIamPolicy
properties:
api: ${apiCfg.api}
apiConfig: ${apiCfg.apiConfigId}
policyData: ${admin.policyData}
variables:
admin:
fn::invoke:
function: gcp:organizations:getIAMPolicy
arguments:
bindings:
- role: roles/apigateway.viewer
members:
- user:jane@example.com
gcp.apigateway.ApiConfigIamBinding
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const binding = new gcp.apigateway.ApiConfigIamBinding("binding", {
api: apiCfg.api,
apiConfig: apiCfg.apiConfigId,
role: "roles/apigateway.viewer",
members: ["user:jane@example.com"],
});
import pulumi
import pulumi_gcp as gcp
binding = gcp.apigateway.ApiConfigIamBinding("binding",
api=api_cfg["api"],
api_config=api_cfg["apiConfigId"],
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.NewApiConfigIamBinding(ctx, "binding", &apigateway.ApiConfigIamBindingArgs{
Api: pulumi.Any(apiCfg.Api),
ApiConfig: pulumi.Any(apiCfg.ApiConfigId),
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.ApiConfigIamBinding("binding", new()
{
Api = apiCfg.Api,
ApiConfig = apiCfg.ApiConfigId,
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.ApiConfigIamBinding;
import com.pulumi.gcp.apigateway.ApiConfigIamBindingArgs;
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 ApiConfigIamBinding("binding", ApiConfigIamBindingArgs.builder()
.api(apiCfg.api())
.apiConfig(apiCfg.apiConfigId())
.role("roles/apigateway.viewer")
.members("user:jane@example.com")
.build());
}
}
resources:
binding:
type: gcp:apigateway:ApiConfigIamBinding
properties:
api: ${apiCfg.api}
apiConfig: ${apiCfg.apiConfigId}
role: roles/apigateway.viewer
members:
- user:jane@example.com
gcp.apigateway.ApiConfigIamMember
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const member = new gcp.apigateway.ApiConfigIamMember("member", {
api: apiCfg.api,
apiConfig: apiCfg.apiConfigId,
role: "roles/apigateway.viewer",
member: "user:jane@example.com",
});
import pulumi
import pulumi_gcp as gcp
member = gcp.apigateway.ApiConfigIamMember("member",
api=api_cfg["api"],
api_config=api_cfg["apiConfigId"],
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.NewApiConfigIamMember(ctx, "member", &apigateway.ApiConfigIamMemberArgs{
Api: pulumi.Any(apiCfg.Api),
ApiConfig: pulumi.Any(apiCfg.ApiConfigId),
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.ApiConfigIamMember("member", new()
{
Api = apiCfg.Api,
ApiConfig = apiCfg.ApiConfigId,
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.ApiConfigIamMember;
import com.pulumi.gcp.apigateway.ApiConfigIamMemberArgs;
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 ApiConfigIamMember("member", ApiConfigIamMemberArgs.builder()
.api(apiCfg.api())
.apiConfig(apiCfg.apiConfigId())
.role("roles/apigateway.viewer")
.member("user:jane@example.com")
.build());
}
}
resources:
member:
type: gcp:apigateway:ApiConfigIamMember
properties:
api: ${apiCfg.api}
apiConfig: ${apiCfg.apiConfigId}
role: roles/apigateway.viewer
member: user:jane@example.com
This resource supports User Project Overrides.
IAM policy for API Gateway ApiConfig
Three different resources help you manage your IAM policy for API Gateway ApiConfig. Each of these resources serves a different use case:
gcp.apigateway.ApiConfigIamPolicy
: Authoritative. Sets the IAM policy for the apiconfig and replaces any existing policy already attached.gcp.apigateway.ApiConfigIamBinding
: 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 apiconfig are preserved.gcp.apigateway.ApiConfigIamMember
: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the apiconfig are preserved.
A data source can be used to retrieve policy data in advent you do not need creation
gcp.apigateway.ApiConfigIamPolicy
: Retrieves the IAM policy for the apiconfig
Note:
gcp.apigateway.ApiConfigIamPolicy
cannot be used in conjunction withgcp.apigateway.ApiConfigIamBinding
andgcp.apigateway.ApiConfigIamMember
or they will fight over what your policy should be.
Note:
gcp.apigateway.ApiConfigIamBinding
resources can be used in conjunction withgcp.apigateway.ApiConfigIamMember
resources only if they do not grant privilege to the same role.
google_api_gateway_api_config_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.ApiConfigIamPolicy("policy", {
api: apiCfg.api,
apiConfig: apiCfg.apiConfigId,
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.ApiConfigIamPolicy("policy",
api=api_cfg["api"],
api_config=api_cfg["apiConfigId"],
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.NewApiConfigIamPolicy(ctx, "policy", &apigateway.ApiConfigIamPolicyArgs{
Api: pulumi.Any(apiCfg.Api),
ApiConfig: pulumi.Any(apiCfg.ApiConfigId),
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.ApiConfigIamPolicy("policy", new()
{
Api = apiCfg.Api,
ApiConfig = apiCfg.ApiConfigId,
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.ApiConfigIamPolicy;
import com.pulumi.gcp.apigateway.ApiConfigIamPolicyArgs;
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 ApiConfigIamPolicy("policy", ApiConfigIamPolicyArgs.builder()
.api(apiCfg.api())
.apiConfig(apiCfg.apiConfigId())
.policyData(admin.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
.build());
}
}
resources:
policy:
type: gcp:apigateway:ApiConfigIamPolicy
properties:
api: ${apiCfg.api}
apiConfig: ${apiCfg.apiConfigId}
policyData: ${admin.policyData}
variables:
admin:
fn::invoke:
function: gcp:organizations:getIAMPolicy
arguments:
bindings:
- role: roles/apigateway.viewer
members:
- user:jane@example.com
gcp.apigateway.ApiConfigIamBinding
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const binding = new gcp.apigateway.ApiConfigIamBinding("binding", {
api: apiCfg.api,
apiConfig: apiCfg.apiConfigId,
role: "roles/apigateway.viewer",
members: ["user:jane@example.com"],
});
import pulumi
import pulumi_gcp as gcp
binding = gcp.apigateway.ApiConfigIamBinding("binding",
api=api_cfg["api"],
api_config=api_cfg["apiConfigId"],
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.NewApiConfigIamBinding(ctx, "binding", &apigateway.ApiConfigIamBindingArgs{
Api: pulumi.Any(apiCfg.Api),
ApiConfig: pulumi.Any(apiCfg.ApiConfigId),
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.ApiConfigIamBinding("binding", new()
{
Api = apiCfg.Api,
ApiConfig = apiCfg.ApiConfigId,
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.ApiConfigIamBinding;
import com.pulumi.gcp.apigateway.ApiConfigIamBindingArgs;
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 ApiConfigIamBinding("binding", ApiConfigIamBindingArgs.builder()
.api(apiCfg.api())
.apiConfig(apiCfg.apiConfigId())
.role("roles/apigateway.viewer")
.members("user:jane@example.com")
.build());
}
}
resources:
binding:
type: gcp:apigateway:ApiConfigIamBinding
properties:
api: ${apiCfg.api}
apiConfig: ${apiCfg.apiConfigId}
role: roles/apigateway.viewer
members:
- user:jane@example.com
gcp.apigateway.ApiConfigIamMember
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const member = new gcp.apigateway.ApiConfigIamMember("member", {
api: apiCfg.api,
apiConfig: apiCfg.apiConfigId,
role: "roles/apigateway.viewer",
member: "user:jane@example.com",
});
import pulumi
import pulumi_gcp as gcp
member = gcp.apigateway.ApiConfigIamMember("member",
api=api_cfg["api"],
api_config=api_cfg["apiConfigId"],
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.NewApiConfigIamMember(ctx, "member", &apigateway.ApiConfigIamMemberArgs{
Api: pulumi.Any(apiCfg.Api),
ApiConfig: pulumi.Any(apiCfg.ApiConfigId),
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.ApiConfigIamMember("member", new()
{
Api = apiCfg.Api,
ApiConfig = apiCfg.ApiConfigId,
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.ApiConfigIamMember;
import com.pulumi.gcp.apigateway.ApiConfigIamMemberArgs;
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 ApiConfigIamMember("member", ApiConfigIamMemberArgs.builder()
.api(apiCfg.api())
.apiConfig(apiCfg.apiConfigId())
.role("roles/apigateway.viewer")
.member("user:jane@example.com")
.build());
}
}
resources:
member:
type: gcp:apigateway:ApiConfigIamMember
properties:
api: ${apiCfg.api}
apiConfig: ${apiCfg.apiConfigId}
role: roles/apigateway.viewer
member: user:jane@example.com
Create ApiConfigIamBinding Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ApiConfigIamBinding(name: string, args: ApiConfigIamBindingArgs, opts?: CustomResourceOptions);
@overload
def ApiConfigIamBinding(resource_name: str,
args: ApiConfigIamBindingArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ApiConfigIamBinding(resource_name: str,
opts: Optional[ResourceOptions] = None,
api: Optional[str] = None,
api_config: Optional[str] = None,
members: Optional[Sequence[str]] = None,
role: Optional[str] = None,
condition: Optional[ApiConfigIamBindingConditionArgs] = None,
project: Optional[str] = None)
func NewApiConfigIamBinding(ctx *Context, name string, args ApiConfigIamBindingArgs, opts ...ResourceOption) (*ApiConfigIamBinding, error)
public ApiConfigIamBinding(string name, ApiConfigIamBindingArgs args, CustomResourceOptions? opts = null)
public ApiConfigIamBinding(String name, ApiConfigIamBindingArgs args)
public ApiConfigIamBinding(String name, ApiConfigIamBindingArgs args, CustomResourceOptions options)
type: gcp:apigateway:ApiConfigIamBinding
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 ApiConfigIamBindingArgs
- 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 ApiConfigIamBindingArgs
- 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 ApiConfigIamBindingArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ApiConfigIamBindingArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ApiConfigIamBindingArgs
- 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 apiConfigIamBindingResource = new Gcp.ApiGateway.ApiConfigIamBinding("apiConfigIamBindingResource", new()
{
Api = "string",
ApiConfig = "string",
Members = new[]
{
"string",
},
Role = "string",
Condition = new Gcp.ApiGateway.Inputs.ApiConfigIamBindingConditionArgs
{
Expression = "string",
Title = "string",
Description = "string",
},
Project = "string",
});
example, err := apigateway.NewApiConfigIamBinding(ctx, "apiConfigIamBindingResource", &apigateway.ApiConfigIamBindingArgs{
Api: pulumi.String("string"),
ApiConfig: pulumi.String("string"),
Members: pulumi.StringArray{
pulumi.String("string"),
},
Role: pulumi.String("string"),
Condition: &apigateway.ApiConfigIamBindingConditionArgs{
Expression: pulumi.String("string"),
Title: pulumi.String("string"),
Description: pulumi.String("string"),
},
Project: pulumi.String("string"),
})
var apiConfigIamBindingResource = new ApiConfigIamBinding("apiConfigIamBindingResource", ApiConfigIamBindingArgs.builder()
.api("string")
.apiConfig("string")
.members("string")
.role("string")
.condition(ApiConfigIamBindingConditionArgs.builder()
.expression("string")
.title("string")
.description("string")
.build())
.project("string")
.build());
api_config_iam_binding_resource = gcp.apigateway.ApiConfigIamBinding("apiConfigIamBindingResource",
api="string",
api_config="string",
members=["string"],
role="string",
condition={
"expression": "string",
"title": "string",
"description": "string",
},
project="string")
const apiConfigIamBindingResource = new gcp.apigateway.ApiConfigIamBinding("apiConfigIamBindingResource", {
api: "string",
apiConfig: "string",
members: ["string"],
role: "string",
condition: {
expression: "string",
title: "string",
description: "string",
},
project: "string",
});
type: gcp:apigateway:ApiConfigIamBinding
properties:
api: string
apiConfig: string
condition:
description: string
expression: string
title: string
members:
- string
project: string
role: string
ApiConfigIamBinding 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 ApiConfigIamBinding resource accepts the following input properties:
- Api string
- The API to attach the config to. Used to find the parent resource to bind the IAM policy to
- Api
Config 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.ApiConfigIamBinding
can be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}
. - Condition
Api
Config Iam Binding Condition - 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
- The API to attach the config to. Used to find the parent resource to bind the IAM policy to
- Api
Config 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.ApiConfigIamBinding
can be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}
. - Condition
Api
Config Iam Binding Condition Args - 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
- The API to attach the config to. Used to find the parent resource to bind the IAM policy to
- api
Config 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.ApiConfigIamBinding
can be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}
. - condition
Api
Config Iam Binding Condition - 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
- The API to attach the config to. Used to find the parent resource to bind the IAM policy to
- api
Config 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.ApiConfigIamBinding
can be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}
. - condition
Api
Config Iam Binding Condition - project string
- The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
- api str
- The API to attach the config to. Used to find the parent resource to bind the IAM policy to
- api_
config 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.ApiConfigIamBinding
can be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}
. - condition
Api
Config Iam Binding Condition Args - project str
- The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
- api String
- The API to attach the config to. Used to find the parent resource to bind the IAM policy to
- api
Config 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.ApiConfigIamBinding
can be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}
. - condition Property Map
- project String
- The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
Outputs
All input properties are implicitly available as output properties. Additionally, the ApiConfigIamBinding resource produces the following output properties:
Look up Existing ApiConfigIamBinding Resource
Get an existing ApiConfigIamBinding 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?: ApiConfigIamBindingState, opts?: CustomResourceOptions): ApiConfigIamBinding
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
api: Optional[str] = None,
api_config: Optional[str] = None,
condition: Optional[ApiConfigIamBindingConditionArgs] = None,
etag: Optional[str] = None,
members: Optional[Sequence[str]] = None,
project: Optional[str] = None,
role: Optional[str] = None) -> ApiConfigIamBinding
func GetApiConfigIamBinding(ctx *Context, name string, id IDInput, state *ApiConfigIamBindingState, opts ...ResourceOption) (*ApiConfigIamBinding, error)
public static ApiConfigIamBinding Get(string name, Input<string> id, ApiConfigIamBindingState? state, CustomResourceOptions? opts = null)
public static ApiConfigIamBinding get(String name, Output<String> id, ApiConfigIamBindingState 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.
- Api string
- The API to attach the config to. Used to find the parent resource to bind the IAM policy to
- Api
Config string - Condition
Api
Config Iam Binding Condition - 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
- The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
- Role string
- The role that should be applied. Only one
gcp.apigateway.ApiConfigIamBinding
can be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}
.
- Api string
- The API to attach the config to. Used to find the parent resource to bind the IAM policy to
- Api
Config string - Condition
Api
Config Iam Binding Condition Args - 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
- The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
- Role string
- The role that should be applied. Only one
gcp.apigateway.ApiConfigIamBinding
can be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}
.
- api String
- The API to attach the config to. Used to find the parent resource to bind the IAM policy to
- api
Config String - condition
Api
Config Iam Binding Condition - 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
- The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
- role String
- The role that should be applied. Only one
gcp.apigateway.ApiConfigIamBinding
can be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}
.
- api string
- The API to attach the config to. Used to find the parent resource to bind the IAM policy to
- api
Config string - condition
Api
Config Iam Binding Condition - 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
- The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
- role string
- The role that should be applied. Only one
gcp.apigateway.ApiConfigIamBinding
can be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}
.
- api str
- The API to attach the config to. Used to find the parent resource to bind the IAM policy to
- api_
config str - condition
Api
Config Iam Binding Condition Args - 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
- The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
- role str
- The role that should be applied. Only one
gcp.apigateway.ApiConfigIamBinding
can be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}
.
- api String
- The API to attach the config to. Used to find the parent resource to bind the IAM policy to
- api
Config 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
- The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
- role String
- The role that should be applied. Only one
gcp.apigateway.ApiConfigIamBinding
can be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}
.
Supporting Types
ApiConfigIamBindingCondition, ApiConfigIamBindingConditionArgs
- 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}}/configs/{{api_config}}
{{project}}/{{api}}/{{api_config}}
{{api}}/{{api_config}}
{{api_config}}
Any variables not passed in the import command will be taken from the provider configuration.
API Gateway apiconfig 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/apiConfigIamBinding:ApiConfigIamBinding editor "projects/{{project}}/locations/global/apis/{{api}}/configs/{{api_config}} 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/apiConfigIamBinding:ApiConfigIamBinding editor "projects/{{project}}/locations/global/apis/{{api}}/configs/{{api_config}} roles/apigateway.viewer"
IAM policy imports use the identifier of the resource in question, e.g.
$ pulumi import gcp:apigateway/apiConfigIamBinding:ApiConfigIamBinding editor projects/{{project}}/locations/global/apis/{{api}}/configs/{{api_config}}
-> 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.