1. Docs
  2. Reference
  3. API
  4. GCP
  5. kms
  6. CryptoKeyIAMPolicy

CryptoKeyIAMPolicy

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:

With IAM Conditions:

With IAM Conditions:

Create a CryptoKeyIAMPolicy Resource

new CryptoKeyIAMPolicy(name: string, args: CryptoKeyIAMPolicyArgs, opts?: CustomResourceOptions);
def CryptoKeyIAMPolicy(resource_name, opts=None, crypto_key_id=None, policy_data=None, __props__=None);
func NewCryptoKeyIAMPolicy(ctx *Context, name string, args CryptoKeyIAMPolicyArgs, opts ...ResourceOption) (*CryptoKeyIAMPolicy, error)
public CryptoKeyIAMPolicy(string name, CryptoKeyIAMPolicyArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args CryptoKeyIAMPolicyArgs
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 CryptoKeyIAMPolicyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args CryptoKeyIAMPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

CryptoKeyIAMPolicy Resource Properties

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

Inputs

The CryptoKeyIAMPolicy 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.

PolicyData string

The policy data generated by a gcp.organizations.getIAMPolicy data source.

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.

PolicyData string

The policy data generated by a gcp.organizations.getIAMPolicy data source.

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.

policyData string

The policy data generated by a gcp.organizations.getIAMPolicy data source.

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.

policy_data str

The policy data generated by a gcp.organizations.getIAMPolicy data source.

Outputs

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

Get an existing CryptoKeyIAMPolicy 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?: CryptoKeyIAMPolicyState, opts?: CustomResourceOptions): CryptoKeyIAMPolicy
static get(resource_name, id, opts=None, crypto_key_id=None, etag=None, policy_data=None, __props__=None);
func GetCryptoKeyIAMPolicy(ctx *Context, name string, id IDInput, state *CryptoKeyIAMPolicyState, opts ...ResourceOption) (*CryptoKeyIAMPolicy, error)
public static CryptoKeyIAMPolicy Get(string name, Input<string> id, CryptoKeyIAMPolicyState? 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:

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.

PolicyData string

The policy data generated by a gcp.organizations.getIAMPolicy data source.

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.

PolicyData string

The policy data generated by a gcp.organizations.getIAMPolicy data source.

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.

policyData string

The policy data generated by a gcp.organizations.getIAMPolicy data source.

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.

policy_data str

The policy data generated by a gcp.organizations.getIAMPolicy data source.

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.