com.pulumi.gcp.bigtable.kotlin.TableArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-kotlin Show documentation
Show all versions of pulumi-gcp-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.bigtable.kotlin
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.gcp.bigtable.TableArgs.builder
import com.pulumi.gcp.bigtable.kotlin.inputs.TableAutomatedBackupPolicyArgs
import com.pulumi.gcp.bigtable.kotlin.inputs.TableAutomatedBackupPolicyArgsBuilder
import com.pulumi.gcp.bigtable.kotlin.inputs.TableColumnFamilyArgs
import com.pulumi.gcp.bigtable.kotlin.inputs.TableColumnFamilyArgsBuilder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName
/**
* 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).
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const instance = new gcp.bigtable.Instance("instance", {
* name: "tf-instance",
* clusters: [{
* clusterId: "tf-instance-cluster",
* zone: "us-central1-b",
* numNodes: 3,
* storageType: "HDD",
* }],
* });
* const table = new gcp.bigtable.Table("table", {
* name: "tf-table",
* instanceName: instance.name,
* splitKeys: [
* "a",
* "b",
* "c",
* ],
* columnFamilies: [
* {
* family: "family-first",
* },
* {
* family: "family-second",
* type: "intsum",
* },
* {
* family: "family-third",
* type: ` {
* \x09\x09\x09\x09\x09"aggregateType": {
* \x09\x09\x09\x09\x09\x09"max": {},
* \x09\x09\x09\x09\x09\x09"inputType": {
* \x09\x09\x09\x09\x09\x09\x09"int64Type": {
* \x09\x09\x09\x09\x09\x09\x09\x09"encoding": {
* \x09\x09\x09\x09\x09\x09\x09\x09\x09"bigEndianBytes": {}
* \x09\x09\x09\x09\x09\x09\x09\x09}
* \x09\x09\x09\x09\x09\x09\x09}
* \x09\x09\x09\x09\x09\x09}
* \x09\x09\x09\x09\x09}
* \x09\x09\x09\x09}
* `,
* },
* ],
* changeStreamRetention: "24h0m0s",
* automatedBackupPolicy: {
* retentionPeriod: "72h0m0s",
* frequency: "24h0m0s",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* instance = gcp.bigtable.Instance("instance",
* name="tf-instance",
* clusters=[{
* "cluster_id": "tf-instance-cluster",
* "zone": "us-central1-b",
* "num_nodes": 3,
* "storage_type": "HDD",
* }])
* table = gcp.bigtable.Table("table",
* name="tf-table",
* instance_name=instance.name,
* split_keys=[
* "a",
* "b",
* "c",
* ],
* column_families=[
* {
* "family": "family-first",
* },
* {
* "family": "family-second",
* "type": "intsum",
* },
* {
* "family": "family-third",
* "type": """ {
* \x09\x09\x09\x09\x09"aggregateType": {
* \x09\x09\x09\x09\x09\x09"max": {},
* \x09\x09\x09\x09\x09\x09"inputType": {
* \x09\x09\x09\x09\x09\x09\x09"int64Type": {
* \x09\x09\x09\x09\x09\x09\x09\x09"encoding": {
* \x09\x09\x09\x09\x09\x09\x09\x09\x09"bigEndianBytes": {}
* \x09\x09\x09\x09\x09\x09\x09\x09}
* \x09\x09\x09\x09\x09\x09\x09}
* \x09\x09\x09\x09\x09\x09}
* \x09\x09\x09\x09\x09}
* \x09\x09\x09\x09}
* """,
* },
* ],
* change_stream_retention="24h0m0s",
* automated_backup_policy={
* "retention_period": "72h0m0s",
* "frequency": "24h0m0s",
* })
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var instance = new Gcp.BigTable.Instance("instance", new()
* {
* Name = "tf-instance",
* Clusters = new[]
* {
* new Gcp.BigTable.Inputs.InstanceClusterArgs
* {
* ClusterId = "tf-instance-cluster",
* Zone = "us-central1-b",
* NumNodes = 3,
* StorageType = "HDD",
* },
* },
* });
* var table = new Gcp.BigTable.Table("table", new()
* {
* Name = "tf-table",
* InstanceName = instance.Name,
* SplitKeys = new[]
* {
* "a",
* "b",
* "c",
* },
* ColumnFamilies = new[]
* {
* new Gcp.BigTable.Inputs.TableColumnFamilyArgs
* {
* Family = "family-first",
* },
* new Gcp.BigTable.Inputs.TableColumnFamilyArgs
* {
* Family = "family-second",
* Type = "intsum",
* },
* new Gcp.BigTable.Inputs.TableColumnFamilyArgs
* {
* Family = "family-third",
* Type = @" {
* ""aggregateType"": {
* ""max"": {},
* ""inputType"": {
* ""int64Type"": {
* ""encoding"": {
* ""bigEndianBytes"": {}
* }
* }
* }
* }
* }
* ",
* },
* },
* ChangeStreamRetention = "24h0m0s",
* AutomatedBackupPolicy = new Gcp.BigTable.Inputs.TableAutomatedBackupPolicyArgs
* {
* RetentionPeriod = "72h0m0s",
* Frequency = "24h0m0s",
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/bigtable"
* "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("tf-instance"),
* Clusters: bigtable.InstanceClusterArray{
* &bigtable.InstanceClusterArgs{
* ClusterId: pulumi.String("tf-instance-cluster"),
* Zone: pulumi.String("us-central1-b"),
* NumNodes: pulumi.Int(3),
* StorageType: pulumi.String("HDD"),
* },
* },
* })
* if err != nil {
* return err
* }
* _, err = bigtable.NewTable(ctx, "table", &bigtable.TableArgs{
* Name: pulumi.String("tf-table"),
* InstanceName: instance.Name,
* SplitKeys: pulumi.StringArray{
* pulumi.String("a"),
* pulumi.String("b"),
* pulumi.String("c"),
* },
* ColumnFamilies: bigtable.TableColumnFamilyArray{
* &bigtable.TableColumnFamilyArgs{
* Family: pulumi.String("family-first"),
* },
* &bigtable.TableColumnFamilyArgs{
* Family: pulumi.String("family-second"),
* Type: pulumi.String("intsum"),
* },
* &bigtable.TableColumnFamilyArgs{
* Family: pulumi.String("family-third"),
* Type: pulumi.String(` {
* "aggregateType": {
* "max": {},
* "inputType": {
* "int64Type": {
* "encoding": {
* "bigEndianBytes": {}
* }
* }
* }
* }
* }
* `),
* },
* },
* ChangeStreamRetention: pulumi.String("24h0m0s"),
* AutomatedBackupPolicy: &bigtable.TableAutomatedBackupPolicyArgs{
* RetentionPeriod: pulumi.String("72h0m0s"),
* Frequency: pulumi.String("24h0m0s"),
* },
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* 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.inputs.TableAutomatedBackupPolicyArgs;
* 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("tf-instance")
* .clusters(InstanceClusterArgs.builder()
* .clusterId("tf-instance-cluster")
* .zone("us-central1-b")
* .numNodes(3)
* .storageType("HDD")
* .build())
* .build());
* var table = new Table("table", TableArgs.builder()
* .name("tf-table")
* .instanceName(instance.name())
* .splitKeys(
* "a",
* "b",
* "c")
* .columnFamilies(
* TableColumnFamilyArgs.builder()
* .family("family-first")
* .build(),
* TableColumnFamilyArgs.builder()
* .family("family-second")
* .type("intsum")
* .build(),
* TableColumnFamilyArgs.builder()
* .family("family-third")
* .type("""
* {
* "aggregateType": {
* "max": {},
* "inputType": {
* "int64Type": {
* "encoding": {
* "bigEndianBytes": {}
* }
* }
* }
* }
* }
* """)
* .build())
* .changeStreamRetention("24h0m0s")
* .automatedBackupPolicy(TableAutomatedBackupPolicyArgs.builder()
* .retentionPeriod("72h0m0s")
* .frequency("24h0m0s")
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* instance:
* type: gcp:bigtable:Instance
* properties:
* name: tf-instance
* clusters:
* - clusterId: tf-instance-cluster
* zone: us-central1-b
* numNodes: 3
* storageType: HDD
* table:
* type: gcp:bigtable:Table
* properties:
* name: tf-table
* instanceName: ${instance.name}
* splitKeys:
* - a
* - b
* - c
* columnFamilies:
* - family: family-first
* - family: family-second
* type: intsum
* - family: family-third
* type: |2
* {
* "aggregateType": {
* "max": {},
* "inputType": {
* "int64Type": {
* "encoding": {
* "bigEndianBytes": {}
* }
* }
* }
* }
* }
* changeStreamRetention: 24h0m0s
* automatedBackupPolicy:
* retentionPeriod: 72h0m0s
* frequency: 24h0m0s
* ```
*
* ## Import
* -> **Fields affected by import** The following fields can't be read and will show diffs if set in config when imported: `split_keys`
* Bigtable Tables can be imported using any of these accepted formats:
* * `projects/{{project}}/instances/{{instance_name}}/tables/{{name}}`
* * `{{project}}/{{instance_name}}/{{name}}`
* * `{{instance_name}}/{{name}}`
* When using the `pulumi import` command, Bigtable Tables can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:bigtable/table:Table default projects/{{project}}/instances/{{instance_name}}/tables/{{name}}
* ```
* ```sh
* $ pulumi import gcp:bigtable/table:Table default {{project}}/{{instance_name}}/{{name}}
* ```
* ```sh
* $ pulumi import gcp:bigtable/table:Table default {{instance_name}}/{{name}}
* ```
* @property automatedBackupPolicy Defines an automated backup policy for a table, specified by Retention Period and Frequency. To disable, set both Retention Period and Frequency to 0.
* -----
* @property changeStreamRetention Duration to retain change stream data for the table. Set to 0 to disable. Must be between 1 and 7 days.
* @property columnFamilies A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
* @property deletionProtection A field to make the table protected against data loss i.e. when set to PROTECTED, deleting the table, the column families in the table, and the instance containing the table would be prohibited. If not provided, deletion protection will be set to UNPROTECTED.
* @property instanceName The name of the Bigtable instance.
* @property name The name of the table. Must be 1-50 characters and must only contain hyphens, underscores, periods, letters and numbers.
* @property project The ID of the project in which the resource belongs. If it
* is not provided, the provider project is used.
* @property splitKeys 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 `gcp.bigtable.Table` resource.
*/
public data class TableArgs(
public val automatedBackupPolicy: Output? = null,
public val changeStreamRetention: Output? = null,
public val columnFamilies: Output>? = null,
public val deletionProtection: Output? = null,
public val instanceName: Output? = null,
public val name: Output? = null,
public val project: Output? = null,
public val splitKeys: Output>? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.gcp.bigtable.TableArgs =
com.pulumi.gcp.bigtable.TableArgs.builder()
.automatedBackupPolicy(
automatedBackupPolicy?.applyValue({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
}),
)
.changeStreamRetention(changeStreamRetention?.applyValue({ args0 -> args0 }))
.columnFamilies(
columnFamilies?.applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
})
}),
)
.deletionProtection(deletionProtection?.applyValue({ args0 -> args0 }))
.instanceName(instanceName?.applyValue({ args0 -> args0 }))
.name(name?.applyValue({ args0 -> args0 }))
.project(project?.applyValue({ args0 -> args0 }))
.splitKeys(splitKeys?.applyValue({ args0 -> args0.map({ args0 -> args0 }) })).build()
}
/**
* Builder for [TableArgs].
*/
@PulumiTagMarker
public class TableArgsBuilder internal constructor() {
private var automatedBackupPolicy: Output? = null
private var changeStreamRetention: Output? = null
private var columnFamilies: Output>? = null
private var deletionProtection: Output? = null
private var instanceName: Output? = null
private var name: Output? = null
private var project: Output? = null
private var splitKeys: Output>? = null
/**
* @param value Defines an automated backup policy for a table, specified by Retention Period and Frequency. To disable, set both Retention Period and Frequency to 0.
* -----
*/
@JvmName("ofjlvpunkgbfivec")
public suspend fun automatedBackupPolicy(`value`: Output) {
this.automatedBackupPolicy = value
}
/**
* @param value Duration to retain change stream data for the table. Set to 0 to disable. Must be between 1 and 7 days.
*/
@JvmName("yjjmlfdhxkmoaprp")
public suspend fun changeStreamRetention(`value`: Output) {
this.changeStreamRetention = value
}
/**
* @param value A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
*/
@JvmName("herlkxxqfjroammb")
public suspend fun columnFamilies(`value`: Output>) {
this.columnFamilies = value
}
@JvmName("sghhiledbdtwigse")
public suspend fun columnFamilies(vararg values: Output) {
this.columnFamilies = Output.all(values.asList())
}
/**
* @param values A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
*/
@JvmName("arspipkoyvxdvkio")
public suspend fun columnFamilies(values: List>) {
this.columnFamilies = Output.all(values)
}
/**
* @param value A field to make the table protected against data loss i.e. when set to PROTECTED, deleting the table, the column families in the table, and the instance containing the table would be prohibited. If not provided, deletion protection will be set to UNPROTECTED.
*/
@JvmName("amhraoemkwypwlqk")
public suspend fun deletionProtection(`value`: Output) {
this.deletionProtection = value
}
/**
* @param value The name of the Bigtable instance.
*/
@JvmName("aerakvauakeplxds")
public suspend fun instanceName(`value`: Output) {
this.instanceName = value
}
/**
* @param value The name of the table. Must be 1-50 characters and must only contain hyphens, underscores, periods, letters and numbers.
*/
@JvmName("judcgjhmphefmehe")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value The ID of the project in which the resource belongs. If it
* is not provided, the provider project is used.
*/
@JvmName("vyyqhfbmetdjpair")
public suspend fun project(`value`: Output) {
this.project = value
}
/**
* @param value 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 `gcp.bigtable.Table` resource.
*/
@JvmName("rpwhegmthtarvkul")
public suspend fun splitKeys(`value`: Output>) {
this.splitKeys = value
}
@JvmName("fpeeaabbigsksuyp")
public suspend fun splitKeys(vararg values: Output) {
this.splitKeys = Output.all(values.asList())
}
/**
* @param values 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 `gcp.bigtable.Table` resource.
*/
@JvmName("bvfayblqounvbepw")
public suspend fun splitKeys(values: List>) {
this.splitKeys = Output.all(values)
}
/**
* @param value Defines an automated backup policy for a table, specified by Retention Period and Frequency. To disable, set both Retention Period and Frequency to 0.
* -----
*/
@JvmName("epitxlubqgwfilvi")
public suspend fun automatedBackupPolicy(`value`: TableAutomatedBackupPolicyArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.automatedBackupPolicy = mapped
}
/**
* @param argument Defines an automated backup policy for a table, specified by Retention Period and Frequency. To disable, set both Retention Period and Frequency to 0.
* -----
*/
@JvmName("kwfvvtsjogkjursb")
public suspend fun automatedBackupPolicy(argument: suspend TableAutomatedBackupPolicyArgsBuilder.() -> Unit) {
val toBeMapped = TableAutomatedBackupPolicyArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.automatedBackupPolicy = mapped
}
/**
* @param value Duration to retain change stream data for the table. Set to 0 to disable. Must be between 1 and 7 days.
*/
@JvmName("fkcrhkgxfhutsltk")
public suspend fun changeStreamRetention(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.changeStreamRetention = mapped
}
/**
* @param value A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
*/
@JvmName("cehvkrvjkcgosqvw")
public suspend fun columnFamilies(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.columnFamilies = mapped
}
/**
* @param argument A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
*/
@JvmName("ibchextqhqmsajgc")
public suspend fun columnFamilies(argument: List Unit>) {
val toBeMapped = argument.toList().map {
TableColumnFamilyArgsBuilder().applySuspend {
it()
}.build()
}
val mapped = of(toBeMapped)
this.columnFamilies = mapped
}
/**
* @param argument A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
*/
@JvmName("ywyrvmgrcyqlkebu")
public suspend fun columnFamilies(vararg argument: suspend TableColumnFamilyArgsBuilder.() -> Unit) {
val toBeMapped = argument.toList().map {
TableColumnFamilyArgsBuilder().applySuspend {
it()
}.build()
}
val mapped = of(toBeMapped)
this.columnFamilies = mapped
}
/**
* @param argument A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
*/
@JvmName("scqyqenvwhefioaa")
public suspend fun columnFamilies(argument: suspend TableColumnFamilyArgsBuilder.() -> Unit) {
val toBeMapped = listOf(TableColumnFamilyArgsBuilder().applySuspend { argument() }.build())
val mapped = of(toBeMapped)
this.columnFamilies = mapped
}
/**
* @param values A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
*/
@JvmName("uqbjuwmelthpmjlp")
public suspend fun columnFamilies(vararg values: TableColumnFamilyArgs) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.columnFamilies = mapped
}
/**
* @param value A field to make the table protected against data loss i.e. when set to PROTECTED, deleting the table, the column families in the table, and the instance containing the table would be prohibited. If not provided, deletion protection will be set to UNPROTECTED.
*/
@JvmName("samtbroetdwfkxwr")
public suspend fun deletionProtection(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.deletionProtection = mapped
}
/**
* @param value The name of the Bigtable instance.
*/
@JvmName("waspawlyytjpqbld")
public suspend fun instanceName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.instanceName = mapped
}
/**
* @param value The name of the table. Must be 1-50 characters and must only contain hyphens, underscores, periods, letters and numbers.
*/
@JvmName("sjtawaulgmjsgroe")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value The ID of the project in which the resource belongs. If it
* is not provided, the provider project is used.
*/
@JvmName("mmvpqmywralbcvlj")
public suspend fun project(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.project = mapped
}
/**
* @param value 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 `gcp.bigtable.Table` resource.
*/
@JvmName("skkdvsbkfjnqnllh")
public suspend fun splitKeys(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.splitKeys = mapped
}
/**
* @param values 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 `gcp.bigtable.Table` resource.
*/
@JvmName("rlqsdgyotfibodto")
public suspend fun splitKeys(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.splitKeys = mapped
}
internal fun build(): TableArgs = TableArgs(
automatedBackupPolicy = automatedBackupPolicy,
changeStreamRetention = changeStreamRetention,
columnFamilies = columnFamilies,
deletionProtection = deletionProtection,
instanceName = instanceName,
name = name,
project = project,
splitKeys = splitKeys,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy