InstanceIAMBinding

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

gcp.compute.InstanceIAMPolicy: Authoritative. Sets the IAM policy for the instance and replaces any existing policy already attached.
gcp.compute.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.compute.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.

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

Create a InstanceIAMBinding Resource

new InstanceIAMBinding(name: string, args: InstanceIAMBindingArgs, opts?: CustomResourceOptions);

def InstanceIAMBinding(resource_name, opts=None, condition=None, instance_name=None, members=None, project=None, role=None, zone=None, __props__=None);

func NewInstanceIAMBinding(ctx *Context, name string, args InstanceIAMBindingArgs, opts ...ResourceOption) (*InstanceIAMBinding, error)

public InstanceIAMBinding(string name, InstanceIAMBindingArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args InstanceIAMBindingArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args InstanceIAMBindingArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args InstanceIAMBindingArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

InstanceIAMBinding Resource Properties

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

Inputs

The InstanceIAMBinding resource accepts the following input properties:

InstanceName string: Used to find the parent resource to bind the IAM policy to
Members List<string>
Role string: The role that should be applied. Only one gcp.compute.InstanceIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
Condition InstanceIAMBindingConditionArgs: ) An IAM Condition for a given binding. Structure is documented below.
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.
Zone string: 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 zone is provided in the parent identifier and no zone is specified, it is taken from the provider configuration.

InstanceName string: Used to find the parent resource to bind the IAM policy to
Members []string
Role string: The role that should be applied. Only one gcp.compute.InstanceIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
Condition InstanceIAMBindingCondition: ) An IAM Condition for a given binding. Structure is documented below.
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.
Zone string: 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 zone is provided in the parent identifier and no zone is specified, it is taken from the provider configuration.

instanceName string: Used to find the parent resource to bind the IAM policy to
members string[]
role string: The role that should be applied. Only one gcp.compute.InstanceIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
condition InstanceIAMBindingCondition: ) An IAM Condition for a given binding. Structure is documented below.
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.
zone string: 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 zone is provided in the parent identifier and no zone is specified, it is taken from the provider configuration.

instance_name str: Used to find the parent resource to bind the IAM policy to
members List[str]
role str: The role that should be applied. Only one gcp.compute.InstanceIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
condition Dict[InstanceIAMBindingCondition]: ) An IAM Condition for a given binding. Structure is documented below.
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.
zone str: 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 zone is provided in the parent identifier and no zone is specified, it is taken from the provider configuration.

Outputs

All input properties are implicitly available as output properties. Additionally, the InstanceIAMBinding 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 str: (Computed) The etag of the IAM policy.
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing InstanceIAMBinding Resource

Get an existing InstanceIAMBinding 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?: InstanceIAMBindingState, opts?: CustomResourceOptions): InstanceIAMBinding

static get(resource_name, id, opts=None, condition=None, etag=None, instance_name=None, members=None, project=None, role=None, zone=None, __props__=None);

func GetInstanceIAMBinding(ctx *Context, name string, id IDInput, state *InstanceIAMBindingState, opts ...ResourceOption) (*InstanceIAMBinding, error)

public static InstanceIAMBinding Get(string name, Input<string> id, InstanceIAMBindingState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

Condition InstanceIAMBindingConditionArgs: ) An IAM Condition for a given binding. Structure is documented below.
Etag string: (Computed) The etag of the IAM policy.
InstanceName string: Used to find the parent resource to bind the IAM policy to
Members List<string>
Project string: The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
Role string: The role that should be applied. Only one gcp.compute.InstanceIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
Zone string: 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 zone is provided in the parent identifier and no zone is specified, it is taken from the provider configuration.

Condition InstanceIAMBindingCondition: ) An IAM Condition for a given binding. Structure is documented below.
Etag string: (Computed) The etag of the IAM policy.
InstanceName string: Used to find the parent resource to bind the IAM policy to
Members []string
Project string: The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
Role string: The role that should be applied. Only one gcp.compute.InstanceIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
Zone string: 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 zone is provided in the parent identifier and no zone is specified, it is taken from the provider configuration.

condition InstanceIAMBindingCondition: ) An IAM Condition for a given binding. Structure is documented below.
etag string: (Computed) The etag of the IAM policy.
instanceName string: Used to find the parent resource to bind the IAM policy to
members string[]
project string: The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
role string: The role that should be applied. Only one gcp.compute.InstanceIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
zone string: 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 zone is provided in the parent identifier and no zone is specified, it is taken from the provider configuration.

condition Dict[InstanceIAMBindingCondition]: ) An IAM Condition for a given binding. Structure is documented below.
etag str: (Computed) The etag of the IAM policy.
instance_name str: Used to find the parent resource to bind the IAM policy to
members List[str]
project str: The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
role str: The role that should be applied. Only one gcp.compute.InstanceIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
zone str: 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 zone is provided in the parent identifier and no zone is specified, it is taken from the provider configuration.

Supporting Types

InstanceIAMBindingCondition

See the input and output API doc for this type.

Expression string: Textual representation of an expression in Common Expression Language syntax.
Title string: A title for the expression, i.e. a short string describing its purpose.
Description string: An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

Expression string: Textual representation of an expression in Common Expression Language syntax.
Title string: A title for the expression, i.e. a short string describing its purpose.
Description string: An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

expression string: Textual representation of an expression in Common Expression Language syntax.
title string: A title for the expression, i.e. a short string describing its purpose.
description string: An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

expression str: Textual representation of an expression in Common Expression Language syntax.
title str: A title for the expression, i.e. a short string describing its purpose.
description str: An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud