bigtable

package
v1.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 9, 2019 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Overview

nolint: lll Package bigtable exports types, functions, subpackages for provisioning bigtable resources.

> This provider is a derived work of the [Terraform Provider](https://github.com/terraform-providers/terraform-provider-google) > distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature, > first check the [`pulumi/pulumi-gcp` repo](https://github.com/pulumi/pulumi-gcp/issues); however, if that doesn't turn up anything, > please consult the source [`terraform-providers/terraform-provider-google` repo](https://github.com/terraform-providers/terraform-provider-google/issues).

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GCPolicy added in v1.3.0 

type GCPolicy struct {
	// contains filtered or unexported fields
}

Creates a Google Cloud Bigtable GC Policy inside a family. For more information see [the official documentation](https://cloud.google.com/bigtable/) and [API](https://cloud.google.com/bigtable/docs/go/reference).

> This content is derived from https://github.com/terraform-providers/terraform-provider-google/blob/master/website/docs/r/bigtable_gc_policy.html.markdown.

func GetGCPolicy added in v1.3.0 

func GetGCPolicy(ctx *pulumi.Context,
	name string, id pulumi.ID, state *GCPolicyState, opts ...pulumi.ResourceOpt) (*GCPolicy, error)

GetGCPolicy gets an existing GCPolicy resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewGCPolicy added in v1.3.0 

func NewGCPolicy(ctx *pulumi.Context,
	name string, args *GCPolicyArgs, opts ...pulumi.ResourceOpt) (*GCPolicy, error)

NewGCPolicy registers a new resource with the given unique name, arguments, and options.

func (*GCPolicy) ColumnFamily added in v1.3.0 

func (r *GCPolicy) ColumnFamily() *pulumi.StringOutput

func (*GCPolicy) ID added in v1.3.0 

func (r *GCPolicy) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*GCPolicy) InstanceName added in v1.3.0 

func (r *GCPolicy) InstanceName() *pulumi.StringOutput

The name of the Bigtable instance.

func (*GCPolicy) MaxAges added in v1.3.0 

func (r *GCPolicy) MaxAges() *pulumi.ArrayOutput

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

func (*GCPolicy) MaxVersions added in v1.3.0 

func (r *GCPolicy) MaxVersions() *pulumi.ArrayOutput

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

func (*GCPolicy) Mode added in v1.3.0 

func (r *GCPolicy) Mode() *pulumi.StringOutput

If multiple policies are set, you should choose between `UNION` OR `INTERSECTION`.

func (*GCPolicy) Project added in v1.3.0 

func (r *GCPolicy) Project() *pulumi.StringOutput

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

func (*GCPolicy) Table added in v1.3.0 

func (r *GCPolicy) Table() *pulumi.StringOutput

func (*GCPolicy) URN added in v1.3.0 

func (r *GCPolicy) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type GCPolicyArgs added in v1.3.0 

type GCPolicyArgs struct {
	ColumnFamily interface{}
	// The name of the Bigtable instance.
	InstanceName interface{}
	// GC policy that applies to all cells older than the given age.
	MaxAges interface{}
	// GC policy that applies to all versions of a cell except for the most recent.
	MaxVersions interface{}
	// If multiple policies are set, you should choose between `UNION` OR `INTERSECTION`.
	Mode interface{}
	// The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
	Project interface{}
	Table   interface{}
}

The set of arguments for constructing a GCPolicy resource.

type GCPolicyState added in v1.3.0 

type GCPolicyState struct {
	ColumnFamily interface{}
	// The name of the Bigtable instance.
	InstanceName interface{}
	// GC policy that applies to all cells older than the given age.
	MaxAges interface{}
	// GC policy that applies to all versions of a cell except for the most recent.
	MaxVersions interface{}
	// If multiple policies are set, you should choose between `UNION` OR `INTERSECTION`.
	Mode interface{}
	// The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
	Project interface{}
	Table   interface{}
}

Input properties used for looking up and filtering GCPolicy resources.

type Instance 

type Instance struct {
	// contains filtered or unexported fields
}

Creates a Google Bigtable instance. For more information see [the official documentation](https://cloud.google.com/bigtable/) and [API](https://cloud.google.com/bigtable/docs/go/reference).

> This content is derived from https://github.com/terraform-providers/terraform-provider-google/blob/master/website/docs/r/bigtable_instance.html.markdown.

func GetInstance 

func GetInstance(ctx *pulumi.Context,
	name string, id pulumi.ID, state *InstanceState, opts ...pulumi.ResourceOpt) (*Instance, error)

GetInstance gets an existing Instance resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewInstance 

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

NewInstance registers a new resource with the given unique name, arguments, and options.

func (*Instance) Clusters added in v0.18.0 

func (r *Instance) Clusters() *pulumi.ArrayOutput

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

func (*Instance) DisplayName 

func (r *Instance) DisplayName() *pulumi.StringOutput

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

func (*Instance) ID 

func (r *Instance) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Instance) InstanceType 

func (r *Instance) InstanceType() *pulumi.StringOutput

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

func (*Instance) Name 

func (r *Instance) Name() *pulumi.StringOutput

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

func (*Instance) Project 

func (r *Instance) Project() *pulumi.StringOutput

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

func (*Instance) URN 

func (r *Instance) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type InstanceArgs 

type InstanceArgs struct {
	// A block of cluster configuration options. This can be specified 1 or 2 times. See structure below.
	Clusters interface{}
	// The human-readable display name of the Bigtable instance. Defaults to the instance `name`.
	DisplayName interface{}
	// The instance type to create. One of `"DEVELOPMENT"` or `"PRODUCTION"`. Defaults to `"PRODUCTION"`.
	InstanceType interface{}
	// The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance.
	Name interface{}
	// The ID of the project in which the resource belongs. If it
	// is not provided, the provider project is used.
	Project interface{}
}

The set of arguments for constructing a Instance resource.

type InstanceIamBinding added in v0.18.13 

type InstanceIamBinding struct {
	// contains filtered or unexported fields
}

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.

> This content is derived from https://github.com/terraform-providers/terraform-provider-google/blob/master/website/docs/r/bigtable_instance_iam_binding.html.markdown.

func GetInstanceIamBinding added in v0.18.13 

func GetInstanceIamBinding(ctx *pulumi.Context,
	name string, id pulumi.ID, state *InstanceIamBindingState, opts ...pulumi.ResourceOpt) (*InstanceIamBinding, error)

GetInstanceIamBinding gets an existing InstanceIamBinding resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewInstanceIamBinding added in v0.18.13 

func NewInstanceIamBinding(ctx *pulumi.Context,
	name string, args *InstanceIamBindingArgs, opts ...pulumi.ResourceOpt) (*InstanceIamBinding, error)

NewInstanceIamBinding registers a new resource with the given unique name, arguments, and options.

func (*InstanceIamBinding) Etag added in v0.18.13 

func (r *InstanceIamBinding) Etag() *pulumi.StringOutput

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

func (*InstanceIamBinding) ID added in v0.18.13 

func (r *InstanceIamBinding) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*InstanceIamBinding) Instance added in v0.18.13 

func (r *InstanceIamBinding) Instance() *pulumi.StringOutput

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

func (*InstanceIamBinding) Members added in v0.18.13 

func (r *InstanceIamBinding) Members() *pulumi.ArrayOutput

func (*InstanceIamBinding) Project added in v0.18.13 

func (r *InstanceIamBinding) Project() *pulumi.StringOutput

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

func (*InstanceIamBinding) Role added in v0.18.13 

func (r *InstanceIamBinding) Role() *pulumi.StringOutput

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

func (*InstanceIamBinding) URN added in v0.18.13 

func (r *InstanceIamBinding) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type InstanceIamBindingArgs added in v0.18.13 

type InstanceIamBindingArgs struct {
	// The name or relative resource id of the instance to manage IAM policies for.
	Instance interface{}
	Members  interface{}
	// The project in which the instance belongs. If it
	// is not provided, this provider will use the provider default.
	Project interface{}
	// 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}`.
	Role interface{}
}

The set of arguments for constructing a InstanceIamBinding resource.

type InstanceIamBindingState added in v0.18.13 

type InstanceIamBindingState struct {
	// (Computed) The etag of the instances's IAM policy.
	Etag interface{}
	// The name or relative resource id of the instance to manage IAM policies for.
	Instance interface{}
	Members  interface{}
	// The project in which the instance belongs. If it
	// is not provided, this provider will use the provider default.
	Project interface{}
	// 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}`.
	Role interface{}
}

Input properties used for looking up and filtering InstanceIamBinding resources.

type InstanceIamMember added in v0.18.13 

type InstanceIamMember struct {
	// contains filtered or unexported fields
}

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.

> This content is derived from https://github.com/terraform-providers/terraform-provider-google/blob/master/website/docs/r/bigtable_instance_iam_member.html.markdown.

func GetInstanceIamMember added in v0.18.13 

func GetInstanceIamMember(ctx *pulumi.Context,
	name string, id pulumi.ID, state *InstanceIamMemberState, opts ...pulumi.ResourceOpt) (*InstanceIamMember, error)

GetInstanceIamMember gets an existing InstanceIamMember resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewInstanceIamMember added in v0.18.13 

func NewInstanceIamMember(ctx *pulumi.Context,
	name string, args *InstanceIamMemberArgs, opts ...pulumi.ResourceOpt) (*InstanceIamMember, error)

NewInstanceIamMember registers a new resource with the given unique name, arguments, and options.

func (*InstanceIamMember) Etag added in v0.18.13 

func (r *InstanceIamMember) Etag() *pulumi.StringOutput

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

func (*InstanceIamMember) ID added in v0.18.13 

func (r *InstanceIamMember) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*InstanceIamMember) Instance added in v0.18.13 

func (r *InstanceIamMember) Instance() *pulumi.StringOutput

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

func (*InstanceIamMember) Member added in v0.18.13 

func (r *InstanceIamMember) Member() *pulumi.StringOutput

func (*InstanceIamMember) Project added in v0.18.13 

func (r *InstanceIamMember) Project() *pulumi.StringOutput

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

func (*InstanceIamMember) Role added in v0.18.13 

func (r *InstanceIamMember) Role() *pulumi.StringOutput

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

func (*InstanceIamMember) URN added in v0.18.13 

func (r *InstanceIamMember) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type InstanceIamMemberArgs added in v0.18.13 

type InstanceIamMemberArgs struct {
	// The name or relative resource id of the instance to manage IAM policies for.
	Instance interface{}
	Member   interface{}
	// The project in which the instance belongs. If it
	// is not provided, this provider will use the provider default.
	Project interface{}
	// 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}`.
	Role interface{}
}

The set of arguments for constructing a InstanceIamMember resource.

type InstanceIamMemberState added in v0.18.13 

type InstanceIamMemberState struct {
	// (Computed) The etag of the instances's IAM policy.
	Etag interface{}
	// The name or relative resource id of the instance to manage IAM policies for.
	Instance interface{}
	Member   interface{}
	// The project in which the instance belongs. If it
	// is not provided, this provider will use the provider default.
	Project interface{}
	// 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}`.
	Role interface{}
}

Input properties used for looking up and filtering InstanceIamMember resources.

type InstanceIamPolicy added in v0.18.13 

type InstanceIamPolicy struct {
	// contains filtered or unexported fields
}

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.

> This content is derived from https://github.com/terraform-providers/terraform-provider-google/blob/master/website/docs/r/bigtable_instance_iam_policy.html.markdown.

func GetInstanceIamPolicy added in v0.18.13 

func GetInstanceIamPolicy(ctx *pulumi.Context,
	name string, id pulumi.ID, state *InstanceIamPolicyState, opts ...pulumi.ResourceOpt) (*InstanceIamPolicy, error)

GetInstanceIamPolicy gets an existing InstanceIamPolicy resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewInstanceIamPolicy added in v0.18.13 

func NewInstanceIamPolicy(ctx *pulumi.Context,
	name string, args *InstanceIamPolicyArgs, opts ...pulumi.ResourceOpt) (*InstanceIamPolicy, error)

NewInstanceIamPolicy registers a new resource with the given unique name, arguments, and options.

func (*InstanceIamPolicy) Etag added in v0.18.13 

func (r *InstanceIamPolicy) Etag() *pulumi.StringOutput

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

func (*InstanceIamPolicy) ID added in v0.18.13 

func (r *InstanceIamPolicy) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*InstanceIamPolicy) Instance added in v0.18.13 

func (r *InstanceIamPolicy) Instance() *pulumi.StringOutput

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

func (*InstanceIamPolicy) PolicyData added in v0.18.13 

func (r *InstanceIamPolicy) PolicyData() *pulumi.StringOutput

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

func (*InstanceIamPolicy) Project added in v0.18.13 

func (r *InstanceIamPolicy) Project() *pulumi.StringOutput

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

func (*InstanceIamPolicy) URN added in v0.18.13 

func (r *InstanceIamPolicy) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type InstanceIamPolicyArgs added in v0.18.13 

type InstanceIamPolicyArgs struct {
	// The name or relative resource id of the instance to manage IAM policies for.
	Instance interface{}
	// The policy data generated by a `organizations.getIAMPolicy` data source.
	PolicyData interface{}
	// The project in which the instance belongs. If it
	// is not provided, this provider will use the provider default.
	Project interface{}
}

The set of arguments for constructing a InstanceIamPolicy resource.

type InstanceIamPolicyState added in v0.18.13 

type InstanceIamPolicyState struct {
	// (Computed) The etag of the instances's IAM policy.
	Etag interface{}
	// The name or relative resource id of the instance to manage IAM policies for.
	Instance interface{}
	// The policy data generated by a `organizations.getIAMPolicy` data source.
	PolicyData interface{}
	// The project in which the instance belongs. If it
	// is not provided, this provider will use the provider default.
	Project interface{}
}

Input properties used for looking up and filtering InstanceIamPolicy resources.

type InstanceState 

type InstanceState struct {
	// A block of cluster configuration options. This can be specified 1 or 2 times. See structure below.
	Clusters interface{}
	// The human-readable display name of the Bigtable instance. Defaults to the instance `name`.
	DisplayName interface{}
	// The instance type to create. One of `"DEVELOPMENT"` or `"PRODUCTION"`. Defaults to `"PRODUCTION"`.
	InstanceType interface{}
	// The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance.
	Name interface{}
	// The ID of the project in which the resource belongs. If it
	// is not provided, the provider project is used.
	Project interface{}
}

Input properties used for looking up and filtering Instance resources.

type Table 

type Table struct {
	// contains filtered or unexported fields
}

Creates a Google Cloud Bigtable table inside an instance. For more information see [the official documentation](https://cloud.google.com/bigtable/) and [API](https://cloud.google.com/bigtable/docs/go/reference).

> This content is derived from https://github.com/terraform-providers/terraform-provider-google/blob/master/website/docs/r/bigtable_table.html.markdown.

func GetTable 

func GetTable(ctx *pulumi.Context,
	name string, id pulumi.ID, state *TableState, opts ...pulumi.ResourceOpt) (*Table, error)

GetTable gets an existing Table resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewTable 

func NewTable(ctx *pulumi.Context,
	name string, args *TableArgs, opts ...pulumi.ResourceOpt) (*Table, error)

NewTable registers a new resource with the given unique name, arguments, and options.

func (*Table) ColumnFamilies added in v0.18.0 

func (r *Table) ColumnFamilies() *pulumi.ArrayOutput

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

func (*Table) ID 

func (r *Table) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Table) InstanceName 

func (r *Table) InstanceName() *pulumi.StringOutput

The name of the Bigtable instance.

func (*Table) Name 

func (r *Table) Name() *pulumi.StringOutput

The name of the table.

func (*Table) Project 

func (r *Table) Project() *pulumi.StringOutput

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

func (*Table) SplitKeys 

func (r *Table) SplitKeys() *pulumi.ArrayOutput

A list of predefined keys to split the table on.

func (*Table) URN 

func (r *Table) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type TableArgs 

type TableArgs struct {
	// A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
	ColumnFamilies interface{}
	// The name of the Bigtable instance.
	InstanceName interface{}
	// The name of the table.
	Name interface{}
	// The ID of the project in which the resource belongs. If it
	// is not provided, the provider project is used.
	Project interface{}
	// A list of predefined keys to split the table on.
	SplitKeys interface{}
}

The set of arguments for constructing a Table resource.

type TableState 

type TableState struct {
	// A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
	ColumnFamilies interface{}
	// The name of the Bigtable instance.
	InstanceName interface{}
	// The name of the table.
	Name interface{}
	// The ID of the project in which the resource belongs. If it
	// is not provided, the provider project is used.
	Project interface{}
	// A list of predefined keys to split the table on.
	SplitKeys interface{}
}

Input properties used for looking up and filtering Table resources.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.