ServiceIamBinding

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

  • gcp.endpoints.ServiceIamPolicy: Authoritative. Sets the IAM policy for the service and replaces any existing policy already attached.
  • gcp.endpoints.ServiceIamBinding: 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 service are preserved.
  • gcp.endpoints.ServiceIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the service are preserved.

Note: gcp.endpoints.ServiceIamPolicy cannot be used in conjunction with gcp.endpoints.ServiceIamBinding and gcp.endpoints.ServiceIamMember or they will fight over what your policy should be.

Note: gcp.endpoints.ServiceIamBinding resources can be used in conjunction with gcp.endpoints.ServiceIamMember resources only if they do not grant privilege to the same role.

Create a ServiceIamBinding Resource

def ServiceIamBinding(resource_name, opts=None, condition=None, members=None, role=None, service_name=None, __props__=None);
name string
The unique name of the resource.
args ServiceIamBindingArgs
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 ServiceIamBindingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ServiceIamBindingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

ServiceIamBinding Resource Properties

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

Inputs

The ServiceIamBinding resource accepts the following input properties:

Members List<string>
Role string

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

ServiceName string

The name of the service. Used to find the parent resource to bind the IAM policy to

Condition ServiceIamBindingConditionArgs
Members []string
Role string

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

ServiceName string

The name of the service. Used to find the parent resource to bind the IAM policy to

Condition ServiceIamBindingCondition
members string[]
role string

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

serviceName string

The name of the service. Used to find the parent resource to bind the IAM policy to

condition ServiceIamBindingCondition
members List[str]
role str

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

service_name str

The name of the service. Used to find the parent resource to bind the IAM policy to

condition Dict[ServiceIamBindingCondition]

Outputs

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

Get an existing ServiceIamBinding 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?: ServiceIamBindingState, opts?: CustomResourceOptions): ServiceIamBinding
static get(resource_name, id, opts=None, condition=None, etag=None, members=None, role=None, service_name=None, __props__=None);
func GetServiceIamBinding(ctx *Context, name string, id IDInput, state *ServiceIamBindingState, opts ...ResourceOption) (*ServiceIamBinding, error)
public static ServiceIamBinding Get(string name, Input<string> id, ServiceIamBindingState? 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 ServiceIamBindingConditionArgs
Etag string

(Computed) The etag of the IAM policy.

Members List<string>
Role string

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

ServiceName string

The name of the service. Used to find the parent resource to bind the IAM policy to

Condition ServiceIamBindingCondition
Etag string

(Computed) The etag of the IAM policy.

Members []string
Role string

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

ServiceName string

The name of the service. Used to find the parent resource to bind the IAM policy to

condition ServiceIamBindingCondition
etag string

(Computed) The etag of the IAM policy.

members string[]
role string

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

serviceName string

The name of the service. Used to find the parent resource to bind the IAM policy to

condition Dict[ServiceIamBindingCondition]
etag str

(Computed) The etag of the IAM policy.

members List[str]
role str

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

service_name str

The name of the service. Used to find the parent resource to bind the IAM policy to

Supporting Types

ServiceIamBindingCondition

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
Title string
Description string
Expression string
Title string
Description string
expression string
title string
description string
expression str
title str
description str

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.