Azure Classic v5.38.0, Mar 21 23

azure.cosmosdb.CassandraKeyspace

Manages a Cassandra KeySpace within a Cosmos DB Account.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var exampleAccount = new Azure.CosmosDB.Account("exampleAccount", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        Location = exampleResourceGroup.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 = exampleResourceGroup.Location,
                FailoverPriority = 0,
            },
        },
    });

    var exampleCassandraKeyspace = new Azure.CosmosDB.CassandraKeyspace("exampleCassandraKeyspace", new()
    {
        ResourceGroupName = exampleAccount.ResourceGroupName,
        AccountName = exampleAccount.Name,
        Throughput = 400,
    });

});

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 {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleAccount, err := cosmosdb.NewAccount(ctx, "exampleAccount", &cosmosdb.AccountArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			Location:          exampleResourceGroup.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:         exampleResourceGroup.Location,
					FailoverPriority: pulumi.Int(0),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = cosmosdb.NewCassandraKeyspace(ctx, "exampleCassandraKeyspace", &cosmosdb.CassandraKeyspaceArgs{
			ResourceGroupName: exampleAccount.ResourceGroupName,
			AccountName:       exampleAccount.Name,
			Throughput:        pulumi.Int(400),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .offerType("Standard")
            .capabilities(AccountCapabilityArgs.builder()
                .name("EnableCassandra")
                .build())
            .consistencyPolicy(AccountConsistencyPolicyArgs.builder()
                .consistencyLevel("Strong")
                .build())
            .geoLocations(AccountGeoLocationArgs.builder()
                .location(exampleResourceGroup.location())
                .failoverPriority(0)
                .build())
            .build());

        var exampleCassandraKeyspace = new CassandraKeyspace("exampleCassandraKeyspace", CassandraKeyspaceArgs.builder()        
            .resourceGroupName(exampleAccount.resourceGroupName())
            .accountName(exampleAccount.name())
            .throughput(400)
            .build());

    }
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.cosmosdb.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    offer_type="Standard",
    capabilities=[azure.cosmosdb.AccountCapabilityArgs(
        name="EnableCassandra",
    )],
    consistency_policy=azure.cosmosdb.AccountConsistencyPolicyArgs(
        consistency_level="Strong",
    ),
    geo_locations=[azure.cosmosdb.AccountGeoLocationArgs(
        location=example_resource_group.location,
        failover_priority=0,
    )])
example_cassandra_keyspace = azure.cosmosdb.CassandraKeyspace("exampleCassandraKeyspace",
    resource_group_name=example_account.resource_group_name,
    account_name=example_account.name,
    throughput=400)

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.cosmosdb.Account("exampleAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    offerType: "Standard",
    capabilities: [{
        name: "EnableCassandra",
    }],
    consistencyPolicy: {
        consistencyLevel: "Strong",
    },
    geoLocations: [{
        location: exampleResourceGroup.location,
        failoverPriority: 0,
    }],
});
const exampleCassandraKeyspace = new azure.cosmosdb.CassandraKeyspace("exampleCassandraKeyspace", {
    resourceGroupName: exampleAccount.resourceGroupName,
    accountName: exampleAccount.name,
    throughput: 400,
});

resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleAccount:
    type: azure:cosmosdb:Account
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      offerType: Standard
      capabilities:
        - name: EnableCassandra
      consistencyPolicy:
        consistencyLevel: Strong
      geoLocations:
        - location: ${exampleResourceGroup.location}
          failoverPriority: 0
  exampleCassandraKeyspace:
    type: azure:cosmosdb:CassandraKeyspace
    properties:
      resourceGroupName: ${exampleAccount.resourceGroupName}
      accountName: ${exampleAccount.name}
      throughput: 400

Create CassandraKeyspace Resource

new CassandraKeyspace(name: string, args: CassandraKeyspaceArgs, opts?: CustomResourceOptions);

@overload
def CassandraKeyspace(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      account_name: Optional[str] = None,
                      autoscale_settings: Optional[CassandraKeyspaceAutoscaleSettingsArgs] = None,
                      name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      throughput: Optional[int] = None)
@overload
def CassandraKeyspace(resource_name: str,
                      args: CassandraKeyspaceArgs,
                      opts: Optional[ResourceOptions] = None)

func NewCassandraKeyspace(ctx *Context, name string, args CassandraKeyspaceArgs, opts ...ResourceOption) (*CassandraKeyspace, error)

public CassandraKeyspace(string name, CassandraKeyspaceArgs args, CustomResourceOptions? opts = null)

public CassandraKeyspace(String name, CassandraKeyspaceArgs args)
public CassandraKeyspace(String name, CassandraKeyspaceArgs args, CustomResourceOptions options)

type: azure:cosmosdb:CassandraKeyspace
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args CassandraKeyspaceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args CassandraKeyspaceArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args CassandraKeyspaceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args CassandraKeyspaceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args CassandraKeyspaceArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

CassandraKeyspace Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The CassandraKeyspace resource accepts the following input properties:

AccountName string: The name of the Cosmos DB Cassandra KeySpace to create the table within. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the Cosmos DB Cassandra KeySpace is created. Changing this forces a new resource to be created.
AutoscaleSettings CassandraKeyspaceAutoscaleSettingsArgs: An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply.
Name string: Specifies the name of the Cosmos DB Cassandra KeySpace. Changing this forces a new resource to be created.
Throughput int: 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.

AccountName string: The name of the Cosmos DB Cassandra KeySpace to create the table within. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the Cosmos DB Cassandra KeySpace is created. Changing this forces a new resource to be created.
AutoscaleSettings CassandraKeyspaceAutoscaleSettingsArgs: An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply.
Name string: Specifies the name of the Cosmos DB Cassandra KeySpace. Changing this forces a new resource to be created.
Throughput int: 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.

accountName String: The name of the Cosmos DB Cassandra KeySpace to create the table within. Changing this forces a new resource to be created.
resourceGroupName String: The name of the resource group in which the Cosmos DB Cassandra KeySpace is created. Changing this forces a new resource to be created.
autoscaleSettings CassandraKeyspaceAutoscaleSettingsArgs: An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply.
name String: Specifies the name of the Cosmos DB Cassandra KeySpace. Changing this forces a new resource to be created.
throughput Integer: 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.

accountName string: The name of the Cosmos DB Cassandra KeySpace to create the table within. Changing this forces a new resource to be created.
resourceGroupName string: The name of the resource group in which the Cosmos DB Cassandra KeySpace is created. Changing this forces a new resource to be created.
autoscaleSettings CassandraKeyspaceAutoscaleSettingsArgs: An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply.
name string: Specifies the name of the Cosmos DB Cassandra KeySpace. Changing this forces a new resource to be created.
throughput number: 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.

account_name str: The name of the Cosmos DB Cassandra KeySpace to create the table within. Changing this forces a new resource to be created.
resource_group_name str: The name of the resource group in which the Cosmos DB Cassandra KeySpace is created. Changing this forces a new resource to be created.
autoscale_settings CassandraKeyspaceAutoscaleSettingsArgs: An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply.
name str: Specifies the name of the Cosmos DB Cassandra KeySpace. Changing this forces a new resource to be created.
throughput int: 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.

accountName String: The name of the Cosmos DB Cassandra KeySpace to create the table within. Changing this forces a new resource to be created.
resourceGroupName String: The name of the resource group in which the Cosmos DB Cassandra KeySpace is created. Changing this forces a new resource to be created.
autoscaleSettings Property Map: An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply.
name String: Specifies the name of the Cosmos DB Cassandra KeySpace. Changing this forces a new resource to be created.
throughput Number: 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.

Outputs

All input properties are implicitly available as output properties. Additionally, the CassandraKeyspace resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing CassandraKeyspace Resource

Get an existing CassandraKeyspace resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: CassandraKeyspaceState, opts?: CustomResourceOptions): CassandraKeyspace

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_name: Optional[str] = None,
        autoscale_settings: Optional[CassandraKeyspaceAutoscaleSettingsArgs] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        throughput: Optional[int] = None) -> CassandraKeyspace

func GetCassandraKeyspace(ctx *Context, name string, id IDInput, state *CassandraKeyspaceState, opts ...ResourceOption) (*CassandraKeyspace, error)

public static CassandraKeyspace Get(string name, Input<string> id, CassandraKeyspaceState? state, CustomResourceOptions? opts = null)

public static CassandraKeyspace get(String name, Output<String> id, CassandraKeyspaceState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AccountName string: The name of the Cosmos DB Cassandra KeySpace to create the table within. Changing this forces a new resource to be created.
AutoscaleSettings CassandraKeyspaceAutoscaleSettingsArgs: An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply.
Name string: Specifies the name of the Cosmos DB Cassandra KeySpace. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the Cosmos DB Cassandra KeySpace is created. Changing this forces a new resource to be created.
Throughput int: 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.

AccountName string: The name of the Cosmos DB Cassandra KeySpace to create the table within. Changing this forces a new resource to be created.
AutoscaleSettings CassandraKeyspaceAutoscaleSettingsArgs: An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply.
Name string: Specifies the name of the Cosmos DB Cassandra KeySpace. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the Cosmos DB Cassandra KeySpace is created. Changing this forces a new resource to be created.
Throughput int: 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.

accountName String: The name of the Cosmos DB Cassandra KeySpace to create the table within. Changing this forces a new resource to be created.
autoscaleSettings CassandraKeyspaceAutoscaleSettingsArgs: An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply.
name String: Specifies the name of the Cosmos DB Cassandra KeySpace. Changing this forces a new resource to be created.
resourceGroupName String: The name of the resource group in which the Cosmos DB Cassandra KeySpace is created. Changing this forces a new resource to be created.
throughput Integer: 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.

accountName string: The name of the Cosmos DB Cassandra KeySpace to create the table within. Changing this forces a new resource to be created.
autoscaleSettings CassandraKeyspaceAutoscaleSettingsArgs: An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply.
name string: Specifies the name of the Cosmos DB Cassandra KeySpace. Changing this forces a new resource to be created.
resourceGroupName string: The name of the resource group in which the Cosmos DB Cassandra KeySpace is created. Changing this forces a new resource to be created.
throughput number: 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.

account_name str: The name of the Cosmos DB Cassandra KeySpace to create the table within. Changing this forces a new resource to be created.
autoscale_settings CassandraKeyspaceAutoscaleSettingsArgs: An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply.
name str: Specifies the name of the Cosmos DB Cassandra KeySpace. Changing this forces a new resource to be created.
resource_group_name str: The name of the resource group in which the Cosmos DB Cassandra KeySpace is created. Changing this forces a new resource to be created.
throughput int: 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.

accountName String: The name of the Cosmos DB Cassandra KeySpace to create the table within. Changing this forces a new resource to be created.
autoscaleSettings Property Map: An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply.
name String: Specifies the name of the Cosmos DB Cassandra KeySpace. Changing this forces a new resource to be created.
resourceGroupName String: The name of the resource group in which the Cosmos DB Cassandra KeySpace is created. Changing this forces a new resource to be created.
throughput Number: 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.

Supporting Types

CassandraKeyspaceAutoscaleSettings

MaxThroughput int: The maximum throughput of the Cassandra KeySpace (RU/s). Must be between 1,000 and 1,000,000. Must be set in increments of 1,000. Conflicts with throughput.

MaxThroughput int: The maximum throughput of the Cassandra KeySpace (RU/s). Must be between 1,000 and 1,000,000. Must be set in increments of 1,000. Conflicts with throughput.

maxThroughput Integer: The maximum throughput of the Cassandra KeySpace (RU/s). Must be between 1,000 and 1,000,000. Must be set in increments of 1,000. Conflicts with throughput.

maxThroughput number: The maximum throughput of the Cassandra KeySpace (RU/s). Must be between 1,000 and 1,000,000. Must be set in increments of 1,000. Conflicts with throughput.

max_throughput int: The maximum throughput of the Cassandra KeySpace (RU/s). Must be between 1,000 and 1,000,000. Must be set in increments of 1,000. Conflicts with throughput.

maxThroughput Number: The maximum throughput of the Cassandra KeySpace (RU/s). Must be between 1,000 and 1,000,000. Must be set in increments of 1,000. Conflicts with throughput.

Import

Cosmos Cassandra KeySpace can be imported using the resource id, e.g.

 $ pulumi import azure:cosmosdb/cassandraKeyspace:CassandraKeyspace ks1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/account1/cassandraKeyspaces/ks1

Package Details

Repository: Azure Classic pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.