Module bigtable

@pulumi/gcp > bigtable

Index

bigtable/instance.ts bigtable/table.ts

class Instance

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

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): 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

static isInstance(obj: any): boolean

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

property cluster

public cluster: pulumi.Output<{ ... } | undefined>;

A block of cluster configuration options. Either cluster or cluster_id must be used. Only one cluster may be specified. See structure below.

property clusterId

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

The ID of the Cloud Bigtable cluster.

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 of the Cloud Bigtable instance.

property numNodes

public numNodes: pulumi.Output<number | undefined>;

The number of nodes in your Cloud Bigtable cluster. Minimum of 3 for a PRODUCTION instance. Cannot be set for a DEVELOPMENT 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 storageType

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

The storage type to use. One of "SSD" or "HDD". Defaults to "SSD".

property urn

urn: Output<URN>;

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

property zone

public zone: pulumi.Output<string>;

The zone to create the Cloud Bigtable cluster in. Zones that support Bigtable instances are noted on the Cloud Bigtable locations page.

class Table

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

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): 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

static isInstance(obj: any): boolean

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

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.

property urn

urn: Output<URN>;

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

interface InstanceArgs

The set of arguments for constructing a Instance resource.

property cluster

cluster?: pulumi.Input<{ ... }>;

A block of cluster configuration options. Either cluster or cluster_id must be used. Only one cluster may be specified. See structure below.

property clusterId

clusterId?: pulumi.Input<string>;

The ID of the Cloud Bigtable cluster.

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 of the Cloud Bigtable instance.

property numNodes

numNodes?: pulumi.Input<number>;

The number of nodes in your Cloud Bigtable cluster. Minimum of 3 for a PRODUCTION instance. Cannot be set for a DEVELOPMENT 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.

property storageType

storageType?: pulumi.Input<string>;

The storage type to use. One of "SSD" or "HDD". Defaults to "SSD".

property zone

zone?: pulumi.Input<string>;

The zone to create the Cloud Bigtable cluster in. Zones that support Bigtable instances are noted on the Cloud Bigtable locations page.

interface InstanceState

Input properties used for looking up and filtering Instance resources.

property cluster

cluster?: pulumi.Input<{ ... }>;

A block of cluster configuration options. Either cluster or cluster_id must be used. Only one cluster may be specified. See structure below.

property clusterId

clusterId?: pulumi.Input<string>;

The ID of the Cloud Bigtable cluster.

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 of the Cloud Bigtable instance.

property numNodes

numNodes?: pulumi.Input<number>;

The number of nodes in your Cloud Bigtable cluster. Minimum of 3 for a PRODUCTION instance. Cannot be set for a DEVELOPMENT 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.

property storageType

storageType?: pulumi.Input<string>;

The storage type to use. One of "SSD" or "HDD". Defaults to "SSD".

property zone

zone?: pulumi.Input<string>;

The zone to create the Cloud Bigtable cluster in. Zones that support Bigtable instances are noted on the Cloud Bigtable locations page.

interface TableArgs

The set of arguments for constructing a Table resource.

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.

interface TableState

Input properties used for looking up and filtering Table resources.

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.