cassandra¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-alicloud repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-alicloud repo.

class pulumi_alicloud.cassandra.AwaitableGetClustersResult(clusters=None, id=None, ids=None, name_regex=None, names=None, output_file=None, tags=None)¶

class pulumi_alicloud.cassandra.AwaitableGetDataCentersResult(centers=None, cluster_id=None, id=None, ids=None, name_regex=None, names=None, output_file=None)¶

class pulumi_alicloud.cassandra.AwaitableGetZonesResult(id=None, ids=None, multi=None, output_file=None, zones=None)¶

class pulumi_alicloud.cassandra.Cluster(resource_name, opts=None, auto_renew=None, auto_renew_period=None, cluster_name=None, data_center_name=None, disk_size=None, disk_type=None, enable_public=None, instance_type=None, ip_white=None, maintain_end_time=None, maintain_start_time=None, major_version=None, node_count=None, password=None, pay_type=None, period=None, period_unit=None, security_groups=None, tags=None, vswitch_id=None, zone_id=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Cassandra cluster resource supports replica set clusters only. The Cassandra provides stable, reliable, and automatic scalable database services. It offers a full range of database solutions, such as disaster recovery, backup, recovery, monitoring, and alarms. You can see detail product introduction here.

NOTE: Available in 1.88.0+.

NOTE: The following regions support create Vpc network Cassandra cluster. The official website mark more regions. Or you can call DescribeRegions.

NOTE: Create Cassandra cluster or change cluster type and storage would cost 30 minutes. Please make full preparation.

import pulumi
import pulumi_alicloud as alicloud

default = alicloud.cassandra.Cluster("default",
    auto_renew="false",
    cluster_name="cassandra-cluster-name-tf",
    data_center_name="dc-1",
    disk_size="160",
    disk_type="cloud_ssd",
    instance_type="cassandra.c.large",
    ip_white="127.0.0.1",
    maintain_end_time="20:00Z",
    maintain_start_time="18:00Z",
    major_version="3.11",
    node_count="2",
    pay_type="PayAsYouGo",
    vswitch_id="vsw-xxxx")

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• auto_renew (pulumi.Input[bool]) – Auto renew of dataCenter-1,true or false. System default to false, valid when pay_type = PrePaid.

• auto_renew_period (pulumi.Input[float]) – Period of dataCenter-1 auto renew, if auto renew is true, one of 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 60, valid when pay_type = Subscription. Unit: month.

• cluster*name (pulumi.Input[str]) –

  Cassandra cluster name. Length must be 2~128 characters long. Only Chinese characters, English letters, numbers, period ., underline *`, or dash``-``are permitted.

• data_center_name (pulumi.Input[str]) – Cassandra dataCenter-1 name. Length must be 2~128 characters long. Only Chinese characters, English letters, numbers, period``.`, underline _`, or dash``-` are permitted.

• disk_size (pulumi.Input[float]) – User-defined Cassandra dataCenter-1 one node’s storage space.Unit: GB. Value range:

- Custom storage space; value range: [160, 2000].
- 80-GB increments.

Parameters

• disk_type (pulumi.Input[str]) – The disk type of Cassandra dataCenter-1. Valid values are cloud_ssd, cloud_efficiency, local_hdd_pro, local_ssd_pro, local_disk size is fixed.

• instance_type (pulumi.Input[str]) – Instance specification. See Instance specifications. Or you can call describeInstanceType api.

• ip_white (pulumi.Input[str]) – Set the instance’s IP whitelist in VPC network.

• maintain_end_time (pulumi.Input[str]) – The end time of the operation and maintenance time period of the cluster, in the format of HH:mmZ (UTC time).

• maintain_start_time (pulumi.Input[str]) – The start time of the operation and maintenance time period of the cluster, in the format of HH:mmZ (UTC time).

• major_version (pulumi.Input[str]) – Cassandra major version. Now only support version 3.11.

• node_count (pulumi.Input[float]) – The node count of Cassandra dataCenter-1 default to 2.

• pay_type (pulumi.Input[str]) – The pay type of Cassandra dataCenter-1. Valid values are Subscription, PayAsYouGo,System default to PayAsYouGo.

• security_groups (pulumi.Input[list]) – A list of security group ids to associate with.

• tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

• vswitch_id (pulumi.Input[str]) – The vswitch_id of dataCenter-1, can not empty.

• zone_id (pulumi.Input[str]) – The Zone to launch the Cassandra cluster. If vswitch_id is not empty, this zone_id can be “” or consistent.

auto_renew: pulumi.Output[bool] = None¶

Auto renew of dataCenter-1,true or false. System default to false, valid when pay_type = PrePaid.

auto_renew_period: pulumi.Output[float] = None¶

Period of dataCenter-1 auto renew, if auto renew is true, one of 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 60, valid when pay_type = Subscription. Unit: month.

cluster_name: pulumi.Output[str] = None¶

Cassandra cluster name. Length must be 2~128 characters long. Only Chinese characters, English letters, numbers, period ., underline _, or dash - are permitted.

data_center_name: pulumi.Output[str] = None¶

Cassandra dataCenter-1 name. Length must be 2~128 characters long. Only Chinese characters, English letters, numbers, period ., underline _, or dash - are permitted.

disk_size: pulumi.Output[float] = None¶

User-defined Cassandra dataCenter-1 one node’s storage space.Unit: GB. Value range:

• Custom storage space; value range: [160, 2000].

• 80-GB increments.

disk_type: pulumi.Output[str] = None¶

The disk type of Cassandra dataCenter-1. Valid values are cloud_ssd, cloud_efficiency, local_hdd_pro, local_ssd_pro, local_disk size is fixed.

instance_type: pulumi.Output[str] = None¶

Instance specification. See Instance specifications. Or you can call describeInstanceType api.

ip_white: pulumi.Output[str] = None¶

Set the instance’s IP whitelist in VPC network.

maintain_end_time: pulumi.Output[str] = None¶

The end time of the operation and maintenance time period of the cluster, in the format of HH:mmZ (UTC time).

maintain_start_time: pulumi.Output[str] = None¶

The start time of the operation and maintenance time period of the cluster, in the format of HH:mmZ (UTC time).

major_version: pulumi.Output[str] = None¶

Cassandra major version. Now only support version 3.11.

node_count: pulumi.Output[float] = None¶

The node count of Cassandra dataCenter-1 default to 2.

pay_type: pulumi.Output[str] = None¶

The pay type of Cassandra dataCenter-1. Valid values are Subscription, PayAsYouGo,System default to PayAsYouGo.

security_groups: pulumi.Output[list] = None¶

A list of security group ids to associate with.

tags: pulumi.Output[dict] = None¶

A mapping of tags to assign to the resource.

vswitch_id: pulumi.Output[str] = None¶

The vswitch_id of dataCenter-1, can not empty.

zone_id: pulumi.Output[str] = None¶

The Zone to launch the Cassandra cluster. If vswitch_id is not empty, this zone_id can be “” or consistent.

static get(resource_name, id, opts=None, auto_renew=None, auto_renew_period=None, cluster_name=None, data_center_name=None, disk_size=None, disk_type=None, enable_public=None, instance_type=None, ip_white=None, maintain_end_time=None, maintain_start_time=None, major_version=None, node_count=None, password=None, pay_type=None, period=None, period_unit=None, public_points=None, security_groups=None, status=None, tags=None, vswitch_id=None, zone_id=None)¶

Get an existing Cluster resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• auto_renew (pulumi.Input[bool]) – Auto renew of dataCenter-1,true or false. System default to false, valid when pay_type = PrePaid.

• auto_renew_period (pulumi.Input[float]) – Period of dataCenter-1 auto renew, if auto renew is true, one of 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 60, valid when pay_type = Subscription. Unit: month.

• cluster*name (pulumi.Input[str]) –

  Cassandra cluster name. Length must be 2~128 characters long. Only Chinese characters, English letters, numbers, period ., underline *`, or dash``-``are permitted.

• data_center_name (pulumi.Input[str]) – Cassandra dataCenter-1 name. Length must be 2~128 characters long. Only Chinese characters, English letters, numbers, period``.`, underline _`, or dash``-` are permitted.

• disk_size (pulumi.Input[float]) – User-defined Cassandra dataCenter-1 one node’s storage space.Unit: GB. Value range:

- Custom storage space; value range: [160, 2000].
- 80-GB increments.

Parameters

• disk_type (pulumi.Input[str]) – The disk type of Cassandra dataCenter-1. Valid values are cloud_ssd, cloud_efficiency, local_hdd_pro, local_ssd_pro, local_disk size is fixed.

• instance_type (pulumi.Input[str]) –

  Instance specification. See Instance specifications. Or you can call describeInstanceType api.

• ip_white (pulumi.Input[str]) – Set the instance’s IP whitelist in VPC network.

• maintain_end_time (pulumi.Input[str]) – The end time of the operation and maintenance time period of the cluster, in the format of HH:mmZ (UTC time).

• maintain_start_time (pulumi.Input[str]) – The start time of the operation and maintenance time period of the cluster, in the format of HH:mmZ (UTC time).

• major_version (pulumi.Input[str]) – Cassandra major version. Now only support version 3.11.

• node_count (pulumi.Input[float]) – The node count of Cassandra dataCenter-1 default to 2.

• pay_type (pulumi.Input[str]) – The pay type of Cassandra dataCenter-1. Valid values are Subscription, PayAsYouGo,System default to PayAsYouGo.

• security_groups (pulumi.Input[list]) – A list of security group ids to associate with.

• tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

• vswitch_id (pulumi.Input[str]) – The vswitch_id of dataCenter-1, can not empty.

• zone_id (pulumi.Input[str]) – The Zone to launch the Cassandra cluster. If vswitch_id is not empty, this zone_id can be “” or consistent.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_alicloud.cassandra.DataCenter(resource_name, opts=None, auto_renew=None, auto_renew_period=None, cluster_id=None, data_center_name=None, disk_size=None, disk_type=None, enable_public=None, instance_type=None, node_count=None, pay_type=None, period=None, period_unit=None, vswitch_id=None, zone_id=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Cassandra dataCenter resource supports replica set dataCenters only. The Cassandra provides stable, reliable, and automatic scalable database services. It offers a full range of database solutions, such as disaster recovery, backup, recovery, monitoring, and alarms. You can see detail product introduction here.

NOTE: Available in 1.88.0+.

NOTE: Create a cassandra dataCenter need a clusterId,so need create a cassandra cluster first.

NOTE: The following regions support create Vpc network Cassandra cluster. The official website mark more regions. Or you can call DescribeRegions.

NOTE: Create Cassandra dataCenter or change dataCenter type and storage would cost 30 minutes. Please make full preparation.

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• auto_renew (pulumi.Input[bool]) – Auto renew of dataCenter-2,true or false. System default to false, valid when pay_type = Subscription.

• auto_renew_period (pulumi.Input[float]) – Period of dataCenter-2 auto renew, if auto renew is true, one of 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 60, valid when pay_type = Subscription. Unit: month.

• cluster_id (pulumi.Input[str]) – Cassandra cluster id of dataCenter-2 belongs to.
  

• data_center*name (pulumi.Input[str]) –

  Cassandra dataCenter-2 name. Length must be 2~128 characters long. Only Chinese characters, English letters, numbers, period ., underline *`, or dash``-` are permitted.

• disk_size (pulumi.Input[float]) – User-defined Cassandra dataCenter one core node’s storage space.Unit: GB. Value range:

- Custom storage space; value range: [160, 2000].
- 80-GB increments.

Parameters

• disk_type (pulumi.Input[str]) – The disk type of Cassandra dataCenter-2. Valid values are cloud_ssd, cloud_efficiency, local_hdd_pro, local_ssd_pro, local_disk size is fixed.

• instance_type (pulumi.Input[str]) –

  Instance specification. See Instance specifications. Or you can call describeInstanceType api.

• node_count (pulumi.Input[float]) – The node count of Cassandra dataCenter-2, default to 2.

• pay_type (pulumi.Input[str]) – The pay type of Cassandra dataCenter-2. Valid values are Subscription, PayAsYouGo. System default to PayAsYouGo.

• vswitch_id (pulumi.Input[str]) – The vswitch_id of dataCenter-2, mast different of vswitch_id(dc-1), can not empty.

• zone_id (pulumi.Input[str]) – The Zone to launch the Cassandra dataCenter-2. If vswitch_id is not empty, this zone_id can be “” or consistent.

auto_renew: pulumi.Output[bool] = None¶

Auto renew of dataCenter-2,true or false. System default to false, valid when pay_type = Subscription.

auto_renew_period: pulumi.Output[float] = None¶

Period of dataCenter-2 auto renew, if auto renew is true, one of 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 60, valid when pay_type = Subscription. Unit: month.

cluster_id: pulumi.Output[str] = None¶

Cassandra cluster id of dataCenter-2 belongs to.

data_center_name: pulumi.Output[str] = None¶

Cassandra dataCenter-2 name. Length must be 2~128 characters long. Only Chinese characters, English letters, numbers, period ., underline _, or dash - are permitted.

disk_size: pulumi.Output[float] = None¶

User-defined Cassandra dataCenter one core node’s storage space.Unit: GB. Value range:

• Custom storage space; value range: [160, 2000].

• 80-GB increments.

disk_type: pulumi.Output[str] = None¶

The disk type of Cassandra dataCenter-2. Valid values are cloud_ssd, cloud_efficiency, local_hdd_pro, local_ssd_pro, local_disk size is fixed.

instance_type: pulumi.Output[str] = None¶

Instance specification. See Instance specifications. Or you can call describeInstanceType api.

node_count: pulumi.Output[float] = None¶

The node count of Cassandra dataCenter-2, default to 2.

pay_type: pulumi.Output[str] = None¶

The pay type of Cassandra dataCenter-2. Valid values are Subscription, PayAsYouGo. System default to PayAsYouGo.

vswitch_id: pulumi.Output[str] = None¶

The vswitch_id of dataCenter-2, mast different of vswitch_id(dc-1), can not empty.

zone_id: pulumi.Output[str] = None¶

The Zone to launch the Cassandra dataCenter-2. If vswitch_id is not empty, this zone_id can be “” or consistent.

static get(resource_name, id, opts=None, auto_renew=None, auto_renew_period=None, cluster_id=None, data_center_id=None, data_center_name=None, disk_size=None, disk_type=None, enable_public=None, instance_type=None, node_count=None, pay_type=None, period=None, period_unit=None, public_points=None, status=None, vswitch_id=None, zone_id=None)¶

Get an existing DataCenter resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• auto_renew (pulumi.Input[bool]) – Auto renew of dataCenter-2,true or false. System default to false, valid when pay_type = Subscription.

• auto_renew_period (pulumi.Input[float]) – Period of dataCenter-2 auto renew, if auto renew is true, one of 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 60, valid when pay_type = Subscription. Unit: month.

• cluster_id (pulumi.Input[str]) – Cassandra cluster id of dataCenter-2 belongs to.
  

• data_center*name (pulumi.Input[str]) –

  Cassandra dataCenter-2 name. Length must be 2~128 characters long. Only Chinese characters, English letters, numbers, period ., underline *`, or dash``-` are permitted.

• disk_size (pulumi.Input[float]) – User-defined Cassandra dataCenter one core node’s storage space.Unit: GB. Value range:

- Custom storage space; value range: [160, 2000].
- 80-GB increments.

Parameters

• disk_type (pulumi.Input[str]) – The disk type of Cassandra dataCenter-2. Valid values are cloud_ssd, cloud_efficiency, local_hdd_pro, local_ssd_pro, local_disk size is fixed.

• instance_type (pulumi.Input[str]) –

  Instance specification. See Instance specifications. Or you can call describeInstanceType api.

• node_count (pulumi.Input[float]) – The node count of Cassandra dataCenter-2, default to 2.

• pay_type (pulumi.Input[str]) – The pay type of Cassandra dataCenter-2. Valid values are Subscription, PayAsYouGo. System default to PayAsYouGo.

• vswitch_id (pulumi.Input[str]) – The vswitch_id of dataCenter-2, mast different of vswitch_id(dc-1), can not empty.

• zone_id (pulumi.Input[str]) – The Zone to launch the Cassandra dataCenter-2. If vswitch_id is not empty, this zone_id can be “” or consistent.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_alicloud.cassandra.GetClustersResult(clusters=None, id=None, ids=None, name_regex=None, names=None, output_file=None, tags=None)¶

A collection of values returned by getClusters.

clusters = None¶

A list of Cassandra clusters. Its every element contains the following attributes:

id = None¶

The provider-assigned unique ID for this managed resource.

ids = None¶

The list of Cassandra cluster ids.

names = None¶

The name list of Cassandra clusters.

tags = None¶

A mapping of tags to assign to the resource.

class pulumi_alicloud.cassandra.GetDataCentersResult(centers=None, cluster_id=None, id=None, ids=None, name_regex=None, names=None, output_file=None)¶

A collection of values returned by getDataCenters.

centers = None¶

A list of Cassandra data centers. Its every element contains the following attributes:

cluster_id = None¶

The ID of the Cassandra cluster.

id = None¶

The provider-assigned unique ID for this managed resource.

ids = None¶

The list of Cassandra data center ids.

names = None¶

The name list of Cassandra data centers.

class pulumi_alicloud.cassandra.GetZonesResult(id=None, ids=None, multi=None, output_file=None, zones=None)¶

A collection of values returned by getZones.

id = None¶

The provider-assigned unique ID for this managed resource.

ids = None¶

A list of zone IDs.

zones = None¶

A list of availability zones. Each element contains the following attributes:

pulumi_alicloud.cassandra.get_clusters(ids=None, name_regex=None, output_file=None, tags=None, opts=None)¶

The cassandra.getClusters data source provides a collection of Cassandra clusters available in Alicloud account. Filters support regular expression for the cluster name, ids or tags.

NOTE: Available in 1.88.0+.

import pulumi
import pulumi_alicloud as alicloud

cassandra = alicloud.cassandra.get_clusters(name_regex="tf_testAccCassandra")

Parameters

• ids (list) – The list of Cassandra cluster ids.

• name_regex (str) – A regex string to apply to the cluster name.

• tags (dict) – A mapping of tags to assign to the resource.

pulumi_alicloud.cassandra.get_data_centers(cluster_id=None, ids=None, name_regex=None, output_file=None, opts=None)¶

The cassandra.getDataCenters data source provides a collection of Cassandra Data Centers available in Alicloud account. Filters support regular expression for the cluster name or ids.

NOTE: Available in 1.88.0+.

import pulumi
import pulumi_alicloud as alicloud

cassandra = alicloud.cassandra.get_data_centers(cluster_id="cds-xxxxx",
    name_regex="tf_testAccCassandra_dc")

Parameters

• cluster_id (str) – The cluster id of dataCenters belongs to.

• ids (list) – The list of Cassandra data center ids.

• name_regex (str) – A regex string to apply to the cluster name.

pulumi_alicloud.cassandra.get_zones(multi=None, output_file=None, opts=None)¶

This data source provides availability zones for Cassandra that can be accessed by an Alibaba Cloud account within the region configured in the provider.

NOTE: Available in v1.88.0+.

import pulumi
import pulumi_alicloud as alicloud

zones_ids = alicloud.cassandra.get_zones()
# Create an Cassandra cluster with the first matched zone
cassandra = alicloud.cassandra.Cluster("cassandra", zone_id=zones_ids.zones[0]["id"])
# Other properties...

Parameters

multi (bool) – Indicate whether the zones can be used in a multi AZ configuration. Default to false. Multi AZ is usually used to launch Cassandra clusters.