KeyRingIAMBinding

Three different resources help you manage your IAM policy for KMS key ring. Each of these resources serves a different use case:

gcp.kms.KeyRingIAMPolicy: Authoritative. Sets the IAM policy for the key ring and replaces any existing policy already attached.
gcp.kms.KeyRingIAMBinding: 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 key ring are preserved.
gcp.kms.KeyRingIAMMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the key ring are preserved.

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

Create a KeyRingIAMBinding Resource

new KeyRingIAMBinding(name: string, args: KeyRingIAMBindingArgs, opts?: CustomResourceOptions);

def KeyRingIAMBinding(resource_name, opts=None, condition=None, key_ring_id=None, members=None, role=None, __props__=None);

func NewKeyRingIAMBinding(ctx *Context, name string, args KeyRingIAMBindingArgs, opts ...ResourceOption) (*KeyRingIAMBinding, error)

public KeyRingIAMBinding(string name, KeyRingIAMBindingArgs args, CustomResourceOptions? opts = null)

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

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

KeyRingIAMBinding Resource Properties

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

Inputs

The KeyRingIAMBinding resource accepts the following input properties:

KeyRingId string: The key ring ID, in the form {project_id}/{location_name}/{key_ring_name} or {location_name}/{key_ring_name}. In the second form, the provider’s project setting will be used as a fallback.
Members List<string>
Role string: The role that should be applied. Only one gcp.kms.KeyRingIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
Condition KeyRingIAMBindingConditionArgs: An IAM Condition for a given binding. Structure is documented below.

KeyRingId string: The key ring ID, in the form {project_id}/{location_name}/{key_ring_name} or {location_name}/{key_ring_name}. In the second form, the provider’s project setting will be used as a fallback.
Members []string
Role string: The role that should be applied. Only one gcp.kms.KeyRingIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
Condition KeyRingIAMBindingCondition: An IAM Condition for a given binding. Structure is documented below.

keyRingId string: The key ring ID, in the form {project_id}/{location_name}/{key_ring_name} or {location_name}/{key_ring_name}. In the second form, the provider’s project setting will be used as a fallback.
members string[]
role string: The role that should be applied. Only one gcp.kms.KeyRingIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
condition KeyRingIAMBindingCondition: An IAM Condition for a given binding. Structure is documented below.

key_ring_id str: The key ring ID, in the form {project_id}/{location_name}/{key_ring_name} or {location_name}/{key_ring_name}. In the second form, the provider’s project setting will be used as a fallback.
members List[str]
role str: The role that should be applied. Only one gcp.kms.KeyRingIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
condition Dict[KeyRingIAMBindingCondition]: An IAM Condition for a given binding. Structure is documented below.

Outputs

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

Etag string: (Computed) The etag of the key ring’s IAM policy.
Id string: The provider-assigned unique ID for this managed resource.

Etag string: (Computed) The etag of the key ring’s IAM policy.
Id string: The provider-assigned unique ID for this managed resource.

etag string: (Computed) The etag of the key ring’s IAM policy.
id string: The provider-assigned unique ID for this managed resource.

etag str: (Computed) The etag of the key ring’s IAM policy.
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing KeyRingIAMBinding Resource

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

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

func GetKeyRingIAMBinding(ctx *Context, name string, id IDInput, state *KeyRingIAMBindingState, opts ...ResourceOption) (*KeyRingIAMBinding, error)

public static KeyRingIAMBinding Get(string name, Input<string> id, KeyRingIAMBindingState? 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 KeyRingIAMBindingConditionArgs: An IAM Condition for a given binding. Structure is documented below.
Etag string: (Computed) The etag of the key ring’s IAM policy.
KeyRingId string: The key ring ID, in the form {project_id}/{location_name}/{key_ring_name} or {location_name}/{key_ring_name}. In the second form, the provider’s project setting will be used as a fallback.
Members List<string>
Role string: The role that should be applied. Only one gcp.kms.KeyRingIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

Condition KeyRingIAMBindingCondition: An IAM Condition for a given binding. Structure is documented below.
Etag string: (Computed) The etag of the key ring’s IAM policy.
KeyRingId string: The key ring ID, in the form {project_id}/{location_name}/{key_ring_name} or {location_name}/{key_ring_name}. In the second form, the provider’s project setting will be used as a fallback.
Members []string
Role string: The role that should be applied. Only one gcp.kms.KeyRingIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

condition KeyRingIAMBindingCondition: An IAM Condition for a given binding. Structure is documented below.
etag string: (Computed) The etag of the key ring’s IAM policy.
keyRingId string: The key ring ID, in the form {project_id}/{location_name}/{key_ring_name} or {location_name}/{key_ring_name}. In the second form, the provider’s project setting will be used as a fallback.
members string[]
role string: The role that should be applied. Only one gcp.kms.KeyRingIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

condition Dict[KeyRingIAMBindingCondition]: An IAM Condition for a given binding. Structure is documented below.
etag str: (Computed) The etag of the key ring’s IAM policy.
key_ring_id str: The key ring ID, in the form {project_id}/{location_name}/{key_ring_name} or {location_name}/{key_ring_name}. In the second form, the provider’s project setting will be used as a fallback.
members List[str]
role str: The role that should be applied. Only one gcp.kms.KeyRingIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

Supporting Types

KeyRingIAMBindingCondition

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