Google Cloud (GCP) Classic

v6.38.0 published on Thursday, Sep 22, 2022 by Pulumi

ConsumersIamBinding

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

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

Note: gcp.endpoints.ConsumersIamPolicy cannot be used in conjunction with gcp.endpoints.ConsumersIamBinding and gcp.endpoints.ConsumersIamMember or they will fight over what your policy should be.

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

Create a ConsumersIamBinding Resource

new ConsumersIamBinding(name: string, args: ConsumersIamBindingArgs, opts?: CustomResourceOptions);
@overload
def ConsumersIamBinding(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        condition: Optional[ConsumersIamBindingConditionArgs] = None,
                        consumer_project: Optional[str] = None,
                        members: Optional[Sequence[str]] = None,
                        role: Optional[str] = None,
                        service_name: Optional[str] = None)
@overload
def ConsumersIamBinding(resource_name: str,
                        args: ConsumersIamBindingArgs,
                        opts: Optional[ResourceOptions] = None)
func NewConsumersIamBinding(ctx *Context, name string, args ConsumersIamBindingArgs, opts ...ResourceOption) (*ConsumersIamBinding, error)
public ConsumersIamBinding(string name, ConsumersIamBindingArgs args, CustomResourceOptions? opts = null)
public ConsumersIamBinding(String name, ConsumersIamBindingArgs args)
public ConsumersIamBinding(String name, ConsumersIamBindingArgs args, CustomResourceOptions options)
type: gcp:endpoints:ConsumersIamBinding
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args ConsumersIamBindingArgs
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 ConsumersIamBindingArgs
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 ConsumersIamBindingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ConsumersIamBindingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ConsumersIamBindingArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

ConsumersIamBinding Resource Properties

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

Inputs

The ConsumersIamBinding resource accepts the following input properties:

ConsumerProject string
Members List<string>
Role string

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

ServiceName string
Condition ConsumersIamBindingConditionArgs
ConsumerProject string
Members []string
Role string

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

ServiceName string
Condition ConsumersIamBindingConditionArgs
consumerProject String
members List<String>
role String

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

serviceName String
condition ConsumersIamBindingConditionArgs
consumerProject string
members string[]
role string

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

serviceName string
condition ConsumersIamBindingConditionArgs
consumer_project str
members Sequence[str]
role str

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

service_name str
condition ConsumersIamBindingConditionArgs
consumerProject String
members List<String>
role String

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

serviceName String
condition Property Map

Outputs

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

etag String

(Computed) The etag of the IAM policy.

id String

The provider-assigned unique ID for this managed resource.

Look up an Existing ConsumersIamBinding Resource

Get an existing ConsumersIamBinding 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?: ConsumersIamBindingState, opts?: CustomResourceOptions): ConsumersIamBinding
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        condition: Optional[ConsumersIamBindingConditionArgs] = None,
        consumer_project: Optional[str] = None,
        etag: Optional[str] = None,
        members: Optional[Sequence[str]] = None,
        role: Optional[str] = None,
        service_name: Optional[str] = None) -> ConsumersIamBinding
func GetConsumersIamBinding(ctx *Context, name string, id IDInput, state *ConsumersIamBindingState, opts ...ResourceOption) (*ConsumersIamBinding, error)
public static ConsumersIamBinding Get(string name, Input<string> id, ConsumersIamBindingState? state, CustomResourceOptions? opts = null)
public static ConsumersIamBinding get(String name, Output<String> id, ConsumersIamBindingState 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.
The following state arguments are supported:
Condition ConsumersIamBindingConditionArgs
ConsumerProject string
Etag string

(Computed) The etag of the IAM policy.

Members List<string>
Role string

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

ServiceName string
Condition ConsumersIamBindingConditionArgs
ConsumerProject string
Etag string

(Computed) The etag of the IAM policy.

Members []string
Role string

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

ServiceName string
condition ConsumersIamBindingConditionArgs
consumerProject String
etag String

(Computed) The etag of the IAM policy.

members List<String>
role String

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

serviceName String
condition ConsumersIamBindingConditionArgs
consumerProject string
etag string

(Computed) The etag of the IAM policy.

members string[]
role string

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

serviceName string
condition ConsumersIamBindingConditionArgs
consumer_project str
etag str

(Computed) The etag of the IAM policy.

members Sequence[str]
role str

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

service_name str
condition Property Map
consumerProject String
etag String

(Computed) The etag of the IAM policy.

members List<String>
role String

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

serviceName String

Supporting Types

ConsumersIamBindingCondition

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 String
title String
description String

Import

For all import syntaxes, the “resource in question” can take any of the following forms* services/{{service_name}}/consumers/{{consumer_project}} * {{service_name}}/{{consumer_project}} * {{consumer_project}} Any variables not passed in the import command will be taken from the provider configuration. Cloud Endpoints serviceconsumers IAM resources can be imported using the resource identifiers, role, and member. IAM member imports use space-delimited identifiersthe resource in question, the role, and the member identity, e.g.

 $ pulumi import gcp:endpoints/consumersIamBinding:ConsumersIamBinding editor "services/{{service_name}}/consumers/{{consumer_project}} roles/servicemanagement.serviceController user:jane@example.com"

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

 $ pulumi import gcp:endpoints/consumersIamBinding:ConsumersIamBinding editor "services/{{service_name}}/consumers/{{consumer_project}} roles/servicemanagement.serviceController"

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

 $ pulumi import gcp:endpoints/consumersIamBinding:ConsumersIamBinding editor services/{{service_name}}/consumers/{{consumer_project}}

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

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.