InstanceIamBindingArgs

data class InstanceIamBindingArgs(val condition: Output<InstanceIamBindingConditionArgs>? = null, val instanceName: Output<String>? = null, val location: Output<String>? = null, val members: Output<List<String>>? = null, val project: Output<String>? = null, val role: Output<String>? = null) : ConvertibleToJava<InstanceIamBindingArgs>

Three different resources help you manage your IAM policy for Cloud AI Notebooks Instance. Each of these resources serves a different use case:

  • gcp.notebooks.InstanceIamPolicy: Authoritative. Sets the IAM policy for the instance and replaces any existing policy already attached.

  • gcp.notebooks.InstanceIamBinding: 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 instance are preserved.

  • gcp.notebooks.InstanceIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the instance are preserved. A data source can be used to retrieve policy data in advent you do not need creation

  • gcp.notebooks.InstanceIamPolicy: Retrieves the IAM policy for the instance

Note: gcp.notebooks.InstanceIamPolicy cannot be used in conjunction with gcp.notebooks.InstanceIamBinding and gcp.notebooks.InstanceIamMember or they will fight over what your policy should be. Note: gcp.notebooks.InstanceIamBinding resources can be used in conjunction with gcp.notebooks.InstanceIamMember resources only if they do not grant privilege to the same role.

gcp.notebooks.InstanceIamPolicy

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const admin = gcp.organizations.getIAMPolicy({
bindings: [{
role: "roles/viewer",
members: ["user:jane@example&#46;com"],
}],
});
const policy = new gcp.notebooks.InstanceIamPolicy("policy", {
project: instance.project,
location: instance.location,
instanceName: instance.name,
policyData: admin.then(admin => admin.policyData),
});
import pulumi
import pulumi_gcp as gcp
admin = gcp.organizations.get_iam_policy(bindings=[{
"role": "roles/viewer",
"members": ["user:jane@example&#46;com"],
}])
policy = gcp.notebooks.InstanceIamPolicy("policy",
project=instance["project"],
location=instance["location"],
instance_name=instance["name"],
policy_data=admin.policy_data)
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/viewer",
Members = new[]
{
"user:jane@example.com",
},
},
},
});
var policy = new Gcp.Notebooks.InstanceIamPolicy("policy", new()
{
Project = instance.Project,
Location = instance.Location,
InstanceName = instance.Name,
PolicyData = admin.Apply(getIAMPolicyResult => getIAMPolicyResult.PolicyData),
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/notebooks"
"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/viewer",
Members: []string{
"user:jane@example.com",
},
},
},
}, nil)
if err != nil {
return err
}
_, err = notebooks.NewInstanceIamPolicy(ctx, "policy", &notebooks.InstanceIamPolicyArgs{
Project: pulumi.Any(instance.Project),
Location: pulumi.Any(instance.Location),
InstanceName: pulumi.Any(instance.Name),
PolicyData: pulumi.String(admin.PolicyData),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetIAMPolicyArgs;
import com.pulumi.gcp.notebooks.InstanceIamPolicy;
import com.pulumi.gcp.notebooks.InstanceIamPolicyArgs;
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/viewer")
.members("user:jane@example.com")
.build())
.build());
var policy = new InstanceIamPolicy("policy", InstanceIamPolicyArgs.builder()
.project(instance.project())
.location(instance.location())
.instanceName(instance.name())
.policyData(admin.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
.build());
}
}
resources:
policy:
type: gcp:notebooks:InstanceIamPolicy
properties:
project: ${instance.project}
location: ${instance.location}
instanceName: ${instance.name}
policyData: ${admin.policyData}
variables:
admin:
fn::invoke:
Function: gcp:organizations:getIAMPolicy
Arguments:
bindings:
- role: roles/viewer
members:
- user:jane@example.com

gcp.notebooks.InstanceIamBinding

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const binding = new gcp.notebooks.InstanceIamBinding("binding", {
project: instance.project,
location: instance.location,
instanceName: instance.name,
role: "roles/viewer",
members: ["user:jane@example&#46;com"],
});
import pulumi
import pulumi_gcp as gcp
binding = gcp.notebooks.InstanceIamBinding("binding",
project=instance["project"],
location=instance["location"],
instance_name=instance["name"],
role="roles/viewer",
members=["user:jane@example&#46;com"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var binding = new Gcp.Notebooks.InstanceIamBinding("binding", new()
{
Project = instance.Project,
Location = instance.Location,
InstanceName = instance.Name,
Role = "roles/viewer",
Members = new[]
{
"user:jane@example.com",
},
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/notebooks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := notebooks.NewInstanceIamBinding(ctx, "binding", &notebooks.InstanceIamBindingArgs{
Project: pulumi.Any(instance.Project),
Location: pulumi.Any(instance.Location),
InstanceName: pulumi.Any(instance.Name),
Role: pulumi.String("roles/viewer"),
Members: pulumi.StringArray{
pulumi.String("user:jane@example.com"),
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.notebooks.InstanceIamBinding;
import com.pulumi.gcp.notebooks.InstanceIamBindingArgs;
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 InstanceIamBinding("binding", InstanceIamBindingArgs.builder()
.project(instance.project())
.location(instance.location())
.instanceName(instance.name())
.role("roles/viewer")
.members("user:jane@example.com")
.build());
}
}
resources:
binding:
type: gcp:notebooks:InstanceIamBinding
properties:
project: ${instance.project}
location: ${instance.location}
instanceName: ${instance.name}
role: roles/viewer
members:
- user:jane@example.com

gcp.notebooks.InstanceIamMember

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const member = new gcp.notebooks.InstanceIamMember("member", {
project: instance.project,
location: instance.location,
instanceName: instance.name,
role: "roles/viewer",
member: "user:jane@example.com",
});
import pulumi
import pulumi_gcp as gcp
member = gcp.notebooks.InstanceIamMember("member",
project=instance["project"],
location=instance["location"],
instance_name=instance["name"],
role="roles/viewer",
member="user:jane@example.com")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var member = new Gcp.Notebooks.InstanceIamMember("member", new()
{
Project = instance.Project,
Location = instance.Location,
InstanceName = instance.Name,
Role = "roles/viewer",
Member = "user:jane@example.com",
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/notebooks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := notebooks.NewInstanceIamMember(ctx, "member", &notebooks.InstanceIamMemberArgs{
Project: pulumi.Any(instance.Project),
Location: pulumi.Any(instance.Location),
InstanceName: pulumi.Any(instance.Name),
Role: pulumi.String("roles/viewer"),
Member: pulumi.String("user:jane@example.com"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.notebooks.InstanceIamMember;
import com.pulumi.gcp.notebooks.InstanceIamMemberArgs;
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 InstanceIamMember("member", InstanceIamMemberArgs.builder()
.project(instance.project())
.location(instance.location())
.instanceName(instance.name())
.role("roles/viewer")
.member("user:jane@example.com")
.build());
}
}
resources:
member:
type: gcp:notebooks:InstanceIamMember
properties:
project: ${instance.project}
location: ${instance.location}
instanceName: ${instance.name}
role: roles/viewer
member: user:jane@example.com

## This resource supports User Project Overrides.

-

IAM policy for Cloud AI Notebooks Instance

Three different resources help you manage your IAM policy for Cloud AI Notebooks Instance. Each of these resources serves a different use case:

  • gcp.notebooks.InstanceIamPolicy: Authoritative. Sets the IAM policy for the instance and replaces any existing policy already attached.

  • gcp.notebooks.InstanceIamBinding: 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 instance are preserved.

  • gcp.notebooks.InstanceIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the instance are preserved. A data source can be used to retrieve policy data in advent you do not need creation

  • gcp.notebooks.InstanceIamPolicy: Retrieves the IAM policy for the instance

Note: gcp.notebooks.InstanceIamPolicy cannot be used in conjunction with gcp.notebooks.InstanceIamBinding and gcp.notebooks.InstanceIamMember or they will fight over what your policy should be. Note: gcp.notebooks.InstanceIamBinding resources can be used in conjunction with gcp.notebooks.InstanceIamMember resources only if they do not grant privilege to the same role.

gcp.notebooks.InstanceIamPolicy

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const admin = gcp.organizations.getIAMPolicy({
bindings: [{
role: "roles/viewer",
members: ["user:jane@example&#46;com"],
}],
});
const policy = new gcp.notebooks.InstanceIamPolicy("policy", {
project: instance.project,
location: instance.location,
instanceName: instance.name,
policyData: admin.then(admin => admin.policyData),
});
import pulumi
import pulumi_gcp as gcp
admin = gcp.organizations.get_iam_policy(bindings=[{
"role": "roles/viewer",
"members": ["user:jane@example&#46;com"],
}])
policy = gcp.notebooks.InstanceIamPolicy("policy",
project=instance["project"],
location=instance["location"],
instance_name=instance["name"],
policy_data=admin.policy_data)
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/viewer",
Members = new[]
{
"user:jane@example.com",
},
},
},
});
var policy = new Gcp.Notebooks.InstanceIamPolicy("policy", new()
{
Project = instance.Project,
Location = instance.Location,
InstanceName = instance.Name,
PolicyData = admin.Apply(getIAMPolicyResult => getIAMPolicyResult.PolicyData),
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/notebooks"
"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/viewer",
Members: []string{
"user:jane@example.com",
},
},
},
}, nil)
if err != nil {
return err
}
_, err = notebooks.NewInstanceIamPolicy(ctx, "policy", &notebooks.InstanceIamPolicyArgs{
Project: pulumi.Any(instance.Project),
Location: pulumi.Any(instance.Location),
InstanceName: pulumi.Any(instance.Name),
PolicyData: pulumi.String(admin.PolicyData),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetIAMPolicyArgs;
import com.pulumi.gcp.notebooks.InstanceIamPolicy;
import com.pulumi.gcp.notebooks.InstanceIamPolicyArgs;
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/viewer")
.members("user:jane@example.com")
.build())
.build());
var policy = new InstanceIamPolicy("policy", InstanceIamPolicyArgs.builder()
.project(instance.project())
.location(instance.location())
.instanceName(instance.name())
.policyData(admin.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
.build());
}
}
resources:
policy:
type: gcp:notebooks:InstanceIamPolicy
properties:
project: ${instance.project}
location: ${instance.location}
instanceName: ${instance.name}
policyData: ${admin.policyData}
variables:
admin:
fn::invoke:
Function: gcp:organizations:getIAMPolicy
Arguments:
bindings:
- role: roles/viewer
members:
- user:jane@example.com

gcp.notebooks.InstanceIamBinding

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const binding = new gcp.notebooks.InstanceIamBinding("binding", {
project: instance.project,
location: instance.location,
instanceName: instance.name,
role: "roles/viewer",
members: ["user:jane@example&#46;com"],
});
import pulumi
import pulumi_gcp as gcp
binding = gcp.notebooks.InstanceIamBinding("binding",
project=instance["project"],
location=instance["location"],
instance_name=instance["name"],
role="roles/viewer",
members=["user:jane@example&#46;com"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var binding = new Gcp.Notebooks.InstanceIamBinding("binding", new()
{
Project = instance.Project,
Location = instance.Location,
InstanceName = instance.Name,
Role = "roles/viewer",
Members = new[]
{
"user:jane@example.com",
},
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/notebooks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := notebooks.NewInstanceIamBinding(ctx, "binding", &notebooks.InstanceIamBindingArgs{
Project: pulumi.Any(instance.Project),
Location: pulumi.Any(instance.Location),
InstanceName: pulumi.Any(instance.Name),
Role: pulumi.String("roles/viewer"),
Members: pulumi.StringArray{
pulumi.String("user:jane@example.com"),
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.notebooks.InstanceIamBinding;
import com.pulumi.gcp.notebooks.InstanceIamBindingArgs;
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 InstanceIamBinding("binding", InstanceIamBindingArgs.builder()
.project(instance.project())
.location(instance.location())
.instanceName(instance.name())
.role("roles/viewer")
.members("user:jane@example.com")
.build());
}
}
resources:
binding:
type: gcp:notebooks:InstanceIamBinding
properties:
project: ${instance.project}
location: ${instance.location}
instanceName: ${instance.name}
role: roles/viewer
members:
- user:jane@example.com

gcp.notebooks.InstanceIamMember

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const member = new gcp.notebooks.InstanceIamMember("member", {
project: instance.project,
location: instance.location,
instanceName: instance.name,
role: "roles/viewer",
member: "user:jane@example.com",
});
import pulumi
import pulumi_gcp as gcp
member = gcp.notebooks.InstanceIamMember("member",
project=instance["project"],
location=instance["location"],
instance_name=instance["name"],
role="roles/viewer",
member="user:jane@example.com")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var member = new Gcp.Notebooks.InstanceIamMember("member", new()
{
Project = instance.Project,
Location = instance.Location,
InstanceName = instance.Name,
Role = "roles/viewer",
Member = "user:jane@example.com",
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/notebooks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := notebooks.NewInstanceIamMember(ctx, "member", &notebooks.InstanceIamMemberArgs{
Project: pulumi.Any(instance.Project),
Location: pulumi.Any(instance.Location),
InstanceName: pulumi.Any(instance.Name),
Role: pulumi.String("roles/viewer"),
Member: pulumi.String("user:jane@example.com"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.notebooks.InstanceIamMember;
import com.pulumi.gcp.notebooks.InstanceIamMemberArgs;
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 InstanceIamMember("member", InstanceIamMemberArgs.builder()
.project(instance.project())
.location(instance.location())
.instanceName(instance.name())
.role("roles/viewer")
.member("user:jane@example.com")
.build());
}
}
resources:
member:
type: gcp:notebooks:InstanceIamMember
properties:
project: ${instance.project}
location: ${instance.location}
instanceName: ${instance.name}
role: roles/viewer
member: user:jane@example.com

Import

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

  • projects/{{project}}/locations/{{location}}/instances/{{instance_name}}

  • {{project}}/{{location}}/{{instance_name}}

  • {{location}}/{{instance_name}}

  • {{instance_name}} Any variables not passed in the import command will be taken from the provider configuration. Cloud AI Notebooks instance 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:notebooks/instanceIamBinding:InstanceIamBinding editor "projects/{{project}}/locations/{{location}}/instances/{{instance_name}} roles/viewer user:jane@example.com"

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

$ pulumi import gcp:notebooks/instanceIamBinding:InstanceIamBinding editor "projects/{{project}}/locations/{{location}}/instances/{{instance_name}} roles/viewer"

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

$ pulumi import gcp:notebooks/instanceIamBinding:InstanceIamBinding editor projects/{{project}}/locations/{{location}}/instances/{{instance_name}}

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

Constructors

Link copied to clipboard
constructor(condition: Output<InstanceIamBindingConditionArgs>? = null, instanceName: Output<String>? = null, location: Output<String>? = null, members: Output<List<String>>? = null, project: Output<String>? = null, role: Output<String>? = null)

Properties

Link copied to clipboard
Link copied to clipboard
val instanceName: Output<String>? = null

Used to find the parent resource to bind the IAM policy to

Link copied to clipboard
val location: Output<String>? = null

A reference to the zone where the machine resides. 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 location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.

Link copied to clipboard
val members: Output<List<String>>? = null

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

Link copied to clipboard
val project: Output<String>? = null

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.

Link copied to clipboard
val role: Output<String>? = null

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

Functions

Link copied to clipboard
open override fun toJava(): InstanceIamBindingArgs