CryptoKeyIAMBinding

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

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

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

With IAM Conditions:

Create a CryptoKeyIAMBinding Resource

new CryptoKeyIAMBinding(name: string, args: CryptoKeyIAMBindingArgs, opts?: CustomResourceOptions);

def CryptoKeyIAMBinding(resource_name, opts=None, condition=None, crypto_key_id=None, members=None, role=None, __props__=None);

func NewCryptoKeyIAMBinding(ctx *Context, name string, args CryptoKeyIAMBindingArgs, opts ...ResourceOption) (*CryptoKeyIAMBinding, error)

public CryptoKeyIAMBinding(string name, CryptoKeyIAMBindingArgs args, CustomResourceOptions? opts = null)

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

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

CryptoKeyIAMBinding Resource Properties

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

Inputs

The CryptoKeyIAMBinding resource accepts the following input properties:

CryptoKeyId string: The crypto key ID, in the form {project_id}/{location_name}/{key_ring_name}/{crypto_key_name} or {location_name}/{key_ring_name}/{crypto_key_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. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
Condition CryptoKeyIAMBindingConditionArgs: An IAM Condition for a given binding. Structure is documented below.

CryptoKeyId string: The crypto key ID, in the form {project_id}/{location_name}/{key_ring_name}/{crypto_key_name} or {location_name}/{key_ring_name}/{crypto_key_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. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
Condition CryptoKeyIAMBindingCondition: An IAM Condition for a given binding. Structure is documented below.

cryptoKeyId string: The crypto key ID, in the form {project_id}/{location_name}/{key_ring_name}/{crypto_key_name} or {location_name}/{key_ring_name}/{crypto_key_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. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
condition CryptoKeyIAMBindingCondition: An IAM Condition for a given binding. Structure is documented below.

crypto_key_id str: The crypto key ID, in the form {project_id}/{location_name}/{key_ring_name}/{crypto_key_name} or {location_name}/{key_ring_name}/{crypto_key_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. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
condition Dict[CryptoKeyIAMBindingCondition]: An IAM Condition for a given binding. Structure is documented below.

Outputs

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

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

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

func GetCryptoKeyIAMBinding(ctx *Context, name string, id IDInput, state *CryptoKeyIAMBindingState, opts ...ResourceOption) (*CryptoKeyIAMBinding, error)

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

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

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

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

Supporting Types

CryptoKeyIAMBindingCondition

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