Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. documentdb
  5. CassandraCluster
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.documentdb.CassandraCluster

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Representation of a managed Cassandra cluster. Azure REST API version: 2023-04-15. Prior API version in Azure Native 1.x: 2021-03-01-preview.

Other available API versions: 2021-07-01-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, 2024-11-15, 2024-12-01-preview.

Example Usage

CosmosDBManagedCassandraClusterCreate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var cassandraCluster = new AzureNative.DocumentDB.CassandraCluster("cassandraCluster", new()
    {
        ClusterName = "cassandra-prod",
        Location = "West US",
        Properties = new AzureNative.DocumentDB.Inputs.ClusterResourcePropertiesArgs
        {
            AuthenticationMethod = AzureNative.DocumentDB.AuthenticationMethod.Cassandra,
            CassandraVersion = "3.11",
            ClientCertificates = new[]
            {
                new AzureNative.DocumentDB.Inputs.CertificateArgs
                {
                    Pem = @"-----BEGIN CERTIFICATE-----
...Base64 encoded certificate...
-----END CERTIFICATE-----",
                },
            },
            ClusterNameOverride = "ClusterNameIllegalForAzureResource",
            DelegatedManagementSubnetId = "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management",
            ExternalGossipCertificates = new[]
            {
                new AzureNative.DocumentDB.Inputs.CertificateArgs
                {
                    Pem = @"-----BEGIN CERTIFICATE-----
...Base64 encoded certificate...
-----END CERTIFICATE-----",
                },
            },
            ExternalSeedNodes = new[]
            {
                new AzureNative.DocumentDB.Inputs.SeedNodeArgs
                {
                    IpAddress = "10.52.221.2",
                },
                new AzureNative.DocumentDB.Inputs.SeedNodeArgs
                {
                    IpAddress = "10.52.221.3",
                },
                new AzureNative.DocumentDB.Inputs.SeedNodeArgs
                {
                    IpAddress = "10.52.221.4",
                },
            },
            HoursBetweenBackups = 24,
            InitialCassandraAdminPassword = "mypassword",
        },
        ResourceGroupName = "cassandra-prod-rg",
        Tags = null,
    });

});
Copy
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.NewCassandraCluster(ctx, "cassandraCluster", &documentdb.CassandraClusterArgs{
			ClusterName: pulumi.String("cassandra-prod"),
			Location:    pulumi.String("West US"),
			Properties: &documentdb.ClusterResourcePropertiesArgs{
				AuthenticationMethod: pulumi.String(documentdb.AuthenticationMethodCassandra),
				CassandraVersion:     pulumi.String("3.11"),
				ClientCertificates: documentdb.CertificateArray{
					&documentdb.CertificateArgs{
						Pem: pulumi.String("-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----"),
					},
				},
				ClusterNameOverride:         pulumi.String("ClusterNameIllegalForAzureResource"),
				DelegatedManagementSubnetId: pulumi.String("/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management"),
				ExternalGossipCertificates: documentdb.CertificateArray{
					&documentdb.CertificateArgs{
						Pem: pulumi.String("-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----"),
					},
				},
				ExternalSeedNodes: documentdb.SeedNodeArray{
					&documentdb.SeedNodeArgs{
						IpAddress: pulumi.String("10.52.221.2"),
					},
					&documentdb.SeedNodeArgs{
						IpAddress: pulumi.String("10.52.221.3"),
					},
					&documentdb.SeedNodeArgs{
						IpAddress: pulumi.String("10.52.221.4"),
					},
				},
				HoursBetweenBackups:           pulumi.Int(24),
				InitialCassandraAdminPassword: pulumi.String("mypassword"),
			},
			ResourceGroupName: pulumi.String("cassandra-prod-rg"),
			Tags:              pulumi.StringMap{},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.documentdb.CassandraCluster;
import com.pulumi.azurenative.documentdb.CassandraClusterArgs;
import com.pulumi.azurenative.documentdb.inputs.ClusterResourcePropertiesArgs;
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 cassandraCluster = new CassandraCluster("cassandraCluster", CassandraClusterArgs.builder()
            .clusterName("cassandra-prod")
            .location("West US")
            .properties(ClusterResourcePropertiesArgs.builder()
                .authenticationMethod("Cassandra")
                .cassandraVersion("3.11")
                .clientCertificates(CertificateArgs.builder()
                    .pem("""
-----BEGIN CERTIFICATE-----
...Base64 encoded certificate...
-----END CERTIFICATE-----                    """)
                    .build())
                .clusterNameOverride("ClusterNameIllegalForAzureResource")
                .delegatedManagementSubnetId("/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management")
                .externalGossipCertificates(CertificateArgs.builder()
                    .pem("""
-----BEGIN CERTIFICATE-----
...Base64 encoded certificate...
-----END CERTIFICATE-----                    """)
                    .build())
                .externalSeedNodes(                
                    SeedNodeArgs.builder()
                        .ipAddress("10.52.221.2")
                        .build(),
                    SeedNodeArgs.builder()
                        .ipAddress("10.52.221.3")
                        .build(),
                    SeedNodeArgs.builder()
                        .ipAddress("10.52.221.4")
                        .build())
                .hoursBetweenBackups(24)
                .initialCassandraAdminPassword("mypassword")
                .build())
            .resourceGroupName("cassandra-prod-rg")
            .tags()
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const cassandraCluster = new azure_native.documentdb.CassandraCluster("cassandraCluster", {
    clusterName: "cassandra-prod",
    location: "West US",
    properties: {
        authenticationMethod: azure_native.documentdb.AuthenticationMethod.Cassandra,
        cassandraVersion: "3.11",
        clientCertificates: [{
            pem: `-----BEGIN CERTIFICATE-----
...Base64 encoded certificate...
-----END CERTIFICATE-----`,
        }],
        clusterNameOverride: "ClusterNameIllegalForAzureResource",
        delegatedManagementSubnetId: "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management",
        externalGossipCertificates: [{
            pem: `-----BEGIN CERTIFICATE-----
...Base64 encoded certificate...
-----END CERTIFICATE-----`,
        }],
        externalSeedNodes: [
            {
                ipAddress: "10.52.221.2",
            },
            {
                ipAddress: "10.52.221.3",
            },
            {
                ipAddress: "10.52.221.4",
            },
        ],
        hoursBetweenBackups: 24,
        initialCassandraAdminPassword: "mypassword",
    },
    resourceGroupName: "cassandra-prod-rg",
    tags: {},
});
Copy
import pulumi
import pulumi_azure_native as azure_native

cassandra_cluster = azure_native.documentdb.CassandraCluster("cassandraCluster",
    cluster_name="cassandra-prod",
    location="West US",
    properties={
        "authentication_method": azure_native.documentdb.AuthenticationMethod.CASSANDRA,
        "cassandra_version": "3.11",
        "client_certificates": [{
            "pem": """-----BEGIN CERTIFICATE-----
...Base64 encoded certificate...
-----END CERTIFICATE-----""",
        }],
        "cluster_name_override": "ClusterNameIllegalForAzureResource",
        "delegated_management_subnet_id": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management",
        "external_gossip_certificates": [{
            "pem": """-----BEGIN CERTIFICATE-----
...Base64 encoded certificate...
-----END CERTIFICATE-----""",
        }],
        "external_seed_nodes": [
            {
                "ip_address": "10.52.221.2",
            },
            {
                "ip_address": "10.52.221.3",
            },
            {
                "ip_address": "10.52.221.4",
            },
        ],
        "hours_between_backups": 24,
        "initial_cassandra_admin_password": "mypassword",
    },
    resource_group_name="cassandra-prod-rg",
    tags={})
Copy
resources:
  cassandraCluster:
    type: azure-native:documentdb:CassandraCluster
    properties:
      clusterName: cassandra-prod
      location: West US
      properties:
        authenticationMethod: Cassandra
        cassandraVersion: '3.11'
        clientCertificates:
          - pem: |-
              -----BEGIN CERTIFICATE-----
              ...Base64 encoded certificate...
              -----END CERTIFICATE-----              
        clusterNameOverride: ClusterNameIllegalForAzureResource
        delegatedManagementSubnetId: /subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management
        externalGossipCertificates:
          - pem: |-
              -----BEGIN CERTIFICATE-----
              ...Base64 encoded certificate...
              -----END CERTIFICATE-----              
        externalSeedNodes:
          - ipAddress: 10.52.221.2
          - ipAddress: 10.52.221.3
          - ipAddress: 10.52.221.4
        hoursBetweenBackups: 24
        initialCassandraAdminPassword: mypassword
      resourceGroupName: cassandra-prod-rg
      tags: {}
Copy

Create CassandraCluster Resource

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

Constructor syntax

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

@overload
def CassandraCluster(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     resource_group_name: Optional[str] = None,
                     cluster_name: Optional[str] = None,
                     identity: Optional[ManagedCassandraManagedServiceIdentityArgs] = None,
                     location: Optional[str] = None,
                     properties: Optional[ClusterResourcePropertiesArgs] = None,
                     tags: Optional[Mapping[str, str]] = None)
func NewCassandraCluster(ctx *Context, name string, args CassandraClusterArgs, opts ...ResourceOption) (*CassandraCluster, error)
public CassandraCluster(string name, CassandraClusterArgs args, CustomResourceOptions? opts = null)
public CassandraCluster(String name, CassandraClusterArgs args)
public CassandraCluster(String name, CassandraClusterArgs args, CustomResourceOptions options)

type: azure-native:documentdb:CassandraCluster
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. CassandraClusterArgs
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. CassandraClusterArgs
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. CassandraClusterArgs
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. CassandraClusterArgs
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. CassandraClusterArgs
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 cassandraClusterResource = new AzureNative.Documentdb.CassandraCluster("cassandraClusterResource", new()
{
    ResourceGroupName = "string",
    ClusterName = "string",
    Identity = 
    {
        { "type", "string" },
    },
    Location = "string",
    Properties = 
    {
        { "authenticationMethod", "string" },
        { "cassandraAuditLoggingEnabled", false },
        { "cassandraVersion", "string" },
        { "clientCertificates", new[]
        {
            
            {
                { "pem", "string" },
            },
        } },
        { "clusterNameOverride", "string" },
        { "deallocated", false },
        { "delegatedManagementSubnetId", "string" },
        { "externalGossipCertificates", new[]
        {
            
            {
                { "pem", "string" },
            },
        } },
        { "externalSeedNodes", new[]
        {
            
            {
                { "ipAddress", "string" },
            },
        } },
        { "hoursBetweenBackups", 0 },
        { "initialCassandraAdminPassword", "string" },
        { "prometheusEndpoint", 
        {
            { "ipAddress", "string" },
        } },
        { "provisionError", 
        {
            { "additionalErrorInfo", "string" },
            { "code", "string" },
            { "message", "string" },
            { "target", "string" },
        } },
        { "provisioningState", "string" },
        { "repairEnabled", false },
        { "restoreFromBackupId", "string" },
    },
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := documentdb.NewCassandraCluster(ctx, "cassandraClusterResource", &documentdb.CassandraClusterArgs{
	ResourceGroupName: "string",
	ClusterName:       "string",
	Identity: map[string]interface{}{
		"type": "string",
	},
	Location: "string",
	Properties: map[string]interface{}{
		"authenticationMethod":         "string",
		"cassandraAuditLoggingEnabled": false,
		"cassandraVersion":             "string",
		"clientCertificates": []map[string]interface{}{
			map[string]interface{}{
				"pem": "string",
			},
		},
		"clusterNameOverride":         "string",
		"deallocated":                 false,
		"delegatedManagementSubnetId": "string",
		"externalGossipCertificates": []map[string]interface{}{
			map[string]interface{}{
				"pem": "string",
			},
		},
		"externalSeedNodes": []map[string]interface{}{
			map[string]interface{}{
				"ipAddress": "string",
			},
		},
		"hoursBetweenBackups":           0,
		"initialCassandraAdminPassword": "string",
		"prometheusEndpoint": map[string]interface{}{
			"ipAddress": "string",
		},
		"provisionError": map[string]interface{}{
			"additionalErrorInfo": "string",
			"code":                "string",
			"message":             "string",
			"target":              "string",
		},
		"provisioningState":   "string",
		"repairEnabled":       false,
		"restoreFromBackupId": "string",
	},
	Tags: map[string]interface{}{
		"string": "string",
	},
})
Copy
var cassandraClusterResource = new CassandraCluster("cassandraClusterResource", CassandraClusterArgs.builder()
    .resourceGroupName("string")
    .clusterName("string")
    .identity(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .location("string")
    .properties(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .build());
Copy
cassandra_cluster_resource = azure_native.documentdb.CassandraCluster("cassandraClusterResource",
    resource_group_name=string,
    cluster_name=string,
    identity={
        type: string,
    },
    location=string,
    properties={
        authenticationMethod: string,
        cassandraAuditLoggingEnabled: False,
        cassandraVersion: string,
        clientCertificates: [{
            pem: string,
        }],
        clusterNameOverride: string,
        deallocated: False,
        delegatedManagementSubnetId: string,
        externalGossipCertificates: [{
            pem: string,
        }],
        externalSeedNodes: [{
            ipAddress: string,
        }],
        hoursBetweenBackups: 0,
        initialCassandraAdminPassword: string,
        prometheusEndpoint: {
            ipAddress: string,
        },
        provisionError: {
            additionalErrorInfo: string,
            code: string,
            message: string,
            target: string,
        },
        provisioningState: string,
        repairEnabled: False,
        restoreFromBackupId: string,
    },
    tags={
        string: string,
    })
Copy
const cassandraClusterResource = new azure_native.documentdb.CassandraCluster("cassandraClusterResource", {
    resourceGroupName: "string",
    clusterName: "string",
    identity: {
        type: "string",
    },
    location: "string",
    properties: {
        authenticationMethod: "string",
        cassandraAuditLoggingEnabled: false,
        cassandraVersion: "string",
        clientCertificates: [{
            pem: "string",
        }],
        clusterNameOverride: "string",
        deallocated: false,
        delegatedManagementSubnetId: "string",
        externalGossipCertificates: [{
            pem: "string",
        }],
        externalSeedNodes: [{
            ipAddress: "string",
        }],
        hoursBetweenBackups: 0,
        initialCassandraAdminPassword: "string",
        prometheusEndpoint: {
            ipAddress: "string",
        },
        provisionError: {
            additionalErrorInfo: "string",
            code: "string",
            message: "string",
            target: "string",
        },
        provisioningState: "string",
        repairEnabled: false,
        restoreFromBackupId: "string",
    },
    tags: {
        string: "string",
    },
});
Copy
type: azure-native:documentdb:CassandraCluster
properties:
    clusterName: string
    identity:
        type: string
    location: string
    properties:
        authenticationMethod: string
        cassandraAuditLoggingEnabled: false
        cassandraVersion: string
        clientCertificates:
            - pem: string
        clusterNameOverride: string
        deallocated: false
        delegatedManagementSubnetId: string
        externalGossipCertificates:
            - pem: string
        externalSeedNodes:
            - ipAddress: string
        hoursBetweenBackups: 0
        initialCassandraAdminPassword: string
        prometheusEndpoint:
            ipAddress: string
        provisionError:
            additionalErrorInfo: string
            code: string
            message: string
            target: string
        provisioningState: string
        repairEnabled: false
        restoreFromBackupId: string
    resourceGroupName: string
    tags:
        string: string
Copy

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

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ClusterName Changes to this property will trigger replacement. string
Managed Cassandra cluster name.
Identity Pulumi.AzureNative.DocumentDB.Inputs.ManagedCassandraManagedServiceIdentity
Identity for the resource.
Location string
The location of the resource group to which the resource belongs.
Properties Pulumi.AzureNative.DocumentDB.Inputs.ClusterResourceProperties
Properties of a managed Cassandra cluster.
Tags 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".
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ClusterName Changes to this property will trigger replacement. string
Managed Cassandra cluster name.
Identity ManagedCassandraManagedServiceIdentityArgs
Identity for the resource.
Location string
The location of the resource group to which the resource belongs.
Properties ClusterResourcePropertiesArgs
Properties of a managed Cassandra cluster.
Tags 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".
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
clusterName Changes to this property will trigger replacement. String
Managed Cassandra cluster name.
identity ManagedCassandraManagedServiceIdentity
Identity for the resource.
location String
The location of the resource group to which the resource belongs.
properties ClusterResourceProperties
Properties of a managed Cassandra cluster.
tags 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".
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
clusterName Changes to this property will trigger replacement. string
Managed Cassandra cluster name.
identity ManagedCassandraManagedServiceIdentity
Identity for the resource.
location string
The location of the resource group to which the resource belongs.
properties ClusterResourceProperties
Properties of a managed Cassandra cluster.
tags {[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".
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
cluster_name Changes to this property will trigger replacement. str
Managed Cassandra cluster name.
identity ManagedCassandraManagedServiceIdentityArgs
Identity for the resource.
location str
The location of the resource group to which the resource belongs.
properties ClusterResourcePropertiesArgs
Properties of a managed Cassandra cluster.
tags 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".
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
clusterName Changes to this property will trigger replacement. String
Managed Cassandra cluster name.
identity Property Map
Identity for the resource.
location String
The location of the resource group to which the resource belongs.
properties Property Map
Properties of a managed Cassandra cluster.
tags 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 CassandraCluster resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the ARM resource.
Type string
The type of Azure resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the ARM resource.
Type string
The type of Azure resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the ARM resource.
type String
The type of Azure resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the ARM resource.
type string
The type of Azure resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the ARM resource.
type str
The type of Azure resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the ARM resource.
type String
The type of Azure resource.

Supporting Types

AuthenticationMethod
, AuthenticationMethodArgs

None
None
Cassandra
Cassandra
Ldap
Ldap
AuthenticationMethodNone
None
AuthenticationMethodCassandra
Cassandra
AuthenticationMethodLdap
Ldap
None
None
Cassandra
Cassandra
Ldap
Ldap
None
None
Cassandra
Cassandra
Ldap
Ldap
NONE
None
CASSANDRA
Cassandra
LDAP
Ldap
"None"
None
"Cassandra"
Cassandra
"Ldap"
Ldap

CassandraError
, CassandraErrorArgs

AdditionalErrorInfo string
Additional information about the error.
Code string
The code of error that occurred.
Message string
The message of the error.
Target string
The target resource of the error.
AdditionalErrorInfo string
Additional information about the error.
Code string
The code of error that occurred.
Message string
The message of the error.
Target string
The target resource of the error.
additionalErrorInfo String
Additional information about the error.
code String
The code of error that occurred.
message String
The message of the error.
target String
The target resource of the error.
additionalErrorInfo string
Additional information about the error.
code string
The code of error that occurred.
message string
The message of the error.
target string
The target resource of the error.
additional_error_info str
Additional information about the error.
code str
The code of error that occurred.
message str
The message of the error.
target str
The target resource of the error.
additionalErrorInfo String
Additional information about the error.
code String
The code of error that occurred.
message String
The message of the error.
target String
The target resource of the error.

CassandraErrorResponse
, CassandraErrorResponseArgs

AdditionalErrorInfo string
Additional information about the error.
Code string
The code of error that occurred.
Message string
The message of the error.
Target string
The target resource of the error.
AdditionalErrorInfo string
Additional information about the error.
Code string
The code of error that occurred.
Message string
The message of the error.
Target string
The target resource of the error.
additionalErrorInfo String
Additional information about the error.
code String
The code of error that occurred.
message String
The message of the error.
target String
The target resource of the error.
additionalErrorInfo string
Additional information about the error.
code string
The code of error that occurred.
message string
The message of the error.
target string
The target resource of the error.
additional_error_info str
Additional information about the error.
code str
The code of error that occurred.
message str
The message of the error.
target str
The target resource of the error.
additionalErrorInfo String
Additional information about the error.
code String
The code of error that occurred.
message String
The message of the error.
target String
The target resource of the error.

Certificate
, CertificateArgs

Pem string
PEM formatted public key.
Pem string
PEM formatted public key.
pem String
PEM formatted public key.
pem string
PEM formatted public key.
pem str
PEM formatted public key.
pem String
PEM formatted public key.

CertificateResponse
, CertificateResponseArgs

Pem string
PEM formatted public key.
Pem string
PEM formatted public key.
pem String
PEM formatted public key.
pem string
PEM formatted public key.
pem str
PEM formatted public key.
pem String
PEM formatted public key.

ClusterResourceProperties
, ClusterResourcePropertiesArgs

AuthenticationMethod string | Pulumi.AzureNative.DocumentDB.AuthenticationMethod
Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'.
CassandraAuditLoggingEnabled bool
Whether Cassandra audit logging is enabled
CassandraVersion string
Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version.
ClientCertificates List<Pulumi.AzureNative.DocumentDB.Inputs.Certificate>
List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property.
ClusterNameOverride string
If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property.
Deallocated bool
Whether the cluster and associated data centers has been deallocated.
DelegatedManagementSubnetId string
Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'
ExternalGossipCertificates List<Pulumi.AzureNative.DocumentDB.Inputs.Certificate>
List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property.
ExternalSeedNodes List<Pulumi.AzureNative.DocumentDB.Inputs.SeedNode>
List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes.
HoursBetweenBackups int
(Deprecated) Number of hours to wait between taking a backup of the cluster.
InitialCassandraAdminPassword string
Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is 'Cassandra'.
PrometheusEndpoint Pulumi.AzureNative.DocumentDB.Inputs.SeedNode
Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached.
ProvisionError Pulumi.AzureNative.DocumentDB.Inputs.CassandraError
Error related to resource provisioning.
ProvisioningState string | Pulumi.AzureNative.DocumentDB.ManagedCassandraProvisioningState
The status of the resource at the time the operation was called.
RepairEnabled bool
Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs.
RestoreFromBackupId string
To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup.
AuthenticationMethod string | AuthenticationMethod
Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'.
CassandraAuditLoggingEnabled bool
Whether Cassandra audit logging is enabled
CassandraVersion string
Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version.
ClientCertificates []Certificate
List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property.
ClusterNameOverride string
If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property.
Deallocated bool
Whether the cluster and associated data centers has been deallocated.
DelegatedManagementSubnetId string
Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'
ExternalGossipCertificates []Certificate
List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property.
ExternalSeedNodes []SeedNode
List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes.
HoursBetweenBackups int
(Deprecated) Number of hours to wait between taking a backup of the cluster.
InitialCassandraAdminPassword string
Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is 'Cassandra'.
PrometheusEndpoint SeedNode
Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached.
ProvisionError CassandraError
Error related to resource provisioning.
ProvisioningState string | ManagedCassandraProvisioningState
The status of the resource at the time the operation was called.
RepairEnabled bool
Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs.
RestoreFromBackupId string
To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup.
authenticationMethod String | AuthenticationMethod
Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'.
cassandraAuditLoggingEnabled Boolean
Whether Cassandra audit logging is enabled
cassandraVersion String
Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version.
clientCertificates List<Certificate>
List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property.
clusterNameOverride String
If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property.
deallocated Boolean
Whether the cluster and associated data centers has been deallocated.
delegatedManagementSubnetId String
Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'
externalGossipCertificates List<Certificate>
List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property.
externalSeedNodes List<SeedNode>
List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes.
hoursBetweenBackups Integer
(Deprecated) Number of hours to wait between taking a backup of the cluster.
initialCassandraAdminPassword String
Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is 'Cassandra'.
prometheusEndpoint SeedNode
Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached.
provisionError CassandraError
Error related to resource provisioning.
provisioningState String | ManagedCassandraProvisioningState
The status of the resource at the time the operation was called.
repairEnabled Boolean
Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs.
restoreFromBackupId String
To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup.
authenticationMethod string | AuthenticationMethod
Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'.
cassandraAuditLoggingEnabled boolean
Whether Cassandra audit logging is enabled
cassandraVersion string
Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version.
clientCertificates Certificate[]
List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property.
clusterNameOverride string
If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property.
deallocated boolean
Whether the cluster and associated data centers has been deallocated.
delegatedManagementSubnetId string
Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'
externalGossipCertificates Certificate[]
List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property.
externalSeedNodes SeedNode[]
List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes.
hoursBetweenBackups number
(Deprecated) Number of hours to wait between taking a backup of the cluster.
initialCassandraAdminPassword string
Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is 'Cassandra'.
prometheusEndpoint SeedNode
Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached.
provisionError CassandraError
Error related to resource provisioning.
provisioningState string | ManagedCassandraProvisioningState
The status of the resource at the time the operation was called.
repairEnabled boolean
Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs.
restoreFromBackupId string
To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup.
authentication_method str | AuthenticationMethod
Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'.
cassandra_audit_logging_enabled bool
Whether Cassandra audit logging is enabled
cassandra_version str
Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version.
client_certificates Sequence[Certificate]
List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property.
cluster_name_override str
If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property.
deallocated bool
Whether the cluster and associated data centers has been deallocated.
delegated_management_subnet_id str
Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'
external_gossip_certificates Sequence[Certificate]
List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property.
external_seed_nodes Sequence[SeedNode]
List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes.
hours_between_backups int
(Deprecated) Number of hours to wait between taking a backup of the cluster.
initial_cassandra_admin_password str
Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is 'Cassandra'.
prometheus_endpoint SeedNode
Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached.
provision_error CassandraError
Error related to resource provisioning.
provisioning_state str | ManagedCassandraProvisioningState
The status of the resource at the time the operation was called.
repair_enabled bool
Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs.
restore_from_backup_id str
To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup.
authenticationMethod String | "None" | "Cassandra" | "Ldap"
Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'.
cassandraAuditLoggingEnabled Boolean
Whether Cassandra audit logging is enabled
cassandraVersion String
Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version.
clientCertificates List<Property Map>
List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property.
clusterNameOverride String
If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property.
deallocated Boolean
Whether the cluster and associated data centers has been deallocated.
delegatedManagementSubnetId String
Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'
externalGossipCertificates List<Property Map>
List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property.
externalSeedNodes List<Property Map>
List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes.
hoursBetweenBackups Number
(Deprecated) Number of hours to wait between taking a backup of the cluster.
initialCassandraAdminPassword String
Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is 'Cassandra'.
prometheusEndpoint Property Map
Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached.
provisionError Property Map
Error related to resource provisioning.
provisioningState String | "Creating" | "Updating" | "Deleting" | "Succeeded" | "Failed" | "Canceled"
The status of the resource at the time the operation was called.
repairEnabled Boolean
Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs.
restoreFromBackupId String
To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup.

ClusterResourceResponseProperties
, ClusterResourceResponsePropertiesArgs

GossipCertificates This property is required. List<Pulumi.AzureNative.DocumentDB.Inputs.CertificateResponse>
List of TLS certificates that unmanaged nodes must trust for gossip with managed nodes. All managed nodes will present TLS client certificates that are verifiable using one of the certificates provided in this property.
SeedNodes This property is required. List<Pulumi.AzureNative.DocumentDB.Inputs.SeedNodeResponse>
List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes.
AuthenticationMethod string
Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'.
CassandraAuditLoggingEnabled bool
Whether Cassandra audit logging is enabled
CassandraVersion string
Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version.
ClientCertificates List<Pulumi.AzureNative.DocumentDB.Inputs.CertificateResponse>
List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property.
ClusterNameOverride string
If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property.
Deallocated bool
Whether the cluster and associated data centers has been deallocated.
DelegatedManagementSubnetId string
Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'
ExternalGossipCertificates List<Pulumi.AzureNative.DocumentDB.Inputs.CertificateResponse>
List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property.
ExternalSeedNodes List<Pulumi.AzureNative.DocumentDB.Inputs.SeedNodeResponse>
List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes.
HoursBetweenBackups int
(Deprecated) Number of hours to wait between taking a backup of the cluster.
PrometheusEndpoint Pulumi.AzureNative.DocumentDB.Inputs.SeedNodeResponse
Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached.
ProvisionError Pulumi.AzureNative.DocumentDB.Inputs.CassandraErrorResponse
Error related to resource provisioning.
ProvisioningState string
The status of the resource at the time the operation was called.
RepairEnabled bool
Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs.
GossipCertificates This property is required. []CertificateResponse
List of TLS certificates that unmanaged nodes must trust for gossip with managed nodes. All managed nodes will present TLS client certificates that are verifiable using one of the certificates provided in this property.
SeedNodes This property is required. []SeedNodeResponse
List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes.
AuthenticationMethod string
Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'.
CassandraAuditLoggingEnabled bool
Whether Cassandra audit logging is enabled
CassandraVersion string
Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version.
ClientCertificates []CertificateResponse
List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property.
ClusterNameOverride string
If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property.
Deallocated bool
Whether the cluster and associated data centers has been deallocated.
DelegatedManagementSubnetId string
Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'
ExternalGossipCertificates []CertificateResponse
List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property.
ExternalSeedNodes []SeedNodeResponse
List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes.
HoursBetweenBackups int
(Deprecated) Number of hours to wait between taking a backup of the cluster.
PrometheusEndpoint SeedNodeResponse
Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached.
ProvisionError CassandraErrorResponse
Error related to resource provisioning.
ProvisioningState string
The status of the resource at the time the operation was called.
RepairEnabled bool
Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs.
gossipCertificates This property is required. List<CertificateResponse>
List of TLS certificates that unmanaged nodes must trust for gossip with managed nodes. All managed nodes will present TLS client certificates that are verifiable using one of the certificates provided in this property.
seedNodes This property is required. List<SeedNodeResponse>
List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes.
authenticationMethod String
Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'.
cassandraAuditLoggingEnabled Boolean
Whether Cassandra audit logging is enabled
cassandraVersion String
Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version.
clientCertificates List<CertificateResponse>
List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property.
clusterNameOverride String
If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property.
deallocated Boolean
Whether the cluster and associated data centers has been deallocated.
delegatedManagementSubnetId String
Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'
externalGossipCertificates List<CertificateResponse>
List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property.
externalSeedNodes List<SeedNodeResponse>
List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes.
hoursBetweenBackups Integer
(Deprecated) Number of hours to wait between taking a backup of the cluster.
prometheusEndpoint SeedNodeResponse
Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached.
provisionError CassandraErrorResponse
Error related to resource provisioning.
provisioningState String
The status of the resource at the time the operation was called.
repairEnabled Boolean
Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs.
gossipCertificates This property is required. CertificateResponse[]
List of TLS certificates that unmanaged nodes must trust for gossip with managed nodes. All managed nodes will present TLS client certificates that are verifiable using one of the certificates provided in this property.
seedNodes This property is required. SeedNodeResponse[]
List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes.
authenticationMethod string
Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'.
cassandraAuditLoggingEnabled boolean
Whether Cassandra audit logging is enabled
cassandraVersion string
Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version.
clientCertificates CertificateResponse[]
List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property.
clusterNameOverride string
If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property.
deallocated boolean
Whether the cluster and associated data centers has been deallocated.
delegatedManagementSubnetId string
Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'
externalGossipCertificates CertificateResponse[]
List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property.
externalSeedNodes SeedNodeResponse[]
List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes.
hoursBetweenBackups number
(Deprecated) Number of hours to wait between taking a backup of the cluster.
prometheusEndpoint SeedNodeResponse
Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached.
provisionError CassandraErrorResponse
Error related to resource provisioning.
provisioningState string
The status of the resource at the time the operation was called.
repairEnabled boolean
Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs.
gossip_certificates This property is required. Sequence[CertificateResponse]
List of TLS certificates that unmanaged nodes must trust for gossip with managed nodes. All managed nodes will present TLS client certificates that are verifiable using one of the certificates provided in this property.
seed_nodes This property is required. Sequence[SeedNodeResponse]
List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes.
authentication_method str
Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'.
cassandra_audit_logging_enabled bool
Whether Cassandra audit logging is enabled
cassandra_version str
Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version.
client_certificates Sequence[CertificateResponse]
List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property.
cluster_name_override str
If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property.
deallocated bool
Whether the cluster and associated data centers has been deallocated.
delegated_management_subnet_id str
Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'
external_gossip_certificates Sequence[CertificateResponse]
List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property.
external_seed_nodes Sequence[SeedNodeResponse]
List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes.
hours_between_backups int
(Deprecated) Number of hours to wait between taking a backup of the cluster.
prometheus_endpoint SeedNodeResponse
Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached.
provision_error CassandraErrorResponse
Error related to resource provisioning.
provisioning_state str
The status of the resource at the time the operation was called.
repair_enabled bool
Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs.
gossipCertificates This property is required. List<Property Map>
List of TLS certificates that unmanaged nodes must trust for gossip with managed nodes. All managed nodes will present TLS client certificates that are verifiable using one of the certificates provided in this property.
seedNodes This property is required. List<Property Map>
List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes.
authenticationMethod String
Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'.
cassandraAuditLoggingEnabled Boolean
Whether Cassandra audit logging is enabled
cassandraVersion String
Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version.
clientCertificates List<Property Map>
List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property.
clusterNameOverride String
If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property.
deallocated Boolean
Whether the cluster and associated data centers has been deallocated.
delegatedManagementSubnetId String
Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'
externalGossipCertificates List<Property Map>
List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property.
externalSeedNodes List<Property Map>
List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes.
hoursBetweenBackups Number
(Deprecated) Number of hours to wait between taking a backup of the cluster.
prometheusEndpoint Property Map
Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached.
provisionError Property Map
Error related to resource provisioning.
provisioningState String
The status of the resource at the time the operation was called.
repairEnabled Boolean
Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs.

ManagedCassandraManagedServiceIdentity
, ManagedCassandraManagedServiceIdentityArgs

Type string | ManagedCassandraResourceIdentityType
The type of the resource.
type String | ManagedCassandraResourceIdentityType
The type of the resource.
type string | ManagedCassandraResourceIdentityType
The type of the resource.
type str | ManagedCassandraResourceIdentityType
The type of the resource.
type String | "SystemAssigned" | "None"
The type of the resource.

ManagedCassandraManagedServiceIdentityResponse
, ManagedCassandraManagedServiceIdentityResponseArgs

PrincipalId This property is required. string
The object id of the identity resource.
TenantId This property is required. string
The tenant id of the resource.
Type string
The type of the resource.
PrincipalId This property is required. string
The object id of the identity resource.
TenantId This property is required. string
The tenant id of the resource.
Type string
The type of the resource.
principalId This property is required. String
The object id of the identity resource.
tenantId This property is required. String
The tenant id of the resource.
type String
The type of the resource.
principalId This property is required. string
The object id of the identity resource.
tenantId This property is required. string
The tenant id of the resource.
type string
The type of the resource.
principal_id This property is required. str
The object id of the identity resource.
tenant_id This property is required. str
The tenant id of the resource.
type str
The type of the resource.
principalId This property is required. String
The object id of the identity resource.
tenantId This property is required. String
The tenant id of the resource.
type String
The type of the resource.

ManagedCassandraProvisioningState
, ManagedCassandraProvisioningStateArgs

Creating
Creating
Updating
Updating
Deleting
Deleting
Succeeded
Succeeded
Failed
Failed
Canceled
Canceled
ManagedCassandraProvisioningStateCreating
Creating
ManagedCassandraProvisioningStateUpdating
Updating
ManagedCassandraProvisioningStateDeleting
Deleting
ManagedCassandraProvisioningStateSucceeded
Succeeded
ManagedCassandraProvisioningStateFailed
Failed
ManagedCassandraProvisioningStateCanceled
Canceled
Creating
Creating
Updating
Updating
Deleting
Deleting
Succeeded
Succeeded
Failed
Failed
Canceled
Canceled
Creating
Creating
Updating
Updating
Deleting
Deleting
Succeeded
Succeeded
Failed
Failed
Canceled
Canceled
CREATING
Creating
UPDATING
Updating
DELETING
Deleting
SUCCEEDED
Succeeded
FAILED
Failed
CANCELED
Canceled
"Creating"
Creating
"Updating"
Updating
"Deleting"
Deleting
"Succeeded"
Succeeded
"Failed"
Failed
"Canceled"
Canceled

ManagedCassandraResourceIdentityType
, ManagedCassandraResourceIdentityTypeArgs

SystemAssigned
SystemAssigned
None
None
ManagedCassandraResourceIdentityTypeSystemAssigned
SystemAssigned
ManagedCassandraResourceIdentityTypeNone
None
SystemAssigned
SystemAssigned
None
None
SystemAssigned
SystemAssigned
None
None
SYSTEM_ASSIGNED
SystemAssigned
NONE
None
"SystemAssigned"
SystemAssigned
"None"
None

SeedNode
, SeedNodeArgs

IpAddress string
IP address of this seed node.
IpAddress string
IP address of this seed node.
ipAddress String
IP address of this seed node.
ipAddress string
IP address of this seed node.
ip_address str
IP address of this seed node.
ipAddress String
IP address of this seed node.

SeedNodeResponse
, SeedNodeResponseArgs

IpAddress string
IP address of this seed node.
IpAddress string
IP address of this seed node.
ipAddress String
IP address of this seed node.
ipAddress string
IP address of this seed node.
ip_address str
IP address of this seed node.
ipAddress String
IP address of this seed node.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:documentdb:CassandraCluster cassandra-prod /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}
Copy

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

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native