gcp.bigtable.SchemaBundle
Explore with Pulumi AI
A schema bundle object that can be referenced in SQL queries.
To get more information about SchemaBundle, see:
Example Usage
Bigtable Schema Bundle
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
import * as std from "@pulumi/std";
const instance = new gcp.bigtable.Instance("instance", {
name: "bt-instance",
clusters: [{
clusterId: "cluster-1",
zone: "us-east1-b",
numNodes: 1,
storageType: "HDD",
}],
deletionProtection: false,
});
const table = new gcp.bigtable.Table("table", {
name: "bt-table",
instanceName: instance.name,
columnFamilies: [{
family: "CF",
}],
});
const schemaBundle = new gcp.bigtable.SchemaBundle("schema_bundle", {
schemaBundleId: "bt-schema-bundle",
instance: instance.name,
table: table.name,
protoSchema: {
protoDescriptors: std.filebase64({
input: "test-fixtures/proto_schema_bundle.pb",
}).then(invoke => invoke.result),
},
});
import pulumi
import pulumi_gcp as gcp
import pulumi_std as std
instance = gcp.bigtable.Instance("instance",
name="bt-instance",
clusters=[{
"cluster_id": "cluster-1",
"zone": "us-east1-b",
"num_nodes": 1,
"storage_type": "HDD",
}],
deletion_protection=False)
table = gcp.bigtable.Table("table",
name="bt-table",
instance_name=instance.name,
column_families=[{
"family": "CF",
}])
schema_bundle = gcp.bigtable.SchemaBundle("schema_bundle",
schema_bundle_id="bt-schema-bundle",
instance=instance.name,
table=table.name,
proto_schema={
"proto_descriptors": std.filebase64(input="test-fixtures/proto_schema_bundle.pb").result,
})
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/bigtable"
"github.com/pulumi/pulumi-std/sdk/go/std"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
instance, err := bigtable.NewInstance(ctx, "instance", &bigtable.InstanceArgs{
Name: pulumi.String("bt-instance"),
Clusters: bigtable.InstanceClusterArray{
&bigtable.InstanceClusterArgs{
ClusterId: pulumi.String("cluster-1"),
Zone: pulumi.String("us-east1-b"),
NumNodes: pulumi.Int(1),
StorageType: pulumi.String("HDD"),
},
},
DeletionProtection: pulumi.Bool(false),
})
if err != nil {
return err
}
table, err := bigtable.NewTable(ctx, "table", &bigtable.TableArgs{
Name: pulumi.String("bt-table"),
InstanceName: instance.Name,
ColumnFamilies: bigtable.TableColumnFamilyArray{
&bigtable.TableColumnFamilyArgs{
Family: pulumi.String("CF"),
},
},
})
if err != nil {
return err
}
invokeFilebase64, err := std.Filebase64(ctx, &std.Filebase64Args{
Input: "test-fixtures/proto_schema_bundle.pb",
}, nil)
if err != nil {
return err
}
_, err = bigtable.NewSchemaBundle(ctx, "schema_bundle", &bigtable.SchemaBundleArgs{
SchemaBundleId: pulumi.String("bt-schema-bundle"),
Instance: instance.Name,
Table: table.Name,
ProtoSchema: &bigtable.SchemaBundleProtoSchemaArgs{
ProtoDescriptors: pulumi.String(invokeFilebase64.Result),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
using Std = Pulumi.Std;
return await Deployment.RunAsync(() =>
{
var instance = new Gcp.BigTable.Instance("instance", new()
{
Name = "bt-instance",
Clusters = new[]
{
new Gcp.BigTable.Inputs.InstanceClusterArgs
{
ClusterId = "cluster-1",
Zone = "us-east1-b",
NumNodes = 1,
StorageType = "HDD",
},
},
DeletionProtection = false,
});
var table = new Gcp.BigTable.Table("table", new()
{
Name = "bt-table",
InstanceName = instance.Name,
ColumnFamilies = new[]
{
new Gcp.BigTable.Inputs.TableColumnFamilyArgs
{
Family = "CF",
},
},
});
var schemaBundle = new Gcp.BigTable.SchemaBundle("schema_bundle", new()
{
SchemaBundleId = "bt-schema-bundle",
Instance = instance.Name,
Table = table.Name,
ProtoSchema = new Gcp.BigTable.Inputs.SchemaBundleProtoSchemaArgs
{
ProtoDescriptors = Std.Filebase64.Invoke(new()
{
Input = "test-fixtures/proto_schema_bundle.pb",
}).Apply(invoke => invoke.Result),
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.bigtable.Instance;
import com.pulumi.gcp.bigtable.InstanceArgs;
import com.pulumi.gcp.bigtable.inputs.InstanceClusterArgs;
import com.pulumi.gcp.bigtable.Table;
import com.pulumi.gcp.bigtable.TableArgs;
import com.pulumi.gcp.bigtable.inputs.TableColumnFamilyArgs;
import com.pulumi.gcp.bigtable.SchemaBundle;
import com.pulumi.gcp.bigtable.SchemaBundleArgs;
import com.pulumi.gcp.bigtable.inputs.SchemaBundleProtoSchemaArgs;
import com.pulumi.std.StdFunctions;
import com.pulumi.std.inputs.Filebase64Args;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var instance = new Instance("instance", InstanceArgs.builder()
.name("bt-instance")
.clusters(InstanceClusterArgs.builder()
.clusterId("cluster-1")
.zone("us-east1-b")
.numNodes(1)
.storageType("HDD")
.build())
.deletionProtection(false)
.build());
var table = new Table("table", TableArgs.builder()
.name("bt-table")
.instanceName(instance.name())
.columnFamilies(TableColumnFamilyArgs.builder()
.family("CF")
.build())
.build());
var schemaBundle = new SchemaBundle("schemaBundle", SchemaBundleArgs.builder()
.schemaBundleId("bt-schema-bundle")
.instance(instance.name())
.table(table.name())
.protoSchema(SchemaBundleProtoSchemaArgs.builder()
.protoDescriptors(StdFunctions.filebase64(Filebase64Args.builder()
.input("test-fixtures/proto_schema_bundle.pb")
.build()).result())
.build())
.build());
}
}
resources:
instance:
type: gcp:bigtable:Instance
properties:
name: bt-instance
clusters:
- clusterId: cluster-1
zone: us-east1-b
numNodes: 1
storageType: HDD
deletionProtection: false
table:
type: gcp:bigtable:Table
properties:
name: bt-table
instanceName: ${instance.name}
columnFamilies:
- family: CF
schemaBundle:
type: gcp:bigtable:SchemaBundle
name: schema_bundle
properties:
schemaBundleId: bt-schema-bundle
instance: ${instance.name}
table: ${table.name}
protoSchema:
protoDescriptors:
fn::invoke:
function: std:filebase64
arguments:
input: test-fixtures/proto_schema_bundle.pb
return: result
Create SchemaBundle Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SchemaBundle(name: string, args: SchemaBundleArgs, opts?: CustomResourceOptions);
@overload
def SchemaBundle(resource_name: str,
args: SchemaBundleArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SchemaBundle(resource_name: str,
opts: Optional[ResourceOptions] = None,
proto_schema: Optional[SchemaBundleProtoSchemaArgs] = None,
schema_bundle_id: Optional[str] = None,
ignore_warnings: Optional[bool] = None,
instance: Optional[str] = None,
project: Optional[str] = None,
table: Optional[str] = None)
func NewSchemaBundle(ctx *Context, name string, args SchemaBundleArgs, opts ...ResourceOption) (*SchemaBundle, error)
public SchemaBundle(string name, SchemaBundleArgs args, CustomResourceOptions? opts = null)
public SchemaBundle(String name, SchemaBundleArgs args)
public SchemaBundle(String name, SchemaBundleArgs args, CustomResourceOptions options)
type: gcp:bigtable:SchemaBundle
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args SchemaBundleArgs
- 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 SchemaBundleArgs
- 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 SchemaBundleArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SchemaBundleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SchemaBundleArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var schemaBundleResource = new Gcp.BigTable.SchemaBundle("schemaBundleResource", new()
{
ProtoSchema = new Gcp.BigTable.Inputs.SchemaBundleProtoSchemaArgs
{
ProtoDescriptors = "string",
},
SchemaBundleId = "string",
IgnoreWarnings = false,
Instance = "string",
Project = "string",
Table = "string",
});
example, err := bigtable.NewSchemaBundle(ctx, "schemaBundleResource", &bigtable.SchemaBundleArgs{
ProtoSchema: &bigtable.SchemaBundleProtoSchemaArgs{
ProtoDescriptors: pulumi.String("string"),
},
SchemaBundleId: pulumi.String("string"),
IgnoreWarnings: pulumi.Bool(false),
Instance: pulumi.String("string"),
Project: pulumi.String("string"),
Table: pulumi.String("string"),
})
var schemaBundleResource = new SchemaBundle("schemaBundleResource", SchemaBundleArgs.builder()
.protoSchema(SchemaBundleProtoSchemaArgs.builder()
.protoDescriptors("string")
.build())
.schemaBundleId("string")
.ignoreWarnings(false)
.instance("string")
.project("string")
.table("string")
.build());
schema_bundle_resource = gcp.bigtable.SchemaBundle("schemaBundleResource",
proto_schema={
"proto_descriptors": "string",
},
schema_bundle_id="string",
ignore_warnings=False,
instance="string",
project="string",
table="string")
const schemaBundleResource = new gcp.bigtable.SchemaBundle("schemaBundleResource", {
protoSchema: {
protoDescriptors: "string",
},
schemaBundleId: "string",
ignoreWarnings: false,
instance: "string",
project: "string",
table: "string",
});
type: gcp:bigtable:SchemaBundle
properties:
ignoreWarnings: false
instance: string
project: string
protoSchema:
protoDescriptors: string
schemaBundleId: string
table: string
SchemaBundle Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The SchemaBundle resource accepts the following input properties:
- Proto
Schema SchemaBundle Proto Schema - File descriptor set, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $ protoc --include_imports --include_source_info test.proto -o out.pb Structure is documented below.
- Schema
Bundle stringId - The unique name of the schema bundle in the form
[_a-zA-Z0-9][-_.a-zA-Z0-9]*
. - Ignore
Warnings bool - If true, allow backwards incompatible changes.
- Instance string
- The name of the instance to create the schema bundle within.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Table string
- The name of the table to create the schema bundle within.
- Proto
Schema SchemaBundle Proto Schema Args - File descriptor set, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $ protoc --include_imports --include_source_info test.proto -o out.pb Structure is documented below.
- Schema
Bundle stringId - The unique name of the schema bundle in the form
[_a-zA-Z0-9][-_.a-zA-Z0-9]*
. - Ignore
Warnings bool - If true, allow backwards incompatible changes.
- Instance string
- The name of the instance to create the schema bundle within.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Table string
- The name of the table to create the schema bundle within.
- proto
Schema SchemaBundle Proto Schema - File descriptor set, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $ protoc --include_imports --include_source_info test.proto -o out.pb Structure is documented below.
- schema
Bundle StringId - The unique name of the schema bundle in the form
[_a-zA-Z0-9][-_.a-zA-Z0-9]*
. - ignore
Warnings Boolean - If true, allow backwards incompatible changes.
- instance String
- The name of the instance to create the schema bundle within.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- table String
- The name of the table to create the schema bundle within.
- proto
Schema SchemaBundle Proto Schema - File descriptor set, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $ protoc --include_imports --include_source_info test.proto -o out.pb Structure is documented below.
- schema
Bundle stringId - The unique name of the schema bundle in the form
[_a-zA-Z0-9][-_.a-zA-Z0-9]*
. - ignore
Warnings boolean - If true, allow backwards incompatible changes.
- instance string
- The name of the instance to create the schema bundle within.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- table string
- The name of the table to create the schema bundle within.
- proto_
schema SchemaBundle Proto Schema Args - File descriptor set, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $ protoc --include_imports --include_source_info test.proto -o out.pb Structure is documented below.
- schema_
bundle_ strid - The unique name of the schema bundle in the form
[_a-zA-Z0-9][-_.a-zA-Z0-9]*
. - ignore_
warnings bool - If true, allow backwards incompatible changes.
- instance str
- The name of the instance to create the schema bundle within.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- table str
- The name of the table to create the schema bundle within.
- proto
Schema Property Map - File descriptor set, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $ protoc --include_imports --include_source_info test.proto -o out.pb Structure is documented below.
- schema
Bundle StringId - The unique name of the schema bundle in the form
[_a-zA-Z0-9][-_.a-zA-Z0-9]*
. - ignore
Warnings Boolean - If true, allow backwards incompatible changes.
- instance String
- The name of the instance to create the schema bundle within.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- table String
- The name of the table to create the schema bundle within.
Outputs
All input properties are implicitly available as output properties. Additionally, the SchemaBundle resource produces the following output properties:
Look up Existing SchemaBundle Resource
Get an existing SchemaBundle resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: SchemaBundleState, opts?: CustomResourceOptions): SchemaBundle
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
ignore_warnings: Optional[bool] = None,
instance: Optional[str] = None,
name: Optional[str] = None,
project: Optional[str] = None,
proto_schema: Optional[SchemaBundleProtoSchemaArgs] = None,
schema_bundle_id: Optional[str] = None,
table: Optional[str] = None) -> SchemaBundle
func GetSchemaBundle(ctx *Context, name string, id IDInput, state *SchemaBundleState, opts ...ResourceOption) (*SchemaBundle, error)
public static SchemaBundle Get(string name, Input<string> id, SchemaBundleState? state, CustomResourceOptions? opts = null)
public static SchemaBundle get(String name, Output<String> id, SchemaBundleState state, CustomResourceOptions options)
resources: _: type: gcp:bigtable:SchemaBundle get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Ignore
Warnings bool - If true, allow backwards incompatible changes.
- Instance string
- The name of the instance to create the schema bundle within.
- Name string
- The unique name of the requested schema bundle. Values are of the form
projects/<project>/instances/<instance>/tables/<table>/schemaBundles/<schemaBundleId>
. - Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Proto
Schema SchemaBundle Proto Schema - File descriptor set, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $ protoc --include_imports --include_source_info test.proto -o out.pb Structure is documented below.
- Schema
Bundle stringId - The unique name of the schema bundle in the form
[_a-zA-Z0-9][-_.a-zA-Z0-9]*
. - Table string
- The name of the table to create the schema bundle within.
- Ignore
Warnings bool - If true, allow backwards incompatible changes.
- Instance string
- The name of the instance to create the schema bundle within.
- Name string
- The unique name of the requested schema bundle. Values are of the form
projects/<project>/instances/<instance>/tables/<table>/schemaBundles/<schemaBundleId>
. - Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Proto
Schema SchemaBundle Proto Schema Args - File descriptor set, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $ protoc --include_imports --include_source_info test.proto -o out.pb Structure is documented below.
- Schema
Bundle stringId - The unique name of the schema bundle in the form
[_a-zA-Z0-9][-_.a-zA-Z0-9]*
. - Table string
- The name of the table to create the schema bundle within.
- ignore
Warnings Boolean - If true, allow backwards incompatible changes.
- instance String
- The name of the instance to create the schema bundle within.
- name String
- The unique name of the requested schema bundle. Values are of the form
projects/<project>/instances/<instance>/tables/<table>/schemaBundles/<schemaBundleId>
. - project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- proto
Schema SchemaBundle Proto Schema - File descriptor set, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $ protoc --include_imports --include_source_info test.proto -o out.pb Structure is documented below.
- schema
Bundle StringId - The unique name of the schema bundle in the form
[_a-zA-Z0-9][-_.a-zA-Z0-9]*
. - table String
- The name of the table to create the schema bundle within.
- ignore
Warnings boolean - If true, allow backwards incompatible changes.
- instance string
- The name of the instance to create the schema bundle within.
- name string
- The unique name of the requested schema bundle. Values are of the form
projects/<project>/instances/<instance>/tables/<table>/schemaBundles/<schemaBundleId>
. - project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- proto
Schema SchemaBundle Proto Schema - File descriptor set, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $ protoc --include_imports --include_source_info test.proto -o out.pb Structure is documented below.
- schema
Bundle stringId - The unique name of the schema bundle in the form
[_a-zA-Z0-9][-_.a-zA-Z0-9]*
. - table string
- The name of the table to create the schema bundle within.
- ignore_
warnings bool - If true, allow backwards incompatible changes.
- instance str
- The name of the instance to create the schema bundle within.
- name str
- The unique name of the requested schema bundle. Values are of the form
projects/<project>/instances/<instance>/tables/<table>/schemaBundles/<schemaBundleId>
. - project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- proto_
schema SchemaBundle Proto Schema Args - File descriptor set, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $ protoc --include_imports --include_source_info test.proto -o out.pb Structure is documented below.
- schema_
bundle_ strid - The unique name of the schema bundle in the form
[_a-zA-Z0-9][-_.a-zA-Z0-9]*
. - table str
- The name of the table to create the schema bundle within.
- ignore
Warnings Boolean - If true, allow backwards incompatible changes.
- instance String
- The name of the instance to create the schema bundle within.
- name String
- The unique name of the requested schema bundle. Values are of the form
projects/<project>/instances/<instance>/tables/<table>/schemaBundles/<schemaBundleId>
. - project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- proto
Schema Property Map - File descriptor set, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $ protoc --include_imports --include_source_info test.proto -o out.pb Structure is documented below.
- schema
Bundle StringId - The unique name of the schema bundle in the form
[_a-zA-Z0-9][-_.a-zA-Z0-9]*
. - table String
- The name of the table to create the schema bundle within.
Supporting Types
SchemaBundleProtoSchema, SchemaBundleProtoSchemaArgs
- Proto
Descriptors string - Base64 encoded content of the file.
- Proto
Descriptors string - Base64 encoded content of the file.
- proto
Descriptors String - Base64 encoded content of the file.
- proto
Descriptors string - Base64 encoded content of the file.
- proto_
descriptors str - Base64 encoded content of the file.
- proto
Descriptors String - Base64 encoded content of the file.
Import
SchemaBundle can be imported using any of these accepted formats:
projects/{{project}}/instances/{{instance}}/tables/{{table}}/schemaBundles/{{schema_bundle_id}}
{{project}}/{{instance}}/{{table}}/{{schema_bundle_id}}
{{instance}}/{{table}}/{{schema_bundle_id}}
When using the pulumi import
command, SchemaBundle can be imported using one of the formats above. For example:
$ pulumi import gcp:bigtable/schemaBundle:SchemaBundle default projects/{{project}}/instances/{{instance}}/tables/{{table}}/schemaBundles/{{schema_bundle_id}}
$ pulumi import gcp:bigtable/schemaBundle:SchemaBundle default {{project}}/{{instance}}/{{table}}/{{schema_bundle_id}}
$ pulumi import gcp:bigtable/schemaBundle:SchemaBundle default {{instance}}/{{table}}/{{schema_bundle_id}}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-beta
Terraform Provider.