ManagedEdgeKubernetesClusterProps
Properties for defining a ManagedEdgeKubernetesCluster.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-cs-managededgekubernetescluster
Initializer
import ros_cdk_cs
ros_cdk_cs.ManagedEdgeKubernetesClusterProps(
name: typing.Union[str, IResolvable],
num_of_nodes: typing.Union[typing.Union[int, float], IResolvable],
addons: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, AddonsProperty]]] = None,
auto_renew: typing.Union[bool, IResolvable] = None,
auto_renew_period: typing.Union[typing.Union[int, float], IResolvable] = None,
charge_type: typing.Union[str, IResolvable] = None,
cloud_monitor_flags: typing.Union[bool, IResolvable] = None,
cluster_spec: typing.Union[str, IResolvable] = None,
container_cidr: typing.Union[str, IResolvable] = None,
deletion_protection: typing.Union[bool, IResolvable] = None,
disable_rollback: typing.Union[bool, IResolvable] = None,
endpoint_public_access: typing.Union[bool, IResolvable] = None,
is_enterprise_security_group: typing.Union[bool, IResolvable] = None,
key_pair: typing.Union[str, IResolvable] = None,
login_password: typing.Union[str, IResolvable] = None,
node_cidr_mask: typing.Union[str, IResolvable] = None,
period: typing.Union[typing.Union[int, float], IResolvable] = None,
period_unit: typing.Union[str, IResolvable] = None,
profile: typing.Union[str, IResolvable] = None,
proxy_mode: typing.Union[str, IResolvable] = None,
resource_group_id: typing.Union[str, IResolvable] = None,
service_cidr: typing.Union[str, IResolvable] = None,
snat_entry: typing.Union[bool, IResolvable] = None,
tags: typing.List[TagsProperty] = None,
timeout_mins: typing.Union[typing.Union[int, float], IResolvable] = None,
vpc_id: typing.Union[str, IResolvable] = None,
v_switch_ids: typing.Union[typing.List[typing.Any], IResolvable] = None,
worker_data_disk: typing.Union[bool, IResolvable] = None,
worker_data_disk_category: typing.Union[str, IResolvable] = None,
worker_data_disks: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, WorkerDataDisksProperty]]] = None,
worker_data_disk_size: typing.Union[typing.Union[int, float], IResolvable] = None,
worker_instance_types: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
worker_system_disk_category: typing.Union[str, IResolvable] = None,
worker_system_disk_size: typing.Union[typing.Union[int, float], IResolvable] = None,
zone_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None
)
Properties
| Name | Type | Description |
|---|---|---|
name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property name: The name of the cluster. |
num_of_nodes |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
Property numOfNodes: Number of worker nodes. |
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. |
auto_renew |
typing.Union[bool, ros_cdk_core.IResolvable] |
Property autoRenew: Whether the cluster automatically renews. |
auto_renew_period |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
Property autoRenewPeriod: Automatic renewal cycle, which takes effect when prepaid and automatic renewal are selected, and is required: When PeriodUnit = Week, the values are: {"1", "2", "3"} When PeriodUnit = Month, the value is {"1", "2", "3", "6", "12"} Default to 1. |
charge_type |
typing.Union[str, ros_cdk_core.IResolvable] |
Property chargeType: cluster payment type. |
cloud_monitor_flags |
typing.Union[bool, ros_cdk_core.IResolvable] |
Property cloudMonitorFlags: Whether to install the cloud monitoring plugin: true: indicates installation false: Do not install Default to false. |
cluster_spec |
typing.Union[str, ros_cdk_core.IResolvable] |
Property clusterSpec: The edge managed cluster spec. |
container_cidr |
typing.Union[str, ros_cdk_core.IResolvable] |
Property containerCidr: The container network segment cannot conflict with the VPC network segment. |
deletion_protection |
typing.Union[bool, ros_cdk_core.IResolvable] |
Property deletionProtection: Specifies whether to enable deletion protection for the cluster. |
disable_rollback |
typing.Union[bool, ros_cdk_core.IResolvable] |
Property disableRollback: Whether the failure was rolled back: true: indicates that it fails to roll back false: rollback failed The default is true. |
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. |
is_enterprise_security_group |
typing.Union[bool, ros_cdk_core.IResolvable] |
Property isEnterpriseSecurityGroup: Specifies whether to create an advanced security group. |
key_pair |
typing.Union[str, ros_cdk_core.IResolvable] |
Property keyPair: Key pair name. |
login_password |
typing.Union[str, ros_cdk_core.IResolvable] |
Property loginPassword: SSH login password. |
node_cidr_mask |
typing.Union[str, ros_cdk_core.IResolvable] |
Property nodeCidrMask: The maximum number of IP addresses that can be assigned to nodes. |
period |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
Property period: The duration of the annual subscription and monthly subscription. |
period_unit |
typing.Union[str, ros_cdk_core.IResolvable] |
Property periodUnit: When you specify PrePaid, you need to specify the period. |
profile |
typing.Union[str, ros_cdk_core.IResolvable] |
Property profile: Edge cluster ID. |
proxy_mode |
typing.Union[str, ros_cdk_core.IResolvable] |
Property proxyMode: kube-proxy proxy mode, supports both iptables and ipvs modes. |
resource_group_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property resourceGroupId: The ID of resource group. |
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. |
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. |
timeout_mins |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
Property timeoutMins: Cluster resource stack creation timeout, in minutes. |
vpc_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property vpcId: VPC ID. |
v_switch_ids |
typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable] |
Property vSwitchIds: The virtual switch ID of the worker node. |
worker_data_disk |
typing.Union[bool, ros_cdk_core.IResolvable] |
Property workerDataDisk: Whether to mount the data disk. |
worker_data_disk_category |
typing.Union[str, ros_cdk_core.IResolvable] |
Property workerDataDiskCategory: Data disk type. |
worker_data_disks |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, WorkerDataDisksProperty]]] |
Property workerDataDisks: A combination of configurations such as worker data disk type and size. |
worker_data_disk_size |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
Property workerDataDiskSize: Data disk size in GiB. |
worker_instance_types |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] |
Property workerInstanceTypes: Worker node ECS specification type code. |
worker_system_disk_category |
typing.Union[str, ros_cdk_core.IResolvable] |
Property workerSystemDiskCategory: Worker node system disk type. |
worker_system_disk_size |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
Property workerSystemDiskSize: Worker disk system disk size, the unit is GiB. |
zone_ids |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] |
Property zoneIds: Zone ids of worker node virtual switches belongs to. |
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.
num_of_nodesRequired
num_of_nodes: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property numOfNodes: Number of worker nodes.
The range is [0,300]
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.
auto_renewOptional
auto_renew: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property autoRenew: Whether the cluster automatically renews.
It takes effect when the value of ChargeType is PrePaid. The optional values are: true: automatic renewal false: do not renew automatically Default to true.
auto_renew_periodOptional
auto_renew_period: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property autoRenewPeriod: Automatic renewal cycle, which takes effect when prepaid and automatic renewal are selected, and is required: When PeriodUnit = Week, the values are: {"1", "2", "3"} When PeriodUnit = Month, the value is {"1", "2", "3", "6", "12"} Default to 1.
charge_typeOptional
charge_type: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property chargeType: cluster payment type.
The optional values are: PrePaid: prepaid PostPaid: Pay as you go Default to PostPaid.
cloud_monitor_flagsOptional
cloud_monitor_flags: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property cloudMonitorFlags: Whether to install the cloud monitoring plugin: true: indicates installation false: Do not install Default to false.
cluster_specOptional
cluster_spec: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property clusterSpec: The edge managed cluster spec.
Value: ack.pro.small: Professional hosting cluster, namely: "ACK Pro version cluster". ack.standard: Standard hosting cluster. Default value: ack.standard. The value can be empty. When it is empty, a standard managed cluster will be created.
container_cidrOptional
container_cidr: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property containerCidr: The container network segment cannot conflict with the VPC network segment.
When the system is selected to automatically create a VPC, the network segment 172.16.0.0/16 is used by default.
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.
disable_rollbackOptional
disable_rollback: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property disableRollback: Whether the failure was rolled back: true: indicates that it fails to roll back false: rollback failed The default is true.
If rollback fails, resources produced during the creation process will be released. False is not recommended.
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 to true.
is_enterprise_security_groupOptional
is_enterprise_security_group: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property isEnterpriseSecurityGroup: Specifies whether to create an advanced security group.
This parameter takes effect only if security_group_id is left empty. Note You must specify an advanced security group for a cluster that has Terway installed. true: creates an advanced security group. false: does not create an advanced security group. Default value: false.
key_pairOptional
key_pair: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property keyPair: Key pair name.
Specify one of KeyPair or LoginPassword.
login_passwordOptional
login_password: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property loginPassword: SSH login password.
Password rules are 8-30 characters and contain three items (upper and lower case letters, numbers, and special symbols). Specify one of KeyPair or LoginPassword.
node_cidr_maskOptional
node_cidr_mask: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property nodeCidrMask: The maximum number of IP addresses that can be assigned to nodes.
This number is determined by the specified pod CIDR block. This parameter takes effect only if the cluster uses the Flannel plug-in.Default value: 25.
periodOptional
period: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property period: The duration of the annual subscription and monthly subscription.
It takes effect when the ChargeType value is PrePaid and is a required value. The value range is: When PeriodUnit = Week, Period values are: {"1", "2", "3", "4"} When PeriodUnit = Month, Period values are: {"1", "2", "3", "4", "5", "6", "7", "8", "9", "12", "24", "36", "48", "60"} When PeriodUnit = Year, Period values are: {"1", "2", "3", "4", "5"} Default to 1.
period_unitOptional
period_unit: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property periodUnit: When you specify PrePaid, you need to specify the period.
The options are: Week: Time is measured in weeks Month: time in months Year: time in years Default to Month
profileOptional
profile: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property profile: Edge cluster ID.
The default value is Edge.
proxy_modeOptional
proxy_mode: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property proxyMode: kube-proxy proxy mode, supports both iptables and ipvs modes.
The default is iptables.
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.
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.
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]
- Type: typing.List[TagsProperty]
Property tags: Tag the cluster.
timeout_minsOptional
timeout_mins: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property timeoutMins: Cluster resource stack creation timeout, in minutes.
The default value is 60.
vpc_idOptional
vpc_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property vpcId: VPC ID.
If not set, the system will automatically create a VPC, and the VPC network segment created by the system is 192.168.0.0/16. VpcId and VSwitchId can only be empty at the same time or set the corresponding values at the same time.
v_switch_idsOptional
v_switch_ids: typing.Union[typing.List[typing.Any], IResolvable]
- Type: typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable]
Property vSwitchIds: The virtual switch ID of the worker node.
worker_data_diskOptional
worker_data_disk: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property workerDataDisk: Whether to mount the data disk.
The options are as follows: true: indicates that the worker node mounts data disks. false: indicates that the worker node does not mount data disks. Default to false.
worker_data_disk_categoryOptional
worker_data_disk_category: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property workerDataDiskCategory: Data disk type.
worker_data_disksOptional
worker_data_disks: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, WorkerDataDisksProperty]]]
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, WorkerDataDisksProperty]]]
Property workerDataDisks: A combination of configurations such as worker data disk type and size.
This parameter is valid only when the worker node data disk is mounted.
worker_data_disk_sizeOptional
worker_data_disk_size: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property workerDataDiskSize: Data disk size in GiB.
worker_instance_typesOptional
worker_instance_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 workerInstanceTypes: Worker node ECS specification type code.
For more details, see Instance Specification Family.
worker_system_disk_categoryOptional
worker_system_disk_category: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property workerSystemDiskCategory: Worker node system disk type.
Default to cloud_efficiency.
worker_system_disk_sizeOptional
worker_system_disk_size: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property workerSystemDiskSize: Worker disk system disk size, the unit is GiB.
Default to 120.
zone_idsOptional
zone_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 zoneIds: Zone ids of worker node virtual switches belongs to.