Google Cloud Native v0.31.1, Jul 20 23

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi

pulumi/pulumi-google-native

google-native.bigtableadmin/v2.Instance

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi

pulumi/pulumi-google-native

Create an instance within a project. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

Create Instance Resource

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

@overload
def Instance(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             clusters: Optional[Mapping[str, str]] = None,
             display_name: Optional[str] = None,
             instance_id: Optional[str] = None,
             labels: Optional[Mapping[str, str]] = None,
             name: Optional[str] = None,
             parent: Optional[str] = None,
             project: Optional[str] = None,
             type: Optional[InstanceType] = None)
@overload
def Instance(resource_name: str,
             args: InstanceArgs,
             opts: Optional[ResourceOptions] = None)

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

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

public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)

type: google-native:bigtableadmin/v2:Instance
properties: # The arguments to resource properties.
options: # 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.

resource_name str: The unique name of the resource.
args InstanceArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control 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.

name String: The unique name of the resource.
args InstanceArgs: The arguments to resource properties.
options 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 Architecture and Concepts docs.

Inputs

The Instance resource accepts the following input properties:

Clusters Dictionary<string, string>: The clusters to be created within the instance, mapped by desired cluster ID, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster. Fields marked OutputOnly must be left blank.
DisplayName string: The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.
InstanceId string: The ID to be used when referring to the new instance within its project, e.g., just myinstance rather than projects/myproject/instances/myinstance.
Parent string: The unique name of the project in which to create the new instance. Values are of the form projects/{project}.
Labels Dictionary<string, string>: Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: \p{Ll}\p{Lo}{0,62}. * Label values must be between 0 and 63 characters long and must conform to the regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes.
Name string: The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9].
Project string
Type Pulumi.GoogleNative.BigtableAdmin.V2.InstanceType: The type of the instance. Defaults to PRODUCTION.

Clusters map[string]string: The clusters to be created within the instance, mapped by desired cluster ID, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster. Fields marked OutputOnly must be left blank.
DisplayName string: The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.
InstanceId string: The ID to be used when referring to the new instance within its project, e.g., just myinstance rather than projects/myproject/instances/myinstance.
Parent string: The unique name of the project in which to create the new instance. Values are of the form projects/{project}.
Labels map[string]string: Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: \p{Ll}\p{Lo}{0,62}. * Label values must be between 0 and 63 characters long and must conform to the regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes.
Name string: The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9].
Project string
Type InstanceType: The type of the instance. Defaults to PRODUCTION.

clusters Map<String,String>: The clusters to be created within the instance, mapped by desired cluster ID, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster. Fields marked OutputOnly must be left blank.
displayName String: The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.
instanceId String: The ID to be used when referring to the new instance within its project, e.g., just myinstance rather than projects/myproject/instances/myinstance.
parent String: The unique name of the project in which to create the new instance. Values are of the form projects/{project}.
labels Map<String,String>: Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: \p{Ll}\p{Lo}{0,62}. * Label values must be between 0 and 63 characters long and must conform to the regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes.
name String: The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9].
project String
type InstanceType: The type of the instance. Defaults to PRODUCTION.

clusters {[key: string]: string}: The clusters to be created within the instance, mapped by desired cluster ID, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster. Fields marked OutputOnly must be left blank.
displayName string: The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.
instanceId string: The ID to be used when referring to the new instance within its project, e.g., just myinstance rather than projects/myproject/instances/myinstance.
parent string: The unique name of the project in which to create the new instance. Values are of the form projects/{project}.
labels {[key: string]: string}: Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: \p{Ll}\p{Lo}{0,62}. * Label values must be between 0 and 63 characters long and must conform to the regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes.
name string: The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9].
project string
type InstanceType: The type of the instance. Defaults to PRODUCTION.

clusters Mapping[str, str]: The clusters to be created within the instance, mapped by desired cluster ID, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster. Fields marked OutputOnly must be left blank.
display_name str: The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.
instance_id str: The ID to be used when referring to the new instance within its project, e.g., just myinstance rather than projects/myproject/instances/myinstance.
parent str: The unique name of the project in which to create the new instance. Values are of the form projects/{project}.
labels Mapping[str, str]: Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: \p{Ll}\p{Lo}{0,62}. * Label values must be between 0 and 63 characters long and must conform to the regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes.
name str: The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9].
project str
type InstanceType: The type of the instance. Defaults to PRODUCTION.

clusters Map<String>: The clusters to be created within the instance, mapped by desired cluster ID, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster. Fields marked OutputOnly must be left blank.
displayName String: The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.
instanceId String: The ID to be used when referring to the new instance within its project, e.g., just myinstance rather than projects/myproject/instances/myinstance.
parent String: The unique name of the project in which to create the new instance. Values are of the form projects/{project}.
labels Map<String>: Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: \p{Ll}\p{Lo}{0,62}. * Label values must be between 0 and 63 characters long and must conform to the regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes.
name String: The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9].
project String
type "TYPE_UNSPECIFIED" | "PRODUCTION" | "DEVELOPMENT": The type of the instance. Defaults to PRODUCTION.

Outputs

All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:

CreateTime string: A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is seconds: 0, nanos: 1.
Id string: The provider-assigned unique ID for this managed resource.
SatisfiesPzs bool: Reserved for future use.
State string: The current state of the instance.

CreateTime string: A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is seconds: 0, nanos: 1.
Id string: The provider-assigned unique ID for this managed resource.
SatisfiesPzs bool: Reserved for future use.
State string: The current state of the instance.

createTime String: A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is seconds: 0, nanos: 1.
id String: The provider-assigned unique ID for this managed resource.
satisfiesPzs Boolean: Reserved for future use.
state String: The current state of the instance.

createTime string: A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is seconds: 0, nanos: 1.
id string: The provider-assigned unique ID for this managed resource.
satisfiesPzs boolean: Reserved for future use.
state string: The current state of the instance.

create_time str: A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is seconds: 0, nanos: 1.
id str: The provider-assigned unique ID for this managed resource.
satisfies_pzs bool: Reserved for future use.
state str: The current state of the instance.

createTime String: A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is seconds: 0, nanos: 1.
id String: The provider-assigned unique ID for this managed resource.
satisfiesPzs Boolean: Reserved for future use.
state String: The current state of the instance.

Supporting Types

InstanceType, InstanceTypeArgs

TypeUnspecified: TYPE_UNSPECIFIED
The type of the instance is unspecified. If set when creating an instance, a PRODUCTION instance will be created. If set when updating an instance, the type will be left unchanged.
Production: PRODUCTION
An instance meant for production use. serve_nodes must be set on the cluster.
Development: DEVELOPMENT
DEPRECATED: Prefer PRODUCTION for all use cases, as it no longer enforces a higher minimum node count than DEVELOPMENT.

InstanceTypeTypeUnspecified: TYPE_UNSPECIFIED
The type of the instance is unspecified. If set when creating an instance, a PRODUCTION instance will be created. If set when updating an instance, the type will be left unchanged.
InstanceTypeProduction: PRODUCTION
An instance meant for production use. serve_nodes must be set on the cluster.
InstanceTypeDevelopment: DEVELOPMENT
DEPRECATED: Prefer PRODUCTION for all use cases, as it no longer enforces a higher minimum node count than DEVELOPMENT.

TypeUnspecified: TYPE_UNSPECIFIED
The type of the instance is unspecified. If set when creating an instance, a PRODUCTION instance will be created. If set when updating an instance, the type will be left unchanged.
Production: PRODUCTION
An instance meant for production use. serve_nodes must be set on the cluster.
Development: DEVELOPMENT
DEPRECATED: Prefer PRODUCTION for all use cases, as it no longer enforces a higher minimum node count than DEVELOPMENT.

TypeUnspecified: TYPE_UNSPECIFIED
The type of the instance is unspecified. If set when creating an instance, a PRODUCTION instance will be created. If set when updating an instance, the type will be left unchanged.
Production: PRODUCTION
An instance meant for production use. serve_nodes must be set on the cluster.
Development: DEVELOPMENT
DEPRECATED: Prefer PRODUCTION for all use cases, as it no longer enforces a higher minimum node count than DEVELOPMENT.

TYPE_UNSPECIFIED: TYPE_UNSPECIFIED
The type of the instance is unspecified. If set when creating an instance, a PRODUCTION instance will be created. If set when updating an instance, the type will be left unchanged.
PRODUCTION: PRODUCTION
An instance meant for production use. serve_nodes must be set on the cluster.
DEVELOPMENT: DEVELOPMENT
DEPRECATED: Prefer PRODUCTION for all use cases, as it no longer enforces a higher minimum node count than DEVELOPMENT.

"TYPE_UNSPECIFIED": TYPE_UNSPECIFIED
The type of the instance is unspecified. If set when creating an instance, a PRODUCTION instance will be created. If set when updating an instance, the type will be left unchanged.
"PRODUCTION": PRODUCTION
An instance meant for production use. serve_nodes must be set on the cluster.
"DEVELOPMENT": DEVELOPMENT
DEPRECATED: Prefer PRODUCTION for all use cases, as it no longer enforces a higher minimum node count than DEVELOPMENT.

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi

pulumi/pulumi-google-native

google-native.bigtableadmin/v2.Instance

On this page

On this page

Create Instance Resource

Instance Resource Properties

Inputs

Outputs

Supporting Types

InstanceType, InstanceTypeArgs

Package Details

On this page

On this page