1. Docs
  2. Reference
  3. API
  4. GCP
  5. spanner
  6. InstanceIAMPolicy

InstanceIAMPolicy

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.InstanceIAMPolicy cannot be used in conjunction with gcp.spanner.InstanceIAMBinding and gcp.spanner.InstanceIAMMember or they will fight over what your policy should be.

Note: gcp.spanner.InstanceIAMBinding resources can be used in conjunction with gcp.spanner.InstanceIAMMember resources only if they do not grant privilege to the same role.

Create a InstanceIAMPolicy Resource

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

InstanceIAMPolicy Resource Properties

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

Inputs

The InstanceIAMPolicy resource accepts the following input properties:

Instance string

The name of the instance.

PolicyData string

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

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.

PolicyData string

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

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.

policyData string

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

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.

policy_data str

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

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 InstanceIAMPolicy resource produces the following output properties:

Etag string

(Computed) The etag of the instance’s IAM policy.

Id string
The provider-assigned unique ID for this managed resource.
Etag string

(Computed) The etag of the instance’s IAM policy.

Id string
The provider-assigned unique ID for this managed resource.
etag string

(Computed) The etag of the instance’s IAM policy.

id string
The provider-assigned unique ID for this managed resource.
etag str

(Computed) The etag of the instance’s IAM policy.

id str
The provider-assigned unique ID for this managed resource.

Look up an Existing InstanceIAMPolicy Resource

Get an existing InstanceIAMPolicy 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?: InstanceIAMPolicyState, opts?: CustomResourceOptions): InstanceIAMPolicy
static get(resource_name, id, opts=None, etag=None, instance=None, policy_data=None, project=None, __props__=None);
func GetInstanceIAMPolicy(ctx *Context, name string, id IDInput, state *InstanceIAMPolicyState, opts ...ResourceOption) (*InstanceIAMPolicy, error)
public static InstanceIAMPolicy Get(string name, Input<string> id, InstanceIAMPolicyState? 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 instance’s IAM policy.

Instance string

The name of the instance.

PolicyData string

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

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Etag string

(Computed) The etag of the instance’s IAM policy.

Instance string

The name of the instance.

PolicyData string

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

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

etag string

(Computed) The etag of the instance’s IAM policy.

instance string

The name of the instance.

policyData string

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

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

etag str

(Computed) The etag of the instance’s IAM policy.

instance str

The name of the instance.

policy_data str

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

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

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.