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

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

Go to download

Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.

There is a newer version: 6.15.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.azure.cosmosdb.kotlin

import com.pulumi.azure.cosmosdb.CassandraKeyspaceArgs.builder
import com.pulumi.azure.cosmosdb.kotlin.inputs.CassandraKeyspaceAutoscaleSettingsArgs
import com.pulumi.azure.cosmosdb.kotlin.inputs.CassandraKeyspaceAutoscaleSettingsArgsBuilder
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 Cassandra KeySpace within a Cosmos DB Account.
 * ## Example Usage
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azure from "@pulumi/azure";
 * const example = new azure.core.ResourceGroup("example", {
 *     name: "tflex-cosmosdb-account-rg",
 *     location: "West Europe",
 * });
 * const exampleAccount = new azure.cosmosdb.Account("example", {
 *     name: "tfex-cosmosdb-account",
 *     resourceGroupName: example.name,
 *     location: example.location,
 *     offerType: "Standard",
 *     capabilities: [{
 *         name: "EnableCassandra",
 *     }],
 *     consistencyPolicy: {
 *         consistencyLevel: "Strong",
 *     },
 *     geoLocations: [{
 *         location: example.location,
 *         failoverPriority: 0,
 *     }],
 * });
 * const exampleCassandraKeyspace = new azure.cosmosdb.CassandraKeyspace("example", {
 *     name: "tfex-cosmos-cassandra-keyspace",
 *     resourceGroupName: exampleAccount.resourceGroupName,
 *     accountName: exampleAccount.name,
 *     throughput: 400,
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_azure as azure
 * example = azure.core.ResourceGroup("example",
 *     name="tflex-cosmosdb-account-rg",
 *     location="West Europe")
 * example_account = azure.cosmosdb.Account("example",
 *     name="tfex-cosmosdb-account",
 *     resource_group_name=example.name,
 *     location=example.location,
 *     offer_type="Standard",
 *     capabilities=[{
 *         "name": "EnableCassandra",
 *     }],
 *     consistency_policy={
 *         "consistency_level": "Strong",
 *     },
 *     geo_locations=[{
 *         "location": example.location,
 *         "failover_priority": 0,
 *     }])
 * example_cassandra_keyspace = azure.cosmosdb.CassandraKeyspace("example",
 *     name="tfex-cosmos-cassandra-keyspace",
 *     resource_group_name=example_account.resource_group_name,
 *     account_name=example_account.name,
 *     throughput=400)
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Azure = Pulumi.Azure;
 * return await Deployment.RunAsync(() =>
 * {
 *     var example = new Azure.Core.ResourceGroup("example", new()
 *     {
 *         Name = "tflex-cosmosdb-account-rg",
 *         Location = "West Europe",
 *     });
 *     var exampleAccount = new Azure.CosmosDB.Account("example", new()
 *     {
 *         Name = "tfex-cosmosdb-account",
 *         ResourceGroupName = example.Name,
 *         Location = example.Location,
 *         OfferType = "Standard",
 *         Capabilities = new[]
 *         {
 *             new Azure.CosmosDB.Inputs.AccountCapabilityArgs
 *             {
 *                 Name = "EnableCassandra",
 *             },
 *         },
 *         ConsistencyPolicy = new Azure.CosmosDB.Inputs.AccountConsistencyPolicyArgs
 *         {
 *             ConsistencyLevel = "Strong",
 *         },
 *         GeoLocations = new[]
 *         {
 *             new Azure.CosmosDB.Inputs.AccountGeoLocationArgs
 *             {
 *                 Location = example.Location,
 *                 FailoverPriority = 0,
 *             },
 *         },
 *     });
 *     var exampleCassandraKeyspace = new Azure.CosmosDB.CassandraKeyspace("example", new()
 *     {
 *         Name = "tfex-cosmos-cassandra-keyspace",
 *         ResourceGroupName = exampleAccount.ResourceGroupName,
 *         AccountName = exampleAccount.Name,
 *         Throughput = 400,
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
 * 	"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 := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
 * 			Name:     pulumi.String("tflex-cosmosdb-account-rg"),
 * 			Location: pulumi.String("West Europe"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		exampleAccount, err := cosmosdb.NewAccount(ctx, "example", &cosmosdb.AccountArgs{
 * 			Name:              pulumi.String("tfex-cosmosdb-account"),
 * 			ResourceGroupName: example.Name,
 * 			Location:          example.Location,
 * 			OfferType:         pulumi.String("Standard"),
 * 			Capabilities: cosmosdb.AccountCapabilityArray{
 * 				&cosmosdb.AccountCapabilityArgs{
 * 					Name: pulumi.String("EnableCassandra"),
 * 				},
 * 			},
 * 			ConsistencyPolicy: &cosmosdb.AccountConsistencyPolicyArgs{
 * 				ConsistencyLevel: pulumi.String("Strong"),
 * 			},
 * 			GeoLocations: cosmosdb.AccountGeoLocationArray{
 * 				&cosmosdb.AccountGeoLocationArgs{
 * 					Location:         example.Location,
 * 					FailoverPriority: pulumi.Int(0),
 * 				},
 * 			},
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = cosmosdb.NewCassandraKeyspace(ctx, "example", &cosmosdb.CassandraKeyspaceArgs{
 * 			Name:              pulumi.String("tfex-cosmos-cassandra-keyspace"),
 * 			ResourceGroupName: exampleAccount.ResourceGroupName,
 * 			AccountName:       exampleAccount.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.core.ResourceGroup;
 * import com.pulumi.azure.core.ResourceGroupArgs;
 * import com.pulumi.azure.cosmosdb.Account;
 * import com.pulumi.azure.cosmosdb.AccountArgs;
 * import com.pulumi.azure.cosmosdb.inputs.AccountCapabilityArgs;
 * import com.pulumi.azure.cosmosdb.inputs.AccountConsistencyPolicyArgs;
 * import com.pulumi.azure.cosmosdb.inputs.AccountGeoLocationArgs;
 * import com.pulumi.azure.cosmosdb.CassandraKeyspace;
 * import com.pulumi.azure.cosmosdb.CassandraKeyspaceArgs;
 * 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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
 *             .name("tflex-cosmosdb-account-rg")
 *             .location("West Europe")
 *             .build());
 *         var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
 *             .name("tfex-cosmosdb-account")
 *             .resourceGroupName(example.name())
 *             .location(example.location())
 *             .offerType("Standard")
 *             .capabilities(AccountCapabilityArgs.builder()
 *                 .name("EnableCassandra")
 *                 .build())
 *             .consistencyPolicy(AccountConsistencyPolicyArgs.builder()
 *                 .consistencyLevel("Strong")
 *                 .build())
 *             .geoLocations(AccountGeoLocationArgs.builder()
 *                 .location(example.location())
 *                 .failoverPriority(0)
 *                 .build())
 *             .build());
 *         var exampleCassandraKeyspace = new CassandraKeyspace("exampleCassandraKeyspace", CassandraKeyspaceArgs.builder()
 *             .name("tfex-cosmos-cassandra-keyspace")
 *             .resourceGroupName(exampleAccount.resourceGroupName())
 *             .accountName(exampleAccount.name())
 *             .throughput(400)
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   example:
 *     type: azure:core:ResourceGroup
 *     properties:
 *       name: tflex-cosmosdb-account-rg
 *       location: West Europe
 *   exampleAccount:
 *     type: azure:cosmosdb:Account
 *     name: example
 *     properties:
 *       name: tfex-cosmosdb-account
 *       resourceGroupName: ${example.name}
 *       location: ${example.location}
 *       offerType: Standard
 *       capabilities:
 *         - name: EnableCassandra
 *       consistencyPolicy:
 *         consistencyLevel: Strong
 *       geoLocations:
 *         - location: ${example.location}
 *           failoverPriority: 0
 *   exampleCassandraKeyspace:
 *     type: azure:cosmosdb:CassandraKeyspace
 *     name: example
 *     properties:
 *       name: tfex-cosmos-cassandra-keyspace
 *       resourceGroupName: ${exampleAccount.resourceGroupName}
 *       accountName: ${exampleAccount.name}
 *       throughput: 400
 * ```
 * 
 * ## Import
 * Cosmos Cassandra KeySpace can be imported using the `resource id`, e.g.
 * ```sh
 * $ pulumi import azure:cosmosdb/cassandraKeyspace:CassandraKeyspace ks1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/account1/cassandraKeyspaces/ks1
 * ```
 * @property accountName The name of the Cosmos DB Cassandra KeySpace 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 Cassandra KeySpace. Changing this forces a new resource to be created.
 * @property resourceGroupName The name of the resource group in which the Cosmos DB Cassandra KeySpace is created. Changing this forces a new resource to be created.
 * @property throughput The throughput of Cassandra KeySpace (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.
 */
public data class CassandraKeyspaceArgs(
    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.CassandraKeyspaceArgs =
        com.pulumi.azure.cosmosdb.CassandraKeyspaceArgs.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 [CassandraKeyspaceArgs].
 */
@PulumiTagMarker
public class CassandraKeyspaceArgsBuilder 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 Cassandra KeySpace to create the table within. Changing this forces a new resource to be created.
     */
    @JvmName("gmimgpbgrxfnmihk")
    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("gkypyfssdleodsvu")
    public suspend fun autoscaleSettings(`value`: Output) {
        this.autoscaleSettings = value
    }

    /**
     * @param value Specifies the name of the Cosmos DB Cassandra KeySpace. Changing this forces a new resource to be created.
     */
    @JvmName("rifmaqaehrhgbfye")
    public suspend fun name(`value`: Output) {
        this.name = value
    }

    /**
     * @param value The name of the resource group in which the Cosmos DB Cassandra KeySpace is created. Changing this forces a new resource to be created.
     */
    @JvmName("vvxxanhqqgabrtfl")
    public suspend fun resourceGroupName(`value`: Output) {
        this.resourceGroupName = value
    }

    /**
     * @param value The throughput of Cassandra KeySpace (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.
     */
    @JvmName("xioyoqjmtgoxofia")
    public suspend fun throughput(`value`: Output) {
        this.throughput = value
    }

    /**
     * @param value The name of the Cosmos DB Cassandra KeySpace to create the table within. Changing this forces a new resource to be created.
     */
    @JvmName("ecmavxeolrdktsdn")
    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("dphagbrllitpkmhn")
    public suspend fun autoscaleSettings(`value`: CassandraKeyspaceAutoscaleSettingsArgs?) {
        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("uebwskobxmaumjgw")
    public suspend fun autoscaleSettings(argument: suspend CassandraKeyspaceAutoscaleSettingsArgsBuilder.() -> Unit) {
        val toBeMapped = CassandraKeyspaceAutoscaleSettingsArgsBuilder().applySuspend {
            argument()
        }.build()
        val mapped = of(toBeMapped)
        this.autoscaleSettings = mapped
    }

    /**
     * @param value Specifies the name of the Cosmos DB Cassandra KeySpace. Changing this forces a new resource to be created.
     */
    @JvmName("hdttcshdamedaxwe")
    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 Cassandra KeySpace is created. Changing this forces a new resource to be created.
     */
    @JvmName("ngpirdhxcbdbfjyx")
    public suspend fun resourceGroupName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.resourceGroupName = mapped
    }

    /**
     * @param value The throughput of Cassandra KeySpace (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.
     */
    @JvmName("spayrpyvhvjwstec")
    public suspend fun throughput(`value`: Int?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.throughput = mapped
    }

    internal fun build(): CassandraKeyspaceArgs = CassandraKeyspaceArgs(
        accountName = accountName,
        autoscaleSettings = autoscaleSettings,
        name = name,
        resourceGroupName = resourceGroupName,
        throughput = throughput,
    )
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy