Instance

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

Create a Instance Resource

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

def Instance(resource_name, opts=None, clusters=None, deletion_protection=None, display_name=None, instance_type=None, name=None, project=None, __props__=None);

func NewInstance(ctx *Context, name string, args *InstanceArgs, opts ...ResourceOption) (*Instance, error)

public Instance(string name, InstanceArgs? args = null, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args InstanceArgs: 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 InstanceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args InstanceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Instance Resource Properties

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

Inputs

The Instance resource accepts the following input properties:

Clusters List<InstanceClusterArgs>: A block of cluster configuration options. This can be specified 1 or 2 times. See structure below.
DeletionProtection bool: 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.
DisplayName string: The human-readable display name of the Bigtable instance. Defaults to the instance name.
InstanceType string: The instance type to create. One of "DEVELOPMENT" or "PRODUCTION". Defaults to "PRODUCTION".
Name string: The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Clusters []InstanceCluster: A block of cluster configuration options. This can be specified 1 or 2 times. See structure below.
DeletionProtection bool: 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.
DisplayName string: The human-readable display name of the Bigtable instance. Defaults to the instance name.
InstanceType string: The instance type to create. One of "DEVELOPMENT" or "PRODUCTION". Defaults to "PRODUCTION".
Name string: The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

clusters InstanceCluster[]: A block of cluster configuration options. This can be specified 1 or 2 times. See structure below.
deletionProtection 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.
displayName string: The human-readable display name of the Bigtable instance. Defaults to the instance name.
instanceType string: The instance type to create. One of "DEVELOPMENT" or "PRODUCTION". Defaults to "PRODUCTION".
name string: The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

clusters List[InstanceCluster]: A block of cluster configuration options. This can be specified 1 or 2 times. See structure below.
deletion_protection bool: 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.
display_name str: The human-readable display name of the Bigtable instance. Defaults to the instance name.
instance_type str: The instance type to create. One of "DEVELOPMENT" or "PRODUCTION". Defaults to "PRODUCTION".
name str: The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance.
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 Instance resource produces the following output properties:

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

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

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

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

Look up an Existing Instance Resource

Get an existing Instance 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?: InstanceState, opts?: CustomResourceOptions): Instance

static get(resource_name, id, opts=None, clusters=None, deletion_protection=None, display_name=None, instance_type=None, name=None, project=None, __props__=None);

func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)

public static Instance Get(string name, Input<string> id, InstanceState? 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:

Clusters List<InstanceClusterArgs>: A block of cluster configuration options. This can be specified 1 or 2 times. See structure below.
DeletionProtection bool: 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.
DisplayName string: The human-readable display name of the Bigtable instance. Defaults to the instance name.
InstanceType string: The instance type to create. One of "DEVELOPMENT" or "PRODUCTION". Defaults to "PRODUCTION".
Name string: The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Clusters []InstanceCluster: A block of cluster configuration options. This can be specified 1 or 2 times. See structure below.
DeletionProtection bool: 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.
DisplayName string: The human-readable display name of the Bigtable instance. Defaults to the instance name.
InstanceType string: The instance type to create. One of "DEVELOPMENT" or "PRODUCTION". Defaults to "PRODUCTION".
Name string: The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

clusters InstanceCluster[]: A block of cluster configuration options. This can be specified 1 or 2 times. See structure below.
deletionProtection 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.
displayName string: The human-readable display name of the Bigtable instance. Defaults to the instance name.
instanceType string: The instance type to create. One of "DEVELOPMENT" or "PRODUCTION". Defaults to "PRODUCTION".
name string: The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

clusters List[InstanceCluster]: A block of cluster configuration options. This can be specified 1 or 2 times. See structure below.
deletion_protection bool: 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.
display_name str: The human-readable display name of the Bigtable instance. Defaults to the instance name.
instance_type str: The instance type to create. One of "DEVELOPMENT" or "PRODUCTION". Defaults to "PRODUCTION".
name str: The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Supporting Types

InstanceCluster

See the input and output API doc for this type.

ClusterId string: The ID of the Cloud Bigtable cluster.
Zone string: The zone to create the Cloud Bigtable cluster in. Each cluster must have a different zone in the same region. Zones that support Bigtable instances are noted on the Cloud Bigtable locations page.
NumNodes int: The number of nodes in your Cloud Bigtable cluster. Required, with a minimum of 1 for a PRODUCTION instance. Must be left unset for a DEVELOPMENT instance.
StorageType string: The storage type to use. One of "SSD" or "HDD". Defaults to "SSD".

ClusterId string: The ID of the Cloud Bigtable cluster.
Zone string: The zone to create the Cloud Bigtable cluster in. Each cluster must have a different zone in the same region. Zones that support Bigtable instances are noted on the Cloud Bigtable locations page.
NumNodes int: The number of nodes in your Cloud Bigtable cluster. Required, with a minimum of 1 for a PRODUCTION instance. Must be left unset for a DEVELOPMENT instance.
StorageType string: The storage type to use. One of "SSD" or "HDD". Defaults to "SSD".

clusterId string: The ID of the Cloud Bigtable cluster.
zone string: The zone to create the Cloud Bigtable cluster in. Each cluster must have a different zone in the same region. Zones that support Bigtable instances are noted on the Cloud Bigtable locations page.
numNodes number: The number of nodes in your Cloud Bigtable cluster. Required, with a minimum of 1 for a PRODUCTION instance. Must be left unset for a DEVELOPMENT instance.
storageType string: The storage type to use. One of "SSD" or "HDD". Defaults to "SSD".

cluster_id str: The ID of the Cloud Bigtable cluster.
zone str: The zone to create the Cloud Bigtable cluster in. Each cluster must have a different zone in the same region. Zones that support Bigtable instances are noted on the Cloud Bigtable locations page.
num_nodes float: The number of nodes in your Cloud Bigtable cluster. Required, with a minimum of 1 for a PRODUCTION instance. Must be left unset for a DEVELOPMENT instance.
storageType str: The storage type to use. One of "SSD" or "HDD". Defaults to "SSD".

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.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud