InstanceIAMMember
Three different resources help you manage your IAM policy for a Spanner instance. Each of these resources serves a different use case:
gcp.spanner.InstanceIAMPolicy: Authoritative. Sets the IAM policy for the instance and replaces any existing policy already attached.
Warning: It’s entirely possibly to lock yourself out of your instance using
gcp.spanner.InstanceIAMPolicy. Any permissions granted by default will be removed unless you include them in your config.
gcp.spanner.InstanceIAMBinding: 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 instance are preserved.gcp.spanner.InstanceIAMMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the instance are preserved.
Note:
gcp.spanner.InstanceIAMPolicycannot be used in conjunction withgcp.spanner.InstanceIAMBindingandgcp.spanner.InstanceIAMMemberor they will fight over what your policy should be.Note:
gcp.spanner.InstanceIAMBindingresources can be used in conjunction withgcp.spanner.InstanceIAMMemberresources only if they do not grant privilege to the same role.
Create a InstanceIAMMember Resource
new InstanceIAMMember(name: string, args: InstanceIAMMemberArgs, opts?: CustomResourceOptions);def InstanceIAMMember(resource_name, opts=None, condition=None, instance=None, member=None, project=None, role=None, __props__=None);func NewInstanceIAMMember(ctx *Context, name string, args InstanceIAMMemberArgs, opts ...ResourceOption) (*InstanceIAMMember, error)public InstanceIAMMember(string name, InstanceIAMMemberArgs args, CustomResourceOptions? opts = null)- name string
- The unique name of the resource.
- args InstanceIAMMemberArgs
- 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 InstanceIAMMemberArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args InstanceIAMMemberArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
InstanceIAMMember Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The InstanceIAMMember resource accepts the following input properties:
- Instance string
The name of the instance.
- Member string
- Role string
The role that should be applied. Only one
gcp.spanner.InstanceIAMBindingcan be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}.- Condition
Instance
IAMMember Condition Args - Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Instance string
The name of the instance.
- Member string
- Role string
The role that should be applied. Only one
gcp.spanner.InstanceIAMBindingcan be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}.- Condition
Instance
IAMMember Condition - Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- instance string
The name of the instance.
- member string
- role string
The role that should be applied. Only one
gcp.spanner.InstanceIAMBindingcan be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}.- condition
Instance
IAMMember Condition - project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- instance str
The name of the instance.
- member str
- role str
The role that should be applied. Only one
gcp.spanner.InstanceIAMBindingcan be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}.- condition
Dict[Instance
IAMMember Condition] - project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Outputs
All input properties are implicitly available as output properties. Additionally, the InstanceIAMMember resource produces the following output properties:
Look up an Existing InstanceIAMMember Resource
Get an existing InstanceIAMMember 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?: InstanceIAMMemberState, opts?: CustomResourceOptions): InstanceIAMMemberstatic get(resource_name, id, opts=None, condition=None, etag=None, instance=None, member=None, project=None, role=None, __props__=None);func GetInstanceIAMMember(ctx *Context, name string, id IDInput, state *InstanceIAMMemberState, opts ...ResourceOption) (*InstanceIAMMember, error)public static InstanceIAMMember Get(string name, Input<string> id, InstanceIAMMemberState? 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
Instance
IAMMember Condition Args - Etag string
(Computed) The etag of the instance’s IAM policy.
- Instance string
The name of the instance.
- Member string
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Role string
The role that should be applied. Only one
gcp.spanner.InstanceIAMBindingcan be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}.
- Condition
Instance
IAMMember Condition - Etag string
(Computed) The etag of the instance’s IAM policy.
- Instance string
The name of the instance.
- Member string
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Role string
The role that should be applied. Only one
gcp.spanner.InstanceIAMBindingcan be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}.
- condition
Instance
IAMMember Condition - etag string
(Computed) The etag of the instance’s IAM policy.
- instance string
The name of the instance.
- member string
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- role string
The role that should be applied. Only one
gcp.spanner.InstanceIAMBindingcan be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}.
- condition
Dict[Instance
IAMMember Condition] - etag str
(Computed) The etag of the instance’s IAM policy.
- instance str
The name of the instance.
- member str
- project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- role str
The role that should be applied. Only one
gcp.spanner.InstanceIAMBindingcan be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}.
Supporting Types
InstanceIAMMemberCondition
Package Details
- Repository
- https://github.com/pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-betaTerraform Provider.