All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.azure.cosmosdb.kotlin.MongoCollection.kt Maven / Gradle / Ivy

@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.azure.cosmosdb.kotlin

import com.pulumi.azure.cosmosdb.kotlin.outputs.MongoCollectionAutoscaleSettings
import com.pulumi.azure.cosmosdb.kotlin.outputs.MongoCollectionIndex
import com.pulumi.azure.cosmosdb.kotlin.outputs.MongoCollectionSystemIndex
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.MongoCollectionAutoscaleSettings.Companion.toKotlin as mongoCollectionAutoscaleSettingsToKotlin
import com.pulumi.azure.cosmosdb.kotlin.outputs.MongoCollectionIndex.Companion.toKotlin as mongoCollectionIndexToKotlin
import com.pulumi.azure.cosmosdb.kotlin.outputs.MongoCollectionSystemIndex.Companion.toKotlin as mongoCollectionSystemIndexToKotlin

/**
 * Builder for [MongoCollection].
 */
@PulumiTagMarker
public class MongoCollectionResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: MongoCollectionArgs = MongoCollectionArgs()

    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 MongoCollectionArgsBuilder.() -> Unit) {
        val builder = MongoCollectionArgsBuilder()
        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(): MongoCollection {
        val builtJavaResource = com.pulumi.azure.cosmosdb.MongoCollection(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return MongoCollection(builtJavaResource)
    }
}

/**
 * Manages a Mongo Collection 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 exampleMongoDatabase = new azure.cosmosdb.MongoDatabase("example", {
 *     name: "tfex-cosmos-mongo-db",
 *     resourceGroupName: example.then(example => example.resourceGroupName),
 *     accountName: example.then(example => example.name),
 * });
 * const exampleMongoCollection = new azure.cosmosdb.MongoCollection("example", {
 *     name: "tfex-cosmos-mongo-db",
 *     resourceGroupName: example.then(example => example.resourceGroupName),
 *     accountName: example.then(example => example.name),
 *     databaseName: exampleMongoDatabase.name,
 *     defaultTtlSeconds: 777,
 *     shardKey: "uniqueKey",
 *     throughput: 400,
 *     indices: [{
 *         keys: ["_id"],
 *         unique: true,
 *     }],
 * });
 * ```
 * ```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_mongo_database = azure.cosmosdb.MongoDatabase("example",
 *     name="tfex-cosmos-mongo-db",
 *     resource_group_name=example.resource_group_name,
 *     account_name=example.name)
 * example_mongo_collection = azure.cosmosdb.MongoCollection("example",
 *     name="tfex-cosmos-mongo-db",
 *     resource_group_name=example.resource_group_name,
 *     account_name=example.name,
 *     database_name=example_mongo_database.name,
 *     default_ttl_seconds=777,
 *     shard_key="uniqueKey",
 *     throughput=400,
 *     indices=[azure.cosmosdb.MongoCollectionIndexArgs(
 *         keys=["_id"],
 *         unique=True,
 *     )])
 * ```
 * ```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 exampleMongoDatabase = new Azure.CosmosDB.MongoDatabase("example", new()
 *     {
 *         Name = "tfex-cosmos-mongo-db",
 *         ResourceGroupName = example.Apply(getAccountResult => getAccountResult.ResourceGroupName),
 *         AccountName = example.Apply(getAccountResult => getAccountResult.Name),
 *     });
 *     var exampleMongoCollection = new Azure.CosmosDB.MongoCollection("example", new()
 *     {
 *         Name = "tfex-cosmos-mongo-db",
 *         ResourceGroupName = example.Apply(getAccountResult => getAccountResult.ResourceGroupName),
 *         AccountName = example.Apply(getAccountResult => getAccountResult.Name),
 *         DatabaseName = exampleMongoDatabase.Name,
 *         DefaultTtlSeconds = 777,
 *         ShardKey = "uniqueKey",
 *         Throughput = 400,
 *         Indices = new[]
 *         {
 *             new Azure.CosmosDB.Inputs.MongoCollectionIndexArgs
 *             {
 *                 Keys = new[]
 *                 {
 *                     "_id",
 *                 },
 *                 Unique = true,
 *             },
 *         },
 *     });
 * });
 * ```
 * ```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
 * 		}
 * 		exampleMongoDatabase, err := cosmosdb.NewMongoDatabase(ctx, "example", &cosmosdb.MongoDatabaseArgs{
 * 			Name:              pulumi.String("tfex-cosmos-mongo-db"),
 * 			ResourceGroupName: pulumi.String(example.ResourceGroupName),
 * 			AccountName:       pulumi.String(example.Name),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = cosmosdb.NewMongoCollection(ctx, "example", &cosmosdb.MongoCollectionArgs{
 * 			Name:              pulumi.String("tfex-cosmos-mongo-db"),
 * 			ResourceGroupName: pulumi.String(example.ResourceGroupName),
 * 			AccountName:       pulumi.String(example.Name),
 * 			DatabaseName:      exampleMongoDatabase.Name,
 * 			DefaultTtlSeconds: pulumi.Int(777),
 * 			ShardKey:          pulumi.String("uniqueKey"),
 * 			Throughput:        pulumi.Int(400),
 * 			Indices: cosmosdb.MongoCollectionIndexArray{
 * 				&cosmosdb.MongoCollectionIndexArgs{
 * 					Keys: pulumi.StringArray{
 * 						pulumi.String("_id"),
 * 					},
 * 					Unique: pulumi.Bool(true),
 * 				},
 * 			},
 * 		})
 * 		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.MongoDatabase;
 * import com.pulumi.azure.cosmosdb.MongoDatabaseArgs;
 * import com.pulumi.azure.cosmosdb.MongoCollection;
 * import com.pulumi.azure.cosmosdb.MongoCollectionArgs;
 * import com.pulumi.azure.cosmosdb.inputs.MongoCollectionIndexArgs;
 * 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 exampleMongoDatabase = new MongoDatabase("exampleMongoDatabase", MongoDatabaseArgs.builder()
 *             .name("tfex-cosmos-mongo-db")
 *             .resourceGroupName(example.applyValue(getAccountResult -> getAccountResult.resourceGroupName()))
 *             .accountName(example.applyValue(getAccountResult -> getAccountResult.name()))
 *             .build());
 *         var exampleMongoCollection = new MongoCollection("exampleMongoCollection", MongoCollectionArgs.builder()
 *             .name("tfex-cosmos-mongo-db")
 *             .resourceGroupName(example.applyValue(getAccountResult -> getAccountResult.resourceGroupName()))
 *             .accountName(example.applyValue(getAccountResult -> getAccountResult.name()))
 *             .databaseName(exampleMongoDatabase.name())
 *             .defaultTtlSeconds("777")
 *             .shardKey("uniqueKey")
 *             .throughput(400)
 *             .indices(MongoCollectionIndexArgs.builder()
 *                 .keys("_id")
 *                 .unique(true)
 *                 .build())
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   exampleMongoDatabase:
 *     type: azure:cosmosdb:MongoDatabase
 *     name: example
 *     properties:
 *       name: tfex-cosmos-mongo-db
 *       resourceGroupName: ${example.resourceGroupName}
 *       accountName: ${example.name}
 *   exampleMongoCollection:
 *     type: azure:cosmosdb:MongoCollection
 *     name: example
 *     properties:
 *       name: tfex-cosmos-mongo-db
 *       resourceGroupName: ${example.resourceGroupName}
 *       accountName: ${example.name}
 *       databaseName: ${exampleMongoDatabase.name}
 *       defaultTtlSeconds: '777'
 *       shardKey: uniqueKey
 *       throughput: 400
 *       indices:
 *         - keys:
 *             - _id
 *           unique: true
 * variables:
 *   example:
 *     fn::invoke:
 *       Function: azure:cosmosdb:getAccount
 *       Arguments:
 *         name: tfex-cosmosdb-account
 *         resourceGroupName: tfex-cosmosdb-account-rg
 * ```
 * 
 * ## Import
 * CosmosDB Mongo Collection can be imported using the `resource id`, e.g.
 * ```sh
 * $ pulumi import azure:cosmosdb/mongoCollection:MongoCollection collection1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/account1/mongodbDatabases/db1/collections/collection1
 * ```
 */
public class MongoCollection internal constructor(
    override val javaResource: com.pulumi.azure.cosmosdb.MongoCollection,
) : KotlinCustomResource(javaResource, MongoCollectionMapper) {
    /**
     * The name of the Cosmos DB Account in which the Cosmos DB Mongo Collection is created. 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 Mongo Collection. 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)
        })

    public val autoscaleSettings: Output?
        get() = javaResource.autoscaleSettings().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 -> mongoCollectionAutoscaleSettingsToKotlin(args0) })
            }).orElse(null)
        })

    /**
     * The name of the Cosmos DB Mongo Database in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created.
     */
    public val databaseName: Output
        get() = javaResource.databaseName().applyValue({ args0 -> args0 })

    /**
     * The default Time To Live in seconds. If the value is `-1`, items are not automatically expired.
     */
    public val defaultTtlSeconds: Output?
        get() = javaResource.defaultTtlSeconds().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * One or more `index` blocks as defined below.
     */
    public val indices: Output>?
        get() = javaResource.indices().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0.let({ args0 -> mongoCollectionIndexToKotlin(args0) })
                })
            }).orElse(null)
        })

    /**
     * Specifies the name of the Cosmos DB Mongo Collection. Changing this forces a new resource to be created.
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * The name of the resource group in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created.
     */
    public val resourceGroupName: Output
        get() = javaResource.resourceGroupName().applyValue({ args0 -> args0 })

    /**
     * The name of the key to partition on for sharding. There must not be any other unique index keys. Changing this forces a new resource to be created.
     */
    public val shardKey: Output?
        get() = javaResource.shardKey().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * One or more `system_indexes` blocks as defined below.
     */
    public val systemIndexes: Output>
        get() = javaResource.systemIndexes().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 -> mongoCollectionSystemIndexToKotlin(args0) })
            })
        })

    public val throughput: Output
        get() = javaResource.throughput().applyValue({ args0 -> args0 })
}

public object MongoCollectionMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.azure.cosmosdb.MongoCollection::class == javaResource::class

    override fun map(javaResource: Resource): MongoCollection = MongoCollection(
        javaResource as
            com.pulumi.azure.cosmosdb.MongoCollection,
    )
}

/**
 * @see [MongoCollection].
 * @param name The _unique_ name of the resulting resource.
 * @param block Builder for [MongoCollection].
 */
public suspend fun mongoCollection(
    name: String,
    block: suspend MongoCollectionResourceBuilder.() -> Unit,
): MongoCollection {
    val builder = MongoCollectionResourceBuilder()
    builder.name(name)
    block(builder)
    return builder.build()
}

/**
 * @see [MongoCollection].
 * @param name The _unique_ name of the resulting resource.
 */
public fun mongoCollection(name: String): MongoCollection {
    val builder = MongoCollectionResourceBuilder()
    builder.name(name)
    return builder.build()
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy