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

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

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

package com.pulumi.azure.cosmosdb.kotlin

import com.pulumi.azure.cosmosdb.kotlin.outputs.MongoDatabaseAutoscaleSettings
import com.pulumi.azure.cosmosdb.kotlin.outputs.MongoDatabaseAutoscaleSettings.Companion.toKotlin
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

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

    public var args: MongoDatabaseArgs = MongoDatabaseArgs()

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

/**
 * Manages a Mongo Database 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),
 *     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_mongo_database = azure.cosmosdb.MongoDatabase("example",
 *     name="tfex-cosmos-mongo-db",
 *     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 exampleMongoDatabase = new Azure.CosmosDB.MongoDatabase("example", new()
 *     {
 *         Name = "tfex-cosmos-mongo-db",
 *         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.NewMongoDatabase(ctx, "example", &cosmosdb.MongoDatabaseArgs{
 * 			Name:              pulumi.String("tfex-cosmos-mongo-db"),
 * 			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.MongoDatabase;
 * import com.pulumi.azure.cosmosdb.MongoDatabaseArgs;
 * 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()))
 *             .throughput(400)
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   exampleMongoDatabase:
 *     type: azure:cosmosdb:MongoDatabase
 *     name: example
 *     properties:
 *       name: tfex-cosmos-mongo-db
 *       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
 * Cosmos Mongo Database can be imported using the `resource id`, e.g.
 * ```sh
 * $ pulumi import azure:cosmosdb/mongoDatabase:MongoDatabase db1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/account1/mongodbDatabases/db1
 * ```
 */
public class MongoDatabase internal constructor(
    override val javaResource: com.pulumi.azure.cosmosdb.MongoDatabase,
) : KotlinCustomResource(javaResource, MongoDatabaseMapper) {
    /**
     * The name of the Cosmos DB Mongo Database to create the table within. Changing this forces a new resource to be created.
     */
    public val accountName: Output
        get() = javaResource.accountName().applyValue({ args0 -> args0 })

    /**
     * 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.
     */
    public val autoscaleSettings: Output?
        get() = javaResource.autoscaleSettings().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 -> toKotlin(args0) })
            }).orElse(null)
        })

    /**
     * Specifies the name of the Cosmos DB Mongo Database. 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 Database is created. Changing this forces a new resource to be created.
     */
    public val resourceGroupName: Output
        get() = javaResource.resourceGroupName().applyValue({ args0 -> args0 })

    /**
     * The throughput of the MongoDB collection (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 val throughput: Output
        get() = javaResource.throughput().applyValue({ args0 -> args0 })
}

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

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

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

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




© 2015 - 2024 Weber Informatics LLC | Privacy Policy