Module bigtable

This page documents the language specification for the gcp package. If you're looking for help working with the inputs, outputs, or functions of gcp resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

GCPolicy
Instance
InstanceIamBinding
InstanceIamMember
InstanceIamPolicy
Table

Resources

Resource GCPolicy

class GCPolicy extends CustomResource

Creates a Google Cloud Bigtable GC Policy inside a family. For more information see the official documentation and API.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const instance = new gcp.bigtable.Instance("instance", {cluster: [{
    clusterId: "tf-instance-cluster",
    zone: "us-central1-b",
    numNodes: 3,
    storageType: "HDD",
}]});
const table = new gcp.bigtable.Table("table", {
    instanceName: instance.name,
    column_family: [{
        family: "name",
    }],
});
const policy = new gcp.bigtable.GCPolicy("policy", {
    instanceName: instance.name,
    table: table.name,
    columnFamily: "name",
    max_age: [{
        days: 7,
    }],
});

constructor

new GCPolicy(name: string, args: GCPolicyArgs, opts?: pulumi.CustomResourceOptions)

Create a GCPolicy resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GCPolicyState, opts?: pulumi.CustomResourceOptions): GCPolicy

Get an existing GCPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is GCPolicy

Returns true if the given object is an instance of GCPolicy. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property columnFamily

public columnFamily: pulumi.Output<string>;

The name of the column family.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceName

public instanceName: pulumi.Output<string>;

The name of the Bigtable instance.

property maxAges

public maxAges: pulumi.Output<GCPolicyMaxAge[] | undefined>;

GC policy that applies to all cells older than the given age.

property maxVersions

public maxVersions: pulumi.Output<GCPolicyMaxVersion[] | undefined>;

GC policy that applies to all versions of a cell except for the most recent.

property mode

public mode: pulumi.Output<string | undefined>;

If multiple policies are set, you should choose between UNION OR INTERSECTION.

property project

public project: pulumi.Output<string>;

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

property table

public table: pulumi.Output<string>;

The name of the table.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Instance

class Instance extends CustomResource

Creates a Google Bigtable instance. For more information see the official documentation and API.

Example Usage - Production Instance

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const productionInstance = new gcp.bigtable.Instance("production-instance", {
    clusters: [{
        clusterId: "tf-instance-cluster",
        numNodes: 1,
        storageType: "HDD",
        zone: "us-central1-b",
    }],
});

Example Usage - Development Instance

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const developmentInstance = new gcp.bigtable.Instance("development-instance", {
    clusters: [{
        clusterId: "tf-instance-cluster",
        storageType: "HDD",
        zone: "us-central1-b",
    }],
    instanceType: "DEVELOPMENT",
});

constructor

new Instance(name: string, args?: InstanceArgs, opts?: pulumi.CustomResourceOptions)

Create a Instance resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: InstanceState, opts?: pulumi.CustomResourceOptions): Instance

Get an existing Instance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Instance

Returns true if the given object is an instance of Instance. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property clusters

public clusters: pulumi.Output<InstanceCluster[]>;

A block of cluster configuration options. This can be specified 1 or 2 times. See structure below.

property deletionProtection

public deletionProtection: pulumi.Output<boolean | undefined>;

Whether or not to allow this provider to destroy the instance. Unless this field is set to false in the statefile, a pulumi destroy or pulumi up that would delete the instance will fail.

property displayName

public displayName: pulumi.Output<string>;

The human-readable display name of the Bigtable instance. Defaults to the instance name.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceType

public instanceType: pulumi.Output<string | undefined>;

The instance type to create. One of "DEVELOPMENT" or "PRODUCTION". Defaults to "PRODUCTION".

property name

public name: pulumi.Output<string>;

The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance.

property project

public project: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource InstanceIamBinding

class InstanceIamBinding extends CustomResource

Three different resources help you manage IAM policies on bigtable instances. Each of these resources serves a different use case:

gcp.bigtable.InstanceIamPolicy: Authoritative. Sets the IAM policy for the instance and replaces any existing policy already attached.
gcp.bigtable.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.bigtable.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.bigtable.InstanceIamPolicy cannot be used in conjunction with gcp.bigtable.InstanceIamBinding and gcp.bigtable.InstanceIamMember or they will fight over what your policy should be. In addition, be careful not to accidentally unset ownership of the instance as gcp.bigtable.InstanceIamPolicy replaces the entire policy.
Note: gcp.bigtable.InstanceIamBinding resources can be used in conjunction with gcp.bigtable.InstanceIamMember resources only if they do not grant privilege to the same role.

google_bigtable_instance_iam_policy

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const admin = gcp.organizations.getIAMPolicy({
    binding: [{
        role: "roles/editor",
        members: ["user:jane@example.com"],
    }],
});
const editor = new gcp.bigtable.InstanceIamPolicy("editor", {
    project: "your-project",
    instance: "your-bigtable-instance",
    policyData: admin.then(admin => admin.policyData),
});

google_bigtable_instance_iam_binding

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const editor = new gcp.bigtable.InstanceIamBinding("editor", {
    instance: "your-bigtable-instance",
    members: ["user:jane@example.com"],
    role: "roles/editor",
});

google_bigtable_instance_iam_member

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const editor = new gcp.bigtable.InstanceIamMember("editor", {
    instance: "your-bigtable-instance",
    member: "user:jane@example.com",
    role: "roles/editor",
});

constructor

new InstanceIamBinding(name: string, args: InstanceIamBindingArgs, opts?: pulumi.CustomResourceOptions)

Create a InstanceIamBinding resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: InstanceIamBindingState, opts?: pulumi.CustomResourceOptions): InstanceIamBinding

Get an existing InstanceIamBinding resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is InstanceIamBinding

Returns true if the given object is an instance of InstanceIamBinding. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property condition

public condition: pulumi.Output<InstanceIamBindingCondition | undefined>;

property etag

public etag: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instance

public instance: pulumi.Output<string>;

The name or relative resource id of the instance to manage IAM policies for.

property members

public members: pulumi.Output<string[]>;

property project

public project: pulumi.Output<string>;

The project in which the instance belongs. If it is not provided, a default will be supplied.

property role

public role: pulumi.Output<string>;

The role that should be applied. Only one gcp.bigtable.InstanceIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource InstanceIamMember

class InstanceIamMember extends CustomResource

Three different resources help you manage IAM policies on bigtable instances. Each of these resources serves a different use case:

gcp.bigtable.InstanceIamPolicy: Authoritative. Sets the IAM policy for the instance and replaces any existing policy already attached.
gcp.bigtable.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.bigtable.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.bigtable.InstanceIamPolicy cannot be used in conjunction with gcp.bigtable.InstanceIamBinding and gcp.bigtable.InstanceIamMember or they will fight over what your policy should be. In addition, be careful not to accidentally unset ownership of the instance as gcp.bigtable.InstanceIamPolicy replaces the entire policy.
Note: gcp.bigtable.InstanceIamBinding resources can be used in conjunction with gcp.bigtable.InstanceIamMember resources only if they do not grant privilege to the same role.

google_bigtable_instance_iam_policy

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const admin = gcp.organizations.getIAMPolicy({
    binding: [{
        role: "roles/editor",
        members: ["user:jane@example.com"],
    }],
});
const editor = new gcp.bigtable.InstanceIamPolicy("editor", {
    project: "your-project",
    instance: "your-bigtable-instance",
    policyData: admin.then(admin => admin.policyData),
});

google_bigtable_instance_iam_binding

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const editor = new gcp.bigtable.InstanceIamBinding("editor", {
    instance: "your-bigtable-instance",
    members: ["user:jane@example.com"],
    role: "roles/editor",
});

google_bigtable_instance_iam_member

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const editor = new gcp.bigtable.InstanceIamMember("editor", {
    instance: "your-bigtable-instance",
    member: "user:jane@example.com",
    role: "roles/editor",
});

constructor

new InstanceIamMember(name: string, args: InstanceIamMemberArgs, opts?: pulumi.CustomResourceOptions)

Create a InstanceIamMember resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: InstanceIamMemberState, opts?: pulumi.CustomResourceOptions): InstanceIamMember

Get an existing InstanceIamMember resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is InstanceIamMember

Returns true if the given object is an instance of InstanceIamMember. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property condition

public condition: pulumi.Output<InstanceIamMemberCondition | undefined>;

property etag

public etag: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instance

public instance: pulumi.Output<string>;

The name or relative resource id of the instance to manage IAM policies for.

property member

public member: pulumi.Output<string>;

property project

public project: pulumi.Output<string>;

The project in which the instance belongs. If it is not provided, a default will be supplied.

property role

public role: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource InstanceIamPolicy

class InstanceIamPolicy extends CustomResource

Three different resources help you manage IAM policies on bigtable instances. Each of these resources serves a different use case:

gcp.bigtable.InstanceIamPolicy: Authoritative. Sets the IAM policy for the instance and replaces any existing policy already attached.
gcp.bigtable.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.bigtable.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.bigtable.InstanceIamPolicy cannot be used in conjunction with gcp.bigtable.InstanceIamBinding and gcp.bigtable.InstanceIamMember or they will fight over what your policy should be. In addition, be careful not to accidentally unset ownership of the instance as gcp.bigtable.InstanceIamPolicy replaces the entire policy.
Note: gcp.bigtable.InstanceIamBinding resources can be used in conjunction with gcp.bigtable.InstanceIamMember resources only if they do not grant privilege to the same role.

google_bigtable_instance_iam_policy

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const admin = gcp.organizations.getIAMPolicy({
    binding: [{
        role: "roles/editor",
        members: ["user:jane@example.com"],
    }],
});
const editor = new gcp.bigtable.InstanceIamPolicy("editor", {
    project: "your-project",
    instance: "your-bigtable-instance",
    policyData: admin.then(admin => admin.policyData),
});

google_bigtable_instance_iam_binding

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const editor = new gcp.bigtable.InstanceIamBinding("editor", {
    instance: "your-bigtable-instance",
    members: ["user:jane@example.com"],
    role: "roles/editor",
});

google_bigtable_instance_iam_member

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const editor = new gcp.bigtable.InstanceIamMember("editor", {
    instance: "your-bigtable-instance",
    member: "user:jane@example.com",
    role: "roles/editor",
});

constructor

new InstanceIamPolicy(name: string, args: InstanceIamPolicyArgs, opts?: pulumi.CustomResourceOptions)

Create a InstanceIamPolicy resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: InstanceIamPolicyState, opts?: pulumi.CustomResourceOptions): InstanceIamPolicy

Get an existing InstanceIamPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is InstanceIamPolicy

Returns true if the given object is an instance of InstanceIamPolicy. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property etag

public etag: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instance

public instance: pulumi.Output<string>;

The name or relative resource id of the instance to manage IAM policies for.

property policyData

public policyData: pulumi.Output<string>;

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

property project

public project: pulumi.Output<string>;

The project in which the instance belongs. If it is not provided, a default will be supplied.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Table

class Table extends CustomResource

Creates a Google Cloud Bigtable table inside an instance. For more information see the official documentation and API.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const instance = new gcp.bigtable.Instance("instance", {cluster: [{
    clusterId: "tf-instance-cluster",
    zone: "us-central1-b",
    numNodes: 3,
    storageType: "HDD",
}]});
const table = new gcp.bigtable.Table("table", {
    instanceName: instance.name,
    splitKeys: [
        "a",
        "b",
        "c",
    ],
});

constructor

new Table(name: string, args: TableArgs, opts?: pulumi.CustomResourceOptions)

Create a Table resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TableState, opts?: pulumi.CustomResourceOptions): Table

Get an existing Table resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Table

Returns true if the given object is an instance of Table. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property columnFamilies

public columnFamilies: pulumi.Output<TableColumnFamily[] | undefined>;

A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceName

public instanceName: pulumi.Output<string>;

The name of the Bigtable instance.

property name

public name: pulumi.Output<string>;

The name of the table.

property project

public project: pulumi.Output<string>;

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

property splitKeys

public splitKeys: pulumi.Output<string[] | undefined>;

A list of predefined keys to split the table on. !> Warning: Modifying the splitKeys of an existing table will cause the provider to delete/recreate the entire gcp.bigtable.Table resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface GCPolicyArgs

interface GCPolicyArgs

The set of arguments for constructing a GCPolicy resource.

property columnFamily

columnFamily: pulumi.Input<string>;

The name of the column family.

property instanceName

instanceName: pulumi.Input<string>;

The name of the Bigtable instance.

property maxAges

maxAges?: pulumi.Input<pulumi.Input<GCPolicyMaxAge>[]>;

GC policy that applies to all cells older than the given age.

property maxVersions

maxVersions?: pulumi.Input<pulumi.Input<GCPolicyMaxVersion>[]>;

GC policy that applies to all versions of a cell except for the most recent.

property mode

mode?: pulumi.Input<string>;

If multiple policies are set, you should choose between UNION OR INTERSECTION.

property project

project?: pulumi.Input<string>;

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

property table

table: pulumi.Input<string>;

The name of the table.

interface GCPolicyState

interface GCPolicyState

Input properties used for looking up and filtering GCPolicy resources.

property columnFamily

columnFamily?: pulumi.Input<string>;

The name of the column family.

property instanceName

instanceName?: pulumi.Input<string>;

The name of the Bigtable instance.

property maxAges

maxAges?: pulumi.Input<pulumi.Input<GCPolicyMaxAge>[]>;

GC policy that applies to all cells older than the given age.

property maxVersions

maxVersions?: pulumi.Input<pulumi.Input<GCPolicyMaxVersion>[]>;

GC policy that applies to all versions of a cell except for the most recent.

property mode

mode?: pulumi.Input<string>;

If multiple policies are set, you should choose between UNION OR INTERSECTION.

property project

project?: pulumi.Input<string>;

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

property table

table?: pulumi.Input<string>;

The name of the table.

interface InstanceArgs

interface InstanceArgs

The set of arguments for constructing a Instance resource.

property clusters

clusters?: pulumi.Input<pulumi.Input<InstanceCluster>[]>;

A block of cluster configuration options. This can be specified 1 or 2 times. See structure below.

property deletionProtection

deletionProtection?: pulumi.Input<boolean>;

Whether or not to allow this provider to destroy the instance. Unless this field is set to false in the statefile, a pulumi destroy or pulumi up that would delete the instance will fail.

property displayName

displayName?: pulumi.Input<string>;

The human-readable display name of the Bigtable instance. Defaults to the instance name.

property instanceType

instanceType?: pulumi.Input<string>;

The instance type to create. One of "DEVELOPMENT" or "PRODUCTION". Defaults to "PRODUCTION".

property name

name?: pulumi.Input<string>;

The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance.

property project

project?: pulumi.Input<string>;

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

interface InstanceIamBindingArgs

interface InstanceIamBindingArgs

The set of arguments for constructing a InstanceIamBinding resource.

property condition

condition?: pulumi.Input<InstanceIamBindingCondition>;

property instance

instance: pulumi.Input<string>;

The name or relative resource id of the instance to manage IAM policies for.

property members

members: pulumi.Input<pulumi.Input<string>[]>;

property project

project?: pulumi.Input<string>;

The project in which the instance belongs. If it is not provided, a default will be supplied.

property role

role: pulumi.Input<string>;

interface InstanceIamBindingState

interface InstanceIamBindingState

Input properties used for looking up and filtering InstanceIamBinding resources.

property condition

condition?: pulumi.Input<InstanceIamBindingCondition>;

property etag

etag?: pulumi.Input<string>;

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

property instance

instance?: pulumi.Input<string>;

The name or relative resource id of the instance to manage IAM policies for.

property members

members?: pulumi.Input<pulumi.Input<string>[]>;

property project

project?: pulumi.Input<string>;

The project in which the instance belongs. If it is not provided, a default will be supplied.

property role

role?: pulumi.Input<string>;

interface InstanceIamMemberArgs

interface InstanceIamMemberArgs

The set of arguments for constructing a InstanceIamMember resource.

property condition

condition?: pulumi.Input<InstanceIamMemberCondition>;

property instance

instance: pulumi.Input<string>;

The name or relative resource id of the instance to manage IAM policies for.

property member

member: pulumi.Input<string>;

property project

project?: pulumi.Input<string>;

The project in which the instance belongs. If it is not provided, a default will be supplied.

property role

role: pulumi.Input<string>;

interface InstanceIamMemberState

interface InstanceIamMemberState

Input properties used for looking up and filtering InstanceIamMember resources.

property condition

condition?: pulumi.Input<InstanceIamMemberCondition>;

property etag

etag?: pulumi.Input<string>;

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

property instance

instance?: pulumi.Input<string>;

The name or relative resource id of the instance to manage IAM policies for.

property member

member?: pulumi.Input<string>;

property project

project?: pulumi.Input<string>;

The project in which the instance belongs. If it is not provided, a default will be supplied.

property role

role?: pulumi.Input<string>;

interface InstanceIamPolicyArgs

interface InstanceIamPolicyArgs

The set of arguments for constructing a InstanceIamPolicy resource.

property instance

instance: pulumi.Input<string>;

The name or relative resource id of the instance to manage IAM policies for.

property policyData

policyData: pulumi.Input<string>;

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

property project

project?: pulumi.Input<string>;

The project in which the instance belongs. If it is not provided, a default will be supplied.

interface InstanceIamPolicyState

interface InstanceIamPolicyState

Input properties used for looking up and filtering InstanceIamPolicy resources.

property etag

etag?: pulumi.Input<string>;

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

property instance

instance?: pulumi.Input<string>;

The name or relative resource id of the instance to manage IAM policies for.

property policyData

policyData?: pulumi.Input<string>;

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

property project

project?: pulumi.Input<string>;

The project in which the instance belongs. If it is not provided, a default will be supplied.

interface InstanceState

interface InstanceState

Input properties used for looking up and filtering Instance resources.

property clusters

clusters?: pulumi.Input<pulumi.Input<InstanceCluster>[]>;

A block of cluster configuration options. This can be specified 1 or 2 times. See structure below.

property deletionProtection

deletionProtection?: pulumi.Input<boolean>;

Whether or not to allow this provider to destroy the instance. Unless this field is set to false in the statefile, a pulumi destroy or pulumi up that would delete the instance will fail.

property displayName

displayName?: pulumi.Input<string>;

The human-readable display name of the Bigtable instance. Defaults to the instance name.

property instanceType

instanceType?: pulumi.Input<string>;

The instance type to create. One of "DEVELOPMENT" or "PRODUCTION". Defaults to "PRODUCTION".

property name

name?: pulumi.Input<string>;

The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance.

property project

project?: pulumi.Input<string>;

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

interface TableArgs

interface TableArgs

The set of arguments for constructing a Table resource.

property columnFamilies

columnFamilies?: pulumi.Input<pulumi.Input<TableColumnFamily>[]>;

A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.

property instanceName

instanceName: pulumi.Input<string>;

The name of the Bigtable instance.

property name

name?: pulumi.Input<string>;

The name of the table.

property project

project?: pulumi.Input<string>;

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

property splitKeys

splitKeys?: pulumi.Input<pulumi.Input<string>[]>;

A list of predefined keys to split the table on. !> Warning: Modifying the splitKeys of an existing table will cause the provider to delete/recreate the entire gcp.bigtable.Table resource.

interface TableState

interface TableState

Input properties used for looking up and filtering Table resources.

property columnFamilies

columnFamilies?: pulumi.Input<pulumi.Input<TableColumnFamily>[]>;

A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.

property instanceName

instanceName?: pulumi.Input<string>;

The name of the Bigtable instance.

property name

name?: pulumi.Input<string>;

The name of the table.

property project

project?: pulumi.Input<string>;

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

property splitKeys

splitKeys?: pulumi.Input<pulumi.Input<string>[]>;

A list of predefined keys to split the table on. !> Warning: Modifying the splitKeys of an existing table will cause the provider to delete/recreate the entire gcp.bigtable.Table resource.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module bigtable

Resources

Others

Resources

Example Usage

Example Usage - Production Instance

Example Usage - Development Instance

google_bigtable_instance_iam_policy

google_bigtable_instance_iam_binding

google_bigtable_instance_iam_member

google_bigtable_instance_iam_policy

google_bigtable_instance_iam_binding

google_bigtable_instance_iam_member

google_bigtable_instance_iam_policy

google_bigtable_instance_iam_binding

google_bigtable_instance_iam_member

Example Usage

Others