Skip to content

ASKClusterProps

Properties for defining a ASKCluster.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-cs-askcluster

Initializer 

import ros_cdk_cs
ros_cdk_cs.ASKClusterProps(
  name: typing.Union[str, IResolvable],
  addons: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, AddonsProperty]]] = None,
  cluster_spec: typing.Union[str, IResolvable] = None,
  deletion_protection: typing.Union[bool, IResolvable] = None,
  endpoint_public_access: typing.Union[bool, IResolvable] = None,
  kubernetes_version: typing.Union[str, IResolvable] = None,
  private_zone: typing.Union[bool, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  security_group_id: typing.Union[str, IResolvable] = None,
  service_cidr: typing.Union[str, IResolvable] = None,
  service_discovery_types: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  snat_entry: typing.Union[bool, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  time_zone: typing.Union[str, IResolvable] = None,
  vpc_id: typing.Union[str, IResolvable] = None,
  v_switch_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  zone_id: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
name typing.Union[str, ros_cdk_core.IResolvable] Property name: The name of the cluster.
addons typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, AddonsProperty]]] Property addons: The add-ons to be installed for the cluster.
cluster_spec typing.Union[str, ros_cdk_core.IResolvable] Property clusterSpec: The managed cluster spec.
deletion_protection typing.Union[bool, ros_cdk_core.IResolvable] Property deletionProtection: Specifies whether to enable deletion protection for the cluster.
endpoint_public_access typing.Union[bool, ros_cdk_core.IResolvable] Property endpointPublicAccess: Whether to enable the public network API Server: true: which means that the public network API Server is open.
kubernetes_version typing.Union[str, ros_cdk_core.IResolvable] Property kubernetesVersion: The version of the Kubernetes cluster.
private_zone typing.Union[bool, ros_cdk_core.IResolvable] Property privateZone: Whether to enable PrivateZone for service discovery.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of resource group.
security_group_id typing.Union[str, ros_cdk_core.IResolvable] Property securityGroupId: Specifies the ID of the security group to which the cluster ECS instance belongs.
service_cidr typing.Union[str, ros_cdk_core.IResolvable] Property serviceCidr: The service network segment cannot conflict with the VPC network segment and the container network segment.
service_discovery_types typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property serviceDiscoveryTypes: Intra-cluster service discovery type, used to specify the service discovery method in the ASK cluster.
snat_entry typing.Union[bool, ros_cdk_core.IResolvable] Property snatEntry: Whether to configure SNAT for the network.
tags typing.List[TagsProperty] Property tags: Tag the cluster.
time_zone typing.Union[str, ros_cdk_core.IResolvable] Property timeZone: The time zone used by the cluster..
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: VPC ID.
v_switch_ids typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property vSwitchIds: The IDs of VSwitches.
zone_id typing.Union[str, ros_cdk_core.IResolvable] Property zoneId: The zone ID.

nameRequired 

name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property name: The name of the cluster.

The cluster name can use uppercase and lowercase letters, Chinese characters, numbers, and dashes.

addonsOptional 

addons: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, AddonsProperty]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, AddonsProperty]]]

Property addons: The add-ons to be installed for the cluster.

cluster_specOptional 

cluster_spec: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property clusterSpec: The managed cluster spec.

Value: ack.pro.small: Professional hosting cluster, namely: "ACK Pro version cluster". ack.standard: Standard hosting cluster. Default value: ack.pro.small.

deletion_protectionOptional 

deletion_protection: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property deletionProtection: Specifies whether to enable deletion protection for the cluster.

After deletion protection is enabled, the cluster cannot be deleted in the ACK console or by calling API operations. Valid values:true: enables deletion protection for the cluster. false: disables deletion protection for the cluster. Default value: false.

endpoint_public_accessOptional 

endpoint_public_access: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property endpointPublicAccess: Whether to enable the public network API Server: true: which means that the public network API Server is open.

false: If set to false, the API server on the public network will not be created, only the API server on the private network will be created.Default value: true.

kubernetes_versionOptional 

kubernetes_version: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property kubernetesVersion: The version of the Kubernetes cluster.

private_zoneOptional 

private_zone: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property privateZone: Whether to enable PrivateZone for service discovery.

resource_group_idOptional 

resource_group_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property resourceGroupId: The ID of resource group.

security_group_idOptional 

security_group_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property securityGroupId: Specifies the ID of the security group to which the cluster ECS instance belongs.

service_cidrOptional 

service_cidr: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property serviceCidr: The service network segment cannot conflict with the VPC network segment and the container network segment.

When the system is selected to automatically create a VPC, the network segment 172.19.0.0/20 is used by default.

service_discovery_typesOptional 

service_discovery_types: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

Property serviceDiscoveryTypes: Intra-cluster service discovery type, used to specify the service discovery method in the ASK cluster.

CoreDNS: To use Kubernetes native standard service discovery component CoreDNS, a set of containers needs to be deployed in the cluster for DNS resolution. By default, two ECI instances with a size of 0.25 Core and 512 MiB are used. PrivateZone: To use Alibaba Cloud PrivateZone products to provide service discovery capabilities, the PrivateZone service needs to be enabled. Default value: off

snat_entryOptional 

snat_entry: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property snatEntry: Whether to configure SNAT for the network.

When a VPC can access the public network environment, set it to false. When an existing VPC cannot access the public network environment: When set to True, SNAT is configured and the public network environment can be accessed at this time. If set to false, it means that SNAT is not configured and the public network environment cannot be accessed at this time. Default to true.

tagsOptional 

tags: typing.List[TagsProperty]

Property tags: Tag the cluster.

time_zoneOptional 

time_zone: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property timeZone: The time zone used by the cluster..

vpc_idOptional 

vpc_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vpcId: VPC ID.

v_switch_idsOptional 

v_switch_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

Property vSwitchIds: The IDs of VSwitches.

If you leave this property empty, the system automatically creates a VSwitch. Note You must specify both the VpcId and VSwitchIds or leave both of them empty.

zone_idOptional 

zone_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property zoneId: The zone ID.