Alibaba Cloud v3.78.0, May 16 25

Alibaba Cloud v3.78.0 published on Friday, May 16, 2025 by Pulumi

alicloud.cs.Cluster

Explore with Pulumi AI

Alibaba Cloud v3.78.0 published on Friday, May 16, 2025 by Pulumi

Create Cluster Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);

@overload
def Cluster(resource_name: str,
            args: ClusterArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            instance_type: Optional[str] = None,
            vswitch_id: Optional[str] = None,
            password: Optional[str] = None,
            cidr_block: Optional[str] = None,
            name: Optional[str] = None,
            is_outdated: Optional[bool] = None,
            image_id: Optional[str] = None,
            name_prefix: Optional[str] = None,
            need_slb: Optional[bool] = None,
            node_number: Optional[int] = None,
            disk_size: Optional[int] = None,
            release_eip: Optional[bool] = None,
            size: Optional[int] = None,
            disk_category: Optional[str] = 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:cs:Cluster
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 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.

Constructor example

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

var exampleclusterResourceResourceFromCscluster = new AliCloud.CS.Cluster("exampleclusterResourceResourceFromCscluster", new()
{
    InstanceType = "string",
    VswitchId = "string",
    Password = "string",
    CidrBlock = "string",
    Name = "string",
    IsOutdated = false,
    ImageId = "string",
    NamePrefix = "string",
    NeedSlb = false,
    NodeNumber = 0,
    DiskSize = 0,
    ReleaseEip = false,
    DiskCategory = "string",
});

example, err := cs.NewCluster(ctx, "exampleclusterResourceResourceFromCscluster", &cs.ClusterArgs{
	InstanceType: pulumi.String("string"),
	VswitchId:    pulumi.String("string"),
	Password:     pulumi.String("string"),
	CidrBlock:    pulumi.String("string"),
	Name:         pulumi.String("string"),
	IsOutdated:   pulumi.Bool(false),
	ImageId:      pulumi.String("string"),
	NamePrefix:   pulumi.String("string"),
	NeedSlb:      pulumi.Bool(false),
	NodeNumber:   pulumi.Int(0),
	DiskSize:     pulumi.Int(0),
	ReleaseEip:   pulumi.Bool(false),
	DiskCategory: pulumi.String("string"),
})

var exampleclusterResourceResourceFromCscluster = new com.pulumi.alicloud.cs.Cluster("exampleclusterResourceResourceFromCscluster", com.pulumi.alicloud.cs.ClusterArgs.builder()
    .instanceType("string")
    .vswitchId("string")
    .password("string")
    .cidrBlock("string")
    .name("string")
    .isOutdated(false)
    .imageId("string")
    .namePrefix("string")
    .needSlb(false)
    .nodeNumber(0)
    .diskSize(0)
    .releaseEip(false)
    .diskCategory("string")
    .build());

examplecluster_resource_resource_from_cscluster = alicloud.cs.Cluster("exampleclusterResourceResourceFromCscluster",
    instance_type="string",
    vswitch_id="string",
    password="string",
    cidr_block="string",
    name="string",
    is_outdated=False,
    image_id="string",
    name_prefix="string",
    need_slb=False,
    node_number=0,
    disk_size=0,
    release_eip=False,
    disk_category="string")

const exampleclusterResourceResourceFromCscluster = new alicloud.cs.Cluster("exampleclusterResourceResourceFromCscluster", {
    instanceType: "string",
    vswitchId: "string",
    password: "string",
    cidrBlock: "string",
    name: "string",
    isOutdated: false,
    imageId: "string",
    namePrefix: "string",
    needSlb: false,
    nodeNumber: 0,
    diskSize: 0,
    releaseEip: false,
    diskCategory: "string",
});

type: alicloud:cs:Cluster
properties:
    cidrBlock: string
    diskCategory: string
    diskSize: 0
    imageId: string
    instanceType: string
    isOutdated: false
    name: string
    namePrefix: string
    needSlb: false
    nodeNumber: 0
    password: string
    releaseEip: false
    vswitchId: string

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Cluster resource accepts the following input properties:

CidrBlock string
InstanceType string
Password string
VswitchId string
DiskCategory string
DiskSize int
ImageId string
IsOutdated bool
Name string
NamePrefix string
NeedSlb bool
NodeNumber int
ReleaseEip bool
Size int: Deprecated: Field 'size' has been deprecated from provider version 1.9.1. New field 'node_number' replaces it.

CidrBlock string
InstanceType string
Password string
VswitchId string
DiskCategory string
DiskSize int
ImageId string
IsOutdated bool
Name string
NamePrefix string
NeedSlb bool
NodeNumber int
ReleaseEip bool
Size int: Deprecated: Field 'size' has been deprecated from provider version 1.9.1. New field 'node_number' replaces it.

cidrBlock String
instanceType String
password String
vswitchId String
diskCategory String
diskSize Integer
imageId String
isOutdated Boolean
name String
namePrefix String
needSlb Boolean
nodeNumber Integer
releaseEip Boolean
size Integer: Deprecated: Field 'size' has been deprecated from provider version 1.9.1. New field 'node_number' replaces it.

cidrBlock string
instanceType string
password string
vswitchId string
diskCategory string
diskSize number
imageId string
isOutdated boolean
name string
namePrefix string
needSlb boolean
nodeNumber number
releaseEip boolean
size number: Deprecated: Field 'size' has been deprecated from provider version 1.9.1. New field 'node_number' replaces it.

cidr_block str
instance_type str
password str
vswitch_id str
disk_category str
disk_size int
image_id str
is_outdated bool
name str
name_prefix str
need_slb bool
node_number int
release_eip bool
size int: Deprecated: Field 'size' has been deprecated from provider version 1.9.1. New field 'node_number' replaces it.

cidrBlock String
instanceType String
password String
vswitchId String
diskCategory String
diskSize Number
imageId String
isOutdated Boolean
name String
namePrefix String
needSlb Boolean
nodeNumber Number
releaseEip Boolean
size Number: Deprecated: Field 'size' has been deprecated from provider version 1.9.1. New field 'node_number' replaces it.

Outputs

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

AgentVersion string
Id string: The provider-assigned unique ID for this managed resource.
Nodes List<Pulumi.AliCloud.CS.Outputs.ClusterNode>
SecurityGroupId string
SlbId string
VpcId string

AgentVersion string
Id string: The provider-assigned unique ID for this managed resource.
Nodes []ClusterNode
SecurityGroupId string
SlbId string
VpcId string

agentVersion String
id String: The provider-assigned unique ID for this managed resource.
nodes List<ClusterNode>
securityGroupId String
slbId String
vpcId String

agentVersion string
id string: The provider-assigned unique ID for this managed resource.
nodes ClusterNode[]
securityGroupId string
slbId string
vpcId string

agent_version str
id str: The provider-assigned unique ID for this managed resource.
nodes Sequence[ClusterNode]
security_group_id str
slb_id str
vpc_id str

agentVersion String
id String: The provider-assigned unique ID for this managed resource.
nodes List<Property Map>
securityGroupId String
slbId String
vpcId 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,
        agent_version: Optional[str] = None,
        cidr_block: Optional[str] = None,
        disk_category: Optional[str] = None,
        disk_size: Optional[int] = None,
        image_id: Optional[str] = None,
        instance_type: Optional[str] = None,
        is_outdated: Optional[bool] = None,
        name: Optional[str] = None,
        name_prefix: Optional[str] = None,
        need_slb: Optional[bool] = None,
        node_number: Optional[int] = None,
        nodes: Optional[Sequence[ClusterNodeArgs]] = None,
        password: Optional[str] = None,
        release_eip: Optional[bool] = None,
        security_group_id: Optional[str] = None,
        size: Optional[int] = None,
        slb_id: Optional[str] = None,
        vpc_id: Optional[str] = None,
        vswitch_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)

resources:  _:    type: alicloud:cs:Cluster    get:      id: ${id}

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:

AgentVersion string
CidrBlock string
DiskCategory string
DiskSize int
ImageId string
InstanceType string
IsOutdated bool
Name string
NamePrefix string
NeedSlb bool
NodeNumber int
Nodes List<Pulumi.AliCloud.CS.Inputs.ClusterNode>
Password string
ReleaseEip bool
SecurityGroupId string
Size int: Deprecated: Field 'size' has been deprecated from provider version 1.9.1. New field 'node_number' replaces it.
SlbId string
VpcId string
VswitchId string

AgentVersion string
CidrBlock string
DiskCategory string
DiskSize int
ImageId string
InstanceType string
IsOutdated bool
Name string
NamePrefix string
NeedSlb bool
NodeNumber int
Nodes []ClusterNodeArgs
Password string
ReleaseEip bool
SecurityGroupId string
Size int: Deprecated: Field 'size' has been deprecated from provider version 1.9.1. New field 'node_number' replaces it.
SlbId string
VpcId string
VswitchId string

agentVersion String
cidrBlock String
diskCategory String
diskSize Integer
imageId String
instanceType String
isOutdated Boolean
name String
namePrefix String
needSlb Boolean
nodeNumber Integer
nodes List<ClusterNode>
password String
releaseEip Boolean
securityGroupId String
size Integer: Deprecated: Field 'size' has been deprecated from provider version 1.9.1. New field 'node_number' replaces it.
slbId String
vpcId String
vswitchId String

agentVersion string
cidrBlock string
diskCategory string
diskSize number
imageId string
instanceType string
isOutdated boolean
name string
namePrefix string
needSlb boolean
nodeNumber number
nodes ClusterNode[]
password string
releaseEip boolean
securityGroupId string
size number: Deprecated: Field 'size' has been deprecated from provider version 1.9.1. New field 'node_number' replaces it.
slbId string
vpcId string
vswitchId string

agent_version str
cidr_block str
disk_category str
disk_size int
image_id str
instance_type str
is_outdated bool
name str
name_prefix str
need_slb bool
node_number int
nodes Sequence[ClusterNodeArgs]
password str
release_eip bool
security_group_id str
size int: Deprecated: Field 'size' has been deprecated from provider version 1.9.1. New field 'node_number' replaces it.
slb_id str
vpc_id str
vswitch_id str

agentVersion String
cidrBlock String
diskCategory String
diskSize Number
imageId String
instanceType String
isOutdated Boolean
name String
namePrefix String
needSlb Boolean
nodeNumber Number
nodes List<Property Map>
password String
releaseEip Boolean
securityGroupId String
size Number: Deprecated: Field 'size' has been deprecated from provider version 1.9.1. New field 'node_number' replaces it.
slbId String
vpcId String
vswitchId String

Supporting Types

ClusterNode, ClusterNodeArgs

Eip string
Id string
Name string
PrivateIp string
Status string

Eip string
Id string
Name string
PrivateIp string
Status string

eip String
id String
name String
privateIp String
status String

eip string
id string
name string
privateIp string
status string

eip str
id str
name str
private_ip str
status str

eip String
id String
name String
privateIp String
status String

Package Details

Repository: Alibaba Cloud pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.

Alibaba Cloud v3.78.0 published on Friday, May 16, 2025 by Pulumi

pulumi/pulumi-alicloud

alicloud.cs.Cluster

On this page

On this page

Create Cluster Resource

Constructor syntax

Parameters

Constructor example

Cluster Resource Properties

Inputs

Outputs

Look up Existing Cluster Resource

Supporting Types

ClusterNode, ClusterNodeArgs

Package Details

On this page

On this page