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

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.cosmosdb.CassandraTable

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a Cassandra Table within a Cosmos DB Cassandra Keyspace.

    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,
});
const exampleCassandraTable = new azure.cosmosdb.CassandraTable("example", {
    name: "testtable",
    cassandraKeyspaceId: exampleCassandraKeyspace.id,
    schema: {
        columns: [
            {
                name: "test1",
                type: "ascii",
            },
            {
                name: "test2",
                type: "int",
            },
        ],
        partitionKeys: [{
            name: "test1",
        }],
    },
});

    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)
example_cassandra_table = azure.cosmosdb.CassandraTable("example",
    name="testtable",
    cassandra_keyspace_id=example_cassandra_keyspace.id,
    schema={
        "columns": [
            {
                "name": "test1",
                "type": "ascii",
            },
            {
                "name": "test2",
                "type": "int",
            },
        ],
        "partition_keys": [{
            "name": "test1",
        }],
    })

    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
		}
		exampleCassandraKeyspace, 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
		}
		_, err = cosmosdb.NewCassandraTable(ctx, "example", &cosmosdb.CassandraTableArgs{
			Name:                pulumi.String("testtable"),
			CassandraKeyspaceId: exampleCassandraKeyspace.ID(),
			Schema: &cosmosdb.CassandraTableSchemaArgs{
				Columns: cosmosdb.CassandraTableSchemaColumnArray{
					&cosmosdb.CassandraTableSchemaColumnArgs{
						Name: pulumi.String("test1"),
						Type: pulumi.String("ascii"),
					},
					&cosmosdb.CassandraTableSchemaColumnArgs{
						Name: pulumi.String("test2"),
						Type: pulumi.String("int"),
					},
				},
				PartitionKeys: cosmosdb.CassandraTableSchemaPartitionKeyArray{
					&cosmosdb.CassandraTableSchemaPartitionKeyArgs{
						Name: pulumi.String("test1"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

    var exampleCassandraTable = new Azure.CosmosDB.CassandraTable("example", new()
    {
        Name = "testtable",
        CassandraKeyspaceId = exampleCassandraKeyspace.Id,
        Schema = new Azure.CosmosDB.Inputs.CassandraTableSchemaArgs
        {
            Columns = new[]
            {
                new Azure.CosmosDB.Inputs.CassandraTableSchemaColumnArgs
                {
                    Name = "test1",
                    Type = "ascii",
                },
                new Azure.CosmosDB.Inputs.CassandraTableSchemaColumnArgs
                {
                    Name = "test2",
                    Type = "int",
                },
            },
            PartitionKeys = new[]
            {
                new Azure.CosmosDB.Inputs.CassandraTableSchemaPartitionKeyArgs
                {
                    Name = "test1",
                },
            },
        },
    });

});

    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 com.pulumi.azure.cosmosdb.CassandraTable;
import com.pulumi.azure.cosmosdb.CassandraTableArgs;
import com.pulumi.azure.cosmosdb.inputs.CassandraTableSchemaArgs;
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());

        var exampleCassandraTable = new CassandraTable("exampleCassandraTable", CassandraTableArgs.builder()
            .name("testtable")
            .cassandraKeyspaceId(exampleCassandraKeyspace.id())
            .schema(CassandraTableSchemaArgs.builder()
                .columns(                
                    CassandraTableSchemaColumnArgs.builder()
                        .name("test1")
                        .type("ascii")
                        .build(),
                    CassandraTableSchemaColumnArgs.builder()
                        .name("test2")
                        .type("int")
                        .build())
                .partitionKeys(CassandraTableSchemaPartitionKeyArgs.builder()
                    .name("test1")
                    .build())
                .build())
            .build());

    }
}

    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
  exampleCassandraTable:
    type: azure:cosmosdb:CassandraTable
    name: example
    properties:
      name: testtable
      cassandraKeyspaceId: ${exampleCassandraKeyspace.id}
      schema:
        columns:
          - name: test1
            type: ascii
          - name: test2
            type: int
        partitionKeys:
          - name: test1

    Create CassandraTable Resource

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

    Constructor syntax

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

@overload
def CassandraTable(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   cassandra_keyspace_id: Optional[str] = None,
                   schema: Optional[CassandraTableSchemaArgs] = None,
                   analytical_storage_ttl: Optional[int] = None,
                   autoscale_settings: Optional[CassandraTableAutoscaleSettingsArgs] = None,
                   default_ttl: Optional[int] = None,
                   name: Optional[str] = None,
                   throughput: Optional[int] = None)
    func NewCassandraTable(ctx *Context, name string, args CassandraTableArgs, opts ...ResourceOption) (*CassandraTable, error)
    public CassandraTable(string name, CassandraTableArgs args, CustomResourceOptions? opts = null)
    public CassandraTable(String name, CassandraTableArgs args)
public CassandraTable(String name, CassandraTableArgs args, CustomResourceOptions options)

    type: azure:cosmosdb:CassandraTable
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 CassandraTableArgs
    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 CassandraTableArgs
    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 CassandraTableArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CassandraTableArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CassandraTableArgs
    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 cassandraTableResource = new Azure.CosmosDB.CassandraTable("cassandraTableResource", new()
{
    CassandraKeyspaceId = "string",
    Schema = new Azure.CosmosDB.Inputs.CassandraTableSchemaArgs
    {
        Columns = new[]
        {
            new Azure.CosmosDB.Inputs.CassandraTableSchemaColumnArgs
            {
                Name = "string",
                Type = "string",
            },
        },
        PartitionKeys = new[]
        {
            new Azure.CosmosDB.Inputs.CassandraTableSchemaPartitionKeyArgs
            {
                Name = "string",
            },
        },
        ClusterKeys = new[]
        {
            new Azure.CosmosDB.Inputs.CassandraTableSchemaClusterKeyArgs
            {
                Name = "string",
                OrderBy = "string",
            },
        },
    },
    AnalyticalStorageTtl = 0,
    AutoscaleSettings = new Azure.CosmosDB.Inputs.CassandraTableAutoscaleSettingsArgs
    {
        MaxThroughput = 0,
    },
    DefaultTtl = 0,
    Name = "string",
    Throughput = 0,
});

    example, err := cosmosdb.NewCassandraTable(ctx, "cassandraTableResource", &cosmosdb.CassandraTableArgs{
	CassandraKeyspaceId: pulumi.String("string"),
	Schema: &cosmosdb.CassandraTableSchemaArgs{
		Columns: cosmosdb.CassandraTableSchemaColumnArray{
			&cosmosdb.CassandraTableSchemaColumnArgs{
				Name: pulumi.String("string"),
				Type: pulumi.String("string"),
			},
		},
		PartitionKeys: cosmosdb.CassandraTableSchemaPartitionKeyArray{
			&cosmosdb.CassandraTableSchemaPartitionKeyArgs{
				Name: pulumi.String("string"),
			},
		},
		ClusterKeys: cosmosdb.CassandraTableSchemaClusterKeyArray{
			&cosmosdb.CassandraTableSchemaClusterKeyArgs{
				Name:    pulumi.String("string"),
				OrderBy: pulumi.String("string"),
			},
		},
	},
	AnalyticalStorageTtl: pulumi.Int(0),
	AutoscaleSettings: &cosmosdb.CassandraTableAutoscaleSettingsArgs{
		MaxThroughput: pulumi.Int(0),
	},
	DefaultTtl: pulumi.Int(0),
	Name:       pulumi.String("string"),
	Throughput: pulumi.Int(0),
})

    var cassandraTableResource = new CassandraTable("cassandraTableResource", CassandraTableArgs.builder()
    .cassandraKeyspaceId("string")
    .schema(CassandraTableSchemaArgs.builder()
        .columns(CassandraTableSchemaColumnArgs.builder()
            .name("string")
            .type("string")
            .build())
        .partitionKeys(CassandraTableSchemaPartitionKeyArgs.builder()
            .name("string")
            .build())
        .clusterKeys(CassandraTableSchemaClusterKeyArgs.builder()
            .name("string")
            .orderBy("string")
            .build())
        .build())
    .analyticalStorageTtl(0)
    .autoscaleSettings(CassandraTableAutoscaleSettingsArgs.builder()
        .maxThroughput(0)
        .build())
    .defaultTtl(0)
    .name("string")
    .throughput(0)
    .build());

    cassandra_table_resource = azure.cosmosdb.CassandraTable("cassandraTableResource",
    cassandra_keyspace_id="string",
    schema={
        "columns": [{
            "name": "string",
            "type": "string",
        }],
        "partition_keys": [{
            "name": "string",
        }],
        "cluster_keys": [{
            "name": "string",
            "order_by": "string",
        }],
    },
    analytical_storage_ttl=0,
    autoscale_settings={
        "max_throughput": 0,
    },
    default_ttl=0,
    name="string",
    throughput=0)

    const cassandraTableResource = new azure.cosmosdb.CassandraTable("cassandraTableResource", {
    cassandraKeyspaceId: "string",
    schema: {
        columns: [{
            name: "string",
            type: "string",
        }],
        partitionKeys: [{
            name: "string",
        }],
        clusterKeys: [{
            name: "string",
            orderBy: "string",
        }],
    },
    analyticalStorageTtl: 0,
    autoscaleSettings: {
        maxThroughput: 0,
    },
    defaultTtl: 0,
    name: "string",
    throughput: 0,
});

    type: azure:cosmosdb:CassandraTable
properties:
    analyticalStorageTtl: 0
    autoscaleSettings:
        maxThroughput: 0
    cassandraKeyspaceId: string
    defaultTtl: 0
    name: string
    schema:
        clusterKeys:
            - name: string
              orderBy: string
        columns:
            - name: string
              type: string
        partitionKeys:
            - name: string
    throughput: 0

    CassandraTable 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 CassandraTable resource accepts the following input properties:

    CassandraKeyspaceId string
    The ID of the Cosmos DB Cassandra Keyspace to create the table within. Changing this forces a new resource to be created.
    Schema CassandraTableSchema
    A schema block as defined below.
    AnalyticalStorageTtl int

    Time to live of the Analytical Storage. Possible values are between -1 and 2147483647 except 0. -1 means the Analytical Storage never expires. Changing this forces a new resource to be created.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support

    AutoscaleSettings CassandraTableAutoscaleSettings
    DefaultTtl int
    Time to live of the Cosmos DB Cassandra table. Possible values are at least -1. -1 means the Cassandra table never expires.
    Name string
    Specifies the name of the Cosmos DB Cassandra Table. Changing this forces a new resource to be created.
    Throughput int
    CassandraKeyspaceId string
    The ID of the Cosmos DB Cassandra Keyspace to create the table within. Changing this forces a new resource to be created.
    Schema CassandraTableSchemaArgs
    A schema block as defined below.
    AnalyticalStorageTtl int

    Time to live of the Analytical Storage. Possible values are between -1 and 2147483647 except 0. -1 means the Analytical Storage never expires. Changing this forces a new resource to be created.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support

    AutoscaleSettings CassandraTableAutoscaleSettingsArgs
    DefaultTtl int
    Time to live of the Cosmos DB Cassandra table. Possible values are at least -1. -1 means the Cassandra table never expires.
    Name string
    Specifies the name of the Cosmos DB Cassandra Table. Changing this forces a new resource to be created.
    Throughput int
    cassandraKeyspaceId String
    The ID of the Cosmos DB Cassandra Keyspace to create the table within. Changing this forces a new resource to be created.
    schema CassandraTableSchema
    A schema block as defined below.
    analyticalStorageTtl Integer

    Time to live of the Analytical Storage. Possible values are between -1 and 2147483647 except 0. -1 means the Analytical Storage never expires. Changing this forces a new resource to be created.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support

    autoscaleSettings CassandraTableAutoscaleSettings
    defaultTtl Integer
    Time to live of the Cosmos DB Cassandra table. Possible values are at least -1. -1 means the Cassandra table never expires.
    name String
    Specifies the name of the Cosmos DB Cassandra Table. Changing this forces a new resource to be created.
    throughput Integer
    cassandraKeyspaceId string
    The ID of the Cosmos DB Cassandra Keyspace to create the table within. Changing this forces a new resource to be created.
    schema CassandraTableSchema
    A schema block as defined below.
    analyticalStorageTtl number

    Time to live of the Analytical Storage. Possible values are between -1 and 2147483647 except 0. -1 means the Analytical Storage never expires. Changing this forces a new resource to be created.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support

    autoscaleSettings CassandraTableAutoscaleSettings
    defaultTtl number
    Time to live of the Cosmos DB Cassandra table. Possible values are at least -1. -1 means the Cassandra table never expires.
    name string
    Specifies the name of the Cosmos DB Cassandra Table. Changing this forces a new resource to be created.
    throughput number
    cassandra_keyspace_id str
    The ID of the Cosmos DB Cassandra Keyspace to create the table within. Changing this forces a new resource to be created.
    schema CassandraTableSchemaArgs
    A schema block as defined below.
    analytical_storage_ttl int

    Time to live of the Analytical Storage. Possible values are between -1 and 2147483647 except 0. -1 means the Analytical Storage never expires. Changing this forces a new resource to be created.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support

    autoscale_settings CassandraTableAutoscaleSettingsArgs
    default_ttl int
    Time to live of the Cosmos DB Cassandra table. Possible values are at least -1. -1 means the Cassandra table never expires.
    name str
    Specifies the name of the Cosmos DB Cassandra Table. Changing this forces a new resource to be created.
    throughput int
    cassandraKeyspaceId String
    The ID of the Cosmos DB Cassandra Keyspace to create the table within. Changing this forces a new resource to be created.
    schema Property Map
    A schema block as defined below.
    analyticalStorageTtl Number

    Time to live of the Analytical Storage. Possible values are between -1 and 2147483647 except 0. -1 means the Analytical Storage never expires. Changing this forces a new resource to be created.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support

    autoscaleSettings Property Map
    defaultTtl Number
    Time to live of the Cosmos DB Cassandra table. Possible values are at least -1. -1 means the Cassandra table never expires.
    name String
    Specifies the name of the Cosmos DB Cassandra Table. Changing this forces a new resource to be created.
    throughput Number

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CassandraTable 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 CassandraTable Resource

    Get an existing CassandraTable 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?: CassandraTableState, opts?: CustomResourceOptions): CassandraTable
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        analytical_storage_ttl: Optional[int] = None,
        autoscale_settings: Optional[CassandraTableAutoscaleSettingsArgs] = None,
        cassandra_keyspace_id: Optional[str] = None,
        default_ttl: Optional[int] = None,
        name: Optional[str] = None,
        schema: Optional[CassandraTableSchemaArgs] = None,
        throughput: Optional[int] = None) -> CassandraTable
    func GetCassandraTable(ctx *Context, name string, id IDInput, state *CassandraTableState, opts ...ResourceOption) (*CassandraTable, error)
    public static CassandraTable Get(string name, Input<string> id, CassandraTableState? state, CustomResourceOptions? opts = null)
    public static CassandraTable get(String name, Output<String> id, CassandraTableState 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:
    AnalyticalStorageTtl int

    Time to live of the Analytical Storage. Possible values are between -1 and 2147483647 except 0. -1 means the Analytical Storage never expires. Changing this forces a new resource to be created.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support

    AutoscaleSettings CassandraTableAutoscaleSettings
    CassandraKeyspaceId string
    The ID of the Cosmos DB Cassandra Keyspace to create the table within. Changing this forces a new resource to be created.
    DefaultTtl int
    Time to live of the Cosmos DB Cassandra table. Possible values are at least -1. -1 means the Cassandra table never expires.
    Name string
    Specifies the name of the Cosmos DB Cassandra Table. Changing this forces a new resource to be created.
    Schema CassandraTableSchema
    A schema block as defined below.
    Throughput int
    AnalyticalStorageTtl int

    Time to live of the Analytical Storage. Possible values are between -1 and 2147483647 except 0. -1 means the Analytical Storage never expires. Changing this forces a new resource to be created.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support

    AutoscaleSettings CassandraTableAutoscaleSettingsArgs
    CassandraKeyspaceId string
    The ID of the Cosmos DB Cassandra Keyspace to create the table within. Changing this forces a new resource to be created.
    DefaultTtl int
    Time to live of the Cosmos DB Cassandra table. Possible values are at least -1. -1 means the Cassandra table never expires.
    Name string
    Specifies the name of the Cosmos DB Cassandra Table. Changing this forces a new resource to be created.
    Schema CassandraTableSchemaArgs
    A schema block as defined below.
    Throughput int
    analyticalStorageTtl Integer

    Time to live of the Analytical Storage. Possible values are between -1 and 2147483647 except 0. -1 means the Analytical Storage never expires. Changing this forces a new resource to be created.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support

    autoscaleSettings CassandraTableAutoscaleSettings
    cassandraKeyspaceId String
    The ID of the Cosmos DB Cassandra Keyspace to create the table within. Changing this forces a new resource to be created.
    defaultTtl Integer
    Time to live of the Cosmos DB Cassandra table. Possible values are at least -1. -1 means the Cassandra table never expires.
    name String
    Specifies the name of the Cosmos DB Cassandra Table. Changing this forces a new resource to be created.
    schema CassandraTableSchema
    A schema block as defined below.
    throughput Integer
    analyticalStorageTtl number

    Time to live of the Analytical Storage. Possible values are between -1 and 2147483647 except 0. -1 means the Analytical Storage never expires. Changing this forces a new resource to be created.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support

    autoscaleSettings CassandraTableAutoscaleSettings
    cassandraKeyspaceId string
    The ID of the Cosmos DB Cassandra Keyspace to create the table within. Changing this forces a new resource to be created.
    defaultTtl number
    Time to live of the Cosmos DB Cassandra table. Possible values are at least -1. -1 means the Cassandra table never expires.
    name string
    Specifies the name of the Cosmos DB Cassandra Table. Changing this forces a new resource to be created.
    schema CassandraTableSchema
    A schema block as defined below.
    throughput number
    analytical_storage_ttl int

    Time to live of the Analytical Storage. Possible values are between -1 and 2147483647 except 0. -1 means the Analytical Storage never expires. Changing this forces a new resource to be created.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support

    autoscale_settings CassandraTableAutoscaleSettingsArgs
    cassandra_keyspace_id str
    The ID of the Cosmos DB Cassandra Keyspace to create the table within. Changing this forces a new resource to be created.
    default_ttl int
    Time to live of the Cosmos DB Cassandra table. Possible values are at least -1. -1 means the Cassandra table never expires.
    name str
    Specifies the name of the Cosmos DB Cassandra Table. Changing this forces a new resource to be created.
    schema CassandraTableSchemaArgs
    A schema block as defined below.
    throughput int
    analyticalStorageTtl Number

    Time to live of the Analytical Storage. Possible values are between -1 and 2147483647 except 0. -1 means the Analytical Storage never expires. Changing this forces a new resource to be created.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support

    autoscaleSettings Property Map
    cassandraKeyspaceId String
    The ID of the Cosmos DB Cassandra Keyspace to create the table within. Changing this forces a new resource to be created.
    defaultTtl Number
    Time to live of the Cosmos DB Cassandra table. Possible values are at least -1. -1 means the Cassandra table never expires.
    name String
    Specifies the name of the Cosmos DB Cassandra Table. Changing this forces a new resource to be created.
    schema Property Map
    A schema block as defined below.
    throughput Number

    Supporting Types

    CassandraTableAutoscaleSettings, CassandraTableAutoscaleSettingsArgs

    MaxThroughput int
    The maximum throughput of the Cassandra Table (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 Table (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 Table (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 Table (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 Table (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 Table (RU/s). Must be between 1,000 and 1,000,000. Must be set in increments of 1,000. Conflicts with throughput.

    CassandraTableSchema, CassandraTableSchemaArgs

    Columns List<CassandraTableSchemaColumn>
    One or more column blocks as defined below.
    PartitionKeys List<CassandraTableSchemaPartitionKey>
    One or more partition_key blocks as defined below.
    ClusterKeys List<CassandraTableSchemaClusterKey>
    One or more cluster_key blocks as defined below.
    Columns []CassandraTableSchemaColumn
    One or more column blocks as defined below.
    PartitionKeys []CassandraTableSchemaPartitionKey
    One or more partition_key blocks as defined below.
    ClusterKeys []CassandraTableSchemaClusterKey
    One or more cluster_key blocks as defined below.
    columns List<CassandraTableSchemaColumn>
    One or more column blocks as defined below.
    partitionKeys List<CassandraTableSchemaPartitionKey>
    One or more partition_key blocks as defined below.
    clusterKeys List<CassandraTableSchemaClusterKey>
    One or more cluster_key blocks as defined below.
    columns CassandraTableSchemaColumn[]
    One or more column blocks as defined below.
    partitionKeys CassandraTableSchemaPartitionKey[]
    One or more partition_key blocks as defined below.
    clusterKeys CassandraTableSchemaClusterKey[]
    One or more cluster_key blocks as defined below.
    columns Sequence[CassandraTableSchemaColumn]
    One or more column blocks as defined below.
    partition_keys Sequence[CassandraTableSchemaPartitionKey]
    One or more partition_key blocks as defined below.
    cluster_keys Sequence[CassandraTableSchemaClusterKey]
    One or more cluster_key blocks as defined below.
    columns List<Property Map>
    One or more column blocks as defined below.
    partitionKeys List<Property Map>
    One or more partition_key blocks as defined below.
    clusterKeys List<Property Map>
    One or more cluster_key blocks as defined below.

    CassandraTableSchemaClusterKey, CassandraTableSchemaClusterKeyArgs

    Name string
    Name of the cluster key to be created.
    OrderBy string
    Order of the key. Currently supported values are Asc and Desc.
    Name string
    Name of the cluster key to be created.
    OrderBy string
    Order of the key. Currently supported values are Asc and Desc.
    name String
    Name of the cluster key to be created.
    orderBy String
    Order of the key. Currently supported values are Asc and Desc.
    name string
    Name of the cluster key to be created.
    orderBy string
    Order of the key. Currently supported values are Asc and Desc.
    name str
    Name of the cluster key to be created.
    order_by str
    Order of the key. Currently supported values are Asc and Desc.
    name String
    Name of the cluster key to be created.
    orderBy String
    Order of the key. Currently supported values are Asc and Desc.

    CassandraTableSchemaColumn, CassandraTableSchemaColumnArgs

    Name string
    Name of the column to be created.
    Type string
    Type of the column to be created.
    Name string
    Name of the column to be created.
    Type string
    Type of the column to be created.
    name String
    Name of the column to be created.
    type String
    Type of the column to be created.
    name string
    Name of the column to be created.
    type string
    Type of the column to be created.
    name str
    Name of the column to be created.
    type str
    Type of the column to be created.
    name String
    Name of the column to be created.
    type String
    Type of the column to be created.

    CassandraTableSchemaPartitionKey, CassandraTableSchemaPartitionKeyArgs

    Name string
    Name of the column to partition by.
    Name string
    Name of the column to partition by.
    name String
    Name of the column to partition by.
    name string
    Name of the column to partition by.
    name str
    Name of the column to partition by.
    name String
    Name of the column to partition by.

    Import

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

    $ pulumi import azure:cosmosdb/cassandraTable:CassandraTable ks1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/account1/cassandraKeyspaces/ks1/tables/table1

    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.
    azure logo

    We recommend using Azure Native.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure