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