Top / Microsoft Azure / Azure CosmosDB (DocumentDB) / Cassandra Cluster

Azure CosmosDB (DocumentDB) Cassandra Cluster

This page shows how to write Terraform and Azure Resource Manager for CosmosDB (DocumentDB) Cassandra Cluster and write them securely.

terraform-logo

Review your .tf file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

azurerm_cosmosdb_cassandra_cluster (Terraform)

The Cassandra Cluster in CosmosDB (DocumentDB) can be configured in Terraform with the resource name azurerm_cosmosdb_cassandra_cluster. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Review your Terraform file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

The following arguments are supported:

  • name - (Required) The name which should be used for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.

  • resource_group_name - (Required) The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.

  • location - (Required) The Azure Region where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.

  • delegated_management_subnet_id - (Required) The ID of the delegated management subnet for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.

  • default_admin_password - (Required) The initial admin password for this Cassandra Cluster.

In addition to the Arguments listed above - the following Attributes are exported:

  • id - The ID of the Cassandra Cluster.

>> from Terraform Registry

Explanation in Terraform Registry

Manages a Cassandra Cluster.

>> from Terraform Registry

Microsoft.DocumentDB/cassandraClusters (Azure Resource Manager)

The cassandraClusters in Microsoft.DocumentDB can be configured in Azure Resource Manager with the resource name Microsoft.DocumentDB/cassandraClusters. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Parameters

  • apiVersion required - string
  • identity optional
      • type optional - string

        The type of the resource.

  • location optional - string

    The location of the resource group to which the resource belongs.

  • name required - string

    Managed Cassandra cluster name.

  • properties required
      • authenticationMethod optional - 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 optional - boolean

        Whether Cassandra audit logging is enabled

      • cassandraVersion optional - 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 optional array
          • pem optional - string

            PEM formatted public key.

      • clusterNameOverride optional - 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 optional - boolean

        Whether the cluster and associated data centers has been deallocated.

      • delegatedManagementSubnetId optional - 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/<subscription id>/resourceGroups/<resource group>/providers/Microsoft.Network/virtualNetworks/<virtual network>/subnets/<subnet>'

      • externalGossipCertificates optional array
          • pem optional - string

            PEM formatted public key.

      • externalSeedNodes optional array
          • ipAddress optional - string

            IP address of this seed node.

      • hoursBetweenBackups optional - integer

        Number of hours to wait between taking a backup of the cluster. To disable backups, set this property to 0.

      • initialCassandraAdminPassword optional - 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 optional
          • ipAddress optional - string

            IP address of this seed node.

      • provisioningState optional - string
      • repairEnabled optional - 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 optional - 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.

  • tags optional - 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".

  • type required - string

>> from Azure Resource Manager Documentation

The Other Related Azure CosmosDB (DocumentDB) Resources

Frequently asked questions

What is Azure CosmosDB (DocumentDB) Cassandra Cluster?

Azure CosmosDB (DocumentDB) Cassandra Cluster is a resource for CosmosDB (DocumentDB) of Microsoft Azure. Settings can be wrote in Terraform.

security-icon

Automate config file reviews on your commits

Fix issues in your infrastructure as code with auto-generated patches.

Table of Contents