azure-native.cosmosdb.DatabaseAccountCassandraTable
Explore with Pulumi AI
An Azure Cosmos DB Cassandra table.
Uses Azure REST API version 2016-03-31.
Other available API versions: 2015-04-01, 2015-04-08, 2015-11-06, 2016-03-19. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native cosmosdb [ApiVersion]
. See the version guide for details.
Create DatabaseAccountCassandraTable Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DatabaseAccountCassandraTable(name: string, args: DatabaseAccountCassandraTableArgs, opts?: CustomResourceOptions);
@overload
def DatabaseAccountCassandraTable(resource_name: str,
args: DatabaseAccountCassandraTableArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DatabaseAccountCassandraTable(resource_name: str,
opts: Optional[ResourceOptions] = None,
account_name: Optional[str] = None,
keyspace_name: Optional[str] = None,
options: Optional[Mapping[str, str]] = None,
resource: Optional[CassandraTableResourceArgs] = None,
resource_group_name: Optional[str] = None,
table_name: Optional[str] = None)
func NewDatabaseAccountCassandraTable(ctx *Context, name string, args DatabaseAccountCassandraTableArgs, opts ...ResourceOption) (*DatabaseAccountCassandraTable, error)
public DatabaseAccountCassandraTable(string name, DatabaseAccountCassandraTableArgs args, CustomResourceOptions? opts = null)
public DatabaseAccountCassandraTable(String name, DatabaseAccountCassandraTableArgs args)
public DatabaseAccountCassandraTable(String name, DatabaseAccountCassandraTableArgs args, CustomResourceOptions options)
type: azure-native:cosmosdb:DatabaseAccountCassandraTable
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. DatabaseAccountCassandraTableArgs - 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. DatabaseAccountCassandraTableArgs - 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. DatabaseAccountCassandraTableArgs - 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. DatabaseAccountCassandraTableArgs - 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. DatabaseAccountCassandraTableArgs - 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 databaseAccountCassandraTableResource = new AzureNative.CosmosDB.DatabaseAccountCassandraTable("databaseAccountCassandraTableResource", new()
{
AccountName = "string",
KeyspaceName = "string",
Options =
{
{ "string", "string" },
},
Resource = new AzureNative.CosmosDB.Inputs.CassandraTableResourceArgs
{
Id = "string",
AnalyticalStorageTtl = 0,
DefaultTtl = 0,
Schema = new AzureNative.CosmosDB.Inputs.CassandraSchemaArgs
{
ClusterKeys = new[]
{
new AzureNative.CosmosDB.Inputs.ClusterKeyArgs
{
Name = "string",
OrderBy = "string",
},
},
Columns = new[]
{
new AzureNative.CosmosDB.Inputs.ColumnArgs
{
Name = "string",
Type = "string",
},
},
PartitionKeys = new[]
{
new AzureNative.CosmosDB.Inputs.CassandraPartitionKeyArgs
{
Name = "string",
},
},
},
},
ResourceGroupName = "string",
TableName = "string",
});
example, err := cosmosdb.NewDatabaseAccountCassandraTable(ctx, "databaseAccountCassandraTableResource", &cosmosdb.DatabaseAccountCassandraTableArgs{
AccountName: pulumi.String("string"),
KeyspaceName: pulumi.String("string"),
Options: pulumi.StringMap{
"string": pulumi.String("string"),
},
Resource: &cosmosdb.CassandraTableResourceArgs{
Id: pulumi.String("string"),
AnalyticalStorageTtl: pulumi.Int(0),
DefaultTtl: pulumi.Int(0),
Schema: &cosmosdb.CassandraSchemaArgs{
ClusterKeys: cosmosdb.ClusterKeyArray{
&cosmosdb.ClusterKeyArgs{
Name: pulumi.String("string"),
OrderBy: pulumi.String("string"),
},
},
Columns: cosmosdb.ColumnArray{
&cosmosdb.ColumnArgs{
Name: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
PartitionKeys: cosmosdb.CassandraPartitionKeyArray{
&cosmosdb.CassandraPartitionKeyArgs{
Name: pulumi.String("string"),
},
},
},
},
ResourceGroupName: pulumi.String("string"),
TableName: pulumi.String("string"),
})
var databaseAccountCassandraTableResource = new DatabaseAccountCassandraTable("databaseAccountCassandraTableResource", DatabaseAccountCassandraTableArgs.builder()
.accountName("string")
.keyspaceName("string")
.options(Map.of("string", "string"))
.resource(CassandraTableResourceArgs.builder()
.id("string")
.analyticalStorageTtl(0)
.defaultTtl(0)
.schema(CassandraSchemaArgs.builder()
.clusterKeys(ClusterKeyArgs.builder()
.name("string")
.orderBy("string")
.build())
.columns(ColumnArgs.builder()
.name("string")
.type("string")
.build())
.partitionKeys(CassandraPartitionKeyArgs.builder()
.name("string")
.build())
.build())
.build())
.resourceGroupName("string")
.tableName("string")
.build());
database_account_cassandra_table_resource = azure_native.cosmosdb.DatabaseAccountCassandraTable("databaseAccountCassandraTableResource",
account_name="string",
keyspace_name="string",
options={
"string": "string",
},
resource={
"id": "string",
"analytical_storage_ttl": 0,
"default_ttl": 0,
"schema": {
"cluster_keys": [{
"name": "string",
"order_by": "string",
}],
"columns": [{
"name": "string",
"type": "string",
}],
"partition_keys": [{
"name": "string",
}],
},
},
resource_group_name="string",
table_name="string")
const databaseAccountCassandraTableResource = new azure_native.cosmosdb.DatabaseAccountCassandraTable("databaseAccountCassandraTableResource", {
accountName: "string",
keyspaceName: "string",
options: {
string: "string",
},
resource: {
id: "string",
analyticalStorageTtl: 0,
defaultTtl: 0,
schema: {
clusterKeys: [{
name: "string",
orderBy: "string",
}],
columns: [{
name: "string",
type: "string",
}],
partitionKeys: [{
name: "string",
}],
},
},
resourceGroupName: "string",
tableName: "string",
});
type: azure-native:cosmosdb:DatabaseAccountCassandraTable
properties:
accountName: string
keyspaceName: string
options:
string: string
resource:
analyticalStorageTtl: 0
defaultTtl: 0
id: string
schema:
clusterKeys:
- name: string
orderBy: string
columns:
- name: string
type: string
partitionKeys:
- name: string
resourceGroupName: string
tableName: string
DatabaseAccountCassandraTable 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 DatabaseAccountCassandraTable resource accepts the following input properties:
- Account
Name This property is required. Changes to this property will trigger replacement.
- Cosmos DB database account name.
- Keyspace
Name This property is required. Changes to this property will trigger replacement.
- Cosmos DB keyspace name.
- Options
This property is required. Dictionary<string, string> - A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- Resource
This property is required. Pulumi.Azure Native. Cosmos DB. Inputs. Cassandra Table Resource - The standard JSON format of a Cassandra table
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of an Azure resource group.
- Table
Name Changes to this property will trigger replacement.
- Cosmos DB table name.
- Account
Name This property is required. Changes to this property will trigger replacement.
- Cosmos DB database account name.
- Keyspace
Name This property is required. Changes to this property will trigger replacement.
- Cosmos DB keyspace name.
- Options
This property is required. map[string]string - A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- Resource
This property is required. CassandraTable Resource Args - The standard JSON format of a Cassandra table
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of an Azure resource group.
- Table
Name Changes to this property will trigger replacement.
- Cosmos DB table name.
- account
Name This property is required. Changes to this property will trigger replacement.
- Cosmos DB database account name.
- keyspace
Name This property is required. Changes to this property will trigger replacement.
- Cosmos DB keyspace name.
- options
This property is required. Map<String,String> - A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- resource
This property is required. CassandraTable Resource - The standard JSON format of a Cassandra table
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of an Azure resource group.
- table
Name Changes to this property will trigger replacement.
- Cosmos DB table name.
- account
Name This property is required. Changes to this property will trigger replacement.
- Cosmos DB database account name.
- keyspace
Name This property is required. Changes to this property will trigger replacement.
- Cosmos DB keyspace name.
- options
This property is required. {[key: string]: string} - A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- resource
This property is required. CassandraTable Resource - The standard JSON format of a Cassandra table
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of an Azure resource group.
- table
Name Changes to this property will trigger replacement.
- Cosmos DB table name.
- account_
name This property is required. Changes to this property will trigger replacement.
- Cosmos DB database account name.
- keyspace_
name This property is required. Changes to this property will trigger replacement.
- Cosmos DB keyspace name.
- options
This property is required. Mapping[str, str] - A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- resource
This property is required. CassandraTable Resource Args - The standard JSON format of a Cassandra table
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- Name of an Azure resource group.
- table_
name Changes to this property will trigger replacement.
- Cosmos DB table name.
- account
Name This property is required. Changes to this property will trigger replacement.
- Cosmos DB database account name.
- keyspace
Name This property is required. Changes to this property will trigger replacement.
- Cosmos DB keyspace name.
- options
This property is required. Map<String> - A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- resource
This property is required. Property Map - The standard JSON format of a Cassandra table
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of an Azure resource group.
- table
Name Changes to this property will trigger replacement.
- Cosmos DB table name.
Outputs
All input properties are implicitly available as output properties. Additionally, the DatabaseAccountCassandraTable resource produces the following output properties:
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the database account.
- Type string
- The type of Azure resource.
- Default
Ttl int - Time to live of the Cosmos DB Cassandra table
- Location string
- The location of the resource group to which the resource belongs.
- Schema
Pulumi.
Azure Native. Cosmos DB. Outputs. Cassandra Schema Response - Schema of the Cosmos DB Cassandra table
- 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".
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the database account.
- Type string
- The type of Azure resource.
- Default
Ttl int - Time to live of the Cosmos DB Cassandra table
- Location string
- The location of the resource group to which the resource belongs.
- Schema
Cassandra
Schema Response - Schema of the Cosmos DB Cassandra table
- 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".
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the database account.
- type String
- The type of Azure resource.
- default
Ttl Integer - Time to live of the Cosmos DB Cassandra table
- location String
- The location of the resource group to which the resource belongs.
- schema
Cassandra
Schema Response - Schema of the Cosmos DB Cassandra table
- 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".
- azure
Api stringVersion - The Azure API version of the resource.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the database account.
- type string
- The type of Azure resource.
- default
Ttl number - Time to live of the Cosmos DB Cassandra table
- location string
- The location of the resource group to which the resource belongs.
- schema
Cassandra
Schema Response - Schema of the Cosmos DB Cassandra table
- {[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".
- azure_
api_ strversion - The Azure API version of the resource.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the database account.
- type str
- The type of Azure resource.
- default_
ttl int - Time to live of the Cosmos DB Cassandra table
- location str
- The location of the resource group to which the resource belongs.
- schema
Cassandra
Schema Response - Schema of the Cosmos DB Cassandra table
- 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".
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the database account.
- type String
- The type of Azure resource.
- default
Ttl Number - Time to live of the Cosmos DB Cassandra table
- location String
- The location of the resource group to which the resource belongs.
- schema Property Map
- Schema of the Cosmos DB Cassandra table
- 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".
Supporting Types
CassandraPartitionKey, CassandraPartitionKeyArgs
- Name string
- Name of the Cosmos DB Cassandra table partition key
- Name string
- Name of the Cosmos DB Cassandra table partition key
- name String
- Name of the Cosmos DB Cassandra table partition key
- name string
- Name of the Cosmos DB Cassandra table partition key
- name str
- Name of the Cosmos DB Cassandra table partition key
- name String
- Name of the Cosmos DB Cassandra table partition key
CassandraPartitionKeyResponse, CassandraPartitionKeyResponseArgs
- Name string
- Name of the Cosmos DB Cassandra table partition key
- Name string
- Name of the Cosmos DB Cassandra table partition key
- name String
- Name of the Cosmos DB Cassandra table partition key
- name string
- Name of the Cosmos DB Cassandra table partition key
- name str
- Name of the Cosmos DB Cassandra table partition key
- name String
- Name of the Cosmos DB Cassandra table partition key
CassandraSchema, CassandraSchemaArgs
- Cluster
Keys List<Pulumi.Azure Native. Cosmos DB. Inputs. Cluster Key> - List of cluster key.
- Columns
List<Pulumi.
Azure Native. Cosmos DB. Inputs. Column> - List of Cassandra table columns.
- Partition
Keys List<Pulumi.Azure Native. Cosmos DB. Inputs. Cassandra Partition Key> - List of partition key.
- Cluster
Keys []ClusterKey - List of cluster key.
- Columns []Column
- List of Cassandra table columns.
- Partition
Keys []CassandraPartition Key - List of partition key.
- cluster
Keys List<ClusterKey> - List of cluster key.
- columns List<Column>
- List of Cassandra table columns.
- partition
Keys List<CassandraPartition Key> - List of partition key.
- cluster
Keys ClusterKey[] - List of cluster key.
- columns Column[]
- List of Cassandra table columns.
- partition
Keys CassandraPartition Key[] - List of partition key.
- cluster_
keys Sequence[ClusterKey] - List of cluster key.
- columns Sequence[Column]
- List of Cassandra table columns.
- partition_
keys Sequence[CassandraPartition Key] - List of partition key.
- cluster
Keys List<Property Map> - List of cluster key.
- columns List<Property Map>
- List of Cassandra table columns.
- partition
Keys List<Property Map> - List of partition key.
CassandraSchemaResponse, CassandraSchemaResponseArgs
- Cluster
Keys List<Pulumi.Azure Native. Cosmos DB. Inputs. Cluster Key Response> - List of cluster key.
- Columns
List<Pulumi.
Azure Native. Cosmos DB. Inputs. Column Response> - List of Cassandra table columns.
- Partition
Keys List<Pulumi.Azure Native. Cosmos DB. Inputs. Cassandra Partition Key Response> - List of partition key.
- Cluster
Keys []ClusterKey Response - List of cluster key.
- Columns
[]Column
Response - List of Cassandra table columns.
- Partition
Keys []CassandraPartition Key Response - List of partition key.
- cluster
Keys List<ClusterKey Response> - List of cluster key.
- columns
List<Column
Response> - List of Cassandra table columns.
- partition
Keys List<CassandraPartition Key Response> - List of partition key.
- cluster
Keys ClusterKey Response[] - List of cluster key.
- columns
Column
Response[] - List of Cassandra table columns.
- partition
Keys CassandraPartition Key Response[] - List of partition key.
- cluster_
keys Sequence[ClusterKey Response] - List of cluster key.
- columns
Sequence[Column
Response] - List of Cassandra table columns.
- partition_
keys Sequence[CassandraPartition Key Response] - List of partition key.
- cluster
Keys List<Property Map> - List of cluster key.
- columns List<Property Map>
- List of Cassandra table columns.
- partition
Keys List<Property Map> - List of partition key.
CassandraTableResource, CassandraTableResourceArgs
- Id
This property is required. string - Name of the Cosmos DB Cassandra table
- Analytical
Storage intTtl - Analytical TTL.
- Default
Ttl int - Time to live of the Cosmos DB Cassandra table
- Schema
Pulumi.
Azure Native. Cosmos DB. Inputs. Cassandra Schema - Schema of the Cosmos DB Cassandra table
- Id
This property is required. string - Name of the Cosmos DB Cassandra table
- Analytical
Storage intTtl - Analytical TTL.
- Default
Ttl int - Time to live of the Cosmos DB Cassandra table
- Schema
Cassandra
Schema - Schema of the Cosmos DB Cassandra table
- id
This property is required. String - Name of the Cosmos DB Cassandra table
- analytical
Storage IntegerTtl - Analytical TTL.
- default
Ttl Integer - Time to live of the Cosmos DB Cassandra table
- schema
Cassandra
Schema - Schema of the Cosmos DB Cassandra table
- id
This property is required. string - Name of the Cosmos DB Cassandra table
- analytical
Storage numberTtl - Analytical TTL.
- default
Ttl number - Time to live of the Cosmos DB Cassandra table
- schema
Cassandra
Schema - Schema of the Cosmos DB Cassandra table
- id
This property is required. str - Name of the Cosmos DB Cassandra table
- analytical_
storage_ intttl - Analytical TTL.
- default_
ttl int - Time to live of the Cosmos DB Cassandra table
- schema
Cassandra
Schema - Schema of the Cosmos DB Cassandra table
- id
This property is required. String - Name of the Cosmos DB Cassandra table
- analytical
Storage NumberTtl - Analytical TTL.
- default
Ttl Number - Time to live of the Cosmos DB Cassandra table
- schema Property Map
- Schema of the Cosmos DB Cassandra table
ClusterKey, ClusterKeyArgs
ClusterKeyResponse, ClusterKeyResponseArgs
Column, ColumnArgs
ColumnResponse, ColumnResponseArgs
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:cosmosdb:DatabaseAccountCassandraTable tableName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/apis/cassandra/keyspaces/{keyspaceName}/tables/{tableName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0