azure-native.documentdb.CassandraResourceCassandraKeyspace
Explore with Pulumi AI
An Azure Cosmos DB Cassandra keyspace. Azure REST API version: 2023-04-15. Prior API version in Azure Native 1.x: 2021-03-15.
Other available API versions: 2019-08-01, 2023-03-15-preview, 2023-09-15, 2023-09-15-preview, 2023-11-15, 2023-11-15-preview, 2024-02-15-preview, 2024-05-15, 2024-05-15-preview, 2024-08-15, 2024-09-01-preview.
Example Usage
CosmosDBCassandraKeyspaceCreateUpdate
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var cassandraResourceCassandraKeyspace = new AzureNative.DocumentDB.CassandraResourceCassandraKeyspace("cassandraResourceCassandraKeyspace", new()
{
AccountName = "ddb1",
KeyspaceName = "keyspaceName",
Location = "West US",
Options = null,
Resource = new AzureNative.DocumentDB.Inputs.CassandraKeyspaceResourceArgs
{
Id = "keyspaceName",
},
ResourceGroupName = "rg1",
Tags = null,
});
});
package main
import (
documentdb "github.com/pulumi/pulumi-azure-native-sdk/documentdb/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := documentdb.NewCassandraResourceCassandraKeyspace(ctx, "cassandraResourceCassandraKeyspace", &documentdb.CassandraResourceCassandraKeyspaceArgs{
AccountName: pulumi.String("ddb1"),
KeyspaceName: pulumi.String("keyspaceName"),
Location: pulumi.String("West US"),
Options: &documentdb.CreateUpdateOptionsArgs{},
Resource: &documentdb.CassandraKeyspaceResourceArgs{
Id: pulumi.String("keyspaceName"),
},
ResourceGroupName: pulumi.String("rg1"),
Tags: pulumi.StringMap{},
})
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.azurenative.documentdb.CassandraResourceCassandraKeyspace;
import com.pulumi.azurenative.documentdb.CassandraResourceCassandraKeyspaceArgs;
import com.pulumi.azurenative.documentdb.inputs.CreateUpdateOptionsArgs;
import com.pulumi.azurenative.documentdb.inputs.CassandraKeyspaceResourceArgs;
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 cassandraResourceCassandraKeyspace = new CassandraResourceCassandraKeyspace("cassandraResourceCassandraKeyspace", CassandraResourceCassandraKeyspaceArgs.builder()
.accountName("ddb1")
.keyspaceName("keyspaceName")
.location("West US")
.options()
.resource(CassandraKeyspaceResourceArgs.builder()
.id("keyspaceName")
.build())
.resourceGroupName("rg1")
.tags()
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
cassandra_resource_cassandra_keyspace = azure_native.documentdb.CassandraResourceCassandraKeyspace("cassandraResourceCassandraKeyspace",
account_name="ddb1",
keyspace_name="keyspaceName",
location="West US",
options={},
resource={
"id": "keyspaceName",
},
resource_group_name="rg1",
tags={})
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const cassandraResourceCassandraKeyspace = new azure_native.documentdb.CassandraResourceCassandraKeyspace("cassandraResourceCassandraKeyspace", {
accountName: "ddb1",
keyspaceName: "keyspaceName",
location: "West US",
options: {},
resource: {
id: "keyspaceName",
},
resourceGroupName: "rg1",
tags: {},
});
resources:
cassandraResourceCassandraKeyspace:
type: azure-native:documentdb:CassandraResourceCassandraKeyspace
properties:
accountName: ddb1
keyspaceName: keyspaceName
location: West US
options: {}
resource:
id: keyspaceName
resourceGroupName: rg1
tags: {}
Create CassandraResourceCassandraKeyspace Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CassandraResourceCassandraKeyspace(name: string, args: CassandraResourceCassandraKeyspaceArgs, opts?: CustomResourceOptions);
@overload
def CassandraResourceCassandraKeyspace(resource_name: str,
args: CassandraResourceCassandraKeyspaceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CassandraResourceCassandraKeyspace(resource_name: str,
opts: Optional[ResourceOptions] = None,
account_name: Optional[str] = None,
resource: Optional[CassandraKeyspaceResourceArgs] = None,
resource_group_name: Optional[str] = None,
keyspace_name: Optional[str] = None,
location: Optional[str] = None,
options: Optional[CreateUpdateOptionsArgs] = None,
tags: Optional[Mapping[str, str]] = None)
func NewCassandraResourceCassandraKeyspace(ctx *Context, name string, args CassandraResourceCassandraKeyspaceArgs, opts ...ResourceOption) (*CassandraResourceCassandraKeyspace, error)
public CassandraResourceCassandraKeyspace(string name, CassandraResourceCassandraKeyspaceArgs args, CustomResourceOptions? opts = null)
public CassandraResourceCassandraKeyspace(String name, CassandraResourceCassandraKeyspaceArgs args)
public CassandraResourceCassandraKeyspace(String name, CassandraResourceCassandraKeyspaceArgs args, CustomResourceOptions options)
type: azure-native:documentdb:CassandraResourceCassandraKeyspace
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args CassandraResourceCassandraKeyspaceArgs
- 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 CassandraResourceCassandraKeyspaceArgs
- 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 CassandraResourceCassandraKeyspaceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CassandraResourceCassandraKeyspaceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CassandraResourceCassandraKeyspaceArgs
- 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 cassandraResourceCassandraKeyspaceResource = new AzureNative.DocumentDB.CassandraResourceCassandraKeyspace("cassandraResourceCassandraKeyspaceResource", new()
{
AccountName = "string",
Resource = new AzureNative.DocumentDB.Inputs.CassandraKeyspaceResourceArgs
{
Id = "string",
},
ResourceGroupName = "string",
KeyspaceName = "string",
Location = "string",
Options = new AzureNative.DocumentDB.Inputs.CreateUpdateOptionsArgs
{
AutoscaleSettings = new AzureNative.DocumentDB.Inputs.AutoscaleSettingsArgs
{
MaxThroughput = 0,
},
Throughput = 0,
},
Tags =
{
{ "string", "string" },
},
});
example, err := documentdb.NewCassandraResourceCassandraKeyspace(ctx, "cassandraResourceCassandraKeyspaceResource", &documentdb.CassandraResourceCassandraKeyspaceArgs{
AccountName: pulumi.String("string"),
Resource: &documentdb.CassandraKeyspaceResourceArgs{
Id: pulumi.String("string"),
},
ResourceGroupName: pulumi.String("string"),
KeyspaceName: pulumi.String("string"),
Location: pulumi.String("string"),
Options: &documentdb.CreateUpdateOptionsArgs{
AutoscaleSettings: &documentdb.AutoscaleSettingsArgs{
MaxThroughput: pulumi.Int(0),
},
Throughput: pulumi.Int(0),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var cassandraResourceCassandraKeyspaceResource = new CassandraResourceCassandraKeyspace("cassandraResourceCassandraKeyspaceResource", CassandraResourceCassandraKeyspaceArgs.builder()
.accountName("string")
.resource(CassandraKeyspaceResourceArgs.builder()
.id("string")
.build())
.resourceGroupName("string")
.keyspaceName("string")
.location("string")
.options(CreateUpdateOptionsArgs.builder()
.autoscaleSettings(AutoscaleSettingsArgs.builder()
.maxThroughput(0)
.build())
.throughput(0)
.build())
.tags(Map.of("string", "string"))
.build());
cassandra_resource_cassandra_keyspace_resource = azure_native.documentdb.CassandraResourceCassandraKeyspace("cassandraResourceCassandraKeyspaceResource",
account_name="string",
resource={
"id": "string",
},
resource_group_name="string",
keyspace_name="string",
location="string",
options={
"autoscaleSettings": {
"maxThroughput": 0,
},
"throughput": 0,
},
tags={
"string": "string",
})
const cassandraResourceCassandraKeyspaceResource = new azure_native.documentdb.CassandraResourceCassandraKeyspace("cassandraResourceCassandraKeyspaceResource", {
accountName: "string",
resource: {
id: "string",
},
resourceGroupName: "string",
keyspaceName: "string",
location: "string",
options: {
autoscaleSettings: {
maxThroughput: 0,
},
throughput: 0,
},
tags: {
string: "string",
},
});
type: azure-native:documentdb:CassandraResourceCassandraKeyspace
properties:
accountName: string
keyspaceName: string
location: string
options:
autoscaleSettings:
maxThroughput: 0
throughput: 0
resource:
id: string
resourceGroupName: string
tags:
string: string
CassandraResourceCassandraKeyspace 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 CassandraResourceCassandraKeyspace resource accepts the following input properties:
- Account
Name string - Cosmos DB database account name.
- Resource
Pulumi.
Azure Native. Document DB. Inputs. Cassandra Keyspace Resource - The standard JSON format of a Cassandra keyspace
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Keyspace
Name string - Cosmos DB keyspace name.
- Location string
- The location of the resource group to which the resource belongs.
- Options
Pulumi.
Azure Native. Document DB. Inputs. Create Update Options - A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- Dictionary<string, string>
- Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
- Account
Name string - Cosmos DB database account name.
- Resource
Cassandra
Keyspace Resource Args - The standard JSON format of a Cassandra keyspace
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Keyspace
Name string - Cosmos DB keyspace name.
- Location string
- The location of the resource group to which the resource belongs.
- Options
Create
Update Options Args - A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- map[string]string
- Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
- account
Name String - Cosmos DB database account name.
- resource
Cassandra
Keyspace Resource - The standard JSON format of a Cassandra keyspace
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- keyspace
Name String - Cosmos DB keyspace name.
- location String
- The location of the resource group to which the resource belongs.
- options
Create
Update Options - A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- Map<String,String>
- Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
- account
Name string - Cosmos DB database account name.
- resource
Cassandra
Keyspace Resource - The standard JSON format of a Cassandra keyspace
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- keyspace
Name string - Cosmos DB keyspace name.
- location string
- The location of the resource group to which the resource belongs.
- options
Create
Update Options - A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- {[key: string]: string}
- Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
- account_
name str - Cosmos DB database account name.
- resource
Cassandra
Keyspace Resource Args - The standard JSON format of a Cassandra keyspace
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- keyspace_
name str - Cosmos DB keyspace name.
- location str
- The location of the resource group to which the resource belongs.
- options
Create
Update Options Args - A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- Mapping[str, str]
- Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
- account
Name String - Cosmos DB database account name.
- resource Property Map
- The standard JSON format of a Cassandra keyspace
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- keyspace
Name String - Cosmos DB keyspace name.
- location String
- The location of the resource group to which the resource belongs.
- options Property Map
- A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- Map<String>
- Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
Outputs
All input properties are implicitly available as output properties. Additionally, the CassandraResourceCassandraKeyspace resource produces the following output properties:
Supporting Types
AutoscaleSettings, AutoscaleSettingsArgs
- Max
Throughput int - Represents maximum throughput, the resource can scale up to.
- Max
Throughput int - Represents maximum throughput, the resource can scale up to.
- max
Throughput Integer - Represents maximum throughput, the resource can scale up to.
- max
Throughput number - Represents maximum throughput, the resource can scale up to.
- max_
throughput int - Represents maximum throughput, the resource can scale up to.
- max
Throughput Number - Represents maximum throughput, the resource can scale up to.
AutoscaleSettingsResponse, AutoscaleSettingsResponseArgs
- Max
Throughput int - Represents maximum throughput, the resource can scale up to.
- Max
Throughput int - Represents maximum throughput, the resource can scale up to.
- max
Throughput Integer - Represents maximum throughput, the resource can scale up to.
- max
Throughput number - Represents maximum throughput, the resource can scale up to.
- max_
throughput int - Represents maximum throughput, the resource can scale up to.
- max
Throughput Number - Represents maximum throughput, the resource can scale up to.
CassandraKeyspaceGetPropertiesResponseOptions, CassandraKeyspaceGetPropertiesResponseOptionsArgs
- Autoscale
Settings Pulumi.Azure Native. Document DB. Inputs. Autoscale Settings Response - Specifies the Autoscale settings.
- Throughput int
- Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- Autoscale
Settings AutoscaleSettings Response - Specifies the Autoscale settings.
- Throughput int
- Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- autoscale
Settings AutoscaleSettings Response - Specifies the Autoscale settings.
- throughput Integer
- Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- autoscale
Settings AutoscaleSettings Response - Specifies the Autoscale settings.
- throughput number
- Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- autoscale_
settings AutoscaleSettings Response - Specifies the Autoscale settings.
- throughput int
- Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- autoscale
Settings Property Map - Specifies the Autoscale settings.
- throughput Number
- Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
CassandraKeyspaceGetPropertiesResponseResource, CassandraKeyspaceGetPropertiesResponseResourceArgs
- Etag string
- A system generated property representing the resource etag required for optimistic concurrency control.
- Id string
- Name of the Cosmos DB Cassandra keyspace
- Rid string
- A system generated property. A unique identifier.
- Ts double
- A system generated property that denotes the last updated timestamp of the resource.
- Etag string
- A system generated property representing the resource etag required for optimistic concurrency control.
- Id string
- Name of the Cosmos DB Cassandra keyspace
- Rid string
- A system generated property. A unique identifier.
- Ts float64
- A system generated property that denotes the last updated timestamp of the resource.
- etag String
- A system generated property representing the resource etag required for optimistic concurrency control.
- id String
- Name of the Cosmos DB Cassandra keyspace
- rid String
- A system generated property. A unique identifier.
- ts Double
- A system generated property that denotes the last updated timestamp of the resource.
- etag string
- A system generated property representing the resource etag required for optimistic concurrency control.
- id string
- Name of the Cosmos DB Cassandra keyspace
- rid string
- A system generated property. A unique identifier.
- ts number
- A system generated property that denotes the last updated timestamp of the resource.
- etag str
- A system generated property representing the resource etag required for optimistic concurrency control.
- id str
- Name of the Cosmos DB Cassandra keyspace
- rid str
- A system generated property. A unique identifier.
- ts float
- A system generated property that denotes the last updated timestamp of the resource.
- etag String
- A system generated property representing the resource etag required for optimistic concurrency control.
- id String
- Name of the Cosmos DB Cassandra keyspace
- rid String
- A system generated property. A unique identifier.
- ts Number
- A system generated property that denotes the last updated timestamp of the resource.
CassandraKeyspaceResource, CassandraKeyspaceResourceArgs
- Id string
- Name of the Cosmos DB Cassandra keyspace
- Id string
- Name of the Cosmos DB Cassandra keyspace
- id String
- Name of the Cosmos DB Cassandra keyspace
- id string
- Name of the Cosmos DB Cassandra keyspace
- id str
- Name of the Cosmos DB Cassandra keyspace
- id String
- Name of the Cosmos DB Cassandra keyspace
CreateUpdateOptions, CreateUpdateOptionsArgs
- Autoscale
Settings Pulumi.Azure Native. Document DB. Inputs. Autoscale Settings - Specifies the Autoscale settings.
- Throughput int
- Request Units per second. For example, "throughput": 10000.
- Autoscale
Settings AutoscaleSettings - Specifies the Autoscale settings.
- Throughput int
- Request Units per second. For example, "throughput": 10000.
- autoscale
Settings AutoscaleSettings - Specifies the Autoscale settings.
- throughput Integer
- Request Units per second. For example, "throughput": 10000.
- autoscale
Settings AutoscaleSettings - Specifies the Autoscale settings.
- throughput number
- Request Units per second. For example, "throughput": 10000.
- autoscale_
settings AutoscaleSettings - Specifies the Autoscale settings.
- throughput int
- Request Units per second. For example, "throughput": 10000.
- autoscale
Settings Property Map - Specifies the Autoscale settings.
- throughput Number
- Request Units per second. For example, "throughput": 10000.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:documentdb:CassandraResourceCassandraKeyspace keyspaceName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0