com.pulumi.azure.cosmosdb.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-azure-kotlin Show documentation
Show all versions of pulumi-azure-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.azure.cosmosdb.kotlin
import com.pulumi.azure.cosmosdb.TableArgs.builder
import com.pulumi.azure.cosmosdb.kotlin.inputs.TableAutoscaleSettingsArgs
import com.pulumi.azure.cosmosdb.kotlin.inputs.TableAutoscaleSettingsArgsBuilder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.jvm.JvmName
/**
* Manages a Table within a Cosmos DB Account.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azure from "@pulumi/azure";
* const example = azure.cosmosdb.getAccount({
* name: "tfex-cosmosdb-account",
* resourceGroupName: "tfex-cosmosdb-account-rg",
* });
* const exampleTable = new azure.cosmosdb.Table("example", {
* name: "tfex-cosmos-table",
* resourceGroupName: example.then(example => example.resourceGroupName),
* accountName: example.then(example => example.name),
* throughput: 400,
* });
* ```
* ```python
* import pulumi
* import pulumi_azure as azure
* example = azure.cosmosdb.get_account(name="tfex-cosmosdb-account",
* resource_group_name="tfex-cosmosdb-account-rg")
* example_table = azure.cosmosdb.Table("example",
* name="tfex-cosmos-table",
* resource_group_name=example.resource_group_name,
* account_name=example.name,
* throughput=400)
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Azure = Pulumi.Azure;
* return await Deployment.RunAsync(() =>
* {
* var example = Azure.CosmosDB.GetAccount.Invoke(new()
* {
* Name = "tfex-cosmosdb-account",
* ResourceGroupName = "tfex-cosmosdb-account-rg",
* });
* var exampleTable = new Azure.CosmosDB.Table("example", new()
* {
* Name = "tfex-cosmos-table",
* ResourceGroupName = example.Apply(getAccountResult => getAccountResult.ResourceGroupName),
* AccountName = example.Apply(getAccountResult => getAccountResult.Name),
* Throughput = 400,
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/cosmosdb"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* example, err := cosmosdb.LookupAccount(ctx, &cosmosdb.LookupAccountArgs{
* Name: "tfex-cosmosdb-account",
* ResourceGroupName: "tfex-cosmosdb-account-rg",
* }, nil)
* if err != nil {
* return err
* }
* _, err = cosmosdb.NewTable(ctx, "example", &cosmosdb.TableArgs{
* Name: pulumi.String("tfex-cosmos-table"),
* ResourceGroupName: pulumi.String(example.ResourceGroupName),
* AccountName: pulumi.String(example.Name),
* Throughput: pulumi.Int(400),
* })
* 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.azure.cosmosdb.CosmosdbFunctions;
* import com.pulumi.azure.cosmosdb.inputs.GetAccountArgs;
* import com.pulumi.azure.cosmosdb.Table;
* import com.pulumi.azure.cosmosdb.TableArgs;
* 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) {
* final var example = CosmosdbFunctions.getAccount(GetAccountArgs.builder()
* .name("tfex-cosmosdb-account")
* .resourceGroupName("tfex-cosmosdb-account-rg")
* .build());
* var exampleTable = new Table("exampleTable", TableArgs.builder()
* .name("tfex-cosmos-table")
* .resourceGroupName(example.applyValue(getAccountResult -> getAccountResult.resourceGroupName()))
* .accountName(example.applyValue(getAccountResult -> getAccountResult.name()))
* .throughput(400)
* .build());
* }
* }
* ```
* ```yaml
* resources:
* exampleTable:
* type: azure:cosmosdb:Table
* name: example
* properties:
* name: tfex-cosmos-table
* resourceGroupName: ${example.resourceGroupName}
* accountName: ${example.name}
* throughput: 400
* variables:
* example:
* fn::invoke:
* Function: azure:cosmosdb:getAccount
* Arguments:
* name: tfex-cosmosdb-account
* resourceGroupName: tfex-cosmosdb-account-rg
* ```
*
* ## Import
* CosmosDB Tables can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:cosmosdb/table:Table table1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/account1/tables/table1
* ```
* @property accountName The name of the Cosmos DB Table to create the table within. Changing this forces a new resource to be created.
* @property autoscaleSettings An `autoscale_settings` block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply.
* > **Note:** Switching between autoscale and manual throughput is not supported via this provider and must be completed via the Azure Portal and refreshed.
* @property name Specifies the name of the Cosmos DB Table. Changing this forces a new resource to be created.
* @property resourceGroupName The name of the resource group in which the Cosmos DB Table is created. Changing this forces a new resource to be created.
* @property throughput The throughput of Table (RU/s). Must be set in increments of `100`. The minimum value is `400`. This must be set upon database creation otherwise it cannot be updated without a manual resource destroy-apply.
* > **Note:** throughput has a maximum value of `1000000` unless a higher limit is requested via Azure Support
*/
public data class TableArgs(
public val accountName: Output? = null,
public val autoscaleSettings: Output? = null,
public val name: Output? = null,
public val resourceGroupName: Output? = null,
public val throughput: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.azure.cosmosdb.TableArgs =
com.pulumi.azure.cosmosdb.TableArgs.builder()
.accountName(accountName?.applyValue({ args0 -> args0 }))
.autoscaleSettings(autoscaleSettings?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.name(name?.applyValue({ args0 -> args0 }))
.resourceGroupName(resourceGroupName?.applyValue({ args0 -> args0 }))
.throughput(throughput?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [TableArgs].
*/
@PulumiTagMarker
public class TableArgsBuilder internal constructor() {
private var accountName: Output? = null
private var autoscaleSettings: Output? = null
private var name: Output? = null
private var resourceGroupName: Output? = null
private var throughput: Output? = null
/**
* @param value The name of the Cosmos DB Table to create the table within. Changing this forces a new resource to be created.
*/
@JvmName("jpxyfgagaykjhjjf")
public suspend fun accountName(`value`: Output) {
this.accountName = value
}
/**
* @param value An `autoscale_settings` block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply.
* > **Note:** Switching between autoscale and manual throughput is not supported via this provider and must be completed via the Azure Portal and refreshed.
*/
@JvmName("pahbqchcasdxwlnm")
public suspend fun autoscaleSettings(`value`: Output) {
this.autoscaleSettings = value
}
/**
* @param value Specifies the name of the Cosmos DB Table. Changing this forces a new resource to be created.
*/
@JvmName("kylsstiofqsehhrw")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value The name of the resource group in which the Cosmos DB Table is created. Changing this forces a new resource to be created.
*/
@JvmName("aarclkeptoasdrjp")
public suspend fun resourceGroupName(`value`: Output) {
this.resourceGroupName = value
}
/**
* @param value The throughput of Table (RU/s). Must be set in increments of `100`. The minimum value is `400`. This must be set upon database creation otherwise it cannot be updated without a manual resource destroy-apply.
* > **Note:** throughput has a maximum value of `1000000` unless a higher limit is requested via Azure Support
*/
@JvmName("usinmqtdfcfcckkl")
public suspend fun throughput(`value`: Output) {
this.throughput = value
}
/**
* @param value The name of the Cosmos DB Table to create the table within. Changing this forces a new resource to be created.
*/
@JvmName("aspcjbthlxhpshdm")
public suspend fun accountName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.accountName = mapped
}
/**
* @param value An `autoscale_settings` block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply.
* > **Note:** Switching between autoscale and manual throughput is not supported via this provider and must be completed via the Azure Portal and refreshed.
*/
@JvmName("kaoqutxrahdlxvvj")
public suspend fun autoscaleSettings(`value`: TableAutoscaleSettingsArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.autoscaleSettings = mapped
}
/**
* @param argument An `autoscale_settings` block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply.
* > **Note:** Switching between autoscale and manual throughput is not supported via this provider and must be completed via the Azure Portal and refreshed.
*/
@JvmName("rmasjpslmmiprgcb")
public suspend
fun autoscaleSettings(argument: suspend TableAutoscaleSettingsArgsBuilder.() -> Unit) {
val toBeMapped = TableAutoscaleSettingsArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.autoscaleSettings = mapped
}
/**
* @param value Specifies the name of the Cosmos DB Table. Changing this forces a new resource to be created.
*/
@JvmName("aialglmbxoqksrkf")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value The name of the resource group in which the Cosmos DB Table is created. Changing this forces a new resource to be created.
*/
@JvmName("rlqcoteyxcnnqnsd")
public suspend fun resourceGroupName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.resourceGroupName = mapped
}
/**
* @param value The throughput of Table (RU/s). Must be set in increments of `100`. The minimum value is `400`. This must be set upon database creation otherwise it cannot be updated without a manual resource destroy-apply.
* > **Note:** throughput has a maximum value of `1000000` unless a higher limit is requested via Azure Support
*/
@JvmName("igpyjcsdcxnmkwtm")
public suspend fun throughput(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.throughput = mapped
}
internal fun build(): TableArgs = TableArgs(
accountName = accountName,
autoscaleSettings = autoscaleSettings,
name = name,
resourceGroupName = resourceGroupName,
throughput = throughput,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy