Docs Packages
  1. Packages
  2. Azure Classic
  3. API Docs
  4. cosmosdb
  5. CassandraCluster

We recommend using Azure Native.

Azure Classic v5.73.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-azure

azure.cosmosdb.CassandraCluster

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.73.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a Cassandra Cluster.

    NOTE: In order for the Azure Managed Instances for Apache Cassandra to work properly the product requires the Azure Cosmos DB Application ID to be present and working in your tenant. If the Azure Cosmos DB Application ID is missing in your environment you will need to have an administrator of your tenant run the following command to add the Azure Cosmos DB Application ID to your tenant:

    New-AzADServicePrincipal -ApplicationId a232010e-820c-4083-83bb-3ace5fc29d0b

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
import * as azuread from "@pulumi/azuread";

const exampleResourceGroup = new azure.core.ResourceGroup("example", {
    name: "accexample-rg",
    location: "West Europe",
});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("example", {
    name: "example-vnet",
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    addressSpaces: ["10.0.0.0/16"],
});
const exampleSubnet = new azure.network.Subnet("example", {
    name: "example-subnet",
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefixes: ["10.0.1.0/24"],
});
const example = azuread.getServicePrincipal({
    displayName: "Azure Cosmos DB",
});
const exampleAssignment = new azure.authorization.Assignment("example", {
    scope: exampleVirtualNetwork.id,
    roleDefinitionName: "Network Contributor",
    principalId: example.then(example => example.objectId),
});
const exampleCassandraCluster = new azure.cosmosdb.CassandraCluster("example", {
    name: "example-cluster",
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    delegatedManagementSubnetId: exampleSubnet.id,
    defaultAdminPassword: "Password1234",
});

    import pulumi
import pulumi_azure as azure
import pulumi_azuread as azuread

example_resource_group = azure.core.ResourceGroup("example",
    name="accexample-rg",
    location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("example",
    name="example-vnet",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    address_spaces=["10.0.0.0/16"])
example_subnet = azure.network.Subnet("example",
    name="example-subnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefixes=["10.0.1.0/24"])
example = azuread.get_service_principal(display_name="Azure Cosmos DB")
example_assignment = azure.authorization.Assignment("example",
    scope=example_virtual_network.id,
    role_definition_name="Network Contributor",
    principal_id=example.object_id)
example_cassandra_cluster = azure.cosmosdb.CassandraCluster("example",
    name="example-cluster",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    delegated_management_subnet_id=example_subnet.id,
    default_admin_password="Password1234")

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/authorization"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/cosmosdb"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/network"
	"github.com/pulumi/pulumi-azuread/sdk/v5/go/azuread"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("accexample-rg"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "example", &network.VirtualNetworkArgs{
			Name:              pulumi.String("example-vnet"),
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			AddressSpaces: pulumi.StringArray{
				pulumi.String("10.0.0.0/16"),
			},
		})
		if err != nil {
			return err
		}
		exampleSubnet, err := network.NewSubnet(ctx, "example", &network.SubnetArgs{
			Name:               pulumi.String("example-subnet"),
			ResourceGroupName:  exampleResourceGroup.Name,
			VirtualNetworkName: exampleVirtualNetwork.Name,
			AddressPrefixes: pulumi.StringArray{
				pulumi.String("10.0.1.0/24"),
			},
		})
		if err != nil {
			return err
		}
		example, err := azuread.LookupServicePrincipal(ctx, &azuread.LookupServicePrincipalArgs{
			DisplayName: pulumi.StringRef("Azure Cosmos DB"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = authorization.NewAssignment(ctx, "example", &authorization.AssignmentArgs{
			Scope:              exampleVirtualNetwork.ID(),
			RoleDefinitionName: pulumi.String("Network Contributor"),
			PrincipalId:        pulumi.String(example.ObjectId),
		})
		if err != nil {
			return err
		}
		_, err = cosmosdb.NewCassandraCluster(ctx, "example", &cosmosdb.CassandraClusterArgs{
			Name:                        pulumi.String("example-cluster"),
			ResourceGroupName:           exampleResourceGroup.Name,
			Location:                    exampleResourceGroup.Location,
			DelegatedManagementSubnetId: exampleSubnet.ID(),
			DefaultAdminPassword:        pulumi.String("Password1234"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
using AzureAD = Pulumi.AzureAD;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "accexample-rg",
        Location = "West Europe",
    });

    var exampleVirtualNetwork = new Azure.Network.VirtualNetwork("example", new()
    {
        Name = "example-vnet",
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        AddressSpaces = new[]
        {
            "10.0.0.0/16",
        },
    });

    var exampleSubnet = new Azure.Network.Subnet("example", new()
    {
        Name = "example-subnet",
        ResourceGroupName = exampleResourceGroup.Name,
        VirtualNetworkName = exampleVirtualNetwork.Name,
        AddressPrefixes = new[]
        {
            "10.0.1.0/24",
        },
    });

    var example = AzureAD.GetServicePrincipal.Invoke(new()
    {
        DisplayName = "Azure Cosmos DB",
    });

    var exampleAssignment = new Azure.Authorization.Assignment("example", new()
    {
        Scope = exampleVirtualNetwork.Id,
        RoleDefinitionName = "Network Contributor",
        PrincipalId = example.Apply(getServicePrincipalResult => getServicePrincipalResult.ObjectId),
    });

    var exampleCassandraCluster = new Azure.CosmosDB.CassandraCluster("example", new()
    {
        Name = "example-cluster",
        ResourceGroupName = exampleResourceGroup.Name,
        Location = exampleResourceGroup.Location,
        DelegatedManagementSubnetId = exampleSubnet.Id,
        DefaultAdminPassword = "Password1234",
    });

});

    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.network.VirtualNetwork;
import com.pulumi.azure.network.VirtualNetworkArgs;
import com.pulumi.azure.network.Subnet;
import com.pulumi.azure.network.SubnetArgs;
import com.pulumi.azuread.AzureadFunctions;
import com.pulumi.azuread.inputs.GetServicePrincipalArgs;
import com.pulumi.azure.authorization.Assignment;
import com.pulumi.azure.authorization.AssignmentArgs;
import com.pulumi.azure.cosmosdb.CassandraCluster;
import com.pulumi.azure.cosmosdb.CassandraClusterArgs;
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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .name("accexample-rg")
            .location("West Europe")
            .build());

        var exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()        
            .name("example-vnet")
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .addressSpaces("10.0.0.0/16")
            .build());

        var exampleSubnet = new Subnet("exampleSubnet", SubnetArgs.builder()        
            .name("example-subnet")
            .resourceGroupName(exampleResourceGroup.name())
            .virtualNetworkName(exampleVirtualNetwork.name())
            .addressPrefixes("10.0.1.0/24")
            .build());

        final var example = AzureadFunctions.getServicePrincipal(GetServicePrincipalArgs.builder()
            .displayName("Azure Cosmos DB")
            .build());

        var exampleAssignment = new Assignment("exampleAssignment", AssignmentArgs.builder()        
            .scope(exampleVirtualNetwork.id())
            .roleDefinitionName("Network Contributor")
            .principalId(example.applyValue(getServicePrincipalResult -> getServicePrincipalResult.objectId()))
            .build());

        var exampleCassandraCluster = new CassandraCluster("exampleCassandraCluster", CassandraClusterArgs.builder()        
            .name("example-cluster")
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .delegatedManagementSubnetId(exampleSubnet.id())
            .defaultAdminPassword("Password1234")
            .build());

    }
}

    resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    name: example
    properties:
      name: accexample-rg
      location: West Europe
  exampleVirtualNetwork:
    type: azure:network:VirtualNetwork
    name: example
    properties:
      name: example-vnet
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      addressSpaces:
        - 10.0.0.0/16
  exampleSubnet:
    type: azure:network:Subnet
    name: example
    properties:
      name: example-subnet
      resourceGroupName: ${exampleResourceGroup.name}
      virtualNetworkName: ${exampleVirtualNetwork.name}
      addressPrefixes:
        - 10.0.1.0/24
  exampleAssignment:
    type: azure:authorization:Assignment
    name: example
    properties:
      scope: ${exampleVirtualNetwork.id}
      roleDefinitionName: Network Contributor
      principalId: ${example.objectId}
  exampleCassandraCluster:
    type: azure:cosmosdb:CassandraCluster
    name: example
    properties:
      name: example-cluster
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      delegatedManagementSubnetId: ${exampleSubnet.id}
      defaultAdminPassword: Password1234
variables:
  example:
    fn::invoke:
      Function: azuread:getServicePrincipal
      Arguments:
        displayName: Azure Cosmos DB

    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,
                     delegated_management_subnet_id: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     default_admin_password: Optional[str] = None,
                     hours_between_backups: Optional[int] = None,
                     external_gossip_certificate_pems: Optional[Sequence[str]] = None,
                     external_seed_node_ip_addresses: Optional[Sequence[str]] = None,
                     authentication_method: Optional[str] = None,
                     identity: Optional[CassandraClusterIdentityArgs] = None,
                     location: Optional[str] = None,
                     name: Optional[str] = None,
                     repair_enabled: Optional[bool] = None,
                     client_certificate_pems: Optional[Sequence[str]] = None,
                     tags: Optional[Mapping[str, str]] = None,
                     version: Optional[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:cosmosdb:CassandraCluster
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 CassandraClusterArgs
    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 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 string
    The unique name of the resource.
    args CassandraClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CassandraClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CassandraClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var cassandraClusterResource = new Azure.CosmosDB.CassandraCluster("cassandraClusterResource", new()
{
    DelegatedManagementSubnetId = "string",
    ResourceGroupName = "string",
    DefaultAdminPassword = "string",
    HoursBetweenBackups = 0,
    ExternalGossipCertificatePems = new[]
    {
        "string",
    },
    ExternalSeedNodeIpAddresses = new[]
    {
        "string",
    },
    AuthenticationMethod = "string",
    Identity = new Azure.CosmosDB.Inputs.CassandraClusterIdentityArgs
    {
        Type = "string",
        PrincipalId = "string",
        TenantId = "string",
    },
    Location = "string",
    Name = "string",
    RepairEnabled = false,
    ClientCertificatePems = new[]
    {
        "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
    Version = "string",
});

    example, err := cosmosdb.NewCassandraCluster(ctx, "cassandraClusterResource", &cosmosdb.CassandraClusterArgs{
	DelegatedManagementSubnetId: pulumi.String("string"),
	ResourceGroupName:           pulumi.String("string"),
	DefaultAdminPassword:        pulumi.String("string"),
	HoursBetweenBackups:         pulumi.Int(0),
	ExternalGossipCertificatePems: pulumi.StringArray{
		pulumi.String("string"),
	},
	ExternalSeedNodeIpAddresses: pulumi.StringArray{
		pulumi.String("string"),
	},
	AuthenticationMethod: pulumi.String("string"),
	Identity: &cosmosdb.CassandraClusterIdentityArgs{
		Type:        pulumi.String("string"),
		PrincipalId: pulumi.String("string"),
		TenantId:    pulumi.String("string"),
	},
	Location:      pulumi.String("string"),
	Name:          pulumi.String("string"),
	RepairEnabled: pulumi.Bool(false),
	ClientCertificatePems: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Version: pulumi.String("string"),
})

    var cassandraClusterResource = new CassandraCluster("cassandraClusterResource", CassandraClusterArgs.builder()        
    .delegatedManagementSubnetId("string")
    .resourceGroupName("string")
    .defaultAdminPassword("string")
    .hoursBetweenBackups(0)
    .externalGossipCertificatePems("string")
    .externalSeedNodeIpAddresses("string")
    .authenticationMethod("string")
    .identity(CassandraClusterIdentityArgs.builder()
        .type("string")
        .principalId("string")
        .tenantId("string")
        .build())
    .location("string")
    .name("string")
    .repairEnabled(false)
    .clientCertificatePems("string")
    .tags(Map.of("string", "string"))
    .version("string")
    .build());

    cassandra_cluster_resource = azure.cosmosdb.CassandraCluster("cassandraClusterResource",
    delegated_management_subnet_id="string",
    resource_group_name="string",
    default_admin_password="string",
    hours_between_backups=0,
    external_gossip_certificate_pems=["string"],
    external_seed_node_ip_addresses=["string"],
    authentication_method="string",
    identity=azure.cosmosdb.CassandraClusterIdentityArgs(
        type="string",
        principal_id="string",
        tenant_id="string",
    ),
    location="string",
    name="string",
    repair_enabled=False,
    client_certificate_pems=["string"],
    tags={
        "string": "string",
    },
    version="string")

    const cassandraClusterResource = new azure.cosmosdb.CassandraCluster("cassandraClusterResource", {
    delegatedManagementSubnetId: "string",
    resourceGroupName: "string",
    defaultAdminPassword: "string",
    hoursBetweenBackups: 0,
    externalGossipCertificatePems: ["string"],
    externalSeedNodeIpAddresses: ["string"],
    authenticationMethod: "string",
    identity: {
        type: "string",
        principalId: "string",
        tenantId: "string",
    },
    location: "string",
    name: "string",
    repairEnabled: false,
    clientCertificatePems: ["string"],
    tags: {
        string: "string",
    },
    version: "string",
});

    type: azure:cosmosdb:CassandraCluster
properties:
    authenticationMethod: string
    clientCertificatePems:
        - string
    defaultAdminPassword: string
    delegatedManagementSubnetId: string
    externalGossipCertificatePems:
        - string
    externalSeedNodeIpAddresses:
        - string
    hoursBetweenBackups: 0
    identity:
        principalId: string
        tenantId: string
        type: string
    location: string
    name: string
    repairEnabled: false
    resourceGroupName: string
    tags:
        string: string
    version: string

    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

    The CassandraCluster resource accepts the following input properties:

    DefaultAdminPassword string
    The initial admin password for this Cassandra Cluster. Changing this forces a new resource to be created.
    DelegatedManagementSubnetId string
    The ID of the delegated management subnet for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    ResourceGroupName string
    The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    AuthenticationMethod string
    The authentication method that is used to authenticate clients. Possible values are None and Cassandra. Defaults to Cassandra.
    ClientCertificatePems List<string>
    A list of TLS certificates that is used to authorize client connecting to the Cassandra Cluster.
    ExternalGossipCertificatePems List<string>
    A list of TLS certificates that is used to authorize gossip from unmanaged Cassandra Data Center.
    ExternalSeedNodeIpAddresses List<string>
    A list of IP Addresses of the seed nodes in unmanaged the Cassandra Data Center which will be added to the seed node lists of all managed nodes.
    HoursBetweenBackups int

    The number of hours to wait between taking a backup of the Cassandra Cluster. Defaults to 24.

    Note: To disable this feature, set this property to 0.

    Identity CassandraClusterIdentity
    An identity block as defined below.
    Location string
    The Azure Region where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    Name string
    The name which should be used for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    RepairEnabled bool
    Is the automatic repair enabled on the Cassandra Cluster? Defaults to true.
    Tags Dictionary<string, string>
    A mapping of tags assigned to the resource.
    Version string
    The version of Cassandra what the Cluster converges to run. Possible values are 3.11 and 4.0. Defaults to 3.11. Changing this forces a new Cassandra Cluster to be created.
    DefaultAdminPassword string
    The initial admin password for this Cassandra Cluster. Changing this forces a new resource to be created.
    DelegatedManagementSubnetId string
    The ID of the delegated management subnet for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    ResourceGroupName string
    The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    AuthenticationMethod string
    The authentication method that is used to authenticate clients. Possible values are None and Cassandra. Defaults to Cassandra.
    ClientCertificatePems []string
    A list of TLS certificates that is used to authorize client connecting to the Cassandra Cluster.
    ExternalGossipCertificatePems []string
    A list of TLS certificates that is used to authorize gossip from unmanaged Cassandra Data Center.
    ExternalSeedNodeIpAddresses []string
    A list of IP Addresses of the seed nodes in unmanaged the Cassandra Data Center which will be added to the seed node lists of all managed nodes.
    HoursBetweenBackups int

    The number of hours to wait between taking a backup of the Cassandra Cluster. Defaults to 24.

    Note: To disable this feature, set this property to 0.

    Identity CassandraClusterIdentityArgs
    An identity block as defined below.
    Location string
    The Azure Region where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    Name string
    The name which should be used for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    RepairEnabled bool
    Is the automatic repair enabled on the Cassandra Cluster? Defaults to true.
    Tags map[string]string
    A mapping of tags assigned to the resource.
    Version string
    The version of Cassandra what the Cluster converges to run. Possible values are 3.11 and 4.0. Defaults to 3.11. Changing this forces a new Cassandra Cluster to be created.
    defaultAdminPassword String
    The initial admin password for this Cassandra Cluster. Changing this forces a new resource to be created.
    delegatedManagementSubnetId String
    The ID of the delegated management subnet for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    resourceGroupName String
    The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    authenticationMethod String
    The authentication method that is used to authenticate clients. Possible values are None and Cassandra. Defaults to Cassandra.
    clientCertificatePems List<String>
    A list of TLS certificates that is used to authorize client connecting to the Cassandra Cluster.
    externalGossipCertificatePems List<String>
    A list of TLS certificates that is used to authorize gossip from unmanaged Cassandra Data Center.
    externalSeedNodeIpAddresses List<String>
    A list of IP Addresses of the seed nodes in unmanaged the Cassandra Data Center which will be added to the seed node lists of all managed nodes.
    hoursBetweenBackups Integer

    The number of hours to wait between taking a backup of the Cassandra Cluster. Defaults to 24.

    Note: To disable this feature, set this property to 0.

    identity CassandraClusterIdentity
    An identity block as defined below.
    location String
    The Azure Region where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    name String
    The name which should be used for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    repairEnabled Boolean
    Is the automatic repair enabled on the Cassandra Cluster? Defaults to true.
    tags Map<String,String>
    A mapping of tags assigned to the resource.
    version String
    The version of Cassandra what the Cluster converges to run. Possible values are 3.11 and 4.0. Defaults to 3.11. Changing this forces a new Cassandra Cluster to be created.
    defaultAdminPassword string
    The initial admin password for this Cassandra Cluster. Changing this forces a new resource to be created.
    delegatedManagementSubnetId string
    The ID of the delegated management subnet for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    resourceGroupName string
    The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    authenticationMethod string
    The authentication method that is used to authenticate clients. Possible values are None and Cassandra. Defaults to Cassandra.
    clientCertificatePems string[]
    A list of TLS certificates that is used to authorize client connecting to the Cassandra Cluster.
    externalGossipCertificatePems string[]
    A list of TLS certificates that is used to authorize gossip from unmanaged Cassandra Data Center.
    externalSeedNodeIpAddresses string[]
    A list of IP Addresses of the seed nodes in unmanaged the Cassandra Data Center which will be added to the seed node lists of all managed nodes.
    hoursBetweenBackups number

    The number of hours to wait between taking a backup of the Cassandra Cluster. Defaults to 24.

    Note: To disable this feature, set this property to 0.

    identity CassandraClusterIdentity
    An identity block as defined below.
    location string
    The Azure Region where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    name string
    The name which should be used for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    repairEnabled boolean
    Is the automatic repair enabled on the Cassandra Cluster? Defaults to true.
    tags {[key: string]: string}
    A mapping of tags assigned to the resource.
    version string
    The version of Cassandra what the Cluster converges to run. Possible values are 3.11 and 4.0. Defaults to 3.11. Changing this forces a new Cassandra Cluster to be created.
    default_admin_password str
    The initial admin password for this Cassandra Cluster. Changing this forces a new resource to be created.
    delegated_management_subnet_id str
    The ID of the delegated management subnet for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    resource_group_name str
    The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    authentication_method str
    The authentication method that is used to authenticate clients. Possible values are None and Cassandra. Defaults to Cassandra.
    client_certificate_pems Sequence[str]
    A list of TLS certificates that is used to authorize client connecting to the Cassandra Cluster.
    external_gossip_certificate_pems Sequence[str]
    A list of TLS certificates that is used to authorize gossip from unmanaged Cassandra Data Center.
    external_seed_node_ip_addresses Sequence[str]
    A list of IP Addresses of the seed nodes in unmanaged the Cassandra Data Center which will be added to the seed node lists of all managed nodes.
    hours_between_backups int

    The number of hours to wait between taking a backup of the Cassandra Cluster. Defaults to 24.

    Note: To disable this feature, set this property to 0.

    identity CassandraClusterIdentityArgs
    An identity block as defined below.
    location str
    The Azure Region where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    name str
    The name which should be used for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    repair_enabled bool
    Is the automatic repair enabled on the Cassandra Cluster? Defaults to true.
    tags Mapping[str, str]
    A mapping of tags assigned to the resource.
    version str
    The version of Cassandra what the Cluster converges to run. Possible values are 3.11 and 4.0. Defaults to 3.11. Changing this forces a new Cassandra Cluster to be created.
    defaultAdminPassword String
    The initial admin password for this Cassandra Cluster. Changing this forces a new resource to be created.
    delegatedManagementSubnetId String
    The ID of the delegated management subnet for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    resourceGroupName String
    The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    authenticationMethod String
    The authentication method that is used to authenticate clients. Possible values are None and Cassandra. Defaults to Cassandra.
    clientCertificatePems List<String>
    A list of TLS certificates that is used to authorize client connecting to the Cassandra Cluster.
    externalGossipCertificatePems List<String>
    A list of TLS certificates that is used to authorize gossip from unmanaged Cassandra Data Center.
    externalSeedNodeIpAddresses List<String>
    A list of IP Addresses of the seed nodes in unmanaged the Cassandra Data Center which will be added to the seed node lists of all managed nodes.
    hoursBetweenBackups Number

    The number of hours to wait between taking a backup of the Cassandra Cluster. Defaults to 24.

    Note: To disable this feature, set this property to 0.

    identity Property Map
    An identity block as defined below.
    location String
    The Azure Region where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    name String
    The name which should be used for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    repairEnabled Boolean
    Is the automatic repair enabled on the Cassandra Cluster? Defaults to true.
    tags Map<String>
    A mapping of tags assigned to the resource.
    version String
    The version of Cassandra what the Cluster converges to run. Possible values are 3.11 and 4.0. Defaults to 3.11. Changing this forces a new Cassandra Cluster to be created.

    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.
    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 CassandraCluster Resource

    Get an existing CassandraCluster 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?: CassandraClusterState, opts?: CustomResourceOptions): CassandraCluster
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authentication_method: Optional[str] = None,
        client_certificate_pems: Optional[Sequence[str]] = None,
        default_admin_password: Optional[str] = None,
        delegated_management_subnet_id: Optional[str] = None,
        external_gossip_certificate_pems: Optional[Sequence[str]] = None,
        external_seed_node_ip_addresses: Optional[Sequence[str]] = None,
        hours_between_backups: Optional[int] = None,
        identity: Optional[CassandraClusterIdentityArgs] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        repair_enabled: Optional[bool] = None,
        resource_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        version: Optional[str] = None) -> CassandraCluster
    func GetCassandraCluster(ctx *Context, name string, id IDInput, state *CassandraClusterState, opts ...ResourceOption) (*CassandraCluster, error)
    public static CassandraCluster Get(string name, Input<string> id, CassandraClusterState? state, CustomResourceOptions? opts = null)
    public static CassandraCluster get(String name, Output<String> id, CassandraClusterState 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:
    AuthenticationMethod string
    The authentication method that is used to authenticate clients. Possible values are None and Cassandra. Defaults to Cassandra.
    ClientCertificatePems List<string>
    A list of TLS certificates that is used to authorize client connecting to the Cassandra Cluster.
    DefaultAdminPassword string
    The initial admin password for this Cassandra Cluster. Changing this forces a new resource to be created.
    DelegatedManagementSubnetId string
    The ID of the delegated management subnet for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    ExternalGossipCertificatePems List<string>
    A list of TLS certificates that is used to authorize gossip from unmanaged Cassandra Data Center.
    ExternalSeedNodeIpAddresses List<string>
    A list of IP Addresses of the seed nodes in unmanaged the Cassandra Data Center which will be added to the seed node lists of all managed nodes.
    HoursBetweenBackups int

    The number of hours to wait between taking a backup of the Cassandra Cluster. Defaults to 24.

    Note: To disable this feature, set this property to 0.

    Identity CassandraClusterIdentity
    An identity block as defined below.
    Location string
    The Azure Region where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    Name string
    The name which should be used for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    RepairEnabled bool
    Is the automatic repair enabled on the Cassandra Cluster? Defaults to true.
    ResourceGroupName string
    The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    Tags Dictionary<string, string>
    A mapping of tags assigned to the resource.
    Version string
    The version of Cassandra what the Cluster converges to run. Possible values are 3.11 and 4.0. Defaults to 3.11. Changing this forces a new Cassandra Cluster to be created.
    AuthenticationMethod string
    The authentication method that is used to authenticate clients. Possible values are None and Cassandra. Defaults to Cassandra.
    ClientCertificatePems []string
    A list of TLS certificates that is used to authorize client connecting to the Cassandra Cluster.
    DefaultAdminPassword string
    The initial admin password for this Cassandra Cluster. Changing this forces a new resource to be created.
    DelegatedManagementSubnetId string
    The ID of the delegated management subnet for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    ExternalGossipCertificatePems []string
    A list of TLS certificates that is used to authorize gossip from unmanaged Cassandra Data Center.
    ExternalSeedNodeIpAddresses []string
    A list of IP Addresses of the seed nodes in unmanaged the Cassandra Data Center which will be added to the seed node lists of all managed nodes.
    HoursBetweenBackups int

    The number of hours to wait between taking a backup of the Cassandra Cluster. Defaults to 24.

    Note: To disable this feature, set this property to 0.

    Identity CassandraClusterIdentityArgs
    An identity block as defined below.
    Location string
    The Azure Region where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    Name string
    The name which should be used for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    RepairEnabled bool
    Is the automatic repair enabled on the Cassandra Cluster? Defaults to true.
    ResourceGroupName string
    The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    Tags map[string]string
    A mapping of tags assigned to the resource.
    Version string
    The version of Cassandra what the Cluster converges to run. Possible values are 3.11 and 4.0. Defaults to 3.11. Changing this forces a new Cassandra Cluster to be created.
    authenticationMethod String
    The authentication method that is used to authenticate clients. Possible values are None and Cassandra. Defaults to Cassandra.
    clientCertificatePems List<String>
    A list of TLS certificates that is used to authorize client connecting to the Cassandra Cluster.
    defaultAdminPassword String
    The initial admin password for this Cassandra Cluster. Changing this forces a new resource to be created.
    delegatedManagementSubnetId String
    The ID of the delegated management subnet for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    externalGossipCertificatePems List<String>
    A list of TLS certificates that is used to authorize gossip from unmanaged Cassandra Data Center.
    externalSeedNodeIpAddresses List<String>
    A list of IP Addresses of the seed nodes in unmanaged the Cassandra Data Center which will be added to the seed node lists of all managed nodes.
    hoursBetweenBackups Integer

    The number of hours to wait between taking a backup of the Cassandra Cluster. Defaults to 24.

    Note: To disable this feature, set this property to 0.

    identity CassandraClusterIdentity
    An identity block as defined below.
    location String
    The Azure Region where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    name String
    The name which should be used for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    repairEnabled Boolean
    Is the automatic repair enabled on the Cassandra Cluster? Defaults to true.
    resourceGroupName String
    The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    tags Map<String,String>
    A mapping of tags assigned to the resource.
    version String
    The version of Cassandra what the Cluster converges to run. Possible values are 3.11 and 4.0. Defaults to 3.11. Changing this forces a new Cassandra Cluster to be created.
    authenticationMethod string
    The authentication method that is used to authenticate clients. Possible values are None and Cassandra. Defaults to Cassandra.
    clientCertificatePems string[]
    A list of TLS certificates that is used to authorize client connecting to the Cassandra Cluster.
    defaultAdminPassword string
    The initial admin password for this Cassandra Cluster. Changing this forces a new resource to be created.
    delegatedManagementSubnetId string
    The ID of the delegated management subnet for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    externalGossipCertificatePems string[]
    A list of TLS certificates that is used to authorize gossip from unmanaged Cassandra Data Center.
    externalSeedNodeIpAddresses string[]
    A list of IP Addresses of the seed nodes in unmanaged the Cassandra Data Center which will be added to the seed node lists of all managed nodes.
    hoursBetweenBackups number

    The number of hours to wait between taking a backup of the Cassandra Cluster. Defaults to 24.

    Note: To disable this feature, set this property to 0.

    identity CassandraClusterIdentity
    An identity block as defined below.
    location string
    The Azure Region where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    name string
    The name which should be used for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    repairEnabled boolean
    Is the automatic repair enabled on the Cassandra Cluster? Defaults to true.
    resourceGroupName string
    The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    tags {[key: string]: string}
    A mapping of tags assigned to the resource.
    version string
    The version of Cassandra what the Cluster converges to run. Possible values are 3.11 and 4.0. Defaults to 3.11. Changing this forces a new Cassandra Cluster to be created.
    authentication_method str
    The authentication method that is used to authenticate clients. Possible values are None and Cassandra. Defaults to Cassandra.
    client_certificate_pems Sequence[str]
    A list of TLS certificates that is used to authorize client connecting to the Cassandra Cluster.
    default_admin_password str
    The initial admin password for this Cassandra Cluster. Changing this forces a new resource to be created.
    delegated_management_subnet_id str
    The ID of the delegated management subnet for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    external_gossip_certificate_pems Sequence[str]
    A list of TLS certificates that is used to authorize gossip from unmanaged Cassandra Data Center.
    external_seed_node_ip_addresses Sequence[str]
    A list of IP Addresses of the seed nodes in unmanaged the Cassandra Data Center which will be added to the seed node lists of all managed nodes.
    hours_between_backups int

    The number of hours to wait between taking a backup of the Cassandra Cluster. Defaults to 24.

    Note: To disable this feature, set this property to 0.

    identity CassandraClusterIdentityArgs
    An identity block as defined below.
    location str
    The Azure Region where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    name str
    The name which should be used for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    repair_enabled bool
    Is the automatic repair enabled on the Cassandra Cluster? Defaults to true.
    resource_group_name str
    The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    tags Mapping[str, str]
    A mapping of tags assigned to the resource.
    version str
    The version of Cassandra what the Cluster converges to run. Possible values are 3.11 and 4.0. Defaults to 3.11. Changing this forces a new Cassandra Cluster to be created.
    authenticationMethod String
    The authentication method that is used to authenticate clients. Possible values are None and Cassandra. Defaults to Cassandra.
    clientCertificatePems List<String>
    A list of TLS certificates that is used to authorize client connecting to the Cassandra Cluster.
    defaultAdminPassword String
    The initial admin password for this Cassandra Cluster. Changing this forces a new resource to be created.
    delegatedManagementSubnetId String
    The ID of the delegated management subnet for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    externalGossipCertificatePems List<String>
    A list of TLS certificates that is used to authorize gossip from unmanaged Cassandra Data Center.
    externalSeedNodeIpAddresses List<String>
    A list of IP Addresses of the seed nodes in unmanaged the Cassandra Data Center which will be added to the seed node lists of all managed nodes.
    hoursBetweenBackups Number

    The number of hours to wait between taking a backup of the Cassandra Cluster. Defaults to 24.

    Note: To disable this feature, set this property to 0.

    identity Property Map
    An identity block as defined below.
    location String
    The Azure Region where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    name String
    The name which should be used for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    repairEnabled Boolean
    Is the automatic repair enabled on the Cassandra Cluster? Defaults to true.
    resourceGroupName String
    The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    tags Map<String>
    A mapping of tags assigned to the resource.
    version String
    The version of Cassandra what the Cluster converges to run. Possible values are 3.11 and 4.0. Defaults to 3.11. Changing this forces a new Cassandra Cluster to be created.

    Supporting Types

    CassandraClusterIdentity, CassandraClusterIdentityArgs

    Type string
    Specifies the type of Managed Service Identity that should be configured on this Cassandra Cluster. The only possible value is SystemAssigned.
    PrincipalId string
    TenantId string
    Type string
    Specifies the type of Managed Service Identity that should be configured on this Cassandra Cluster. The only possible value is SystemAssigned.
    PrincipalId string
    TenantId string
    type String
    Specifies the type of Managed Service Identity that should be configured on this Cassandra Cluster. The only possible value is SystemAssigned.
    principalId String
    tenantId String
    type string
    Specifies the type of Managed Service Identity that should be configured on this Cassandra Cluster. The only possible value is SystemAssigned.
    principalId string
    tenantId string
    type str
    Specifies the type of Managed Service Identity that should be configured on this Cassandra Cluster. The only possible value is SystemAssigned.
    principal_id str
    tenant_id str
    type String
    Specifies the type of Managed Service Identity that should be configured on this Cassandra Cluster. The only possible value is SystemAssigned.
    principalId String
    tenantId String

    Import

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

    $ pulumi import azure:cosmosdb/cassandraCluster:CassandraCluster example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/resGroup1/providers/Microsoft.DocumentDB/cassandraClusters/cluster1

    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 Classic v5.73.0 published on Monday, Apr 22, 2024 by Pulumi
    pulumi/pulumi-azure