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.Instance(resource_name, opts=None, clusters=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.

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.

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

  • clusterId (pulumi.Input[str])

  • numNodes (pulumi.Input[float])

  • storageType (pulumi.Input[str])

  • zone (pulumi.Input[str])

clusters = None

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

  • clusterId (str)

  • numNodes (float)

  • storageType (str)

  • zone (str)

display_name = None

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

instance_type = None

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

name = None

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

project = 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, 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.

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

  • clusterId (pulumi.Input[str])

  • numNodes (pulumi.Input[float])

  • storageType (pulumi.Input[str])

  • zone (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.InstanceIamBinding(resource_name, opts=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 accidentaly 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.

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, this provider will use the provider default.

  • 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}.

etag = None

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

instance = None

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

project = None

The project in which the instance belongs. If it is not provided, this provider will use the provider default.

role = 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, 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, this provider will use the provider default.

  • 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}.

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, 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 accidentaly 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.

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, this provider will use the provider default.

  • 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}.

etag = None

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

instance = None

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

project = None

The project in which the instance belongs. If it is not provided, this provider will use the provider default.

role = 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, 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, this provider will use the provider default.

  • 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}.

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 accidentaly 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.

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, this provider will use the provider default.

etag = None

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

instance = None

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

policy_data = None

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

project = None

The project in which the instance belongs. If it is not provided, this provider will use the provider default.

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, this provider will use the provider default.

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.

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.

The column_families object supports the following:

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

column_families = 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 = None

The name of the Bigtable instance.

name = None

The name of the table.

project = None

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

split_keys = None

A list of predefined keys to split the table on.

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.

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