Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. cosmosdb
  5. CassandraKeyspace

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.cosmosdb.CassandraKeyspace

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages a Cassandra KeySpace within a Cosmos DB Account.

Example Usage

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,
});
Copy
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)
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/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
	})
}
Copy
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,
    });

});
Copy
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());

    }
}
Copy
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
Copy

Create CassandraKeyspace Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new CassandraKeyspace(name: string, args: CassandraKeyspaceArgs, opts?: CustomResourceOptions);
@overload
def CassandraKeyspace(resource_name: str,
                      args: CassandraKeyspaceArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def CassandraKeyspace(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      account_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      autoscale_settings: Optional[CassandraKeyspaceAutoscaleSettingsArgs] = None,
                      name: Optional[str] = None,
                      throughput: Optional[int] = 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.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. CassandraKeyspaceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. CassandraKeyspaceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. CassandraKeyspaceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. CassandraKeyspaceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var cassandraKeyspaceResource = new Azure.CosmosDB.CassandraKeyspace("cassandraKeyspaceResource", new()
{
    AccountName = "string",
    ResourceGroupName = "string",
    AutoscaleSettings = new Azure.CosmosDB.Inputs.CassandraKeyspaceAutoscaleSettingsArgs
    {
        MaxThroughput = 0,
    },
    Name = "string",
    Throughput = 0,
});
Copy
example, err := cosmosdb.NewCassandraKeyspace(ctx, "cassandraKeyspaceResource", &cosmosdb.CassandraKeyspaceArgs{
	AccountName:       pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	AutoscaleSettings: &cosmosdb.CassandraKeyspaceAutoscaleSettingsArgs{
		MaxThroughput: pulumi.Int(0),
	},
	Name:       pulumi.String("string"),
	Throughput: pulumi.Int(0),
})
Copy
var cassandraKeyspaceResource = new CassandraKeyspace("cassandraKeyspaceResource", CassandraKeyspaceArgs.builder()
    .accountName("string")
    .resourceGroupName("string")
    .autoscaleSettings(CassandraKeyspaceAutoscaleSettingsArgs.builder()
        .maxThroughput(0)
        .build())
    .name("string")
    .throughput(0)
    .build());
Copy
cassandra_keyspace_resource = azure.cosmosdb.CassandraKeyspace("cassandraKeyspaceResource",
    account_name="string",
    resource_group_name="string",
    autoscale_settings={
        "max_throughput": 0,
    },
    name="string",
    throughput=0)
Copy
const cassandraKeyspaceResource = new azure.cosmosdb.CassandraKeyspace("cassandraKeyspaceResource", {
    accountName: "string",
    resourceGroupName: "string",
    autoscaleSettings: {
        maxThroughput: 0,
    },
    name: "string",
    throughput: 0,
});
Copy
type: azure:cosmosdb:CassandraKeyspace
properties:
    accountName: string
    autoscaleSettings:
        maxThroughput: 0
    name: string
    resourceGroupName: string
    throughput: 0
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The CassandraKeyspace resource accepts the following input properties:

AccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Cosmos DB Cassandra KeySpace to create the table within. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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 CassandraKeyspaceAutoscaleSettings

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.

Name Changes to this property will trigger replacement. 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
This property is required.
Changes to this property will trigger replacement.
string
The name of the Cosmos DB Cassandra KeySpace to create the table within. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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.

Note: Switching between autoscale and manual throughput is not supported via this provider and must be completed via the Azure Portal and refreshed.

Name Changes to this property will trigger replacement. 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
This property is required.
Changes to this property will trigger replacement.
String
The name of the Cosmos DB Cassandra KeySpace to create the table within. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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 CassandraKeyspaceAutoscaleSettings

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.

name Changes to this property will trigger replacement. 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
This property is required.
Changes to this property will trigger replacement.
string
The name of the Cosmos DB Cassandra KeySpace to create the table within. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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 CassandraKeyspaceAutoscaleSettings

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.

name Changes to this property will trigger replacement. 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
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
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.

Note: Switching between autoscale and manual throughput is not supported via this provider and must be completed via the Azure Portal and refreshed.

name Changes to this property will trigger replacement. 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
This property is required.
Changes to this property will trigger replacement.
String
The name of the Cosmos DB Cassandra KeySpace to create the table within. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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.

Note: Switching between autoscale and manual throughput is not supported via this provider and must be completed via the Azure Portal and refreshed.

name Changes to this property will trigger replacement. 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)
resources:  _:    type: azure:cosmosdb:CassandraKeyspace    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 Changes to this property will trigger replacement. string
The name of the Cosmos DB Cassandra KeySpace to create the table within. Changing this forces a new resource to be created.
AutoscaleSettings CassandraKeyspaceAutoscaleSettings

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.

Name Changes to this property will trigger replacement. string
Specifies the name of the Cosmos DB Cassandra KeySpace. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.

Note: Switching between autoscale and manual throughput is not supported via this provider and must be completed via the Azure Portal and refreshed.

Name Changes to this property will trigger replacement. string
Specifies the name of the Cosmos DB Cassandra KeySpace. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. String
The name of the Cosmos DB Cassandra KeySpace to create the table within. Changing this forces a new resource to be created.
autoscaleSettings CassandraKeyspaceAutoscaleSettings

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.

name Changes to this property will trigger replacement. String
Specifies the name of the Cosmos DB Cassandra KeySpace. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
The name of the Cosmos DB Cassandra KeySpace to create the table within. Changing this forces a new resource to be created.
autoscaleSettings CassandraKeyspaceAutoscaleSettings

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.

name Changes to this property will trigger replacement. string
Specifies the name of the Cosmos DB Cassandra KeySpace. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.

Note: Switching between autoscale and manual throughput is not supported via this provider and must be completed via the Azure Portal and refreshed.

name Changes to this property will trigger replacement. str
Specifies the name of the Cosmos DB Cassandra KeySpace. Changing this forces a new resource to be created.
resource_group_name Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.

Note: Switching between autoscale and manual throughput is not supported via this provider and must be completed via the Azure Portal and refreshed.

name Changes to this property will trigger replacement. String
Specifies the name of the Cosmos DB Cassandra KeySpace. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. 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
, CassandraKeyspaceAutoscaleSettingsArgs

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
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

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

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure