1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. cassandra
  5. Cluster
Alibaba Cloud v3.45.1 published on Thursday, Dec 7, 2023 by Pulumi

alicloud.cassandra.Cluster

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.45.1 published on Thursday, Dec 7, 2023 by Pulumi

    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.

    Example Usage

    Create a cassandra cluster

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var @default = new AliCloud.Cassandra.Cluster("default", new()
        {
            AutoRenew = false,
            ClusterName = "cassandra-cluster-name-tf",
            DataCenterName = "dc-1",
            DiskSize = 160,
            DiskType = "cloud_ssd",
            InstanceType = "cassandra.c.large",
            IpWhite = "127.0.0.1",
            MaintainEndTime = "20:00Z",
            MaintainStartTime = "18:00Z",
            MajorVersion = "3.11",
            NodeCount = 2,
            PayType = "PayAsYouGo",
            VswitchId = "vsw-xxxx",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/cassandra"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cassandra.NewCluster(ctx, "default", &cassandra.ClusterArgs{
    			AutoRenew:         pulumi.Bool(false),
    			ClusterName:       pulumi.String("cassandra-cluster-name-tf"),
    			DataCenterName:    pulumi.String("dc-1"),
    			DiskSize:          pulumi.Int(160),
    			DiskType:          pulumi.String("cloud_ssd"),
    			InstanceType:      pulumi.String("cassandra.c.large"),
    			IpWhite:           pulumi.String("127.0.0.1"),
    			MaintainEndTime:   pulumi.String("20:00Z"),
    			MaintainStartTime: pulumi.String("18:00Z"),
    			MajorVersion:      pulumi.String("3.11"),
    			NodeCount:         pulumi.Int(2),
    			PayType:           pulumi.String("PayAsYouGo"),
    			VswitchId:         pulumi.String("vsw-xxxx"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.cassandra.Cluster;
    import com.pulumi.alicloud.cassandra.ClusterArgs;
    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 default_ = new Cluster("default", ClusterArgs.builder()        
                .autoRenew("false")
                .clusterName("cassandra-cluster-name-tf")
                .dataCenterName("dc-1")
                .diskSize("160")
                .diskType("cloud_ssd")
                .instanceType("cassandra.c.large")
                .ipWhite("127.0.0.1")
                .maintainEndTime("20:00Z")
                .maintainStartTime("18:00Z")
                .majorVersion("3.11")
                .nodeCount("2")
                .payType("PayAsYouGo")
                .vswitchId("vsw-xxxx")
                .build());
    
        }
    }
    
    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")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const _default = new alicloud.cassandra.Cluster("default", {
        autoRenew: false,
        clusterName: "cassandra-cluster-name-tf",
        dataCenterName: "dc-1",
        diskSize: 160,
        diskType: "cloud_ssd",
        instanceType: "cassandra.c.large",
        ipWhite: "127.0.0.1",
        maintainEndTime: "20:00Z",
        maintainStartTime: "18:00Z",
        majorVersion: "3.11",
        nodeCount: 2,
        payType: "PayAsYouGo",
        vswitchId: "vsw-xxxx",
    });
    
    resources:
      default:
        type: alicloud:cassandra:Cluster
        properties:
          autoRenew: 'false'
          clusterName: cassandra-cluster-name-tf
          dataCenterName: dc-1
          diskSize: '160'
          diskType: cloud_ssd
          instanceType: cassandra.c.large
          ipWhite: 127.0.0.1
          maintainEndTime: 20:00Z
          maintainStartTime: 18:00Z
          majorVersion: '3.11'
          nodeCount: '2'
          payType: PayAsYouGo
          vswitchId: vsw-xxxx
    

    Create Cluster Resource

    new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
    @overload
    def Cluster(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                auto_renew: Optional[bool] = None,
                auto_renew_period: Optional[int] = None,
                cluster_name: Optional[str] = None,
                data_center_name: Optional[str] = None,
                disk_size: Optional[int] = None,
                disk_type: Optional[str] = None,
                enable_public: Optional[bool] = None,
                instance_type: Optional[str] = None,
                ip_white: Optional[str] = None,
                maintain_end_time: Optional[str] = None,
                maintain_start_time: Optional[str] = None,
                major_version: Optional[str] = None,
                node_count: Optional[int] = None,
                password: Optional[str] = None,
                pay_type: Optional[str] = None,
                period: Optional[int] = None,
                period_unit: Optional[str] = None,
                security_groups: Optional[Sequence[str]] = None,
                tags: Optional[Mapping[str, Any]] = None,
                vswitch_id: Optional[str] = None,
                zone_id: Optional[str] = None)
    @overload
    def Cluster(resource_name: str,
                args: ClusterArgs,
                opts: Optional[ResourceOptions] = None)
    func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)
    public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
    public Cluster(String name, ClusterArgs args)
    public Cluster(String name, ClusterArgs args, CustomResourceOptions options)
    
    type: alicloud:cassandra:Cluster
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args ClusterArgs
    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 ClusterArgs
    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 ClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    InstanceType string

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

    MajorVersion string

    Cassandra major version. Now only support version 3.11.

    NodeCount int

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

    PayType string

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

    VswitchId string

    The vswitch_id of dataCenter-1, can not empty.

    AutoRenew bool

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

    AutoRenewPeriod int

    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.

    ClusterName string

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

    DataCenterName string

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

    DiskSize int

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

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

    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.

    EnablePublic bool
    IpWhite string

    Set the instance's IP whitelist in VPC network.

    MaintainEndTime string

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

    MaintainStartTime string

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

    Password string
    Period int
    PeriodUnit string
    SecurityGroups List<string>

    A list of security group ids to associate with.

    NOTE: Now cluster_name,data_center_name,instance_type,node_count,disk_type,disk_size,maintain_start_time,maintain_end_time,tags,ip_white,security_groups can be change. The others(auto_renew, auto_renew_period and so on) will be supported in the furture.

    Tags Dictionary<string, object>

    A mapping of tags to assign to the resource.

    ZoneId string

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

    InstanceType string

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

    MajorVersion string

    Cassandra major version. Now only support version 3.11.

    NodeCount int

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

    PayType string

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

    VswitchId string

    The vswitch_id of dataCenter-1, can not empty.

    AutoRenew bool

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

    AutoRenewPeriod int

    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.

    ClusterName string

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

    DataCenterName string

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

    DiskSize int

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

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

    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.

    EnablePublic bool
    IpWhite string

    Set the instance's IP whitelist in VPC network.

    MaintainEndTime string

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

    MaintainStartTime string

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

    Password string
    Period int
    PeriodUnit string
    SecurityGroups []string

    A list of security group ids to associate with.

    NOTE: Now cluster_name,data_center_name,instance_type,node_count,disk_type,disk_size,maintain_start_time,maintain_end_time,tags,ip_white,security_groups can be change. The others(auto_renew, auto_renew_period and so on) will be supported in the furture.

    Tags map[string]interface{}

    A mapping of tags to assign to the resource.

    ZoneId string

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

    instanceType String

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

    majorVersion String

    Cassandra major version. Now only support version 3.11.

    nodeCount Integer

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

    payType String

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

    vswitchId String

    The vswitch_id of dataCenter-1, can not empty.

    autoRenew Boolean

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

    autoRenewPeriod Integer

    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.

    clusterName String

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

    dataCenterName String

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

    diskSize Integer

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

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

    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.

    enablePublic Boolean
    ipWhite String

    Set the instance's IP whitelist in VPC network.

    maintainEndTime String

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

    maintainStartTime String

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

    password String
    period Integer
    periodUnit String
    securityGroups List<String>

    A list of security group ids to associate with.

    NOTE: Now cluster_name,data_center_name,instance_type,node_count,disk_type,disk_size,maintain_start_time,maintain_end_time,tags,ip_white,security_groups can be change. The others(auto_renew, auto_renew_period and so on) will be supported in the furture.

    tags Map<String,Object>

    A mapping of tags to assign to the resource.

    zoneId String

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

    instanceType string

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

    majorVersion string

    Cassandra major version. Now only support version 3.11.

    nodeCount number

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

    payType string

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

    vswitchId string

    The vswitch_id of dataCenter-1, can not empty.

    autoRenew boolean

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

    autoRenewPeriod number

    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.

    clusterName string

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

    dataCenterName string

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

    diskSize number

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

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

    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.

    enablePublic boolean
    ipWhite string

    Set the instance's IP whitelist in VPC network.

    maintainEndTime string

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

    maintainStartTime string

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

    password string
    period number
    periodUnit string
    securityGroups string[]

    A list of security group ids to associate with.

    NOTE: Now cluster_name,data_center_name,instance_type,node_count,disk_type,disk_size,maintain_start_time,maintain_end_time,tags,ip_white,security_groups can be change. The others(auto_renew, auto_renew_period and so on) will be supported in the furture.

    tags {[key: string]: any}

    A mapping of tags to assign to the resource.

    zoneId string

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

    instance_type str

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

    major_version str

    Cassandra major version. Now only support version 3.11.

    node_count int

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

    pay_type str

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

    vswitch_id str

    The vswitch_id of dataCenter-1, can not empty.

    auto_renew bool

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

    auto_renew_period int

    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 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 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 int

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

    enable_public bool
    ip_white str

    Set the instance's IP whitelist in VPC network.

    maintain_end_time 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 str

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

    password str
    period int
    period_unit str
    security_groups Sequence[str]

    A list of security group ids to associate with.

    NOTE: Now cluster_name,data_center_name,instance_type,node_count,disk_type,disk_size,maintain_start_time,maintain_end_time,tags,ip_white,security_groups can be change. The others(auto_renew, auto_renew_period and so on) will be supported in the furture.

    tags Mapping[str, Any]

    A mapping of tags to assign to the resource.

    zone_id str

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

    instanceType String

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

    majorVersion String

    Cassandra major version. Now only support version 3.11.

    nodeCount Number

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

    payType String

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

    vswitchId String

    The vswitch_id of dataCenter-1, can not empty.

    autoRenew Boolean

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

    autoRenewPeriod Number

    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.

    clusterName String

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

    dataCenterName String

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

    diskSize Number

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

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

    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.

    enablePublic Boolean
    ipWhite String

    Set the instance's IP whitelist in VPC network.

    maintainEndTime String

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

    maintainStartTime String

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

    password String
    period Number
    periodUnit String
    securityGroups List<String>

    A list of security group ids to associate with.

    NOTE: Now cluster_name,data_center_name,instance_type,node_count,disk_type,disk_size,maintain_start_time,maintain_end_time,tags,ip_white,security_groups can be change. The others(auto_renew, auto_renew_period and so on) will be supported in the furture.

    tags Map<Any>

    A mapping of tags to assign to the resource.

    zoneId String

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

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:

    Id string

    The provider-assigned unique ID for this managed resource.

    PublicPoints List<string>
    Status string
    Id string

    The provider-assigned unique ID for this managed resource.

    PublicPoints []string
    Status string
    id String

    The provider-assigned unique ID for this managed resource.

    publicPoints List<String>
    status String
    id string

    The provider-assigned unique ID for this managed resource.

    publicPoints string[]
    status string
    id str

    The provider-assigned unique ID for this managed resource.

    public_points Sequence[str]
    status str
    id String

    The provider-assigned unique ID for this managed resource.

    publicPoints List<String>
    status String

    Look up Existing Cluster Resource

    Get an existing Cluster 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?: ClusterState, opts?: CustomResourceOptions): Cluster
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            auto_renew: Optional[bool] = None,
            auto_renew_period: Optional[int] = None,
            cluster_name: Optional[str] = None,
            data_center_name: Optional[str] = None,
            disk_size: Optional[int] = None,
            disk_type: Optional[str] = None,
            enable_public: Optional[bool] = None,
            instance_type: Optional[str] = None,
            ip_white: Optional[str] = None,
            maintain_end_time: Optional[str] = None,
            maintain_start_time: Optional[str] = None,
            major_version: Optional[str] = None,
            node_count: Optional[int] = None,
            password: Optional[str] = None,
            pay_type: Optional[str] = None,
            period: Optional[int] = None,
            period_unit: Optional[str] = None,
            public_points: Optional[Sequence[str]] = None,
            security_groups: Optional[Sequence[str]] = None,
            status: Optional[str] = None,
            tags: Optional[Mapping[str, Any]] = None,
            vswitch_id: Optional[str] = None,
            zone_id: Optional[str] = None) -> Cluster
    func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)
    public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)
    public static Cluster get(String name, Output<String> id, ClusterState 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:
    AutoRenew bool

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

    AutoRenewPeriod int

    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.

    ClusterName string

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

    DataCenterName string

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

    DiskSize int

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

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

    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.

    EnablePublic bool
    InstanceType string

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

    IpWhite string

    Set the instance's IP whitelist in VPC network.

    MaintainEndTime string

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

    MaintainStartTime string

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

    MajorVersion string

    Cassandra major version. Now only support version 3.11.

    NodeCount int

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

    Password string
    PayType string

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

    Period int
    PeriodUnit string
    PublicPoints List<string>
    SecurityGroups List<string>

    A list of security group ids to associate with.

    NOTE: Now cluster_name,data_center_name,instance_type,node_count,disk_type,disk_size,maintain_start_time,maintain_end_time,tags,ip_white,security_groups can be change. The others(auto_renew, auto_renew_period and so on) will be supported in the furture.

    Status string
    Tags Dictionary<string, object>

    A mapping of tags to assign to the resource.

    VswitchId string

    The vswitch_id of dataCenter-1, can not empty.

    ZoneId string

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

    AutoRenew bool

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

    AutoRenewPeriod int

    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.

    ClusterName string

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

    DataCenterName string

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

    DiskSize int

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

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

    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.

    EnablePublic bool
    InstanceType string

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

    IpWhite string

    Set the instance's IP whitelist in VPC network.

    MaintainEndTime string

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

    MaintainStartTime string

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

    MajorVersion string

    Cassandra major version. Now only support version 3.11.

    NodeCount int

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

    Password string
    PayType string

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

    Period int
    PeriodUnit string
    PublicPoints []string
    SecurityGroups []string

    A list of security group ids to associate with.

    NOTE: Now cluster_name,data_center_name,instance_type,node_count,disk_type,disk_size,maintain_start_time,maintain_end_time,tags,ip_white,security_groups can be change. The others(auto_renew, auto_renew_period and so on) will be supported in the furture.

    Status string
    Tags map[string]interface{}

    A mapping of tags to assign to the resource.

    VswitchId string

    The vswitch_id of dataCenter-1, can not empty.

    ZoneId string

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

    autoRenew Boolean

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

    autoRenewPeriod Integer

    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.

    clusterName String

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

    dataCenterName String

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

    diskSize Integer

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

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

    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.

    enablePublic Boolean
    instanceType String

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

    ipWhite String

    Set the instance's IP whitelist in VPC network.

    maintainEndTime String

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

    maintainStartTime String

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

    majorVersion String

    Cassandra major version. Now only support version 3.11.

    nodeCount Integer

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

    password String
    payType String

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

    period Integer
    periodUnit String
    publicPoints List<String>
    securityGroups List<String>

    A list of security group ids to associate with.

    NOTE: Now cluster_name,data_center_name,instance_type,node_count,disk_type,disk_size,maintain_start_time,maintain_end_time,tags,ip_white,security_groups can be change. The others(auto_renew, auto_renew_period and so on) will be supported in the furture.

    status String
    tags Map<String,Object>

    A mapping of tags to assign to the resource.

    vswitchId String

    The vswitch_id of dataCenter-1, can not empty.

    zoneId String

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

    autoRenew boolean

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

    autoRenewPeriod number

    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.

    clusterName string

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

    dataCenterName string

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

    diskSize number

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

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

    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.

    enablePublic boolean
    instanceType string

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

    ipWhite string

    Set the instance's IP whitelist in VPC network.

    maintainEndTime string

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

    maintainStartTime string

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

    majorVersion string

    Cassandra major version. Now only support version 3.11.

    nodeCount number

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

    password string
    payType string

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

    period number
    periodUnit string
    publicPoints string[]
    securityGroups string[]

    A list of security group ids to associate with.

    NOTE: Now cluster_name,data_center_name,instance_type,node_count,disk_type,disk_size,maintain_start_time,maintain_end_time,tags,ip_white,security_groups can be change. The others(auto_renew, auto_renew_period and so on) will be supported in the furture.

    status string
    tags {[key: string]: any}

    A mapping of tags to assign to the resource.

    vswitchId string

    The vswitch_id of dataCenter-1, can not empty.

    zoneId string

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

    auto_renew bool

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

    auto_renew_period int

    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 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 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 int

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

    enable_public bool
    instance_type str

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

    ip_white str

    Set the instance's IP whitelist in VPC network.

    maintain_end_time 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 str

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

    major_version str

    Cassandra major version. Now only support version 3.11.

    node_count int

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

    password str
    pay_type str

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

    period int
    period_unit str
    public_points Sequence[str]
    security_groups Sequence[str]

    A list of security group ids to associate with.

    NOTE: Now cluster_name,data_center_name,instance_type,node_count,disk_type,disk_size,maintain_start_time,maintain_end_time,tags,ip_white,security_groups can be change. The others(auto_renew, auto_renew_period and so on) will be supported in the furture.

    status str
    tags Mapping[str, Any]

    A mapping of tags to assign to the resource.

    vswitch_id str

    The vswitch_id of dataCenter-1, can not empty.

    zone_id str

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

    autoRenew Boolean

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

    autoRenewPeriod Number

    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.

    clusterName String

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

    dataCenterName String

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

    diskSize Number

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

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

    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.

    enablePublic Boolean
    instanceType String

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

    ipWhite String

    Set the instance's IP whitelist in VPC network.

    maintainEndTime String

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

    maintainStartTime String

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

    majorVersion String

    Cassandra major version. Now only support version 3.11.

    nodeCount Number

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

    password String
    payType String

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

    period Number
    periodUnit String
    publicPoints List<String>
    securityGroups List<String>

    A list of security group ids to associate with.

    NOTE: Now cluster_name,data_center_name,instance_type,node_count,disk_type,disk_size,maintain_start_time,maintain_end_time,tags,ip_white,security_groups can be change. The others(auto_renew, auto_renew_period and so on) will be supported in the furture.

    status String
    tags Map<Any>

    A mapping of tags to assign to the resource.

    vswitchId String

    The vswitch_id of dataCenter-1, can not empty.

    zoneId String

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

    Import

    Cassandra cluster can be imported using the id, e.g.

     $ pulumi import alicloud:cassandra/cluster:Cluster example cds-wz9sr400dd7xxxxx
    

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the alicloud Terraform Provider.

    alicloud logo
    Alibaba Cloud v3.45.1 published on Thursday, Dec 7, 2023 by Pulumi