KeyRingIAMPolicy

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 KeyRingIAMPolicy Resource

new KeyRingIAMPolicy(name: string, args: KeyRingIAMPolicyArgs, opts?: CustomResourceOptions);

def KeyRingIAMPolicy(resource_name, opts=None, key_ring_id=None, policy_data=None, __props__=None);

func NewKeyRingIAMPolicy(ctx *Context, name string, args KeyRingIAMPolicyArgs, opts ...ResourceOption) (*KeyRingIAMPolicy, error)

public KeyRingIAMPolicy(string name, KeyRingIAMPolicyArgs args, CustomResourceOptions? opts = null)

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

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

KeyRingIAMPolicy Resource Properties

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

Inputs

The KeyRingIAMPolicy 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.
PolicyData string: The policy data generated by a gcp.organizations.getIAMPolicy data source.

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.
PolicyData string: The policy data generated by a gcp.organizations.getIAMPolicy data source.

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.
policyData string: The policy data generated by a gcp.organizations.getIAMPolicy data source.

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.
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 KeyRingIAMPolicy 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 KeyRingIAMPolicy Resource

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

static get(resource_name, id, opts=None, etag=None, key_ring_id=None, policy_data=None, __props__=None);

func GetKeyRingIAMPolicy(ctx *Context, name string, id IDInput, state *KeyRingIAMPolicyState, opts ...ResourceOption) (*KeyRingIAMPolicy, error)

public static KeyRingIAMPolicy Get(string name, Input<string> id, KeyRingIAMPolicyState? 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:

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.
PolicyData string: The policy data generated by a gcp.organizations.getIAMPolicy data source.

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.
PolicyData string: The policy data generated by a gcp.organizations.getIAMPolicy data source.

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.
policyData string: The policy data generated by a gcp.organizations.getIAMPolicy data source.

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud