com.pulumi.azure.cosmosdb.kotlin.SqlContainer.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.kotlin.outputs.SqlContainerAutoscaleSettings
import com.pulumi.azure.cosmosdb.kotlin.outputs.SqlContainerConflictResolutionPolicy
import com.pulumi.azure.cosmosdb.kotlin.outputs.SqlContainerIndexingPolicy
import com.pulumi.azure.cosmosdb.kotlin.outputs.SqlContainerUniqueKey
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import com.pulumi.azure.cosmosdb.kotlin.outputs.SqlContainerAutoscaleSettings.Companion.toKotlin as sqlContainerAutoscaleSettingsToKotlin
import com.pulumi.azure.cosmosdb.kotlin.outputs.SqlContainerConflictResolutionPolicy.Companion.toKotlin as sqlContainerConflictResolutionPolicyToKotlin
import com.pulumi.azure.cosmosdb.kotlin.outputs.SqlContainerIndexingPolicy.Companion.toKotlin as sqlContainerIndexingPolicyToKotlin
import com.pulumi.azure.cosmosdb.kotlin.outputs.SqlContainerUniqueKey.Companion.toKotlin as sqlContainerUniqueKeyToKotlin
/**
* Builder for [SqlContainer].
*/
@PulumiTagMarker
public class SqlContainerResourceBuilder internal constructor() {
public var name: String? = null
public var args: SqlContainerArgs = SqlContainerArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend SqlContainerArgsBuilder.() -> Unit) {
val builder = SqlContainerArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): SqlContainer {
val builtJavaResource = com.pulumi.azure.cosmosdb.SqlContainer(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return SqlContainer(builtJavaResource)
}
}
/**
* Manages a SQL Container 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 exampleSqlDatabase = new azure.cosmosdb.SqlDatabase("example", {
* name: "example-acsd",
* resourceGroupName: example.then(example => example.resourceGroupName),
* accountName: example.then(example => example.name),
* });
* const exampleSqlContainer = new azure.cosmosdb.SqlContainer("example", {
* name: "example-container",
* resourceGroupName: example.then(example => example.resourceGroupName),
* accountName: example.then(example => example.name),
* databaseName: exampleSqlDatabase.name,
* partitionKeyPath: "/definition/id",
* partitionKeyVersion: 1,
* throughput: 400,
* indexingPolicy: {
* indexingMode: "consistent",
* includedPaths: [
* {
* path: "/*",
* },
* {
* path: "/included/?",
* },
* ],
* excludedPaths: [{
* path: "/excluded/?",
* }],
* },
* uniqueKeys: [{
* paths: [
* "/definition/idlong",
* "/definition/idshort",
* ],
* }],
* });
* ```
* ```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_sql_database = azure.cosmosdb.SqlDatabase("example",
* name="example-acsd",
* resource_group_name=example.resource_group_name,
* account_name=example.name)
* example_sql_container = azure.cosmosdb.SqlContainer("example",
* name="example-container",
* resource_group_name=example.resource_group_name,
* account_name=example.name,
* database_name=example_sql_database.name,
* partition_key_path="/definition/id",
* partition_key_version=1,
* throughput=400,
* indexing_policy=azure.cosmosdb.SqlContainerIndexingPolicyArgs(
* indexing_mode="consistent",
* included_paths=[
* azure.cosmosdb.SqlContainerIndexingPolicyIncludedPathArgs(
* path="/*",
* ),
* azure.cosmosdb.SqlContainerIndexingPolicyIncludedPathArgs(
* path="/included/?",
* ),
* ],
* excluded_paths=[azure.cosmosdb.SqlContainerIndexingPolicyExcludedPathArgs(
* path="/excluded/?",
* )],
* ),
* unique_keys=[azure.cosmosdb.SqlContainerUniqueKeyArgs(
* paths=[
* "/definition/idlong",
* "/definition/idshort",
* ],
* )])
* ```
* ```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 exampleSqlDatabase = new Azure.CosmosDB.SqlDatabase("example", new()
* {
* Name = "example-acsd",
* ResourceGroupName = example.Apply(getAccountResult => getAccountResult.ResourceGroupName),
* AccountName = example.Apply(getAccountResult => getAccountResult.Name),
* });
* var exampleSqlContainer = new Azure.CosmosDB.SqlContainer("example", new()
* {
* Name = "example-container",
* ResourceGroupName = example.Apply(getAccountResult => getAccountResult.ResourceGroupName),
* AccountName = example.Apply(getAccountResult => getAccountResult.Name),
* DatabaseName = exampleSqlDatabase.Name,
* PartitionKeyPath = "/definition/id",
* PartitionKeyVersion = 1,
* Throughput = 400,
* IndexingPolicy = new Azure.CosmosDB.Inputs.SqlContainerIndexingPolicyArgs
* {
* IndexingMode = "consistent",
* IncludedPaths = new[]
* {
* new Azure.CosmosDB.Inputs.SqlContainerIndexingPolicyIncludedPathArgs
* {
* Path = "/*",
* },
* new Azure.CosmosDB.Inputs.SqlContainerIndexingPolicyIncludedPathArgs
* {
* Path = "/included/?",
* },
* },
* ExcludedPaths = new[]
* {
* new Azure.CosmosDB.Inputs.SqlContainerIndexingPolicyExcludedPathArgs
* {
* Path = "/excluded/?",
* },
* },
* },
* UniqueKeys = new[]
* {
* new Azure.CosmosDB.Inputs.SqlContainerUniqueKeyArgs
* {
* Paths = new[]
* {
* "/definition/idlong",
* "/definition/idshort",
* },
* },
* },
* });
* });
* ```
* ```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
* }
* exampleSqlDatabase, err := cosmosdb.NewSqlDatabase(ctx, "example", &cosmosdb.SqlDatabaseArgs{
* Name: pulumi.String("example-acsd"),
* ResourceGroupName: pulumi.String(example.ResourceGroupName),
* AccountName: pulumi.String(example.Name),
* })
* if err != nil {
* return err
* }
* _, err = cosmosdb.NewSqlContainer(ctx, "example", &cosmosdb.SqlContainerArgs{
* Name: pulumi.String("example-container"),
* ResourceGroupName: pulumi.String(example.ResourceGroupName),
* AccountName: pulumi.String(example.Name),
* DatabaseName: exampleSqlDatabase.Name,
* PartitionKeyPath: pulumi.String("/definition/id"),
* PartitionKeyVersion: pulumi.Int(1),
* Throughput: pulumi.Int(400),
* IndexingPolicy: &cosmosdb.SqlContainerIndexingPolicyArgs{
* IndexingMode: pulumi.String("consistent"),
* IncludedPaths: cosmosdb.SqlContainerIndexingPolicyIncludedPathArray{
* &cosmosdb.SqlContainerIndexingPolicyIncludedPathArgs{
* Path: pulumi.String("/*"),
* },
* &cosmosdb.SqlContainerIndexingPolicyIncludedPathArgs{
* Path: pulumi.String("/included/?"),
* },
* },
* ExcludedPaths: cosmosdb.SqlContainerIndexingPolicyExcludedPathArray{
* &cosmosdb.SqlContainerIndexingPolicyExcludedPathArgs{
* Path: pulumi.String("/excluded/?"),
* },
* },
* },
* UniqueKeys: cosmosdb.SqlContainerUniqueKeyArray{
* &cosmosdb.SqlContainerUniqueKeyArgs{
* Paths: pulumi.StringArray{
* pulumi.String("/definition/idlong"),
* pulumi.String("/definition/idshort"),
* },
* },
* },
* })
* 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.SqlDatabase;
* import com.pulumi.azure.cosmosdb.SqlDatabaseArgs;
* import com.pulumi.azure.cosmosdb.SqlContainer;
* import com.pulumi.azure.cosmosdb.SqlContainerArgs;
* import com.pulumi.azure.cosmosdb.inputs.SqlContainerIndexingPolicyArgs;
* import com.pulumi.azure.cosmosdb.inputs.SqlContainerUniqueKeyArgs;
* 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 exampleSqlDatabase = new SqlDatabase("exampleSqlDatabase", SqlDatabaseArgs.builder()
* .name("example-acsd")
* .resourceGroupName(example.applyValue(getAccountResult -> getAccountResult.resourceGroupName()))
* .accountName(example.applyValue(getAccountResult -> getAccountResult.name()))
* .build());
* var exampleSqlContainer = new SqlContainer("exampleSqlContainer", SqlContainerArgs.builder()
* .name("example-container")
* .resourceGroupName(example.applyValue(getAccountResult -> getAccountResult.resourceGroupName()))
* .accountName(example.applyValue(getAccountResult -> getAccountResult.name()))
* .databaseName(exampleSqlDatabase.name())
* .partitionKeyPath("/definition/id")
* .partitionKeyVersion(1)
* .throughput(400)
* .indexingPolicy(SqlContainerIndexingPolicyArgs.builder()
* .indexingMode("consistent")
* .includedPaths(
* SqlContainerIndexingPolicyIncludedPathArgs.builder()
* .path("/*")
* .build(),
* SqlContainerIndexingPolicyIncludedPathArgs.builder()
* .path("/included/?")
* .build())
* .excludedPaths(SqlContainerIndexingPolicyExcludedPathArgs.builder()
* .path("/excluded/?")
* .build())
* .build())
* .uniqueKeys(SqlContainerUniqueKeyArgs.builder()
* .paths(
* "/definition/idlong",
* "/definition/idshort")
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* exampleSqlDatabase:
* type: azure:cosmosdb:SqlDatabase
* name: example
* properties:
* name: example-acsd
* resourceGroupName: ${example.resourceGroupName}
* accountName: ${example.name}
* exampleSqlContainer:
* type: azure:cosmosdb:SqlContainer
* name: example
* properties:
* name: example-container
* resourceGroupName: ${example.resourceGroupName}
* accountName: ${example.name}
* databaseName: ${exampleSqlDatabase.name}
* partitionKeyPath: /definition/id
* partitionKeyVersion: 1
* throughput: 400
* indexingPolicy:
* indexingMode: consistent
* includedPaths:
* - path: /*
* - path: /included/?
* excludedPaths:
* - path: /excluded/?
* uniqueKeys:
* - paths:
* - /definition/idlong
* - /definition/idshort
* variables:
* example:
* fn::invoke:
* Function: azure:cosmosdb:getAccount
* Arguments:
* name: tfex-cosmosdb-account
* resourceGroupName: tfex-cosmosdb-account-rg
* ```
*
* ## Import
* Cosmos SQL Containers can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:cosmosdb/sqlContainer:SqlContainer example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.DocumentDB/databaseAccounts/account1/sqlDatabases/database1/containers/container1
* ```
* */*/*/*/*/*/
*/
public class SqlContainer internal constructor(
override val javaResource: com.pulumi.azure.cosmosdb.SqlContainer,
) : KotlinCustomResource(javaResource, SqlContainerMapper) {
/**
* The name of the Cosmos DB Account to create the container within. Changing this forces a new resource to be created.
*/
public val accountName: Output
get() = javaResource.accountName().applyValue({ args0 -> args0 })
/**
* The default time to live of Analytical Storage for this SQL container. If present and the value is set to `-1`, it is equal to infinity, and items don’t expire by default. If present and the value is set to some number `n` – items will expire `n` seconds after their last modified time.
*/
public val analyticalStorageTtl: Output?
get() = javaResource.analyticalStorageTtl().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* An `autoscale_settings` block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply. Requires `partition_key_path` to be set.
* > **Note:** Switching between autoscale and manual throughput is not supported via this provider and must be completed via the Azure Portal and refreshed.
*/
public val autoscaleSettings: Output?
get() = javaResource.autoscaleSettings().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> sqlContainerAutoscaleSettingsToKotlin(args0) })
}).orElse(null)
})
/**
* A `conflict_resolution_policy` blocks as defined below. Changing this forces a new resource to be created.
*/
public val conflictResolutionPolicy: Output
get() = javaResource.conflictResolutionPolicy().applyValue({ args0 ->
args0.let({ args0 ->
sqlContainerConflictResolutionPolicyToKotlin(args0)
})
})
/**
* The name of the Cosmos DB SQL Database to create the container within. Changing this forces a new resource to be created.
*/
public val databaseName: Output
get() = javaResource.databaseName().applyValue({ args0 -> args0 })
/**
* The default time to live of SQL container. If missing, items are not expired automatically. If present and the value is set to `-1`, it is equal to infinity, and items don’t expire by default. If present and the value is set to some number `n` – items will expire `n` seconds after their last modified time.
*/
public val defaultTtl: Output
get() = javaResource.defaultTtl().applyValue({ args0 -> args0 })
/**
* An `indexing_policy` block as defined below.
*/
public val indexingPolicy: Output
get() = javaResource.indexingPolicy().applyValue({ args0 ->
args0.let({ args0 ->
sqlContainerIndexingPolicyToKotlin(args0)
})
})
/**
* Specifies the name of the Cosmos DB SQL Container. Changing this forces a new resource to be created.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* Define a partition key. Changing this forces a new resource to be created.
*/
public val partitionKeyPath: Output
get() = javaResource.partitionKeyPath().applyValue({ args0 -> args0 })
/**
* Define a partition key version. Changing this forces a new resource to be created. Possible values are `1`and `2`. This should be set to `2` in order to use large partition keys.
*/
public val partitionKeyVersion: Output?
get() = javaResource.partitionKeyVersion().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The name of the resource group in which the Cosmos DB SQL Container is created. Changing this forces a new resource to be created.
*/
public val resourceGroupName: Output
get() = javaResource.resourceGroupName().applyValue({ args0 -> args0 })
/**
* The throughput of SQL container (RU/s). Must be set in increments of `100`. The minimum value is `400`. This must be set upon container creation otherwise it cannot be updated without a manual resource destroy-apply.
*/
public val throughput: Output
get() = javaResource.throughput().applyValue({ args0 -> args0 })
/**
* One or more `unique_key` blocks as defined below. Changing this forces a new resource to be created.
*/
public val uniqueKeys: Output>?
get() = javaResource.uniqueKeys().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> sqlContainerUniqueKeyToKotlin(args0) })
})
}).orElse(null)
})
}
public object SqlContainerMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.azure.cosmosdb.SqlContainer::class == javaResource::class
override fun map(javaResource: Resource): SqlContainer = SqlContainer(
javaResource as
com.pulumi.azure.cosmosdb.SqlContainer,
)
}
/**
* @see [SqlContainer].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [SqlContainer].
*/
public suspend fun sqlContainer(
name: String,
block: suspend SqlContainerResourceBuilder.() -> Unit,
): SqlContainer {
val builder = SqlContainerResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [SqlContainer].
* @param name The _unique_ name of the resulting resource.
*/
public fun sqlContainer(name: String): SqlContainer {
val builder = SqlContainerResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy