ClusterResourceProperties Class

Properties of a managed Cassandra cluster.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance

Model

ClusterResourceProperties

Constructor

ClusterResourceProperties(*, provisioning_state: Optional[Union[str, azure.mgmt.cosmosdb.models._cosmos_db_management_client_enums.ManagedCassandraProvisioningState]] = None, restore_from_backup_id: Optional[str] = None, delegated_management_subnet_id: Optional[str] = None, cassandra_version: Optional[str] = None, cluster_name_override: Optional[str] = None, authentication_method: Optional[Union[str, azure.mgmt.cosmosdb.models._cosmos_db_management_client_enums.AuthenticationMethod]] = None, initial_cassandra_admin_password: Optional[str] = None, prometheus_endpoint: Optional[azure.mgmt.cosmosdb.models._models_py3.SeedNode] = None, repair_enabled: Optional[bool] = None, client_certificates: Optional[List[azure.mgmt.cosmosdb.models._models_py3.Certificate]] = None, external_gossip_certificates: Optional[List[azure.mgmt.cosmosdb.models._models_py3.Certificate]] = None, external_seed_nodes: Optional[List[azure.mgmt.cosmosdb.models._models_py3.SeedNode]] = None, hours_between_backups: Optional[int] = None, deallocated: Optional[bool] = None, cassandra_audit_logging_enabled: Optional[bool] = None, **kwargs)

Variables

provisioning_state

str or ManagedCassandraProvisioningState

The status of the resource at the time the operation was called. Possible values include: "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled".

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.

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

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.

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.

authentication_method

str or 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'. 'Ldap' is in preview. Possible values include: "None", "Cassandra", "Ldap".

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.

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.

client_certificates

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.

external_gossip_certificates

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.

gossip_certificates

list[Certificate]

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.

external_seed_nodes

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.

seed_nodes

list[SeedNode]

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.

hours_between_backups

int

Number of hours to wait between taking a backup of the cluster.

deallocated

bool

Whether the cluster and associated data centers has been deallocated.

cassandra_audit_logging_enabled

bool

Whether Cassandra audit logging is enabled.