CryptoKeyIAMMember
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.CryptoKeyIAMPolicycannot be used in conjunction withgcp.kms.CryptoKeyIAMBindingandgcp.kms.CryptoKeyIAMMemberor they will fight over what your policy should be.Note:
gcp.kms.CryptoKeyIAMBindingresources can be used in conjunction withgcp.kms.CryptoKeyIAMMemberresources only if they do not grant privilege to the same role.
With IAM Conditions:
With IAM Conditions:
With IAM Conditions:
Create a CryptoKeyIAMMember Resource
new CryptoKeyIAMMember(name: string, args: CryptoKeyIAMMemberArgs, opts?: CustomResourceOptions);def CryptoKeyIAMMember(resource_name, opts=None, condition=None, crypto_key_id=None, member=None, role=None, __props__=None);func NewCryptoKeyIAMMember(ctx *Context, name string, args CryptoKeyIAMMemberArgs, opts ...ResourceOption) (*CryptoKeyIAMMember, error)public CryptoKeyIAMMember(string name, CryptoKeyIAMMemberArgs args, CustomResourceOptions? opts = null)- name string
- The unique name of the resource.
- args CryptoKeyIAMMemberArgs
- 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 CryptoKeyIAMMemberArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CryptoKeyIAMMemberArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
CryptoKeyIAMMember Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The CryptoKeyIAMMember resource accepts the following input properties:
- Crypto
Key stringId 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.- Member 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
Crypto
Key IAMMember Condition Args An IAM Condition for a given binding. Structure is documented below.
- Crypto
Key stringId 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.- Member 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
Crypto
Key IAMMember Condition An IAM Condition for a given binding. Structure is documented below.
- crypto
Key stringId 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.- member 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
Crypto
Key IAMMember Condition An IAM Condition for a given binding. Structure is documented below.
- crypto_
key_ strid 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.- member 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[Crypto
Key IAMMember Condition] An IAM Condition for a given binding. Structure is documented below.
Outputs
All input properties are implicitly available as output properties. Additionally, the CryptoKeyIAMMember resource produces the following output properties:
Look up an Existing CryptoKeyIAMMember Resource
Get an existing CryptoKeyIAMMember 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?: CryptoKeyIAMMemberState, opts?: CustomResourceOptions): CryptoKeyIAMMemberstatic get(resource_name, id, opts=None, condition=None, crypto_key_id=None, etag=None, member=None, role=None, __props__=None);func GetCryptoKeyIAMMember(ctx *Context, name string, id IDInput, state *CryptoKeyIAMMemberState, opts ...ResourceOption) (*CryptoKeyIAMMember, error)public static CryptoKeyIAMMember Get(string name, Input<string> id, CryptoKeyIAMMemberState? 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
Crypto
Key IAMMember Condition Args An IAM Condition for a given binding. Structure is documented below.
- Crypto
Key stringId 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.
- Member 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
Crypto
Key IAMMember Condition An IAM Condition for a given binding. Structure is documented below.
- Crypto
Key stringId 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.
- Member 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
Crypto
Key IAMMember Condition An IAM Condition for a given binding. Structure is documented below.
- crypto
Key stringId 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.
- member 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[Crypto
Key IAMMember Condition] An IAM Condition for a given binding. Structure is documented below.
- crypto_
key_ strid 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.
- member 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
CryptoKeyIAMMemberCondition
- 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-betaTerraform Provider.