IAMMember

Four different resources help you manage your IAM policy for a project. Each of these resources serves a different use case:

  • gcp.projects.IAMPolicy: Authoritative. Sets the IAM policy for the project and replaces any existing policy already attached.
  • gcp.projects.IAMBinding: 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 project are preserved.
  • gcp.projects.IAMMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the project are preserved.
  • gcp.projects.IAMAuditConfig: Authoritative for a given service. Updates the IAM policy to enable audit logging for the given service.

Note: gcp.projects.IAMPolicy cannot be used in conjunction with gcp.projects.IAMBinding, gcp.projects.IAMMember, or gcp.projects.IAMAuditConfig or they will fight over what your policy should be.

Note: gcp.projects.IAMBinding resources can be used in conjunction with gcp.projects.IAMMember resources only if they do not grant privilege to the same role.

Create a IAMMember Resource

def IAMMember(resource_name, opts=None, condition=None, member=None, project=None, role=None, __props__=None);
func NewIAMMember(ctx *Context, name string, args IAMMemberArgs, opts ...ResourceOption) (*IAMMember, error)
public IAMMember(string name, IAMMemberArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args IAMMemberArgs
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 IAMMemberArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args IAMMemberArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

IAMMember Resource Properties

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

Inputs

The IAMMember resource accepts the following input properties:

Member string
Role string

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

Condition IAMMemberConditionArgs

An IAM Condition for a given binding. Structure is documented below.

Project string

The project ID. If not specified for gcp.projects.IAMBinding, gcp.projects.IAMMember, or gcp.projects.IAMAuditConfig, uses the ID of the project configured with the provider. Required for gcp.projects.IAMPolicy - you must explicitly set the project, and it will not be inferred from the provider.

Member string
Role string

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

Condition IAMMemberCondition

An IAM Condition for a given binding. Structure is documented below.

Project string

The project ID. If not specified for gcp.projects.IAMBinding, gcp.projects.IAMMember, or gcp.projects.IAMAuditConfig, uses the ID of the project configured with the provider. Required for gcp.projects.IAMPolicy - you must explicitly set the project, and it will not be inferred from the provider.

member string
role string

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

condition IAMMemberCondition

An IAM Condition for a given binding. Structure is documented below.

project string

The project ID. If not specified for gcp.projects.IAMBinding, gcp.projects.IAMMember, or gcp.projects.IAMAuditConfig, uses the ID of the project configured with the provider. Required for gcp.projects.IAMPolicy - you must explicitly set the project, and it will not be inferred from the provider.

member str
role str

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

condition Dict[IAMMemberCondition]

An IAM Condition for a given binding. Structure is documented below.

project str

The project ID. If not specified for gcp.projects.IAMBinding, gcp.projects.IAMMember, or gcp.projects.IAMAuditConfig, uses the ID of the project configured with the provider. Required for gcp.projects.IAMPolicy - you must explicitly set the project, and it will not be inferred from the provider.

Outputs

All input properties are implicitly available as output properties. Additionally, the IAMMember resource produces the following output properties:

Etag string

(Computed) The etag of the project’s IAM policy.

Id string
The provider-assigned unique ID for this managed resource.
Etag string

(Computed) The etag of the project’s IAM policy.

Id string
The provider-assigned unique ID for this managed resource.
etag string

(Computed) The etag of the project’s IAM policy.

id string
The provider-assigned unique ID for this managed resource.
etag str

(Computed) The etag of the project’s IAM policy.

id str
The provider-assigned unique ID for this managed resource.

Look up an Existing IAMMember Resource

Get an existing IAMMember 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?: IAMMemberState, opts?: CustomResourceOptions): IAMMember
static get(resource_name, id, opts=None, condition=None, etag=None, member=None, project=None, role=None, __props__=None);
func GetIAMMember(ctx *Context, name string, id IDInput, state *IAMMemberState, opts ...ResourceOption) (*IAMMember, error)
public static IAMMember Get(string name, Input<string> id, IAMMemberState? 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 IAMMemberConditionArgs

An IAM Condition for a given binding. Structure is documented below.

Etag string

(Computed) The etag of the project’s IAM policy.

Member string
Project string

The project ID. If not specified for gcp.projects.IAMBinding, gcp.projects.IAMMember, or gcp.projects.IAMAuditConfig, uses the ID of the project configured with the provider. Required for gcp.projects.IAMPolicy - you must explicitly set the project, and it will not be inferred from the provider.

Role string

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

Condition IAMMemberCondition

An IAM Condition for a given binding. Structure is documented below.

Etag string

(Computed) The etag of the project’s IAM policy.

Member string
Project string

The project ID. If not specified for gcp.projects.IAMBinding, gcp.projects.IAMMember, or gcp.projects.IAMAuditConfig, uses the ID of the project configured with the provider. Required for gcp.projects.IAMPolicy - you must explicitly set the project, and it will not be inferred from the provider.

Role string

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

condition IAMMemberCondition

An IAM Condition for a given binding. Structure is documented below.

etag string

(Computed) The etag of the project’s IAM policy.

member string
project string

The project ID. If not specified for gcp.projects.IAMBinding, gcp.projects.IAMMember, or gcp.projects.IAMAuditConfig, uses the ID of the project configured with the provider. Required for gcp.projects.IAMPolicy - you must explicitly set the project, and it will not be inferred from the provider.

role string

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

condition Dict[IAMMemberCondition]

An IAM Condition for a given binding. Structure is documented below.

etag str

(Computed) The etag of the project’s IAM policy.

member str
project str

The project ID. If not specified for gcp.projects.IAMBinding, gcp.projects.IAMMember, or gcp.projects.IAMAuditConfig, uses the ID of the project configured with the provider. Required for gcp.projects.IAMPolicy - you must explicitly set the project, and it will not be inferred from the provider.

role str

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

Supporting Types

IAMMemberCondition

See the input and output API doc for this type.

See the input and output API doc for this type.

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.