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.

bigtable¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-gcp repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-google repo.

class pulumi_gcp.bigtable.GCPolicy(resource_name, opts=None, column_family=None, instance_name=None, max_ages=None, max_versions=None, mode=None, project=None, table=None, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_gcp as gcp

instance = gcp.bigtable.Instance("instance", cluster=[{
    "cluster_id": "tf-instance-cluster",
    "zone": "us-central1-b",
    "num_nodes": 3,
    "storageType": "HDD",
}])
table = gcp.bigtable.Table("table",
    instance_name=instance.name,
    column_family=[{
        "family": "name",
    }])
policy = gcp.bigtable.GCPolicy("policy",
    instance_name=instance.name,
    table=table.name,
    column_family="name",
    max_age=[{
        "days": 7,
    }])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
column_family (pulumi.Input[str]) – The name of the column family.
instance_name (pulumi.Input[str]) – The name of the Bigtable instance.
max_ages (pulumi.Input[list]) – GC policy that applies to all cells older than the given age.
max_versions (pulumi.Input[list]) – GC policy that applies to all versions of a cell except for the most recent.
mode (pulumi.Input[str]) – If multiple policies are set, you should choose between UNION OR INTERSECTION.
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
table (pulumi.Input[str]) – The name of the table.

The max_ages object supports the following:

days (pulumi.Input[float]) - Number of days before applying GC policy.

The max_versions object supports the following:

number (pulumi.Input[float]) - Number of version before applying the GC policy.

column_family: pulumi.Output[str] = None¶: The name of the column family.

instance_name: pulumi.Output[str] = None¶: The name of the Bigtable instance.

max_ages: pulumi.Output[list] = None¶

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

days (float) - Number of days before applying GC policy.

max_versions: pulumi.Output[list] = None¶

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

number (float) - Number of version before applying the GC policy.

mode: pulumi.Output[str] = None¶: If multiple policies are set, you should choose between UNION OR INTERSECTION.

project: pulumi.Output[str] = None¶: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

table: pulumi.Output[str] = None¶: The name of the table.

static get(resource_name, id, opts=None, column_family=None, instance_name=None, max_ages=None, max_versions=None, mode=None, project=None, table=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
column_family (pulumi.Input[str]) – The name of the column family.
instance_name (pulumi.Input[str]) – The name of the Bigtable instance.
max_ages (pulumi.Input[list]) – GC policy that applies to all cells older than the given age.
max_versions (pulumi.Input[list]) – GC policy that applies to all versions of a cell except for the most recent.
mode (pulumi.Input[str]) – If multiple policies are set, you should choose between UNION OR INTERSECTION.
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
table (pulumi.Input[str]) – The name of the table.

The max_ages object supports the following:

days (pulumi.Input[float]) - Number of days before applying GC policy.

The max_versions object supports the following:

number (pulumi.Input[float]) - Number of version before applying the GC policy.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gcp.bigtable.Instance(resource_name, opts=None, clusters=None, deletion_protection=None, display_name=None, instance_type=None, name=None, project=None, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_gcp as gcp

production_instance = gcp.bigtable.Instance("production-instance",
    clusters=[{
        "cluster_id": "tf-instance-cluster",
        "num_nodes": 1,
        "storageType": "HDD",
        "zone": "us-central1-b",
    }],
    lifecycle={
        "preventDestroy": True,
    })

import pulumi
import pulumi_gcp as gcp

development_instance = gcp.bigtable.Instance("development-instance",
    clusters=[{
        "cluster_id": "tf-instance-cluster",
        "storageType": "HDD",
        "zone": "us-central1-b",
    }],
    instance_type="DEVELOPMENT")

Parameters

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

The clusters object supports the following:

cluster_id (pulumi.Input[str]) - The ID of the Cloud Bigtable cluster.
num_nodes (pulumi.Input[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 (pulumi.Input[str]) - The storage type to use. One of "SSD" or "HDD". Defaults to "SSD".
zone (pulumi.Input[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.

clusters: pulumi.Output[list] = None¶

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

cluster_id (str) - The ID of the Cloud Bigtable cluster.
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".
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.

deletion_protection: pulumi.Output[bool] = None¶: 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: pulumi.Output[str] = None¶: The human-readable display name of the Bigtable instance. Defaults to the instance name.

instance_type: pulumi.Output[str] = None¶: The instance type to create. One of "DEVELOPMENT" or "PRODUCTION". Defaults to "PRODUCTION".

name: pulumi.Output[str] = None¶: The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance.

project: pulumi.Output[str] = None¶: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

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

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
clusters (pulumi.Input[list]) – A block of cluster configuration options. This can be specified 1 or 2 times. See structure below.
deletion_protection (pulumi.Input[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 (pulumi.Input[str]) – The human-readable display name of the Bigtable instance. Defaults to the instance name.
instance_type (pulumi.Input[str]) – The instance type to create. One of "DEVELOPMENT" or "PRODUCTION". Defaults to "PRODUCTION".
name (pulumi.Input[str]) – The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance.
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The clusters object supports the following:

cluster_id (pulumi.Input[str]) - The ID of the Cloud Bigtable cluster.
num_nodes (pulumi.Input[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 (pulumi.Input[str]) - The storage type to use. One of "SSD" or "HDD". Defaults to "SSD".
zone (pulumi.Input[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.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gcp.bigtable.InstanceIamBinding(resource_name, opts=None, condition=None, instance=None, members=None, project=None, role=None, __props__=None, __name__=None, __opts__=None)¶

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

bigtable.InstanceIamPolicy: Authoritative. Sets the IAM policy for the instance and replaces any existing policy already attached.
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.
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: bigtable.InstanceIamPolicy cannot be used in conjunction with bigtable.InstanceIamBinding and 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 bigtable.InstanceIamPolicy replaces the entire policy.
Note: bigtable.InstanceIamBinding resources can be used in conjunction with bigtable.InstanceIamMember resources only if they do not grant privilege to the same role.

import pulumi
import pulumi_gcp as gcp

admin = gcp.organizations.get_iam_policy(binding=[{
    "role": "roles/editor",
    "members": ["user:jane@example.com"],
}])
editor = gcp.bigtable.InstanceIamPolicy("editor",
    project="your-project",
    instance="your-bigtable-instance",
    policy_data=admin.policy_data)

import pulumi
import pulumi_gcp as gcp

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

import pulumi
import pulumi_gcp as gcp

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

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
instance (pulumi.Input[str]) – The name or relative resource id of the instance to manage IAM policies for.
project (pulumi.Input[str]) – The project in which the instance belongs. If it is not provided, a default will be supplied.
role (pulumi.Input[str]) – The role that should be applied. Only one bigtable.InstanceIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

The condition object supports the following:

description (pulumi.Input[str])
expression (pulumi.Input[str])
title (pulumi.Input[str])

etag: pulumi.Output[str] = None¶: (Computed) The etag of the instances’s IAM policy.

instance: pulumi.Output[str] = None¶: The name or relative resource id of the instance to manage IAM policies for.

project: pulumi.Output[str] = None¶: The project in which the instance belongs. If it is not provided, a default will be supplied.

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

static get(resource_name, id, opts=None, condition=None, etag=None, instance=None, members=None, project=None, role=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
etag (pulumi.Input[str]) – (Computed) The etag of the instances’s IAM policy.
instance (pulumi.Input[str]) – The name or relative resource id of the instance to manage IAM policies for.
project (pulumi.Input[str]) – The project in which the instance belongs. If it is not provided, a default will be supplied.
role (pulumi.Input[str]) – The role that should be applied. Only one bigtable.InstanceIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

The condition object supports the following:

description (pulumi.Input[str])
expression (pulumi.Input[str])
title (pulumi.Input[str])

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gcp.bigtable.InstanceIamMember(resource_name, opts=None, condition=None, instance=None, member=None, project=None, role=None, __props__=None, __name__=None, __opts__=None)¶

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

bigtable.InstanceIamPolicy: Authoritative. Sets the IAM policy for the instance and replaces any existing policy already attached.
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.
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: bigtable.InstanceIamPolicy cannot be used in conjunction with bigtable.InstanceIamBinding and 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 bigtable.InstanceIamPolicy replaces the entire policy.
Note: bigtable.InstanceIamBinding resources can be used in conjunction with bigtable.InstanceIamMember resources only if they do not grant privilege to the same role.

import pulumi
import pulumi_gcp as gcp

admin = gcp.organizations.get_iam_policy(binding=[{
    "role": "roles/editor",
    "members": ["user:jane@example.com"],
}])
editor = gcp.bigtable.InstanceIamPolicy("editor",
    project="your-project",
    instance="your-bigtable-instance",
    policy_data=admin.policy_data)

import pulumi
import pulumi_gcp as gcp

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

import pulumi
import pulumi_gcp as gcp

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

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
instance (pulumi.Input[str]) – The name or relative resource id of the instance to manage IAM policies for.
project (pulumi.Input[str]) – The project in which the instance belongs. If it is not provided, a default will be supplied.
role (pulumi.Input[str]) – The role that should be applied. Only one bigtable.InstanceIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

The condition object supports the following:

description (pulumi.Input[str])
expression (pulumi.Input[str])
title (pulumi.Input[str])

etag: pulumi.Output[str] = None¶: (Computed) The etag of the instances’s IAM policy.

instance: pulumi.Output[str] = None¶: The name or relative resource id of the instance to manage IAM policies for.

project: pulumi.Output[str] = None¶: The project in which the instance belongs. If it is not provided, a default will be supplied.

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

static get(resource_name, id, opts=None, condition=None, etag=None, instance=None, member=None, project=None, role=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
etag (pulumi.Input[str]) – (Computed) The etag of the instances’s IAM policy.
instance (pulumi.Input[str]) – The name or relative resource id of the instance to manage IAM policies for.
project (pulumi.Input[str]) – The project in which the instance belongs. If it is not provided, a default will be supplied.
role (pulumi.Input[str]) – The role that should be applied. Only one bigtable.InstanceIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

The condition object supports the following:

description (pulumi.Input[str])
expression (pulumi.Input[str])
title (pulumi.Input[str])

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gcp.bigtable.InstanceIamPolicy(resource_name, opts=None, instance=None, policy_data=None, project=None, __props__=None, __name__=None, __opts__=None)¶

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

bigtable.InstanceIamPolicy: Authoritative. Sets the IAM policy for the instance and replaces any existing policy already attached.
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.
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: bigtable.InstanceIamPolicy cannot be used in conjunction with bigtable.InstanceIamBinding and 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 bigtable.InstanceIamPolicy replaces the entire policy.
Note: bigtable.InstanceIamBinding resources can be used in conjunction with bigtable.InstanceIamMember resources only if they do not grant privilege to the same role.

import pulumi
import pulumi_gcp as gcp

admin = gcp.organizations.get_iam_policy(binding=[{
    "role": "roles/editor",
    "members": ["user:jane@example.com"],
}])
editor = gcp.bigtable.InstanceIamPolicy("editor",
    project="your-project",
    instance="your-bigtable-instance",
    policy_data=admin.policy_data)

import pulumi
import pulumi_gcp as gcp

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

import pulumi
import pulumi_gcp as gcp

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

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
instance (pulumi.Input[str]) – The name or relative resource id of the instance to manage IAM policies for.
policy_data (pulumi.Input[str]) – The policy data generated by a organizations.getIAMPolicy data source.
project (pulumi.Input[str]) – The project in which the instance belongs. If it is not provided, a default will be supplied.

etag: pulumi.Output[str] = None¶: (Computed) The etag of the instances’s IAM policy.

instance: pulumi.Output[str] = None¶: The name or relative resource id of the instance to manage IAM policies for.

policy_data: pulumi.Output[str] = None¶: The policy data generated by a organizations.getIAMPolicy data source.

project: pulumi.Output[str] = None¶: The project in which the instance belongs. If it is not provided, a default will be supplied.

static get(resource_name, id, opts=None, etag=None, instance=None, policy_data=None, project=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
etag (pulumi.Input[str]) – (Computed) The etag of the instances’s IAM policy.
instance (pulumi.Input[str]) – The name or relative resource id of the instance to manage IAM policies for.
policy_data (pulumi.Input[str]) – The policy data generated by a organizations.getIAMPolicy data source.
project (pulumi.Input[str]) – The project in which the instance belongs. If it is not provided, a default will be supplied.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gcp.bigtable.Table(resource_name, opts=None, column_families=None, instance_name=None, name=None, project=None, split_keys=None, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_gcp as gcp

instance = gcp.bigtable.Instance("instance", cluster=[{
    "cluster_id": "tf-instance-cluster",
    "zone": "us-central1-b",
    "num_nodes": 3,
    "storageType": "HDD",
}])
table = gcp.bigtable.Table("table",
    instance_name=instance.name,
    split_keys=[
        "a",
        "b",
        "c",
    ])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
column_families (pulumi.Input[list]) – A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
instance_name (pulumi.Input[str]) – The name of the Bigtable instance.
name (pulumi.Input[str]) – The name of the table.
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
split_keys (pulumi.Input[list]) – A list of predefined keys to split the table on. !> Warning: Modifying the split_keys of an existing table will cause the provider to delete/recreate the entire bigtable.Table resource.

The column_families object supports the following:

family (pulumi.Input[str]) - The name of the column family.

column_families: pulumi.Output[list] = None¶

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

family (str) - The name of the column family.

instance_name: pulumi.Output[str] = None¶: The name of the Bigtable instance.

name: pulumi.Output[str] = None¶: The name of the table.

project: pulumi.Output[str] = None¶: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

split_keys: pulumi.Output[list] = None¶: A list of predefined keys to split the table on. !> Warning: Modifying the split_keys of an existing table will cause the provider to delete/recreate the entire bigtable.Table resource.

static get(resource_name, id, opts=None, column_families=None, instance_name=None, name=None, project=None, split_keys=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
column_families (pulumi.Input[list]) – A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
instance_name (pulumi.Input[str]) – The name of the Bigtable instance.
name (pulumi.Input[str]) – The name of the table.
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
split_keys (pulumi.Input[list]) – A list of predefined keys to split the table on. !> Warning: Modifying the split_keys of an existing table will cause the provider to delete/recreate the entire bigtable.Table resource.

The column_families object supports the following:

family (pulumi.Input[str]) - The name of the column family.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

bigtable¶

On This Page