alicloud.cs.NodePool
Explore with Pulumi AI
Example Usage
Basic Usage
Create NodePool Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new NodePool(name: string, args: NodePoolArgs, opts?: CustomResourceOptions);
@overload
def NodePool(resource_name: str,
args: NodePoolArgs,
opts: Optional[ResourceOptions] = None)
@overload
def NodePool(resource_name: str,
opts: Optional[ResourceOptions] = None,
cluster_id: Optional[str] = None,
instance_types: Optional[Sequence[str]] = None,
vswitch_ids: Optional[Sequence[str]] = None,
auto_renew: Optional[bool] = None,
auto_renew_period: Optional[int] = None,
cis_enabled: Optional[bool] = None,
compensate_with_on_demand: Optional[bool] = None,
cpu_policy: Optional[str] = None,
data_disks: Optional[Sequence[NodePoolDataDiskArgs]] = None,
deployment_set_id: Optional[str] = None,
desired_size: Optional[int] = None,
force_delete: Optional[bool] = None,
format_disk: Optional[bool] = None,
image_id: Optional[str] = None,
image_type: Optional[str] = None,
install_cloud_monitor: Optional[bool] = None,
instance_charge_type: Optional[str] = None,
instances: Optional[Sequence[str]] = None,
internet_charge_type: Optional[str] = None,
internet_max_bandwidth_out: Optional[int] = None,
keep_instance_name: Optional[bool] = None,
key_name: Optional[str] = None,
kms_encrypted_password: Optional[str] = None,
kms_encryption_context: Optional[Mapping[str, str]] = None,
kubelet_configuration: Optional[NodePoolKubeletConfigurationArgs] = None,
labels: Optional[Sequence[NodePoolLabelArgs]] = None,
login_as_non_root: Optional[bool] = None,
management: Optional[NodePoolManagementArgs] = None,
multi_az_policy: Optional[str] = None,
name: Optional[str] = None,
node_count: Optional[int] = None,
node_name_mode: Optional[str] = None,
node_pool_name: Optional[str] = None,
on_demand_base_capacity: Optional[int] = None,
on_demand_percentage_above_base_capacity: Optional[int] = None,
password: Optional[str] = None,
period: Optional[int] = None,
period_unit: Optional[str] = None,
platform: Optional[str] = None,
pre_user_data: Optional[str] = None,
private_pool_options: Optional[NodePoolPrivatePoolOptionsArgs] = None,
rds_instances: Optional[Sequence[str]] = None,
resource_group_id: Optional[str] = None,
rolling_policy: Optional[NodePoolRollingPolicyArgs] = None,
runtime_name: Optional[str] = None,
runtime_version: Optional[str] = None,
scaling_config: Optional[NodePoolScalingConfigArgs] = None,
scaling_policy: Optional[str] = None,
security_group_id: Optional[str] = None,
security_group_ids: Optional[Sequence[str]] = None,
security_hardening_os: Optional[bool] = None,
soc_enabled: Optional[bool] = None,
spot_instance_pools: Optional[int] = None,
spot_instance_remedy: Optional[bool] = None,
spot_price_limits: Optional[Sequence[NodePoolSpotPriceLimitArgs]] = None,
spot_strategy: Optional[str] = None,
system_disk_bursting_enabled: Optional[bool] = None,
system_disk_categories: Optional[Sequence[str]] = None,
system_disk_category: Optional[str] = None,
system_disk_encrypt_algorithm: Optional[str] = None,
system_disk_encrypted: Optional[bool] = None,
system_disk_kms_key: Optional[str] = None,
system_disk_performance_level: Optional[str] = None,
system_disk_provisioned_iops: Optional[int] = None,
system_disk_size: Optional[int] = None,
system_disk_snapshot_policy_id: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
taints: Optional[Sequence[NodePoolTaintArgs]] = None,
tee_config: Optional[NodePoolTeeConfigArgs] = None,
unschedulable: Optional[bool] = None,
update_nodes: Optional[bool] = None,
user_data: Optional[str] = None)
func NewNodePool(ctx *Context, name string, args NodePoolArgs, opts ...ResourceOption) (*NodePool, error)
public NodePool(string name, NodePoolArgs args, CustomResourceOptions? opts = null)
public NodePool(String name, NodePoolArgs args)
public NodePool(String name, NodePoolArgs args, CustomResourceOptions options)
type: alicloud:cs:NodePool
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 NodePoolArgs
- 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 NodePoolArgs
- 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 NodePoolArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args NodePoolArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args NodePoolArgs
- 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 nodePoolResource = new AliCloud.CS.NodePool("nodePoolResource", new()
{
ClusterId = "string",
InstanceTypes = new[]
{
"string",
},
VswitchIds = new[]
{
"string",
},
AutoRenew = false,
AutoRenewPeriod = 0,
CompensateWithOnDemand = false,
CpuPolicy = "string",
DataDisks = new[]
{
new AliCloud.CS.Inputs.NodePoolDataDiskArgs
{
AutoFormat = "string",
AutoSnapshotPolicyId = "string",
BurstingEnabled = false,
Category = "string",
Device = "string",
Encrypted = "string",
FileSystem = "string",
KmsKeyId = "string",
MountTarget = "string",
Name = "string",
PerformanceLevel = "string",
ProvisionedIops = 0,
Size = 0,
SnapshotId = "string",
},
},
DeploymentSetId = "string",
DesiredSize = 0,
ForceDelete = false,
FormatDisk = false,
ImageId = "string",
ImageType = "string",
InstallCloudMonitor = false,
InstanceChargeType = "string",
Instances = new[]
{
"string",
},
InternetChargeType = "string",
InternetMaxBandwidthOut = 0,
KeepInstanceName = false,
KeyName = "string",
KmsEncryptedPassword = "string",
KmsEncryptionContext =
{
{ "string", "string" },
},
KubeletConfiguration = new AliCloud.CS.Inputs.NodePoolKubeletConfigurationArgs
{
AllowedUnsafeSysctls = new[]
{
"string",
},
ContainerLogMaxFiles = "string",
ContainerLogMaxSize = "string",
CpuManagerPolicy = "string",
EventBurst = "string",
EventRecordQps = "string",
EvictionHard =
{
{ "string", "string" },
},
EvictionSoft =
{
{ "string", "string" },
},
EvictionSoftGracePeriod =
{
{ "string", "string" },
},
FeatureGates =
{
{ "string", false },
},
KubeApiBurst = "string",
KubeApiQps = "string",
KubeReserved =
{
{ "string", "string" },
},
MaxPods = "string",
ReadOnlyPort = "string",
RegistryBurst = "string",
RegistryPullQps = "string",
SerializeImagePulls = "string",
SystemReserved =
{
{ "string", "string" },
},
},
Labels = new[]
{
new AliCloud.CS.Inputs.NodePoolLabelArgs
{
Key = "string",
Value = "string",
},
},
LoginAsNonRoot = false,
Management = new AliCloud.CS.Inputs.NodePoolManagementArgs
{
AutoRepair = false,
AutoRepairPolicy = new AliCloud.CS.Inputs.NodePoolManagementAutoRepairPolicyArgs
{
RestartNode = false,
},
AutoUpgrade = false,
AutoUpgradePolicy = new AliCloud.CS.Inputs.NodePoolManagementAutoUpgradePolicyArgs
{
AutoUpgradeKubelet = false,
},
AutoVulFix = false,
AutoVulFixPolicy = new AliCloud.CS.Inputs.NodePoolManagementAutoVulFixPolicyArgs
{
RestartNode = false,
VulLevel = "string",
},
Enable = false,
MaxUnavailable = 0,
},
MultiAzPolicy = "string",
NodeNameMode = "string",
NodePoolName = "string",
OnDemandBaseCapacity = 0,
OnDemandPercentageAboveBaseCapacity = 0,
Password = "string",
Period = 0,
PeriodUnit = "string",
PreUserData = "string",
PrivatePoolOptions = new AliCloud.CS.Inputs.NodePoolPrivatePoolOptionsArgs
{
PrivatePoolOptionsId = "string",
PrivatePoolOptionsMatchCriteria = "string",
},
RdsInstances = new[]
{
"string",
},
ResourceGroupId = "string",
RollingPolicy = new AliCloud.CS.Inputs.NodePoolRollingPolicyArgs
{
MaxParallelism = 0,
},
RuntimeName = "string",
RuntimeVersion = "string",
ScalingConfig = new AliCloud.CS.Inputs.NodePoolScalingConfigArgs
{
EipBandwidth = 0,
EipInternetChargeType = "string",
Enable = false,
IsBondEip = false,
MaxSize = 0,
MinSize = 0,
Type = "string",
},
ScalingPolicy = "string",
SecurityGroupIds = new[]
{
"string",
},
SecurityHardeningOs = false,
SocEnabled = false,
SpotInstancePools = 0,
SpotInstanceRemedy = false,
SpotPriceLimits = new[]
{
new AliCloud.CS.Inputs.NodePoolSpotPriceLimitArgs
{
InstanceType = "string",
PriceLimit = "string",
},
},
SpotStrategy = "string",
SystemDiskBurstingEnabled = false,
SystemDiskCategories = new[]
{
"string",
},
SystemDiskCategory = "string",
SystemDiskEncryptAlgorithm = "string",
SystemDiskEncrypted = false,
SystemDiskKmsKey = "string",
SystemDiskPerformanceLevel = "string",
SystemDiskProvisionedIops = 0,
SystemDiskSize = 0,
SystemDiskSnapshotPolicyId = "string",
Tags =
{
{ "string", "string" },
},
Taints = new[]
{
new AliCloud.CS.Inputs.NodePoolTaintArgs
{
Key = "string",
Effect = "string",
Value = "string",
},
},
TeeConfig = new AliCloud.CS.Inputs.NodePoolTeeConfigArgs
{
TeeEnable = false,
},
Unschedulable = false,
UpdateNodes = false,
UserData = "string",
});
example, err := cs.NewNodePool(ctx, "nodePoolResource", &cs.NodePoolArgs{
ClusterId: pulumi.String("string"),
InstanceTypes: pulumi.StringArray{
pulumi.String("string"),
},
VswitchIds: pulumi.StringArray{
pulumi.String("string"),
},
AutoRenew: pulumi.Bool(false),
AutoRenewPeriod: pulumi.Int(0),
CompensateWithOnDemand: pulumi.Bool(false),
CpuPolicy: pulumi.String("string"),
DataDisks: cs.NodePoolDataDiskArray{
&cs.NodePoolDataDiskArgs{
AutoFormat: pulumi.String("string"),
AutoSnapshotPolicyId: pulumi.String("string"),
BurstingEnabled: pulumi.Bool(false),
Category: pulumi.String("string"),
Device: pulumi.String("string"),
Encrypted: pulumi.String("string"),
FileSystem: pulumi.String("string"),
KmsKeyId: pulumi.String("string"),
MountTarget: pulumi.String("string"),
Name: pulumi.String("string"),
PerformanceLevel: pulumi.String("string"),
ProvisionedIops: pulumi.Int(0),
Size: pulumi.Int(0),
SnapshotId: pulumi.String("string"),
},
},
DeploymentSetId: pulumi.String("string"),
DesiredSize: pulumi.Int(0),
ForceDelete: pulumi.Bool(false),
FormatDisk: pulumi.Bool(false),
ImageId: pulumi.String("string"),
ImageType: pulumi.String("string"),
InstallCloudMonitor: pulumi.Bool(false),
InstanceChargeType: pulumi.String("string"),
Instances: pulumi.StringArray{
pulumi.String("string"),
},
InternetChargeType: pulumi.String("string"),
InternetMaxBandwidthOut: pulumi.Int(0),
KeepInstanceName: pulumi.Bool(false),
KeyName: pulumi.String("string"),
KmsEncryptedPassword: pulumi.String("string"),
KmsEncryptionContext: pulumi.StringMap{
"string": pulumi.String("string"),
},
KubeletConfiguration: &cs.NodePoolKubeletConfigurationArgs{
AllowedUnsafeSysctls: pulumi.StringArray{
pulumi.String("string"),
},
ContainerLogMaxFiles: pulumi.String("string"),
ContainerLogMaxSize: pulumi.String("string"),
CpuManagerPolicy: pulumi.String("string"),
EventBurst: pulumi.String("string"),
EventRecordQps: pulumi.String("string"),
EvictionHard: pulumi.StringMap{
"string": pulumi.String("string"),
},
EvictionSoft: pulumi.StringMap{
"string": pulumi.String("string"),
},
EvictionSoftGracePeriod: pulumi.StringMap{
"string": pulumi.String("string"),
},
FeatureGates: pulumi.BoolMap{
"string": pulumi.Bool(false),
},
KubeApiBurst: pulumi.String("string"),
KubeApiQps: pulumi.String("string"),
KubeReserved: pulumi.StringMap{
"string": pulumi.String("string"),
},
MaxPods: pulumi.String("string"),
ReadOnlyPort: pulumi.String("string"),
RegistryBurst: pulumi.String("string"),
RegistryPullQps: pulumi.String("string"),
SerializeImagePulls: pulumi.String("string"),
SystemReserved: pulumi.StringMap{
"string": pulumi.String("string"),
},
},
Labels: cs.NodePoolLabelArray{
&cs.NodePoolLabelArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
LoginAsNonRoot: pulumi.Bool(false),
Management: &cs.NodePoolManagementArgs{
AutoRepair: pulumi.Bool(false),
AutoRepairPolicy: &cs.NodePoolManagementAutoRepairPolicyArgs{
RestartNode: pulumi.Bool(false),
},
AutoUpgrade: pulumi.Bool(false),
AutoUpgradePolicy: &cs.NodePoolManagementAutoUpgradePolicyArgs{
AutoUpgradeKubelet: pulumi.Bool(false),
},
AutoVulFix: pulumi.Bool(false),
AutoVulFixPolicy: &cs.NodePoolManagementAutoVulFixPolicyArgs{
RestartNode: pulumi.Bool(false),
VulLevel: pulumi.String("string"),
},
Enable: pulumi.Bool(false),
MaxUnavailable: pulumi.Int(0),
},
MultiAzPolicy: pulumi.String("string"),
NodeNameMode: pulumi.String("string"),
NodePoolName: pulumi.String("string"),
OnDemandBaseCapacity: pulumi.Int(0),
OnDemandPercentageAboveBaseCapacity: pulumi.Int(0),
Password: pulumi.String("string"),
Period: pulumi.Int(0),
PeriodUnit: pulumi.String("string"),
PreUserData: pulumi.String("string"),
PrivatePoolOptions: &cs.NodePoolPrivatePoolOptionsArgs{
PrivatePoolOptionsId: pulumi.String("string"),
PrivatePoolOptionsMatchCriteria: pulumi.String("string"),
},
RdsInstances: pulumi.StringArray{
pulumi.String("string"),
},
ResourceGroupId: pulumi.String("string"),
RollingPolicy: &cs.NodePoolRollingPolicyArgs{
MaxParallelism: pulumi.Int(0),
},
RuntimeName: pulumi.String("string"),
RuntimeVersion: pulumi.String("string"),
ScalingConfig: &cs.NodePoolScalingConfigArgs{
EipBandwidth: pulumi.Int(0),
EipInternetChargeType: pulumi.String("string"),
Enable: pulumi.Bool(false),
IsBondEip: pulumi.Bool(false),
MaxSize: pulumi.Int(0),
MinSize: pulumi.Int(0),
Type: pulumi.String("string"),
},
ScalingPolicy: pulumi.String("string"),
SecurityGroupIds: pulumi.StringArray{
pulumi.String("string"),
},
SecurityHardeningOs: pulumi.Bool(false),
SocEnabled: pulumi.Bool(false),
SpotInstancePools: pulumi.Int(0),
SpotInstanceRemedy: pulumi.Bool(false),
SpotPriceLimits: cs.NodePoolSpotPriceLimitArray{
&cs.NodePoolSpotPriceLimitArgs{
InstanceType: pulumi.String("string"),
PriceLimit: pulumi.String("string"),
},
},
SpotStrategy: pulumi.String("string"),
SystemDiskBurstingEnabled: pulumi.Bool(false),
SystemDiskCategories: pulumi.StringArray{
pulumi.String("string"),
},
SystemDiskCategory: pulumi.String("string"),
SystemDiskEncryptAlgorithm: pulumi.String("string"),
SystemDiskEncrypted: pulumi.Bool(false),
SystemDiskKmsKey: pulumi.String("string"),
SystemDiskPerformanceLevel: pulumi.String("string"),
SystemDiskProvisionedIops: pulumi.Int(0),
SystemDiskSize: pulumi.Int(0),
SystemDiskSnapshotPolicyId: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Taints: cs.NodePoolTaintArray{
&cs.NodePoolTaintArgs{
Key: pulumi.String("string"),
Effect: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
TeeConfig: &cs.NodePoolTeeConfigArgs{
TeeEnable: pulumi.Bool(false),
},
Unschedulable: pulumi.Bool(false),
UpdateNodes: pulumi.Bool(false),
UserData: pulumi.String("string"),
})
var nodePoolResource = new NodePool("nodePoolResource", NodePoolArgs.builder()
.clusterId("string")
.instanceTypes("string")
.vswitchIds("string")
.autoRenew(false)
.autoRenewPeriod(0)
.compensateWithOnDemand(false)
.cpuPolicy("string")
.dataDisks(NodePoolDataDiskArgs.builder()
.autoFormat("string")
.autoSnapshotPolicyId("string")
.burstingEnabled(false)
.category("string")
.device("string")
.encrypted("string")
.fileSystem("string")
.kmsKeyId("string")
.mountTarget("string")
.name("string")
.performanceLevel("string")
.provisionedIops(0)
.size(0)
.snapshotId("string")
.build())
.deploymentSetId("string")
.desiredSize(0)
.forceDelete(false)
.formatDisk(false)
.imageId("string")
.imageType("string")
.installCloudMonitor(false)
.instanceChargeType("string")
.instances("string")
.internetChargeType("string")
.internetMaxBandwidthOut(0)
.keepInstanceName(false)
.keyName("string")
.kmsEncryptedPassword("string")
.kmsEncryptionContext(Map.of("string", "string"))
.kubeletConfiguration(NodePoolKubeletConfigurationArgs.builder()
.allowedUnsafeSysctls("string")
.containerLogMaxFiles("string")
.containerLogMaxSize("string")
.cpuManagerPolicy("string")
.eventBurst("string")
.eventRecordQps("string")
.evictionHard(Map.of("string", "string"))
.evictionSoft(Map.of("string", "string"))
.evictionSoftGracePeriod(Map.of("string", "string"))
.featureGates(Map.of("string", false))
.kubeApiBurst("string")
.kubeApiQps("string")
.kubeReserved(Map.of("string", "string"))
.maxPods("string")
.readOnlyPort("string")
.registryBurst("string")
.registryPullQps("string")
.serializeImagePulls("string")
.systemReserved(Map.of("string", "string"))
.build())
.labels(NodePoolLabelArgs.builder()
.key("string")
.value("string")
.build())
.loginAsNonRoot(false)
.management(NodePoolManagementArgs.builder()
.autoRepair(false)
.autoRepairPolicy(NodePoolManagementAutoRepairPolicyArgs.builder()
.restartNode(false)
.build())
.autoUpgrade(false)
.autoUpgradePolicy(NodePoolManagementAutoUpgradePolicyArgs.builder()
.autoUpgradeKubelet(false)
.build())
.autoVulFix(false)
.autoVulFixPolicy(NodePoolManagementAutoVulFixPolicyArgs.builder()
.restartNode(false)
.vulLevel("string")
.build())
.enable(false)
.maxUnavailable(0)
.build())
.multiAzPolicy("string")
.nodeNameMode("string")
.nodePoolName("string")
.onDemandBaseCapacity(0)
.onDemandPercentageAboveBaseCapacity(0)
.password("string")
.period(0)
.periodUnit("string")
.preUserData("string")
.privatePoolOptions(NodePoolPrivatePoolOptionsArgs.builder()
.privatePoolOptionsId("string")
.privatePoolOptionsMatchCriteria("string")
.build())
.rdsInstances("string")
.resourceGroupId("string")
.rollingPolicy(NodePoolRollingPolicyArgs.builder()
.maxParallelism(0)
.build())
.runtimeName("string")
.runtimeVersion("string")
.scalingConfig(NodePoolScalingConfigArgs.builder()
.eipBandwidth(0)
.eipInternetChargeType("string")
.enable(false)
.isBondEip(false)
.maxSize(0)
.minSize(0)
.type("string")
.build())
.scalingPolicy("string")
.securityGroupIds("string")
.securityHardeningOs(false)
.socEnabled(false)
.spotInstancePools(0)
.spotInstanceRemedy(false)
.spotPriceLimits(NodePoolSpotPriceLimitArgs.builder()
.instanceType("string")
.priceLimit("string")
.build())
.spotStrategy("string")
.systemDiskBurstingEnabled(false)
.systemDiskCategories("string")
.systemDiskCategory("string")
.systemDiskEncryptAlgorithm("string")
.systemDiskEncrypted(false)
.systemDiskKmsKey("string")
.systemDiskPerformanceLevel("string")
.systemDiskProvisionedIops(0)
.systemDiskSize(0)
.systemDiskSnapshotPolicyId("string")
.tags(Map.of("string", "string"))
.taints(NodePoolTaintArgs.builder()
.key("string")
.effect("string")
.value("string")
.build())
.teeConfig(NodePoolTeeConfigArgs.builder()
.teeEnable(false)
.build())
.unschedulable(false)
.updateNodes(false)
.userData("string")
.build());
node_pool_resource = alicloud.cs.NodePool("nodePoolResource",
cluster_id="string",
instance_types=["string"],
vswitch_ids=["string"],
auto_renew=False,
auto_renew_period=0,
compensate_with_on_demand=False,
cpu_policy="string",
data_disks=[{
"auto_format": "string",
"auto_snapshot_policy_id": "string",
"bursting_enabled": False,
"category": "string",
"device": "string",
"encrypted": "string",
"file_system": "string",
"kms_key_id": "string",
"mount_target": "string",
"name": "string",
"performance_level": "string",
"provisioned_iops": 0,
"size": 0,
"snapshot_id": "string",
}],
deployment_set_id="string",
desired_size=0,
force_delete=False,
format_disk=False,
image_id="string",
image_type="string",
install_cloud_monitor=False,
instance_charge_type="string",
instances=["string"],
internet_charge_type="string",
internet_max_bandwidth_out=0,
keep_instance_name=False,
key_name="string",
kms_encrypted_password="string",
kms_encryption_context={
"string": "string",
},
kubelet_configuration={
"allowed_unsafe_sysctls": ["string"],
"container_log_max_files": "string",
"container_log_max_size": "string",
"cpu_manager_policy": "string",
"event_burst": "string",
"event_record_qps": "string",
"eviction_hard": {
"string": "string",
},
"eviction_soft": {
"string": "string",
},
"eviction_soft_grace_period": {
"string": "string",
},
"feature_gates": {
"string": False,
},
"kube_api_burst": "string",
"kube_api_qps": "string",
"kube_reserved": {
"string": "string",
},
"max_pods": "string",
"read_only_port": "string",
"registry_burst": "string",
"registry_pull_qps": "string",
"serialize_image_pulls": "string",
"system_reserved": {
"string": "string",
},
},
labels=[{
"key": "string",
"value": "string",
}],
login_as_non_root=False,
management={
"auto_repair": False,
"auto_repair_policy": {
"restart_node": False,
},
"auto_upgrade": False,
"auto_upgrade_policy": {
"auto_upgrade_kubelet": False,
},
"auto_vul_fix": False,
"auto_vul_fix_policy": {
"restart_node": False,
"vul_level": "string",
},
"enable": False,
"max_unavailable": 0,
},
multi_az_policy="string",
node_name_mode="string",
node_pool_name="string",
on_demand_base_capacity=0,
on_demand_percentage_above_base_capacity=0,
password="string",
period=0,
period_unit="string",
pre_user_data="string",
private_pool_options={
"private_pool_options_id": "string",
"private_pool_options_match_criteria": "string",
},
rds_instances=["string"],
resource_group_id="string",
rolling_policy={
"max_parallelism": 0,
},
runtime_name="string",
runtime_version="string",
scaling_config={
"eip_bandwidth": 0,
"eip_internet_charge_type": "string",
"enable": False,
"is_bond_eip": False,
"max_size": 0,
"min_size": 0,
"type": "string",
},
scaling_policy="string",
security_group_ids=["string"],
security_hardening_os=False,
soc_enabled=False,
spot_instance_pools=0,
spot_instance_remedy=False,
spot_price_limits=[{
"instance_type": "string",
"price_limit": "string",
}],
spot_strategy="string",
system_disk_bursting_enabled=False,
system_disk_categories=["string"],
system_disk_category="string",
system_disk_encrypt_algorithm="string",
system_disk_encrypted=False,
system_disk_kms_key="string",
system_disk_performance_level="string",
system_disk_provisioned_iops=0,
system_disk_size=0,
system_disk_snapshot_policy_id="string",
tags={
"string": "string",
},
taints=[{
"key": "string",
"effect": "string",
"value": "string",
}],
tee_config={
"tee_enable": False,
},
unschedulable=False,
update_nodes=False,
user_data="string")
const nodePoolResource = new alicloud.cs.NodePool("nodePoolResource", {
clusterId: "string",
instanceTypes: ["string"],
vswitchIds: ["string"],
autoRenew: false,
autoRenewPeriod: 0,
compensateWithOnDemand: false,
cpuPolicy: "string",
dataDisks: [{
autoFormat: "string",
autoSnapshotPolicyId: "string",
burstingEnabled: false,
category: "string",
device: "string",
encrypted: "string",
fileSystem: "string",
kmsKeyId: "string",
mountTarget: "string",
name: "string",
performanceLevel: "string",
provisionedIops: 0,
size: 0,
snapshotId: "string",
}],
deploymentSetId: "string",
desiredSize: 0,
forceDelete: false,
formatDisk: false,
imageId: "string",
imageType: "string",
installCloudMonitor: false,
instanceChargeType: "string",
instances: ["string"],
internetChargeType: "string",
internetMaxBandwidthOut: 0,
keepInstanceName: false,
keyName: "string",
kmsEncryptedPassword: "string",
kmsEncryptionContext: {
string: "string",
},
kubeletConfiguration: {
allowedUnsafeSysctls: ["string"],
containerLogMaxFiles: "string",
containerLogMaxSize: "string",
cpuManagerPolicy: "string",
eventBurst: "string",
eventRecordQps: "string",
evictionHard: {
string: "string",
},
evictionSoft: {
string: "string",
},
evictionSoftGracePeriod: {
string: "string",
},
featureGates: {
string: false,
},
kubeApiBurst: "string",
kubeApiQps: "string",
kubeReserved: {
string: "string",
},
maxPods: "string",
readOnlyPort: "string",
registryBurst: "string",
registryPullQps: "string",
serializeImagePulls: "string",
systemReserved: {
string: "string",
},
},
labels: [{
key: "string",
value: "string",
}],
loginAsNonRoot: false,
management: {
autoRepair: false,
autoRepairPolicy: {
restartNode: false,
},
autoUpgrade: false,
autoUpgradePolicy: {
autoUpgradeKubelet: false,
},
autoVulFix: false,
autoVulFixPolicy: {
restartNode: false,
vulLevel: "string",
},
enable: false,
maxUnavailable: 0,
},
multiAzPolicy: "string",
nodeNameMode: "string",
nodePoolName: "string",
onDemandBaseCapacity: 0,
onDemandPercentageAboveBaseCapacity: 0,
password: "string",
period: 0,
periodUnit: "string",
preUserData: "string",
privatePoolOptions: {
privatePoolOptionsId: "string",
privatePoolOptionsMatchCriteria: "string",
},
rdsInstances: ["string"],
resourceGroupId: "string",
rollingPolicy: {
maxParallelism: 0,
},
runtimeName: "string",
runtimeVersion: "string",
scalingConfig: {
eipBandwidth: 0,
eipInternetChargeType: "string",
enable: false,
isBondEip: false,
maxSize: 0,
minSize: 0,
type: "string",
},
scalingPolicy: "string",
securityGroupIds: ["string"],
securityHardeningOs: false,
socEnabled: false,
spotInstancePools: 0,
spotInstanceRemedy: false,
spotPriceLimits: [{
instanceType: "string",
priceLimit: "string",
}],
spotStrategy: "string",
systemDiskBurstingEnabled: false,
systemDiskCategories: ["string"],
systemDiskCategory: "string",
systemDiskEncryptAlgorithm: "string",
systemDiskEncrypted: false,
systemDiskKmsKey: "string",
systemDiskPerformanceLevel: "string",
systemDiskProvisionedIops: 0,
systemDiskSize: 0,
systemDiskSnapshotPolicyId: "string",
tags: {
string: "string",
},
taints: [{
key: "string",
effect: "string",
value: "string",
}],
teeConfig: {
teeEnable: false,
},
unschedulable: false,
updateNodes: false,
userData: "string",
});
type: alicloud:cs:NodePool
properties:
autoRenew: false
autoRenewPeriod: 0
clusterId: string
compensateWithOnDemand: false
cpuPolicy: string
dataDisks:
- autoFormat: string
autoSnapshotPolicyId: string
burstingEnabled: false
category: string
device: string
encrypted: string
fileSystem: string
kmsKeyId: string
mountTarget: string
name: string
performanceLevel: string
provisionedIops: 0
size: 0
snapshotId: string
deploymentSetId: string
desiredSize: 0
forceDelete: false
formatDisk: false
imageId: string
imageType: string
installCloudMonitor: false
instanceChargeType: string
instanceTypes:
- string
instances:
- string
internetChargeType: string
internetMaxBandwidthOut: 0
keepInstanceName: false
keyName: string
kmsEncryptedPassword: string
kmsEncryptionContext:
string: string
kubeletConfiguration:
allowedUnsafeSysctls:
- string
containerLogMaxFiles: string
containerLogMaxSize: string
cpuManagerPolicy: string
eventBurst: string
eventRecordQps: string
evictionHard:
string: string
evictionSoft:
string: string
evictionSoftGracePeriod:
string: string
featureGates:
string: false
kubeApiBurst: string
kubeApiQps: string
kubeReserved:
string: string
maxPods: string
readOnlyPort: string
registryBurst: string
registryPullQps: string
serializeImagePulls: string
systemReserved:
string: string
labels:
- key: string
value: string
loginAsNonRoot: false
management:
autoRepair: false
autoRepairPolicy:
restartNode: false
autoUpgrade: false
autoUpgradePolicy:
autoUpgradeKubelet: false
autoVulFix: false
autoVulFixPolicy:
restartNode: false
vulLevel: string
enable: false
maxUnavailable: 0
multiAzPolicy: string
nodeNameMode: string
nodePoolName: string
onDemandBaseCapacity: 0
onDemandPercentageAboveBaseCapacity: 0
password: string
period: 0
periodUnit: string
preUserData: string
privatePoolOptions:
privatePoolOptionsId: string
privatePoolOptionsMatchCriteria: string
rdsInstances:
- string
resourceGroupId: string
rollingPolicy:
maxParallelism: 0
runtimeName: string
runtimeVersion: string
scalingConfig:
eipBandwidth: 0
eipInternetChargeType: string
enable: false
isBondEip: false
maxSize: 0
minSize: 0
type: string
scalingPolicy: string
securityGroupIds:
- string
securityHardeningOs: false
socEnabled: false
spotInstancePools: 0
spotInstanceRemedy: false
spotPriceLimits:
- instanceType: string
priceLimit: string
spotStrategy: string
systemDiskBurstingEnabled: false
systemDiskCategories:
- string
systemDiskCategory: string
systemDiskEncryptAlgorithm: string
systemDiskEncrypted: false
systemDiskKmsKey: string
systemDiskPerformanceLevel: string
systemDiskProvisionedIops: 0
systemDiskSize: 0
systemDiskSnapshotPolicyId: string
tags:
string: string
taints:
- effect: string
key: string
value: string
teeConfig:
teeEnable: false
unschedulable: false
updateNodes: false
userData: string
vswitchIds:
- string
NodePool 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 NodePool resource accepts the following input properties:
- Cluster
Id string - The id of kubernetes cluster.
- Instance
Types List<string> - In the node instance specification list, you can select multiple instance specifications as alternatives. When each node is created, it will try to purchase from the first specification until it is created successfully. The final purchased instance specifications may vary with inventory changes.
- Vswitch
Ids List<string> - The vswitches used by node pool workers.
- Auto
Renew bool - Whether to enable automatic renewal for nodes in the node pool takes effect only when
instance_charge_type
is set toPrePaid
. Default value:false
. Valid values: - Auto
Renew intPeriod - The automatic renewal period of nodes in the node pool takes effect only when you select Prepaid and Automatic Renewal, and is a required value. When
PeriodUnit = Month
, the value range is {1, 2, 3, 6, 12}. Default value: 1. - Cis
Enabled bool - Whether enable worker node to support cis security reinforcement, its valid value
true
orfalse
. Default tofalse
and apply to AliyunLinux series. Usesecurity_hardening_os
instead. - Compensate
With boolOn Demand - Specifies whether to automatically create pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created due to reasons such as cost or insufficient inventory. This parameter takes effect when you set
multi_az_policy
toCOST_OPTIMIZED
. Valid values:true
: automatically creates pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created.false
: does not create pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created. - Cpu
Policy string - Node CPU management policies. Default value:
none
. When the cluster version is 1.12.6 or later, the following two policies are supported: - Data
Disks List<Pulumi.Ali Cloud. CS. Inputs. Node Pool Data Disk> - Configure the data disk of the node in the node pool. See
data_disks
below. - Deployment
Set stringId - The deployment set of node pool. Specify the deploymentSet to ensure that the nodes in the node pool can be distributed on different physical machines.
- Desired
Size int - Number of expected nodes in the node pool.
- Force
Delete bool - Whether to force deletion.
- Format
Disk bool - After you select this check box, if data disks have been attached to the specified ECS instances and the file system of the last data disk is uninitialized, the system automatically formats the last data disk to ext4 and mounts the data disk to /var/lib/docker and /var/lib/kubelet. The original data on the disk will be cleared. Make sure that you back up data in advance. If no data disk is mounted on the ECS instance, no new data disk will be purchased. Default is
false
. - Image
Id string - The custom image ID. The system-provided image is used by default.
- Image
Type string - The operating system image type and the
platform
parameter can be selected from the following values:AliyunLinux
: Alinux2 image.AliyunLinux3
: Alinux3 image.AliyunLinux3Arm64
: Alinux3 mirror ARM version.AliyunLinuxUEFI
: Alinux2 Image UEFI version.CentOS
: CentOS image.Windows
: Windows image.WindowsCore
: WindowsCore image.ContainerOS
: container-optimized image.
- Install
Cloud boolMonitor - Whether to install cloud monitoring on the ECS node. After installation, you can view the monitoring information of the created ECS instance in the cloud monitoring console and recommend enable it. Default value:
false
. Valid values: - Instance
Charge stringType - Node payment type. Valid values:
PostPaid
,PrePaid
, default isPostPaid
. If value isPrePaid
, the argumentsperiod
,period_unit
,auto_renew
andauto_renew_period
are required. - Instances List<string>
- The instance list. Add existing nodes under the same cluster VPC to the node pool.
- Internet
Charge stringType - The billing method for network usage. Valid values
PayByBandwidth
andPayByTraffic
. Conflict witheip_internet_charge_type
, EIP and public network IP can only choose one. - Internet
Max intBandwidth Out - The maximum bandwidth of the public IP address of the node. The unit is Mbps(Mega bit per second). The value range is:[1,100]
- Keep
Instance boolName - Add an existing instance to the node pool, whether to keep the original instance name. It is recommended to set to
true
. - Key
Name string - The name of the key pair. When the node pool is a managed node pool, only
key_name
is supported. - Kms
Encrypted stringPassword - An KMS encrypts password used to a cs kubernetes. You have to specify one of
password
key_name
kms_encrypted_password
fields. - Kms
Encryption Dictionary<string, string>Context - An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating a cs kubernetes withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set. - Kubelet
Configuration Pulumi.Ali Cloud. CS. Inputs. Node Pool Kubelet Configuration - Kubelet configuration parameters for worker nodes. See
kubelet_configuration
below. More information in Kubelet Configuration. Seekubelet_configuration
below. - Labels
List<Pulumi.
Ali Cloud. CS. Inputs. Node Pool Label> - A List of Kubernetes labels to assign to the nodes . Only labels that are applied with the ACK API are managed by this argument. Detailed below. More information in Labels. See
labels
below. - Login
As boolNon Root - Whether the ECS instance is logged on as a ecs-user user. Valid value:
true
andfalse
. - Management
Pulumi.
Ali Cloud. CS. Inputs. Node Pool Management - Managed node pool configuration. See
management
below. - Multi
Az stringPolicy - The scaling policy for ECS instances in a multi-zone scaling group. Valid value:
PRIORITY
,COST_OPTIMIZED
andBALANCE
.PRIORITY
: scales the capacity according to the virtual switches you define (VSwitchIds.N). When an ECS instance cannot be created in the zone where the higher-priority vSwitch is located, the next-priority vSwitch is automatically used to create an ECS instance.COST_OPTIMIZED
: try to create by vCPU unit price from low to high. When the scaling configuration is configured with multiple instances of preemptible billing, preemptible instances are created first. You can continue to use theCompensateWithOnDemand
parameter to specify whether to automatically try to create a preemptible instance by paying for it. It takes effect only when the scaling configuration has multi-instance specifications or preemptible instances.BALANCE
: distributes ECS instances evenly among the multi-zone specified by the scaling group. If the zones become unbalanced due to insufficient inventory, you can use the API RebalanceInstances to balance resources. - Name string
- . Field 'name' has been deprecated from provider version 1.219.0. New field 'node_pool_name' instead.
- Node
Count int - The worker node number of the node pool. From version 1.111.0,
node_count
is not required. - Node
Name stringMode - Each node name consists of a prefix, its private network IP, and a suffix, separated by commas. The input format is
customized,,ip,
.- The prefix and suffix can be composed of one or more parts separated by '.', each part can use lowercase letters, numbers and '-', and the beginning and end of the node name must be lowercase letters and numbers.
- The node IP address is the complete private IP address of the node.
- For example, if the string
customized,aliyun,ip,com
is passed in (where 'customized' and 'ip' are fixed strings, 'aliyun' is the prefix, and 'com' is the suffix), the name of the node isaliyun192.168.xxx.xxxcom
.
- Node
Pool stringName - The name of node pool.
- On
Demand intBase Capacity - The minimum number of pay-as-you-go instances that must be kept in the scaling group. Valid values: 0 to 1000. If the number of pay-as-you-go instances is less than the value of this parameter, Auto Scaling preferably creates pay-as-you-go instances.
- On
Demand intPercentage Above Base Capacity - The percentage of pay-as-you-go instances among the extra instances that exceed the number specified by
on_demand_base_capacity
. Valid values: 0 to 100. - Password string
- The password of ssh login. You have to specify one of
password
andkey_name
fields. The password rule is 8 to 30 characters and contains at least three items (upper and lower case letters, numbers, and special symbols). - Period int
- Node payment period. Its valid value is one of {1, 2, 3, 6, 12}.
- Period
Unit string - Node payment period unit, valid value:
Month
. Default isMonth
. - Platform string
- Operating system release, using
image_type
instead. - Pre
User stringData - Node pre custom data, base64-encoded, the script executed before the node is initialized.
- Private
Pool Pulumi.Options Ali Cloud. CS. Inputs. Node Pool Private Pool Options - Private node pool configuration. See
private_pool_options
below. - Rds
Instances List<string> - The list of RDS instances.
- Resource
Group stringId - The ID of the resource group
- Rolling
Policy Pulumi.Ali Cloud. CS. Inputs. Node Pool Rolling Policy - Rotary configuration. See
rolling_policy
below. - Runtime
Name string - The runtime name of containers. If not set, the cluster runtime will be used as the node pool runtime. If you select another container runtime, see Comparison of Docker, containerd, and Sandboxed-Container.
- Runtime
Version string - The runtime version of containers. If not set, the cluster runtime will be used as the node pool runtime.
- Scaling
Config Pulumi.Ali Cloud. CS. Inputs. Node Pool Scaling Config - Automatic scaling configuration. See
scaling_config
below. - Scaling
Policy string - Scaling group mode, default value:
release
. Valid values: - Security
Group stringId - The security group ID of the node pool. This field has been replaced by
security_group_ids
, please use thesecurity_group_ids
field instead. - Security
Group List<string>Ids - Multiple security groups can be configured for a node pool. If both
security_group_ids
andsecurity_group_id
are configured,security_group_ids
takes effect. This field cannot be modified. - Security
Hardening boolOs - Alibaba Cloud OS security reinforcement. Default value:
false
. Value: - Soc
Enabled bool Whether enable worker node to support soc security reinforcement, its valid value
true
orfalse
. Default tofalse
and apply to AliyunLinux series. See SOC Reinforcement.NOTE: It is forbidden to set both
security_hardening_os
andsoc_enabled
totrue
at the same time.- Spot
Instance intPools - The number of instance types that are available. Auto Scaling creates preemptible instances of multiple instance types that are available at the lowest cost. Valid values: 1 to 10.
- Spot
Instance boolRemedy - Specifies whether to supplement preemptible instances when the number of preemptible instances drops below the specified minimum number. If you set the value to true, Auto Scaling attempts to create a new preemptible instance when the system notifies that an existing preemptible instance is about to be reclaimed. Valid values:
true
: enables the supplementation of preemptible instances.false
: disables the supplementation of preemptible instances. - Spot
Price List<Pulumi.Limits Ali Cloud. CS. Inputs. Node Pool Spot Price Limit> - The current single preemptible instance type market price range configuration. See
spot_price_limit
below. - Spot
Strategy string - The preemptible instance type. Value:
NoSpot
: Non-preemptible instance.SpotWithPriceLimit
: Set the upper limit of the preemptible instance price.SpotAsPriceGo
: The system automatically bids, following the actual price of the current market.
- System
Disk boolBursting Enabled - Specifies whether to enable the burst feature for system disks. Valid values:
true
: enables the burst feature.false
: disables the burst feature. This parameter is supported only whensystem_disk_category
is set tocloud_auto
. - System
Disk List<string>Categories - The multi-disk categories of the system disk. When a high-priority disk type cannot be used, Auto Scaling automatically tries to create a system disk with the next priority disk category. Valid values:
cloud
: cloud disk.cloud_efficiency
: a high-efficiency cloud disk.cloud_ssd
:SSD cloud disk.cloud_essd
: ESSD cloud disk. - System
Disk stringCategory - The system disk category of worker node. Its valid value are
cloud_ssd
,cloud_efficiency
,cloud_essd
andcloud_auto
. - System
Disk stringEncrypt Algorithm - The encryption algorithm used by the system disk. Value range: aes-256.
- System
Disk boolEncrypted - Whether to encrypt the system disk. Value range:
true
: encryption.false
: Do not encrypt. - System
Disk stringKms Key - The ID of the KMS key used by the system disk.
- System
Disk stringPerformance Level - The system disk performance of the node takes effect only for the ESSD disk.
PL0
: maximum random read/write IOPS 10000 for a single disk.PL1
: maximum random read/write IOPS 50000 for a single disk.PL2
: highest random read/write IOPS 100000 for a single disk.PL3
: maximum random read/write IOPS 1 million for a single disk.
- System
Disk intProvisioned Iops - The predefined IOPS of a system disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. Baseline IOPS = min{1,800 + 50 × Capacity, 50,000}. This parameter is supported only when
system_disk_category
is set tocloud_auto
. - System
Disk intSize - The system disk category of worker node. Its valid value range [40~500] in GB. Default to
120
. - System
Disk stringSnapshot Policy Id - The ID of the automatic snapshot policy used by the system disk.
- Dictionary<string, string>
- Add tags only for ECS instances. The maximum length of the tag key is 128 characters. The tag key and value cannot start with aliyun or acs:, or contain https:// or http://.
- Taints
List<Pulumi.
Ali Cloud. CS. Inputs. Node Pool Taint> - A List of Kubernetes taints to assign to the nodes. Detailed below. More information in Taints and Toleration. See
taints
below. - Tee
Config Pulumi.Ali Cloud. CS. Inputs. Node Pool Tee Config - The configuration about confidential computing for the cluster. See
tee_config
below. - Unschedulable bool
- Whether the node after expansion can be scheduled.
- Update
Nodes bool - Synchronously update node labels and taints.
- User
Data string - Node custom data, base64-encoded.
- Cluster
Id string - The id of kubernetes cluster.
- Instance
Types []string - In the node instance specification list, you can select multiple instance specifications as alternatives. When each node is created, it will try to purchase from the first specification until it is created successfully. The final purchased instance specifications may vary with inventory changes.
- Vswitch
Ids []string - The vswitches used by node pool workers.
- Auto
Renew bool - Whether to enable automatic renewal for nodes in the node pool takes effect only when
instance_charge_type
is set toPrePaid
. Default value:false
. Valid values: - Auto
Renew intPeriod - The automatic renewal period of nodes in the node pool takes effect only when you select Prepaid and Automatic Renewal, and is a required value. When
PeriodUnit = Month
, the value range is {1, 2, 3, 6, 12}. Default value: 1. - Cis
Enabled bool - Whether enable worker node to support cis security reinforcement, its valid value
true
orfalse
. Default tofalse
and apply to AliyunLinux series. Usesecurity_hardening_os
instead. - Compensate
With boolOn Demand - Specifies whether to automatically create pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created due to reasons such as cost or insufficient inventory. This parameter takes effect when you set
multi_az_policy
toCOST_OPTIMIZED
. Valid values:true
: automatically creates pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created.false
: does not create pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created. - Cpu
Policy string - Node CPU management policies. Default value:
none
. When the cluster version is 1.12.6 or later, the following two policies are supported: - Data
Disks []NodePool Data Disk Args - Configure the data disk of the node in the node pool. See
data_disks
below. - Deployment
Set stringId - The deployment set of node pool. Specify the deploymentSet to ensure that the nodes in the node pool can be distributed on different physical machines.
- Desired
Size int - Number of expected nodes in the node pool.
- Force
Delete bool - Whether to force deletion.
- Format
Disk bool - After you select this check box, if data disks have been attached to the specified ECS instances and the file system of the last data disk is uninitialized, the system automatically formats the last data disk to ext4 and mounts the data disk to /var/lib/docker and /var/lib/kubelet. The original data on the disk will be cleared. Make sure that you back up data in advance. If no data disk is mounted on the ECS instance, no new data disk will be purchased. Default is
false
. - Image
Id string - The custom image ID. The system-provided image is used by default.
- Image
Type string - The operating system image type and the
platform
parameter can be selected from the following values:AliyunLinux
: Alinux2 image.AliyunLinux3
: Alinux3 image.AliyunLinux3Arm64
: Alinux3 mirror ARM version.AliyunLinuxUEFI
: Alinux2 Image UEFI version.CentOS
: CentOS image.Windows
: Windows image.WindowsCore
: WindowsCore image.ContainerOS
: container-optimized image.
- Install
Cloud boolMonitor - Whether to install cloud monitoring on the ECS node. After installation, you can view the monitoring information of the created ECS instance in the cloud monitoring console and recommend enable it. Default value:
false
. Valid values: - Instance
Charge stringType - Node payment type. Valid values:
PostPaid
,PrePaid
, default isPostPaid
. If value isPrePaid
, the argumentsperiod
,period_unit
,auto_renew
andauto_renew_period
are required. - Instances []string
- The instance list. Add existing nodes under the same cluster VPC to the node pool.
- Internet
Charge stringType - The billing method for network usage. Valid values
PayByBandwidth
andPayByTraffic
. Conflict witheip_internet_charge_type
, EIP and public network IP can only choose one. - Internet
Max intBandwidth Out - The maximum bandwidth of the public IP address of the node. The unit is Mbps(Mega bit per second). The value range is:[1,100]
- Keep
Instance boolName - Add an existing instance to the node pool, whether to keep the original instance name. It is recommended to set to
true
. - Key
Name string - The name of the key pair. When the node pool is a managed node pool, only
key_name
is supported. - Kms
Encrypted stringPassword - An KMS encrypts password used to a cs kubernetes. You have to specify one of
password
key_name
kms_encrypted_password
fields. - Kms
Encryption map[string]stringContext - An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating a cs kubernetes withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set. - Kubelet
Configuration NodePool Kubelet Configuration Args - Kubelet configuration parameters for worker nodes. See
kubelet_configuration
below. More information in Kubelet Configuration. Seekubelet_configuration
below. - Labels
[]Node
Pool Label Args - A List of Kubernetes labels to assign to the nodes . Only labels that are applied with the ACK API are managed by this argument. Detailed below. More information in Labels. See
labels
below. - Login
As boolNon Root - Whether the ECS instance is logged on as a ecs-user user. Valid value:
true
andfalse
. - Management
Node
Pool Management Args - Managed node pool configuration. See
management
below. - Multi
Az stringPolicy - The scaling policy for ECS instances in a multi-zone scaling group. Valid value:
PRIORITY
,COST_OPTIMIZED
andBALANCE
.PRIORITY
: scales the capacity according to the virtual switches you define (VSwitchIds.N). When an ECS instance cannot be created in the zone where the higher-priority vSwitch is located, the next-priority vSwitch is automatically used to create an ECS instance.COST_OPTIMIZED
: try to create by vCPU unit price from low to high. When the scaling configuration is configured with multiple instances of preemptible billing, preemptible instances are created first. You can continue to use theCompensateWithOnDemand
parameter to specify whether to automatically try to create a preemptible instance by paying for it. It takes effect only when the scaling configuration has multi-instance specifications or preemptible instances.BALANCE
: distributes ECS instances evenly among the multi-zone specified by the scaling group. If the zones become unbalanced due to insufficient inventory, you can use the API RebalanceInstances to balance resources. - Name string
- . Field 'name' has been deprecated from provider version 1.219.0. New field 'node_pool_name' instead.
- Node
Count int - The worker node number of the node pool. From version 1.111.0,
node_count
is not required. - Node
Name stringMode - Each node name consists of a prefix, its private network IP, and a suffix, separated by commas. The input format is
customized,,ip,
.- The prefix and suffix can be composed of one or more parts separated by '.', each part can use lowercase letters, numbers and '-', and the beginning and end of the node name must be lowercase letters and numbers.
- The node IP address is the complete private IP address of the node.
- For example, if the string
customized,aliyun,ip,com
is passed in (where 'customized' and 'ip' are fixed strings, 'aliyun' is the prefix, and 'com' is the suffix), the name of the node isaliyun192.168.xxx.xxxcom
.
- Node
Pool stringName - The name of node pool.
- On
Demand intBase Capacity - The minimum number of pay-as-you-go instances that must be kept in the scaling group. Valid values: 0 to 1000. If the number of pay-as-you-go instances is less than the value of this parameter, Auto Scaling preferably creates pay-as-you-go instances.
- On
Demand intPercentage Above Base Capacity - The percentage of pay-as-you-go instances among the extra instances that exceed the number specified by
on_demand_base_capacity
. Valid values: 0 to 100. - Password string
- The password of ssh login. You have to specify one of
password
andkey_name
fields. The password rule is 8 to 30 characters and contains at least three items (upper and lower case letters, numbers, and special symbols). - Period int
- Node payment period. Its valid value is one of {1, 2, 3, 6, 12}.
- Period
Unit string - Node payment period unit, valid value:
Month
. Default isMonth
. - Platform string
- Operating system release, using
image_type
instead. - Pre
User stringData - Node pre custom data, base64-encoded, the script executed before the node is initialized.
- Private
Pool NodeOptions Pool Private Pool Options Args - Private node pool configuration. See
private_pool_options
below. - Rds
Instances []string - The list of RDS instances.
- Resource
Group stringId - The ID of the resource group
- Rolling
Policy NodePool Rolling Policy Args - Rotary configuration. See
rolling_policy
below. - Runtime
Name string - The runtime name of containers. If not set, the cluster runtime will be used as the node pool runtime. If you select another container runtime, see Comparison of Docker, containerd, and Sandboxed-Container.
- Runtime
Version string - The runtime version of containers. If not set, the cluster runtime will be used as the node pool runtime.
- Scaling
Config NodePool Scaling Config Args - Automatic scaling configuration. See
scaling_config
below. - Scaling
Policy string - Scaling group mode, default value:
release
. Valid values: - Security
Group stringId - The security group ID of the node pool. This field has been replaced by
security_group_ids
, please use thesecurity_group_ids
field instead. - Security
Group []stringIds - Multiple security groups can be configured for a node pool. If both
security_group_ids
andsecurity_group_id
are configured,security_group_ids
takes effect. This field cannot be modified. - Security
Hardening boolOs - Alibaba Cloud OS security reinforcement. Default value:
false
. Value: - Soc
Enabled bool Whether enable worker node to support soc security reinforcement, its valid value
true
orfalse
. Default tofalse
and apply to AliyunLinux series. See SOC Reinforcement.NOTE: It is forbidden to set both
security_hardening_os
andsoc_enabled
totrue
at the same time.- Spot
Instance intPools - The number of instance types that are available. Auto Scaling creates preemptible instances of multiple instance types that are available at the lowest cost. Valid values: 1 to 10.
- Spot
Instance boolRemedy - Specifies whether to supplement preemptible instances when the number of preemptible instances drops below the specified minimum number. If you set the value to true, Auto Scaling attempts to create a new preemptible instance when the system notifies that an existing preemptible instance is about to be reclaimed. Valid values:
true
: enables the supplementation of preemptible instances.false
: disables the supplementation of preemptible instances. - Spot
Price []NodeLimits Pool Spot Price Limit Args - The current single preemptible instance type market price range configuration. See
spot_price_limit
below. - Spot
Strategy string - The preemptible instance type. Value:
NoSpot
: Non-preemptible instance.SpotWithPriceLimit
: Set the upper limit of the preemptible instance price.SpotAsPriceGo
: The system automatically bids, following the actual price of the current market.
- System
Disk boolBursting Enabled - Specifies whether to enable the burst feature for system disks. Valid values:
true
: enables the burst feature.false
: disables the burst feature. This parameter is supported only whensystem_disk_category
is set tocloud_auto
. - System
Disk []stringCategories - The multi-disk categories of the system disk. When a high-priority disk type cannot be used, Auto Scaling automatically tries to create a system disk with the next priority disk category. Valid values:
cloud
: cloud disk.cloud_efficiency
: a high-efficiency cloud disk.cloud_ssd
:SSD cloud disk.cloud_essd
: ESSD cloud disk. - System
Disk stringCategory - The system disk category of worker node. Its valid value are
cloud_ssd
,cloud_efficiency
,cloud_essd
andcloud_auto
. - System
Disk stringEncrypt Algorithm - The encryption algorithm used by the system disk. Value range: aes-256.
- System
Disk boolEncrypted - Whether to encrypt the system disk. Value range:
true
: encryption.false
: Do not encrypt. - System
Disk stringKms Key - The ID of the KMS key used by the system disk.
- System
Disk stringPerformance Level - The system disk performance of the node takes effect only for the ESSD disk.
PL0
: maximum random read/write IOPS 10000 for a single disk.PL1
: maximum random read/write IOPS 50000 for a single disk.PL2
: highest random read/write IOPS 100000 for a single disk.PL3
: maximum random read/write IOPS 1 million for a single disk.
- System
Disk intProvisioned Iops - The predefined IOPS of a system disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. Baseline IOPS = min{1,800 + 50 × Capacity, 50,000}. This parameter is supported only when
system_disk_category
is set tocloud_auto
. - System
Disk intSize - The system disk category of worker node. Its valid value range [40~500] in GB. Default to
120
. - System
Disk stringSnapshot Policy Id - The ID of the automatic snapshot policy used by the system disk.
- map[string]string
- Add tags only for ECS instances. The maximum length of the tag key is 128 characters. The tag key and value cannot start with aliyun or acs:, or contain https:// or http://.
- Taints
[]Node
Pool Taint Args - A List of Kubernetes taints to assign to the nodes. Detailed below. More information in Taints and Toleration. See
taints
below. - Tee
Config NodePool Tee Config Args - The configuration about confidential computing for the cluster. See
tee_config
below. - Unschedulable bool
- Whether the node after expansion can be scheduled.
- Update
Nodes bool - Synchronously update node labels and taints.
- User
Data string - Node custom data, base64-encoded.
- cluster
Id String - The id of kubernetes cluster.
- instance
Types List<String> - In the node instance specification list, you can select multiple instance specifications as alternatives. When each node is created, it will try to purchase from the first specification until it is created successfully. The final purchased instance specifications may vary with inventory changes.
- vswitch
Ids List<String> - The vswitches used by node pool workers.
- auto
Renew Boolean - Whether to enable automatic renewal for nodes in the node pool takes effect only when
instance_charge_type
is set toPrePaid
. Default value:false
. Valid values: - auto
Renew IntegerPeriod - The automatic renewal period of nodes in the node pool takes effect only when you select Prepaid and Automatic Renewal, and is a required value. When
PeriodUnit = Month
, the value range is {1, 2, 3, 6, 12}. Default value: 1. - cis
Enabled Boolean - Whether enable worker node to support cis security reinforcement, its valid value
true
orfalse
. Default tofalse
and apply to AliyunLinux series. Usesecurity_hardening_os
instead. - compensate
With BooleanOn Demand - Specifies whether to automatically create pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created due to reasons such as cost or insufficient inventory. This parameter takes effect when you set
multi_az_policy
toCOST_OPTIMIZED
. Valid values:true
: automatically creates pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created.false
: does not create pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created. - cpu
Policy String - Node CPU management policies. Default value:
none
. When the cluster version is 1.12.6 or later, the following two policies are supported: - data
Disks List<NodePool Data Disk> - Configure the data disk of the node in the node pool. See
data_disks
below. - deployment
Set StringId - The deployment set of node pool. Specify the deploymentSet to ensure that the nodes in the node pool can be distributed on different physical machines.
- desired
Size Integer - Number of expected nodes in the node pool.
- force
Delete Boolean - Whether to force deletion.
- format
Disk Boolean - After you select this check box, if data disks have been attached to the specified ECS instances and the file system of the last data disk is uninitialized, the system automatically formats the last data disk to ext4 and mounts the data disk to /var/lib/docker and /var/lib/kubelet. The original data on the disk will be cleared. Make sure that you back up data in advance. If no data disk is mounted on the ECS instance, no new data disk will be purchased. Default is
false
. - image
Id String - The custom image ID. The system-provided image is used by default.
- image
Type String - The operating system image type and the
platform
parameter can be selected from the following values:AliyunLinux
: Alinux2 image.AliyunLinux3
: Alinux3 image.AliyunLinux3Arm64
: Alinux3 mirror ARM version.AliyunLinuxUEFI
: Alinux2 Image UEFI version.CentOS
: CentOS image.Windows
: Windows image.WindowsCore
: WindowsCore image.ContainerOS
: container-optimized image.
- install
Cloud BooleanMonitor - Whether to install cloud monitoring on the ECS node. After installation, you can view the monitoring information of the created ECS instance in the cloud monitoring console and recommend enable it. Default value:
false
. Valid values: - instance
Charge StringType - Node payment type. Valid values:
PostPaid
,PrePaid
, default isPostPaid
. If value isPrePaid
, the argumentsperiod
,period_unit
,auto_renew
andauto_renew_period
are required. - instances List<String>
- The instance list. Add existing nodes under the same cluster VPC to the node pool.
- internet
Charge StringType - The billing method for network usage. Valid values
PayByBandwidth
andPayByTraffic
. Conflict witheip_internet_charge_type
, EIP and public network IP can only choose one. - internet
Max IntegerBandwidth Out - The maximum bandwidth of the public IP address of the node. The unit is Mbps(Mega bit per second). The value range is:[1,100]
- keep
Instance BooleanName - Add an existing instance to the node pool, whether to keep the original instance name. It is recommended to set to
true
. - key
Name String - The name of the key pair. When the node pool is a managed node pool, only
key_name
is supported. - kms
Encrypted StringPassword - An KMS encrypts password used to a cs kubernetes. You have to specify one of
password
key_name
kms_encrypted_password
fields. - kms
Encryption Map<String,String>Context - An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating a cs kubernetes withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set. - kubelet
Configuration NodePool Kubelet Configuration - Kubelet configuration parameters for worker nodes. See
kubelet_configuration
below. More information in Kubelet Configuration. Seekubelet_configuration
below. - labels
List<Node
Pool Label> - A List of Kubernetes labels to assign to the nodes . Only labels that are applied with the ACK API are managed by this argument. Detailed below. More information in Labels. See
labels
below. - login
As BooleanNon Root - Whether the ECS instance is logged on as a ecs-user user. Valid value:
true
andfalse
. - management
Node
Pool Management - Managed node pool configuration. See
management
below. - multi
Az StringPolicy - The scaling policy for ECS instances in a multi-zone scaling group. Valid value:
PRIORITY
,COST_OPTIMIZED
andBALANCE
.PRIORITY
: scales the capacity according to the virtual switches you define (VSwitchIds.N). When an ECS instance cannot be created in the zone where the higher-priority vSwitch is located, the next-priority vSwitch is automatically used to create an ECS instance.COST_OPTIMIZED
: try to create by vCPU unit price from low to high. When the scaling configuration is configured with multiple instances of preemptible billing, preemptible instances are created first. You can continue to use theCompensateWithOnDemand
parameter to specify whether to automatically try to create a preemptible instance by paying for it. It takes effect only when the scaling configuration has multi-instance specifications or preemptible instances.BALANCE
: distributes ECS instances evenly among the multi-zone specified by the scaling group. If the zones become unbalanced due to insufficient inventory, you can use the API RebalanceInstances to balance resources. - name String
- . Field 'name' has been deprecated from provider version 1.219.0. New field 'node_pool_name' instead.
- node
Count Integer - The worker node number of the node pool. From version 1.111.0,
node_count
is not required. - node
Name StringMode - Each node name consists of a prefix, its private network IP, and a suffix, separated by commas. The input format is
customized,,ip,
.- The prefix and suffix can be composed of one or more parts separated by '.', each part can use lowercase letters, numbers and '-', and the beginning and end of the node name must be lowercase letters and numbers.
- The node IP address is the complete private IP address of the node.
- For example, if the string
customized,aliyun,ip,com
is passed in (where 'customized' and 'ip' are fixed strings, 'aliyun' is the prefix, and 'com' is the suffix), the name of the node isaliyun192.168.xxx.xxxcom
.
- node
Pool StringName - The name of node pool.
- on
Demand IntegerBase Capacity - The minimum number of pay-as-you-go instances that must be kept in the scaling group. Valid values: 0 to 1000. If the number of pay-as-you-go instances is less than the value of this parameter, Auto Scaling preferably creates pay-as-you-go instances.
- on
Demand IntegerPercentage Above Base Capacity - The percentage of pay-as-you-go instances among the extra instances that exceed the number specified by
on_demand_base_capacity
. Valid values: 0 to 100. - password String
- The password of ssh login. You have to specify one of
password
andkey_name
fields. The password rule is 8 to 30 characters and contains at least three items (upper and lower case letters, numbers, and special symbols). - period Integer
- Node payment period. Its valid value is one of {1, 2, 3, 6, 12}.
- period
Unit String - Node payment period unit, valid value:
Month
. Default isMonth
. - platform String
- Operating system release, using
image_type
instead. - pre
User StringData - Node pre custom data, base64-encoded, the script executed before the node is initialized.
- private
Pool NodeOptions Pool Private Pool Options - Private node pool configuration. See
private_pool_options
below. - rds
Instances List<String> - The list of RDS instances.
- resource
Group StringId - The ID of the resource group
- rolling
Policy NodePool Rolling Policy - Rotary configuration. See
rolling_policy
below. - runtime
Name String - The runtime name of containers. If not set, the cluster runtime will be used as the node pool runtime. If you select another container runtime, see Comparison of Docker, containerd, and Sandboxed-Container.
- runtime
Version String - The runtime version of containers. If not set, the cluster runtime will be used as the node pool runtime.
- scaling
Config NodePool Scaling Config - Automatic scaling configuration. See
scaling_config
below. - scaling
Policy String - Scaling group mode, default value:
release
. Valid values: - security
Group StringId - The security group ID of the node pool. This field has been replaced by
security_group_ids
, please use thesecurity_group_ids
field instead. - security
Group List<String>Ids - Multiple security groups can be configured for a node pool. If both
security_group_ids
andsecurity_group_id
are configured,security_group_ids
takes effect. This field cannot be modified. - security
Hardening BooleanOs - Alibaba Cloud OS security reinforcement. Default value:
false
. Value: - soc
Enabled Boolean Whether enable worker node to support soc security reinforcement, its valid value
true
orfalse
. Default tofalse
and apply to AliyunLinux series. See SOC Reinforcement.NOTE: It is forbidden to set both
security_hardening_os
andsoc_enabled
totrue
at the same time.- spot
Instance IntegerPools - The number of instance types that are available. Auto Scaling creates preemptible instances of multiple instance types that are available at the lowest cost. Valid values: 1 to 10.
- spot
Instance BooleanRemedy - Specifies whether to supplement preemptible instances when the number of preemptible instances drops below the specified minimum number. If you set the value to true, Auto Scaling attempts to create a new preemptible instance when the system notifies that an existing preemptible instance is about to be reclaimed. Valid values:
true
: enables the supplementation of preemptible instances.false
: disables the supplementation of preemptible instances. - spot
Price List<NodeLimits Pool Spot Price Limit> - The current single preemptible instance type market price range configuration. See
spot_price_limit
below. - spot
Strategy String - The preemptible instance type. Value:
NoSpot
: Non-preemptible instance.SpotWithPriceLimit
: Set the upper limit of the preemptible instance price.SpotAsPriceGo
: The system automatically bids, following the actual price of the current market.
- system
Disk BooleanBursting Enabled - Specifies whether to enable the burst feature for system disks. Valid values:
true
: enables the burst feature.false
: disables the burst feature. This parameter is supported only whensystem_disk_category
is set tocloud_auto
. - system
Disk List<String>Categories - The multi-disk categories of the system disk. When a high-priority disk type cannot be used, Auto Scaling automatically tries to create a system disk with the next priority disk category. Valid values:
cloud
: cloud disk.cloud_efficiency
: a high-efficiency cloud disk.cloud_ssd
:SSD cloud disk.cloud_essd
: ESSD cloud disk. - system
Disk StringCategory - The system disk category of worker node. Its valid value are
cloud_ssd
,cloud_efficiency
,cloud_essd
andcloud_auto
. - system
Disk StringEncrypt Algorithm - The encryption algorithm used by the system disk. Value range: aes-256.
- system
Disk BooleanEncrypted - Whether to encrypt the system disk. Value range:
true
: encryption.false
: Do not encrypt. - system
Disk StringKms Key - The ID of the KMS key used by the system disk.
- system
Disk StringPerformance Level - The system disk performance of the node takes effect only for the ESSD disk.
PL0
: maximum random read/write IOPS 10000 for a single disk.PL1
: maximum random read/write IOPS 50000 for a single disk.PL2
: highest random read/write IOPS 100000 for a single disk.PL3
: maximum random read/write IOPS 1 million for a single disk.
- system
Disk IntegerProvisioned Iops - The predefined IOPS of a system disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. Baseline IOPS = min{1,800 + 50 × Capacity, 50,000}. This parameter is supported only when
system_disk_category
is set tocloud_auto
. - system
Disk IntegerSize - The system disk category of worker node. Its valid value range [40~500] in GB. Default to
120
. - system
Disk StringSnapshot Policy Id - The ID of the automatic snapshot policy used by the system disk.
- Map<String,String>
- Add tags only for ECS instances. The maximum length of the tag key is 128 characters. The tag key and value cannot start with aliyun or acs:, or contain https:// or http://.
- taints
List<Node
Pool Taint> - A List of Kubernetes taints to assign to the nodes. Detailed below. More information in Taints and Toleration. See
taints
below. - tee
Config NodePool Tee Config - The configuration about confidential computing for the cluster. See
tee_config
below. - unschedulable Boolean
- Whether the node after expansion can be scheduled.
- update
Nodes Boolean - Synchronously update node labels and taints.
- user
Data String - Node custom data, base64-encoded.
- cluster
Id string - The id of kubernetes cluster.
- instance
Types string[] - In the node instance specification list, you can select multiple instance specifications as alternatives. When each node is created, it will try to purchase from the first specification until it is created successfully. The final purchased instance specifications may vary with inventory changes.
- vswitch
Ids string[] - The vswitches used by node pool workers.
- auto
Renew boolean - Whether to enable automatic renewal for nodes in the node pool takes effect only when
instance_charge_type
is set toPrePaid
. Default value:false
. Valid values: - auto
Renew numberPeriod - The automatic renewal period of nodes in the node pool takes effect only when you select Prepaid and Automatic Renewal, and is a required value. When
PeriodUnit = Month
, the value range is {1, 2, 3, 6, 12}. Default value: 1. - cis
Enabled boolean - Whether enable worker node to support cis security reinforcement, its valid value
true
orfalse
. Default tofalse
and apply to AliyunLinux series. Usesecurity_hardening_os
instead. - compensate
With booleanOn Demand - Specifies whether to automatically create pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created due to reasons such as cost or insufficient inventory. This parameter takes effect when you set
multi_az_policy
toCOST_OPTIMIZED
. Valid values:true
: automatically creates pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created.false
: does not create pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created. - cpu
Policy string - Node CPU management policies. Default value:
none
. When the cluster version is 1.12.6 or later, the following two policies are supported: - data
Disks NodePool Data Disk[] - Configure the data disk of the node in the node pool. See
data_disks
below. - deployment
Set stringId - The deployment set of node pool. Specify the deploymentSet to ensure that the nodes in the node pool can be distributed on different physical machines.
- desired
Size number - Number of expected nodes in the node pool.
- force
Delete boolean - Whether to force deletion.
- format
Disk boolean - After you select this check box, if data disks have been attached to the specified ECS instances and the file system of the last data disk is uninitialized, the system automatically formats the last data disk to ext4 and mounts the data disk to /var/lib/docker and /var/lib/kubelet. The original data on the disk will be cleared. Make sure that you back up data in advance. If no data disk is mounted on the ECS instance, no new data disk will be purchased. Default is
false
. - image
Id string - The custom image ID. The system-provided image is used by default.
- image
Type string - The operating system image type and the
platform
parameter can be selected from the following values:AliyunLinux
: Alinux2 image.AliyunLinux3
: Alinux3 image.AliyunLinux3Arm64
: Alinux3 mirror ARM version.AliyunLinuxUEFI
: Alinux2 Image UEFI version.CentOS
: CentOS image.Windows
: Windows image.WindowsCore
: WindowsCore image.ContainerOS
: container-optimized image.
- install
Cloud booleanMonitor - Whether to install cloud monitoring on the ECS node. After installation, you can view the monitoring information of the created ECS instance in the cloud monitoring console and recommend enable it. Default value:
false
. Valid values: - instance
Charge stringType - Node payment type. Valid values:
PostPaid
,PrePaid
, default isPostPaid
. If value isPrePaid
, the argumentsperiod
,period_unit
,auto_renew
andauto_renew_period
are required. - instances string[]
- The instance list. Add existing nodes under the same cluster VPC to the node pool.
- internet
Charge stringType - The billing method for network usage. Valid values
PayByBandwidth
andPayByTraffic
. Conflict witheip_internet_charge_type
, EIP and public network IP can only choose one. - internet
Max numberBandwidth Out - The maximum bandwidth of the public IP address of the node. The unit is Mbps(Mega bit per second). The value range is:[1,100]
- keep
Instance booleanName - Add an existing instance to the node pool, whether to keep the original instance name. It is recommended to set to
true
. - key
Name string - The name of the key pair. When the node pool is a managed node pool, only
key_name
is supported. - kms
Encrypted stringPassword - An KMS encrypts password used to a cs kubernetes. You have to specify one of
password
key_name
kms_encrypted_password
fields. - kms
Encryption {[key: string]: string}Context - An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating a cs kubernetes withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set. - kubelet
Configuration NodePool Kubelet Configuration - Kubelet configuration parameters for worker nodes. See
kubelet_configuration
below. More information in Kubelet Configuration. Seekubelet_configuration
below. - labels
Node
Pool Label[] - A List of Kubernetes labels to assign to the nodes . Only labels that are applied with the ACK API are managed by this argument. Detailed below. More information in Labels. See
labels
below. - login
As booleanNon Root - Whether the ECS instance is logged on as a ecs-user user. Valid value:
true
andfalse
. - management
Node
Pool Management - Managed node pool configuration. See
management
below. - multi
Az stringPolicy - The scaling policy for ECS instances in a multi-zone scaling group. Valid value:
PRIORITY
,COST_OPTIMIZED
andBALANCE
.PRIORITY
: scales the capacity according to the virtual switches you define (VSwitchIds.N). When an ECS instance cannot be created in the zone where the higher-priority vSwitch is located, the next-priority vSwitch is automatically used to create an ECS instance.COST_OPTIMIZED
: try to create by vCPU unit price from low to high. When the scaling configuration is configured with multiple instances of preemptible billing, preemptible instances are created first. You can continue to use theCompensateWithOnDemand
parameter to specify whether to automatically try to create a preemptible instance by paying for it. It takes effect only when the scaling configuration has multi-instance specifications or preemptible instances.BALANCE
: distributes ECS instances evenly among the multi-zone specified by the scaling group. If the zones become unbalanced due to insufficient inventory, you can use the API RebalanceInstances to balance resources. - name string
- . Field 'name' has been deprecated from provider version 1.219.0. New field 'node_pool_name' instead.
- node
Count number - The worker node number of the node pool. From version 1.111.0,
node_count
is not required. - node
Name stringMode - Each node name consists of a prefix, its private network IP, and a suffix, separated by commas. The input format is
customized,,ip,
.- The prefix and suffix can be composed of one or more parts separated by '.', each part can use lowercase letters, numbers and '-', and the beginning and end of the node name must be lowercase letters and numbers.
- The node IP address is the complete private IP address of the node.
- For example, if the string
customized,aliyun,ip,com
is passed in (where 'customized' and 'ip' are fixed strings, 'aliyun' is the prefix, and 'com' is the suffix), the name of the node isaliyun192.168.xxx.xxxcom
.
- node
Pool stringName - The name of node pool.
- on
Demand numberBase Capacity - The minimum number of pay-as-you-go instances that must be kept in the scaling group. Valid values: 0 to 1000. If the number of pay-as-you-go instances is less than the value of this parameter, Auto Scaling preferably creates pay-as-you-go instances.
- on
Demand numberPercentage Above Base Capacity - The percentage of pay-as-you-go instances among the extra instances that exceed the number specified by
on_demand_base_capacity
. Valid values: 0 to 100. - password string
- The password of ssh login. You have to specify one of
password
andkey_name
fields. The password rule is 8 to 30 characters and contains at least three items (upper and lower case letters, numbers, and special symbols). - period number
- Node payment period. Its valid value is one of {1, 2, 3, 6, 12}.
- period
Unit string - Node payment period unit, valid value:
Month
. Default isMonth
. - platform string
- Operating system release, using
image_type
instead. - pre
User stringData - Node pre custom data, base64-encoded, the script executed before the node is initialized.
- private
Pool NodeOptions Pool Private Pool Options - Private node pool configuration. See
private_pool_options
below. - rds
Instances string[] - The list of RDS instances.
- resource
Group stringId - The ID of the resource group
- rolling
Policy NodePool Rolling Policy - Rotary configuration. See
rolling_policy
below. - runtime
Name string - The runtime name of containers. If not set, the cluster runtime will be used as the node pool runtime. If you select another container runtime, see Comparison of Docker, containerd, and Sandboxed-Container.
- runtime
Version string - The runtime version of containers. If not set, the cluster runtime will be used as the node pool runtime.
- scaling
Config NodePool Scaling Config - Automatic scaling configuration. See
scaling_config
below. - scaling
Policy string - Scaling group mode, default value:
release
. Valid values: - security
Group stringId - The security group ID of the node pool. This field has been replaced by
security_group_ids
, please use thesecurity_group_ids
field instead. - security
Group string[]Ids - Multiple security groups can be configured for a node pool. If both
security_group_ids
andsecurity_group_id
are configured,security_group_ids
takes effect. This field cannot be modified. - security
Hardening booleanOs - Alibaba Cloud OS security reinforcement. Default value:
false
. Value: - soc
Enabled boolean Whether enable worker node to support soc security reinforcement, its valid value
true
orfalse
. Default tofalse
and apply to AliyunLinux series. See SOC Reinforcement.NOTE: It is forbidden to set both
security_hardening_os
andsoc_enabled
totrue
at the same time.- spot
Instance numberPools - The number of instance types that are available. Auto Scaling creates preemptible instances of multiple instance types that are available at the lowest cost. Valid values: 1 to 10.
- spot
Instance booleanRemedy - Specifies whether to supplement preemptible instances when the number of preemptible instances drops below the specified minimum number. If you set the value to true, Auto Scaling attempts to create a new preemptible instance when the system notifies that an existing preemptible instance is about to be reclaimed. Valid values:
true
: enables the supplementation of preemptible instances.false
: disables the supplementation of preemptible instances. - spot
Price NodeLimits Pool Spot Price Limit[] - The current single preemptible instance type market price range configuration. See
spot_price_limit
below. - spot
Strategy string - The preemptible instance type. Value:
NoSpot
: Non-preemptible instance.SpotWithPriceLimit
: Set the upper limit of the preemptible instance price.SpotAsPriceGo
: The system automatically bids, following the actual price of the current market.
- system
Disk booleanBursting Enabled - Specifies whether to enable the burst feature for system disks. Valid values:
true
: enables the burst feature.false
: disables the burst feature. This parameter is supported only whensystem_disk_category
is set tocloud_auto
. - system
Disk string[]Categories - The multi-disk categories of the system disk. When a high-priority disk type cannot be used, Auto Scaling automatically tries to create a system disk with the next priority disk category. Valid values:
cloud
: cloud disk.cloud_efficiency
: a high-efficiency cloud disk.cloud_ssd
:SSD cloud disk.cloud_essd
: ESSD cloud disk. - system
Disk stringCategory - The system disk category of worker node. Its valid value are
cloud_ssd
,cloud_efficiency
,cloud_essd
andcloud_auto
. - system
Disk stringEncrypt Algorithm - The encryption algorithm used by the system disk. Value range: aes-256.
- system
Disk booleanEncrypted - Whether to encrypt the system disk. Value range:
true
: encryption.false
: Do not encrypt. - system
Disk stringKms Key - The ID of the KMS key used by the system disk.
- system
Disk stringPerformance Level - The system disk performance of the node takes effect only for the ESSD disk.
PL0
: maximum random read/write IOPS 10000 for a single disk.PL1
: maximum random read/write IOPS 50000 for a single disk.PL2
: highest random read/write IOPS 100000 for a single disk.PL3
: maximum random read/write IOPS 1 million for a single disk.
- system
Disk numberProvisioned Iops - The predefined IOPS of a system disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. Baseline IOPS = min{1,800 + 50 × Capacity, 50,000}. This parameter is supported only when
system_disk_category
is set tocloud_auto
. - system
Disk numberSize - The system disk category of worker node. Its valid value range [40~500] in GB. Default to
120
. - system
Disk stringSnapshot Policy Id - The ID of the automatic snapshot policy used by the system disk.
- {[key: string]: string}
- Add tags only for ECS instances. The maximum length of the tag key is 128 characters. The tag key and value cannot start with aliyun or acs:, or contain https:// or http://.
- taints
Node
Pool Taint[] - A List of Kubernetes taints to assign to the nodes. Detailed below. More information in Taints and Toleration. See
taints
below. - tee
Config NodePool Tee Config - The configuration about confidential computing for the cluster. See
tee_config
below. - unschedulable boolean
- Whether the node after expansion can be scheduled.
- update
Nodes boolean - Synchronously update node labels and taints.
- user
Data string - Node custom data, base64-encoded.
- cluster_
id str - The id of kubernetes cluster.
- instance_
types Sequence[str] - In the node instance specification list, you can select multiple instance specifications as alternatives. When each node is created, it will try to purchase from the first specification until it is created successfully. The final purchased instance specifications may vary with inventory changes.
- vswitch_
ids Sequence[str] - The vswitches used by node pool workers.
- auto_
renew bool - Whether to enable automatic renewal for nodes in the node pool takes effect only when
instance_charge_type
is set toPrePaid
. Default value:false
. Valid values: - auto_
renew_ intperiod - The automatic renewal period of nodes in the node pool takes effect only when you select Prepaid and Automatic Renewal, and is a required value. When
PeriodUnit = Month
, the value range is {1, 2, 3, 6, 12}. Default value: 1. - cis_
enabled bool - Whether enable worker node to support cis security reinforcement, its valid value
true
orfalse
. Default tofalse
and apply to AliyunLinux series. Usesecurity_hardening_os
instead. - compensate_
with_ boolon_ demand - Specifies whether to automatically create pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created due to reasons such as cost or insufficient inventory. This parameter takes effect when you set
multi_az_policy
toCOST_OPTIMIZED
. Valid values:true
: automatically creates pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created.false
: does not create pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created. - cpu_
policy str - Node CPU management policies. Default value:
none
. When the cluster version is 1.12.6 or later, the following two policies are supported: - data_
disks Sequence[NodePool Data Disk Args] - Configure the data disk of the node in the node pool. See
data_disks
below. - deployment_
set_ strid - The deployment set of node pool. Specify the deploymentSet to ensure that the nodes in the node pool can be distributed on different physical machines.
- desired_
size int - Number of expected nodes in the node pool.
- force_
delete bool - Whether to force deletion.
- format_
disk bool - After you select this check box, if data disks have been attached to the specified ECS instances and the file system of the last data disk is uninitialized, the system automatically formats the last data disk to ext4 and mounts the data disk to /var/lib/docker and /var/lib/kubelet. The original data on the disk will be cleared. Make sure that you back up data in advance. If no data disk is mounted on the ECS instance, no new data disk will be purchased. Default is
false
. - image_
id str - The custom image ID. The system-provided image is used by default.
- image_
type str - The operating system image type and the
platform
parameter can be selected from the following values:AliyunLinux
: Alinux2 image.AliyunLinux3
: Alinux3 image.AliyunLinux3Arm64
: Alinux3 mirror ARM version.AliyunLinuxUEFI
: Alinux2 Image UEFI version.CentOS
: CentOS image.Windows
: Windows image.WindowsCore
: WindowsCore image.ContainerOS
: container-optimized image.
- install_
cloud_ boolmonitor - Whether to install cloud monitoring on the ECS node. After installation, you can view the monitoring information of the created ECS instance in the cloud monitoring console and recommend enable it. Default value:
false
. Valid values: - instance_
charge_ strtype - Node payment type. Valid values:
PostPaid
,PrePaid
, default isPostPaid
. If value isPrePaid
, the argumentsperiod
,period_unit
,auto_renew
andauto_renew_period
are required. - instances Sequence[str]
- The instance list. Add existing nodes under the same cluster VPC to the node pool.
- internet_
charge_ strtype - The billing method for network usage. Valid values
PayByBandwidth
andPayByTraffic
. Conflict witheip_internet_charge_type
, EIP and public network IP can only choose one. - internet_
max_ intbandwidth_ out - The maximum bandwidth of the public IP address of the node. The unit is Mbps(Mega bit per second). The value range is:[1,100]
- keep_
instance_ boolname - Add an existing instance to the node pool, whether to keep the original instance name. It is recommended to set to
true
. - key_
name str - The name of the key pair. When the node pool is a managed node pool, only
key_name
is supported. - kms_
encrypted_ strpassword - An KMS encrypts password used to a cs kubernetes. You have to specify one of
password
key_name
kms_encrypted_password
fields. - kms_
encryption_ Mapping[str, str]context - An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating a cs kubernetes withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set. - kubelet_
configuration NodePool Kubelet Configuration Args - Kubelet configuration parameters for worker nodes. See
kubelet_configuration
below. More information in Kubelet Configuration. Seekubelet_configuration
below. - labels
Sequence[Node
Pool Label Args] - A List of Kubernetes labels to assign to the nodes . Only labels that are applied with the ACK API are managed by this argument. Detailed below. More information in Labels. See
labels
below. - login_
as_ boolnon_ root - Whether the ECS instance is logged on as a ecs-user user. Valid value:
true
andfalse
. - management
Node
Pool Management Args - Managed node pool configuration. See
management
below. - multi_
az_ strpolicy - The scaling policy for ECS instances in a multi-zone scaling group. Valid value:
PRIORITY
,COST_OPTIMIZED
andBALANCE
.PRIORITY
: scales the capacity according to the virtual switches you define (VSwitchIds.N). When an ECS instance cannot be created in the zone where the higher-priority vSwitch is located, the next-priority vSwitch is automatically used to create an ECS instance.COST_OPTIMIZED
: try to create by vCPU unit price from low to high. When the scaling configuration is configured with multiple instances of preemptible billing, preemptible instances are created first. You can continue to use theCompensateWithOnDemand
parameter to specify whether to automatically try to create a preemptible instance by paying for it. It takes effect only when the scaling configuration has multi-instance specifications or preemptible instances.BALANCE
: distributes ECS instances evenly among the multi-zone specified by the scaling group. If the zones become unbalanced due to insufficient inventory, you can use the API RebalanceInstances to balance resources. - name str
- . Field 'name' has been deprecated from provider version 1.219.0. New field 'node_pool_name' instead.
- node_
count int - The worker node number of the node pool. From version 1.111.0,
node_count
is not required. - node_
name_ strmode - Each node name consists of a prefix, its private network IP, and a suffix, separated by commas. The input format is
customized,,ip,
.- The prefix and suffix can be composed of one or more parts separated by '.', each part can use lowercase letters, numbers and '-', and the beginning and end of the node name must be lowercase letters and numbers.
- The node IP address is the complete private IP address of the node.
- For example, if the string
customized,aliyun,ip,com
is passed in (where 'customized' and 'ip' are fixed strings, 'aliyun' is the prefix, and 'com' is the suffix), the name of the node isaliyun192.168.xxx.xxxcom
.
- node_
pool_ strname - The name of node pool.
- on_
demand_ intbase_ capacity - The minimum number of pay-as-you-go instances that must be kept in the scaling group. Valid values: 0 to 1000. If the number of pay-as-you-go instances is less than the value of this parameter, Auto Scaling preferably creates pay-as-you-go instances.
- on_
demand_ intpercentage_ above_ base_ capacity - The percentage of pay-as-you-go instances among the extra instances that exceed the number specified by
on_demand_base_capacity
. Valid values: 0 to 100. - password str
- The password of ssh login. You have to specify one of
password
andkey_name
fields. The password rule is 8 to 30 characters and contains at least three items (upper and lower case letters, numbers, and special symbols). - period int
- Node payment period. Its valid value is one of {1, 2, 3, 6, 12}.
- period_
unit str - Node payment period unit, valid value:
Month
. Default isMonth
. - platform str
- Operating system release, using
image_type
instead. - pre_
user_ strdata - Node pre custom data, base64-encoded, the script executed before the node is initialized.
- private_
pool_ Nodeoptions Pool Private Pool Options Args - Private node pool configuration. See
private_pool_options
below. - rds_
instances Sequence[str] - The list of RDS instances.
- resource_
group_ strid - The ID of the resource group
- rolling_
policy NodePool Rolling Policy Args - Rotary configuration. See
rolling_policy
below. - runtime_
name str - The runtime name of containers. If not set, the cluster runtime will be used as the node pool runtime. If you select another container runtime, see Comparison of Docker, containerd, and Sandboxed-Container.
- runtime_
version str - The runtime version of containers. If not set, the cluster runtime will be used as the node pool runtime.
- scaling_
config NodePool Scaling Config Args - Automatic scaling configuration. See
scaling_config
below. - scaling_
policy str - Scaling group mode, default value:
release
. Valid values: - security_
group_ strid - The security group ID of the node pool. This field has been replaced by
security_group_ids
, please use thesecurity_group_ids
field instead. - security_
group_ Sequence[str]ids - Multiple security groups can be configured for a node pool. If both
security_group_ids
andsecurity_group_id
are configured,security_group_ids
takes effect. This field cannot be modified. - security_
hardening_ boolos - Alibaba Cloud OS security reinforcement. Default value:
false
. Value: - soc_
enabled bool Whether enable worker node to support soc security reinforcement, its valid value
true
orfalse
. Default tofalse
and apply to AliyunLinux series. See SOC Reinforcement.NOTE: It is forbidden to set both
security_hardening_os
andsoc_enabled
totrue
at the same time.- spot_
instance_ intpools - The number of instance types that are available. Auto Scaling creates preemptible instances of multiple instance types that are available at the lowest cost. Valid values: 1 to 10.
- spot_
instance_ boolremedy - Specifies whether to supplement preemptible instances when the number of preemptible instances drops below the specified minimum number. If you set the value to true, Auto Scaling attempts to create a new preemptible instance when the system notifies that an existing preemptible instance is about to be reclaimed. Valid values:
true
: enables the supplementation of preemptible instances.false
: disables the supplementation of preemptible instances. - spot_
price_ Sequence[Nodelimits Pool Spot Price Limit Args] - The current single preemptible instance type market price range configuration. See
spot_price_limit
below. - spot_
strategy str - The preemptible instance type. Value:
NoSpot
: Non-preemptible instance.SpotWithPriceLimit
: Set the upper limit of the preemptible instance price.SpotAsPriceGo
: The system automatically bids, following the actual price of the current market.
- system_
disk_ boolbursting_ enabled - Specifies whether to enable the burst feature for system disks. Valid values:
true
: enables the burst feature.false
: disables the burst feature. This parameter is supported only whensystem_disk_category
is set tocloud_auto
. - system_
disk_ Sequence[str]categories - The multi-disk categories of the system disk. When a high-priority disk type cannot be used, Auto Scaling automatically tries to create a system disk with the next priority disk category. Valid values:
cloud
: cloud disk.cloud_efficiency
: a high-efficiency cloud disk.cloud_ssd
:SSD cloud disk.cloud_essd
: ESSD cloud disk. - system_
disk_ strcategory - The system disk category of worker node. Its valid value are
cloud_ssd
,cloud_efficiency
,cloud_essd
andcloud_auto
. - system_
disk_ strencrypt_ algorithm - The encryption algorithm used by the system disk. Value range: aes-256.
- system_
disk_ boolencrypted - Whether to encrypt the system disk. Value range:
true
: encryption.false
: Do not encrypt. - system_
disk_ strkms_ key - The ID of the KMS key used by the system disk.
- system_
disk_ strperformance_ level - The system disk performance of the node takes effect only for the ESSD disk.
PL0
: maximum random read/write IOPS 10000 for a single disk.PL1
: maximum random read/write IOPS 50000 for a single disk.PL2
: highest random read/write IOPS 100000 for a single disk.PL3
: maximum random read/write IOPS 1 million for a single disk.
- system_
disk_ intprovisioned_ iops - The predefined IOPS of a system disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. Baseline IOPS = min{1,800 + 50 × Capacity, 50,000}. This parameter is supported only when
system_disk_category
is set tocloud_auto
. - system_
disk_ intsize - The system disk category of worker node. Its valid value range [40~500] in GB. Default to
120
. - system_
disk_ strsnapshot_ policy_ id - The ID of the automatic snapshot policy used by the system disk.
- Mapping[str, str]
- Add tags only for ECS instances. The maximum length of the tag key is 128 characters. The tag key and value cannot start with aliyun or acs:, or contain https:// or http://.
- taints
Sequence[Node
Pool Taint Args] - A List of Kubernetes taints to assign to the nodes. Detailed below. More information in Taints and Toleration. See
taints
below. - tee_
config NodePool Tee Config Args - The configuration about confidential computing for the cluster. See
tee_config
below. - unschedulable bool
- Whether the node after expansion can be scheduled.
- update_
nodes bool - Synchronously update node labels and taints.
- user_
data str - Node custom data, base64-encoded.
- cluster
Id String - The id of kubernetes cluster.
- instance
Types List<String> - In the node instance specification list, you can select multiple instance specifications as alternatives. When each node is created, it will try to purchase from the first specification until it is created successfully. The final purchased instance specifications may vary with inventory changes.
- vswitch
Ids List<String> - The vswitches used by node pool workers.
- auto
Renew Boolean - Whether to enable automatic renewal for nodes in the node pool takes effect only when
instance_charge_type
is set toPrePaid
. Default value:false
. Valid values: - auto
Renew NumberPeriod - The automatic renewal period of nodes in the node pool takes effect only when you select Prepaid and Automatic Renewal, and is a required value. When
PeriodUnit = Month
, the value range is {1, 2, 3, 6, 12}. Default value: 1. - cis
Enabled Boolean - Whether enable worker node to support cis security reinforcement, its valid value
true
orfalse
. Default tofalse
and apply to AliyunLinux series. Usesecurity_hardening_os
instead. - compensate
With BooleanOn Demand - Specifies whether to automatically create pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created due to reasons such as cost or insufficient inventory. This parameter takes effect when you set
multi_az_policy
toCOST_OPTIMIZED
. Valid values:true
: automatically creates pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created.false
: does not create pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created. - cpu
Policy String - Node CPU management policies. Default value:
none
. When the cluster version is 1.12.6 or later, the following two policies are supported: - data
Disks List<Property Map> - Configure the data disk of the node in the node pool. See
data_disks
below. - deployment
Set StringId - The deployment set of node pool. Specify the deploymentSet to ensure that the nodes in the node pool can be distributed on different physical machines.
- desired
Size Number - Number of expected nodes in the node pool.
- force
Delete Boolean - Whether to force deletion.
- format
Disk Boolean - After you select this check box, if data disks have been attached to the specified ECS instances and the file system of the last data disk is uninitialized, the system automatically formats the last data disk to ext4 and mounts the data disk to /var/lib/docker and /var/lib/kubelet. The original data on the disk will be cleared. Make sure that you back up data in advance. If no data disk is mounted on the ECS instance, no new data disk will be purchased. Default is
false
. - image
Id String - The custom image ID. The system-provided image is used by default.
- image
Type String - The operating system image type and the
platform
parameter can be selected from the following values:AliyunLinux
: Alinux2 image.AliyunLinux3
: Alinux3 image.AliyunLinux3Arm64
: Alinux3 mirror ARM version.AliyunLinuxUEFI
: Alinux2 Image UEFI version.CentOS
: CentOS image.Windows
: Windows image.WindowsCore
: WindowsCore image.ContainerOS
: container-optimized image.
- install
Cloud BooleanMonitor - Whether to install cloud monitoring on the ECS node. After installation, you can view the monitoring information of the created ECS instance in the cloud monitoring console and recommend enable it. Default value:
false
. Valid values: - instance
Charge StringType - Node payment type. Valid values:
PostPaid
,PrePaid
, default isPostPaid
. If value isPrePaid
, the argumentsperiod
,period_unit
,auto_renew
andauto_renew_period
are required. - instances List<String>
- The instance list. Add existing nodes under the same cluster VPC to the node pool.
- internet
Charge StringType - The billing method for network usage. Valid values
PayByBandwidth
andPayByTraffic
. Conflict witheip_internet_charge_type
, EIP and public network IP can only choose one. - internet
Max NumberBandwidth Out - The maximum bandwidth of the public IP address of the node. The unit is Mbps(Mega bit per second). The value range is:[1,100]
- keep
Instance BooleanName - Add an existing instance to the node pool, whether to keep the original instance name. It is recommended to set to
true
. - key
Name String - The name of the key pair. When the node pool is a managed node pool, only
key_name
is supported. - kms
Encrypted StringPassword - An KMS encrypts password used to a cs kubernetes. You have to specify one of
password
key_name
kms_encrypted_password
fields. - kms
Encryption Map<String>Context - An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating a cs kubernetes withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set. - kubelet
Configuration Property Map - Kubelet configuration parameters for worker nodes. See
kubelet_configuration
below. More information in Kubelet Configuration. Seekubelet_configuration
below. - labels List<Property Map>
- A List of Kubernetes labels to assign to the nodes . Only labels that are applied with the ACK API are managed by this argument. Detailed below. More information in Labels. See
labels
below. - login
As BooleanNon Root - Whether the ECS instance is logged on as a ecs-user user. Valid value:
true
andfalse
. - management Property Map
- Managed node pool configuration. See
management
below. - multi
Az StringPolicy - The scaling policy for ECS instances in a multi-zone scaling group. Valid value:
PRIORITY
,COST_OPTIMIZED
andBALANCE
.PRIORITY
: scales the capacity according to the virtual switches you define (VSwitchIds.N). When an ECS instance cannot be created in the zone where the higher-priority vSwitch is located, the next-priority vSwitch is automatically used to create an ECS instance.COST_OPTIMIZED
: try to create by vCPU unit price from low to high. When the scaling configuration is configured with multiple instances of preemptible billing, preemptible instances are created first. You can continue to use theCompensateWithOnDemand
parameter to specify whether to automatically try to create a preemptible instance by paying for it. It takes effect only when the scaling configuration has multi-instance specifications or preemptible instances.BALANCE
: distributes ECS instances evenly among the multi-zone specified by the scaling group. If the zones become unbalanced due to insufficient inventory, you can use the API RebalanceInstances to balance resources. - name String
- . Field 'name' has been deprecated from provider version 1.219.0. New field 'node_pool_name' instead.
- node
Count Number - The worker node number of the node pool. From version 1.111.0,
node_count
is not required. - node
Name StringMode - Each node name consists of a prefix, its private network IP, and a suffix, separated by commas. The input format is
customized,,ip,
.- The prefix and suffix can be composed of one or more parts separated by '.', each part can use lowercase letters, numbers and '-', and the beginning and end of the node name must be lowercase letters and numbers.
- The node IP address is the complete private IP address of the node.
- For example, if the string
customized,aliyun,ip,com
is passed in (where 'customized' and 'ip' are fixed strings, 'aliyun' is the prefix, and 'com' is the suffix), the name of the node isaliyun192.168.xxx.xxxcom
.
- node
Pool StringName - The name of node pool.
- on
Demand NumberBase Capacity - The minimum number of pay-as-you-go instances that must be kept in the scaling group. Valid values: 0 to 1000. If the number of pay-as-you-go instances is less than the value of this parameter, Auto Scaling preferably creates pay-as-you-go instances.
- on
Demand NumberPercentage Above Base Capacity - The percentage of pay-as-you-go instances among the extra instances that exceed the number specified by
on_demand_base_capacity
. Valid values: 0 to 100. - password String
- The password of ssh login. You have to specify one of
password
andkey_name
fields. The password rule is 8 to 30 characters and contains at least three items (upper and lower case letters, numbers, and special symbols). - period Number
- Node payment period. Its valid value is one of {1, 2, 3, 6, 12}.
- period
Unit String - Node payment period unit, valid value:
Month
. Default isMonth
. - platform String
- Operating system release, using
image_type
instead. - pre
User StringData - Node pre custom data, base64-encoded, the script executed before the node is initialized.
- private
Pool Property MapOptions - Private node pool configuration. See
private_pool_options
below. - rds
Instances List<String> - The list of RDS instances.
- resource
Group StringId - The ID of the resource group
- rolling
Policy Property Map - Rotary configuration. See
rolling_policy
below. - runtime
Name String - The runtime name of containers. If not set, the cluster runtime will be used as the node pool runtime. If you select another container runtime, see Comparison of Docker, containerd, and Sandboxed-Container.
- runtime
Version String - The runtime version of containers. If not set, the cluster runtime will be used as the node pool runtime.
- scaling
Config Property Map - Automatic scaling configuration. See
scaling_config
below. - scaling
Policy String - Scaling group mode, default value:
release
. Valid values: - security
Group StringId - The security group ID of the node pool. This field has been replaced by
security_group_ids
, please use thesecurity_group_ids
field instead. - security
Group List<String>Ids - Multiple security groups can be configured for a node pool. If both
security_group_ids
andsecurity_group_id
are configured,security_group_ids
takes effect. This field cannot be modified. - security
Hardening BooleanOs - Alibaba Cloud OS security reinforcement. Default value:
false
. Value: - soc
Enabled Boolean Whether enable worker node to support soc security reinforcement, its valid value
true
orfalse
. Default tofalse
and apply to AliyunLinux series. See SOC Reinforcement.NOTE: It is forbidden to set both
security_hardening_os
andsoc_enabled
totrue
at the same time.- spot
Instance NumberPools - The number of instance types that are available. Auto Scaling creates preemptible instances of multiple instance types that are available at the lowest cost. Valid values: 1 to 10.
- spot
Instance BooleanRemedy - Specifies whether to supplement preemptible instances when the number of preemptible instances drops below the specified minimum number. If you set the value to true, Auto Scaling attempts to create a new preemptible instance when the system notifies that an existing preemptible instance is about to be reclaimed. Valid values:
true
: enables the supplementation of preemptible instances.false
: disables the supplementation of preemptible instances. - spot
Price List<Property Map>Limits - The current single preemptible instance type market price range configuration. See
spot_price_limit
below. - spot
Strategy String - The preemptible instance type. Value:
NoSpot
: Non-preemptible instance.SpotWithPriceLimit
: Set the upper limit of the preemptible instance price.SpotAsPriceGo
: The system automatically bids, following the actual price of the current market.
- system
Disk BooleanBursting Enabled - Specifies whether to enable the burst feature for system disks. Valid values:
true
: enables the burst feature.false
: disables the burst feature. This parameter is supported only whensystem_disk_category
is set tocloud_auto
. - system
Disk List<String>Categories - The multi-disk categories of the system disk. When a high-priority disk type cannot be used, Auto Scaling automatically tries to create a system disk with the next priority disk category. Valid values:
cloud
: cloud disk.cloud_efficiency
: a high-efficiency cloud disk.cloud_ssd
:SSD cloud disk.cloud_essd
: ESSD cloud disk. - system
Disk StringCategory - The system disk category of worker node. Its valid value are
cloud_ssd
,cloud_efficiency
,cloud_essd
andcloud_auto
. - system
Disk StringEncrypt Algorithm - The encryption algorithm used by the system disk. Value range: aes-256.
- system
Disk BooleanEncrypted - Whether to encrypt the system disk. Value range:
true
: encryption.false
: Do not encrypt. - system
Disk StringKms Key - The ID of the KMS key used by the system disk.
- system
Disk StringPerformance Level - The system disk performance of the node takes effect only for the ESSD disk.
PL0
: maximum random read/write IOPS 10000 for a single disk.PL1
: maximum random read/write IOPS 50000 for a single disk.PL2
: highest random read/write IOPS 100000 for a single disk.PL3
: maximum random read/write IOPS 1 million for a single disk.
- system
Disk NumberProvisioned Iops - The predefined IOPS of a system disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. Baseline IOPS = min{1,800 + 50 × Capacity, 50,000}. This parameter is supported only when
system_disk_category
is set tocloud_auto
. - system
Disk NumberSize - The system disk category of worker node. Its valid value range [40~500] in GB. Default to
120
. - system
Disk StringSnapshot Policy Id - The ID of the automatic snapshot policy used by the system disk.
- Map<String>
- Add tags only for ECS instances. The maximum length of the tag key is 128 characters. The tag key and value cannot start with aliyun or acs:, or contain https:// or http://.
- taints List<Property Map>
- A List of Kubernetes taints to assign to the nodes. Detailed below. More information in Taints and Toleration. See
taints
below. - tee
Config Property Map - The configuration about confidential computing for the cluster. See
tee_config
below. - unschedulable Boolean
- Whether the node after expansion can be scheduled.
- update
Nodes Boolean - Synchronously update node labels and taints.
- user
Data String - Node custom data, base64-encoded.
Outputs
All input properties are implicitly available as output properties. Additionally, the NodePool resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Node
Pool stringId - The first ID of the resource.
- Scaling
Group stringId - The ID of the scaling group.
- Id string
- The provider-assigned unique ID for this managed resource.
- Node
Pool stringId - The first ID of the resource.
- Scaling
Group stringId - The ID of the scaling group.
- id String
- The provider-assigned unique ID for this managed resource.
- node
Pool StringId - The first ID of the resource.
- scaling
Group StringId - The ID of the scaling group.
- id string
- The provider-assigned unique ID for this managed resource.
- node
Pool stringId - The first ID of the resource.
- scaling
Group stringId - The ID of the scaling group.
- id str
- The provider-assigned unique ID for this managed resource.
- node_
pool_ strid - The first ID of the resource.
- scaling_
group_ strid - The ID of the scaling group.
- id String
- The provider-assigned unique ID for this managed resource.
- node
Pool StringId - The first ID of the resource.
- scaling
Group StringId - The ID of the scaling group.
Look up Existing NodePool Resource
Get an existing NodePool 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?: NodePoolState, opts?: CustomResourceOptions): NodePool
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
auto_renew: Optional[bool] = None,
auto_renew_period: Optional[int] = None,
cis_enabled: Optional[bool] = None,
cluster_id: Optional[str] = None,
compensate_with_on_demand: Optional[bool] = None,
cpu_policy: Optional[str] = None,
data_disks: Optional[Sequence[NodePoolDataDiskArgs]] = None,
deployment_set_id: Optional[str] = None,
desired_size: Optional[int] = None,
force_delete: Optional[bool] = None,
format_disk: Optional[bool] = None,
image_id: Optional[str] = None,
image_type: Optional[str] = None,
install_cloud_monitor: Optional[bool] = None,
instance_charge_type: Optional[str] = None,
instance_types: Optional[Sequence[str]] = None,
instances: Optional[Sequence[str]] = None,
internet_charge_type: Optional[str] = None,
internet_max_bandwidth_out: Optional[int] = None,
keep_instance_name: Optional[bool] = None,
key_name: Optional[str] = None,
kms_encrypted_password: Optional[str] = None,
kms_encryption_context: Optional[Mapping[str, str]] = None,
kubelet_configuration: Optional[NodePoolKubeletConfigurationArgs] = None,
labels: Optional[Sequence[NodePoolLabelArgs]] = None,
login_as_non_root: Optional[bool] = None,
management: Optional[NodePoolManagementArgs] = None,
multi_az_policy: Optional[str] = None,
name: Optional[str] = None,
node_count: Optional[int] = None,
node_name_mode: Optional[str] = None,
node_pool_id: Optional[str] = None,
node_pool_name: Optional[str] = None,
on_demand_base_capacity: Optional[int] = None,
on_demand_percentage_above_base_capacity: Optional[int] = None,
password: Optional[str] = None,
period: Optional[int] = None,
period_unit: Optional[str] = None,
platform: Optional[str] = None,
pre_user_data: Optional[str] = None,
private_pool_options: Optional[NodePoolPrivatePoolOptionsArgs] = None,
rds_instances: Optional[Sequence[str]] = None,
resource_group_id: Optional[str] = None,
rolling_policy: Optional[NodePoolRollingPolicyArgs] = None,
runtime_name: Optional[str] = None,
runtime_version: Optional[str] = None,
scaling_config: Optional[NodePoolScalingConfigArgs] = None,
scaling_group_id: Optional[str] = None,
scaling_policy: Optional[str] = None,
security_group_id: Optional[str] = None,
security_group_ids: Optional[Sequence[str]] = None,
security_hardening_os: Optional[bool] = None,
soc_enabled: Optional[bool] = None,
spot_instance_pools: Optional[int] = None,
spot_instance_remedy: Optional[bool] = None,
spot_price_limits: Optional[Sequence[NodePoolSpotPriceLimitArgs]] = None,
spot_strategy: Optional[str] = None,
system_disk_bursting_enabled: Optional[bool] = None,
system_disk_categories: Optional[Sequence[str]] = None,
system_disk_category: Optional[str] = None,
system_disk_encrypt_algorithm: Optional[str] = None,
system_disk_encrypted: Optional[bool] = None,
system_disk_kms_key: Optional[str] = None,
system_disk_performance_level: Optional[str] = None,
system_disk_provisioned_iops: Optional[int] = None,
system_disk_size: Optional[int] = None,
system_disk_snapshot_policy_id: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
taints: Optional[Sequence[NodePoolTaintArgs]] = None,
tee_config: Optional[NodePoolTeeConfigArgs] = None,
unschedulable: Optional[bool] = None,
update_nodes: Optional[bool] = None,
user_data: Optional[str] = None,
vswitch_ids: Optional[Sequence[str]] = None) -> NodePool
func GetNodePool(ctx *Context, name string, id IDInput, state *NodePoolState, opts ...ResourceOption) (*NodePool, error)
public static NodePool Get(string name, Input<string> id, NodePoolState? state, CustomResourceOptions? opts = null)
public static NodePool get(String name, Output<String> id, NodePoolState 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.
- Auto
Renew bool - Whether to enable automatic renewal for nodes in the node pool takes effect only when
instance_charge_type
is set toPrePaid
. Default value:false
. Valid values: - Auto
Renew intPeriod - The automatic renewal period of nodes in the node pool takes effect only when you select Prepaid and Automatic Renewal, and is a required value. When
PeriodUnit = Month
, the value range is {1, 2, 3, 6, 12}. Default value: 1. - Cis
Enabled bool - Whether enable worker node to support cis security reinforcement, its valid value
true
orfalse
. Default tofalse
and apply to AliyunLinux series. Usesecurity_hardening_os
instead. - Cluster
Id string - The id of kubernetes cluster.
- Compensate
With boolOn Demand - Specifies whether to automatically create pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created due to reasons such as cost or insufficient inventory. This parameter takes effect when you set
multi_az_policy
toCOST_OPTIMIZED
. Valid values:true
: automatically creates pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created.false
: does not create pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created. - Cpu
Policy string - Node CPU management policies. Default value:
none
. When the cluster version is 1.12.6 or later, the following two policies are supported: - Data
Disks List<Pulumi.Ali Cloud. CS. Inputs. Node Pool Data Disk> - Configure the data disk of the node in the node pool. See
data_disks
below. - Deployment
Set stringId - The deployment set of node pool. Specify the deploymentSet to ensure that the nodes in the node pool can be distributed on different physical machines.
- Desired
Size int - Number of expected nodes in the node pool.
- Force
Delete bool - Whether to force deletion.
- Format
Disk bool - After you select this check box, if data disks have been attached to the specified ECS instances and the file system of the last data disk is uninitialized, the system automatically formats the last data disk to ext4 and mounts the data disk to /var/lib/docker and /var/lib/kubelet. The original data on the disk will be cleared. Make sure that you back up data in advance. If no data disk is mounted on the ECS instance, no new data disk will be purchased. Default is
false
. - Image
Id string - The custom image ID. The system-provided image is used by default.
- Image
Type string - The operating system image type and the
platform
parameter can be selected from the following values:AliyunLinux
: Alinux2 image.AliyunLinux3
: Alinux3 image.AliyunLinux3Arm64
: Alinux3 mirror ARM version.AliyunLinuxUEFI
: Alinux2 Image UEFI version.CentOS
: CentOS image.Windows
: Windows image.WindowsCore
: WindowsCore image.ContainerOS
: container-optimized image.
- Install
Cloud boolMonitor - Whether to install cloud monitoring on the ECS node. After installation, you can view the monitoring information of the created ECS instance in the cloud monitoring console and recommend enable it. Default value:
false
. Valid values: - Instance
Charge stringType - Node payment type. Valid values:
PostPaid
,PrePaid
, default isPostPaid
. If value isPrePaid
, the argumentsperiod
,period_unit
,auto_renew
andauto_renew_period
are required. - Instance
Types List<string> - In the node instance specification list, you can select multiple instance specifications as alternatives. When each node is created, it will try to purchase from the first specification until it is created successfully. The final purchased instance specifications may vary with inventory changes.
- Instances List<string>
- The instance list. Add existing nodes under the same cluster VPC to the node pool.
- Internet
Charge stringType - The billing method for network usage. Valid values
PayByBandwidth
andPayByTraffic
. Conflict witheip_internet_charge_type
, EIP and public network IP can only choose one. - Internet
Max intBandwidth Out - The maximum bandwidth of the public IP address of the node. The unit is Mbps(Mega bit per second). The value range is:[1,100]
- Keep
Instance boolName - Add an existing instance to the node pool, whether to keep the original instance name. It is recommended to set to
true
. - Key
Name string - The name of the key pair. When the node pool is a managed node pool, only
key_name
is supported. - Kms
Encrypted stringPassword - An KMS encrypts password used to a cs kubernetes. You have to specify one of
password
key_name
kms_encrypted_password
fields. - Kms
Encryption Dictionary<string, string>Context - An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating a cs kubernetes withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set. - Kubelet
Configuration Pulumi.Ali Cloud. CS. Inputs. Node Pool Kubelet Configuration - Kubelet configuration parameters for worker nodes. See
kubelet_configuration
below. More information in Kubelet Configuration. Seekubelet_configuration
below. - Labels
List<Pulumi.
Ali Cloud. CS. Inputs. Node Pool Label> - A List of Kubernetes labels to assign to the nodes . Only labels that are applied with the ACK API are managed by this argument. Detailed below. More information in Labels. See
labels
below. - Login
As boolNon Root - Whether the ECS instance is logged on as a ecs-user user. Valid value:
true
andfalse
. - Management
Pulumi.
Ali Cloud. CS. Inputs. Node Pool Management - Managed node pool configuration. See
management
below. - Multi
Az stringPolicy - The scaling policy for ECS instances in a multi-zone scaling group. Valid value:
PRIORITY
,COST_OPTIMIZED
andBALANCE
.PRIORITY
: scales the capacity according to the virtual switches you define (VSwitchIds.N). When an ECS instance cannot be created in the zone where the higher-priority vSwitch is located, the next-priority vSwitch is automatically used to create an ECS instance.COST_OPTIMIZED
: try to create by vCPU unit price from low to high. When the scaling configuration is configured with multiple instances of preemptible billing, preemptible instances are created first. You can continue to use theCompensateWithOnDemand
parameter to specify whether to automatically try to create a preemptible instance by paying for it. It takes effect only when the scaling configuration has multi-instance specifications or preemptible instances.BALANCE
: distributes ECS instances evenly among the multi-zone specified by the scaling group. If the zones become unbalanced due to insufficient inventory, you can use the API RebalanceInstances to balance resources. - Name string
- . Field 'name' has been deprecated from provider version 1.219.0. New field 'node_pool_name' instead.
- Node
Count int - The worker node number of the node pool. From version 1.111.0,
node_count
is not required. - Node
Name stringMode - Each node name consists of a prefix, its private network IP, and a suffix, separated by commas. The input format is
customized,,ip,
.- The prefix and suffix can be composed of one or more parts separated by '.', each part can use lowercase letters, numbers and '-', and the beginning and end of the node name must be lowercase letters and numbers.
- The node IP address is the complete private IP address of the node.
- For example, if the string
customized,aliyun,ip,com
is passed in (where 'customized' and 'ip' are fixed strings, 'aliyun' is the prefix, and 'com' is the suffix), the name of the node isaliyun192.168.xxx.xxxcom
.
- Node
Pool stringId - The first ID of the resource.
- Node
Pool stringName - The name of node pool.
- On
Demand intBase Capacity - The minimum number of pay-as-you-go instances that must be kept in the scaling group. Valid values: 0 to 1000. If the number of pay-as-you-go instances is less than the value of this parameter, Auto Scaling preferably creates pay-as-you-go instances.
- On
Demand intPercentage Above Base Capacity - The percentage of pay-as-you-go instances among the extra instances that exceed the number specified by
on_demand_base_capacity
. Valid values: 0 to 100. - Password string
- The password of ssh login. You have to specify one of
password
andkey_name
fields. The password rule is 8 to 30 characters and contains at least three items (upper and lower case letters, numbers, and special symbols). - Period int
- Node payment period. Its valid value is one of {1, 2, 3, 6, 12}.
- Period
Unit string - Node payment period unit, valid value:
Month
. Default isMonth
. - Platform string
- Operating system release, using
image_type
instead. - Pre
User stringData - Node pre custom data, base64-encoded, the script executed before the node is initialized.
- Private
Pool Pulumi.Options Ali Cloud. CS. Inputs. Node Pool Private Pool Options - Private node pool configuration. See
private_pool_options
below. - Rds
Instances List<string> - The list of RDS instances.
- Resource
Group stringId - The ID of the resource group
- Rolling
Policy Pulumi.Ali Cloud. CS. Inputs. Node Pool Rolling Policy - Rotary configuration. See
rolling_policy
below. - Runtime
Name string - The runtime name of containers. If not set, the cluster runtime will be used as the node pool runtime. If you select another container runtime, see Comparison of Docker, containerd, and Sandboxed-Container.
- Runtime
Version string - The runtime version of containers. If not set, the cluster runtime will be used as the node pool runtime.
- Scaling
Config Pulumi.Ali Cloud. CS. Inputs. Node Pool Scaling Config - Automatic scaling configuration. See
scaling_config
below. - Scaling
Group stringId - The ID of the scaling group.
- Scaling
Policy string - Scaling group mode, default value:
release
. Valid values: - Security
Group stringId - The security group ID of the node pool. This field has been replaced by
security_group_ids
, please use thesecurity_group_ids
field instead. - Security
Group List<string>Ids - Multiple security groups can be configured for a node pool. If both
security_group_ids
andsecurity_group_id
are configured,security_group_ids
takes effect. This field cannot be modified. - Security
Hardening boolOs - Alibaba Cloud OS security reinforcement. Default value:
false
. Value: - Soc
Enabled bool Whether enable worker node to support soc security reinforcement, its valid value
true
orfalse
. Default tofalse
and apply to AliyunLinux series. See SOC Reinforcement.NOTE: It is forbidden to set both
security_hardening_os
andsoc_enabled
totrue
at the same time.- Spot
Instance intPools - The number of instance types that are available. Auto Scaling creates preemptible instances of multiple instance types that are available at the lowest cost. Valid values: 1 to 10.
- Spot
Instance boolRemedy - Specifies whether to supplement preemptible instances when the number of preemptible instances drops below the specified minimum number. If you set the value to true, Auto Scaling attempts to create a new preemptible instance when the system notifies that an existing preemptible instance is about to be reclaimed. Valid values:
true
: enables the supplementation of preemptible instances.false
: disables the supplementation of preemptible instances. - Spot
Price List<Pulumi.Limits Ali Cloud. CS. Inputs. Node Pool Spot Price Limit> - The current single preemptible instance type market price range configuration. See
spot_price_limit
below. - Spot
Strategy string - The preemptible instance type. Value:
NoSpot
: Non-preemptible instance.SpotWithPriceLimit
: Set the upper limit of the preemptible instance price.SpotAsPriceGo
: The system automatically bids, following the actual price of the current market.
- System
Disk boolBursting Enabled - Specifies whether to enable the burst feature for system disks. Valid values:
true
: enables the burst feature.false
: disables the burst feature. This parameter is supported only whensystem_disk_category
is set tocloud_auto
. - System
Disk List<string>Categories - The multi-disk categories of the system disk. When a high-priority disk type cannot be used, Auto Scaling automatically tries to create a system disk with the next priority disk category. Valid values:
cloud
: cloud disk.cloud_efficiency
: a high-efficiency cloud disk.cloud_ssd
:SSD cloud disk.cloud_essd
: ESSD cloud disk. - System
Disk stringCategory - The system disk category of worker node. Its valid value are
cloud_ssd
,cloud_efficiency
,cloud_essd
andcloud_auto
. - System
Disk stringEncrypt Algorithm - The encryption algorithm used by the system disk. Value range: aes-256.
- System
Disk boolEncrypted - Whether to encrypt the system disk. Value range:
true
: encryption.false
: Do not encrypt. - System
Disk stringKms Key - The ID of the KMS key used by the system disk.
- System
Disk stringPerformance Level - The system disk performance of the node takes effect only for the ESSD disk.
PL0
: maximum random read/write IOPS 10000 for a single disk.PL1
: maximum random read/write IOPS 50000 for a single disk.PL2
: highest random read/write IOPS 100000 for a single disk.PL3
: maximum random read/write IOPS 1 million for a single disk.
- System
Disk intProvisioned Iops - The predefined IOPS of a system disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. Baseline IOPS = min{1,800 + 50 × Capacity, 50,000}. This parameter is supported only when
system_disk_category
is set tocloud_auto
. - System
Disk intSize - The system disk category of worker node. Its valid value range [40~500] in GB. Default to
120
. - System
Disk stringSnapshot Policy Id - The ID of the automatic snapshot policy used by the system disk.
- Dictionary<string, string>
- Add tags only for ECS instances. The maximum length of the tag key is 128 characters. The tag key and value cannot start with aliyun or acs:, or contain https:// or http://.
- Taints
List<Pulumi.
Ali Cloud. CS. Inputs. Node Pool Taint> - A List of Kubernetes taints to assign to the nodes. Detailed below. More information in Taints and Toleration. See
taints
below. - Tee
Config Pulumi.Ali Cloud. CS. Inputs. Node Pool Tee Config - The configuration about confidential computing for the cluster. See
tee_config
below. - Unschedulable bool
- Whether the node after expansion can be scheduled.
- Update
Nodes bool - Synchronously update node labels and taints.
- User
Data string - Node custom data, base64-encoded.
- Vswitch
Ids List<string> - The vswitches used by node pool workers.
- Auto
Renew bool - Whether to enable automatic renewal for nodes in the node pool takes effect only when
instance_charge_type
is set toPrePaid
. Default value:false
. Valid values: - Auto
Renew intPeriod - The automatic renewal period of nodes in the node pool takes effect only when you select Prepaid and Automatic Renewal, and is a required value. When
PeriodUnit = Month
, the value range is {1, 2, 3, 6, 12}. Default value: 1. - Cis
Enabled bool - Whether enable worker node to support cis security reinforcement, its valid value
true
orfalse
. Default tofalse
and apply to AliyunLinux series. Usesecurity_hardening_os
instead. - Cluster
Id string - The id of kubernetes cluster.
- Compensate
With boolOn Demand - Specifies whether to automatically create pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created due to reasons such as cost or insufficient inventory. This parameter takes effect when you set
multi_az_policy
toCOST_OPTIMIZED
. Valid values:true
: automatically creates pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created.false
: does not create pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created. - Cpu
Policy string - Node CPU management policies. Default value:
none
. When the cluster version is 1.12.6 or later, the following two policies are supported: - Data
Disks []NodePool Data Disk Args - Configure the data disk of the node in the node pool. See
data_disks
below. - Deployment
Set stringId - The deployment set of node pool. Specify the deploymentSet to ensure that the nodes in the node pool can be distributed on different physical machines.
- Desired
Size int - Number of expected nodes in the node pool.
- Force
Delete bool - Whether to force deletion.
- Format
Disk bool - After you select this check box, if data disks have been attached to the specified ECS instances and the file system of the last data disk is uninitialized, the system automatically formats the last data disk to ext4 and mounts the data disk to /var/lib/docker and /var/lib/kubelet. The original data on the disk will be cleared. Make sure that you back up data in advance. If no data disk is mounted on the ECS instance, no new data disk will be purchased. Default is
false
. - Image
Id string - The custom image ID. The system-provided image is used by default.
- Image
Type string - The operating system image type and the
platform
parameter can be selected from the following values:AliyunLinux
: Alinux2 image.AliyunLinux3
: Alinux3 image.AliyunLinux3Arm64
: Alinux3 mirror ARM version.AliyunLinuxUEFI
: Alinux2 Image UEFI version.CentOS
: CentOS image.Windows
: Windows image.WindowsCore
: WindowsCore image.ContainerOS
: container-optimized image.
- Install
Cloud boolMonitor - Whether to install cloud monitoring on the ECS node. After installation, you can view the monitoring information of the created ECS instance in the cloud monitoring console and recommend enable it. Default value:
false
. Valid values: - Instance
Charge stringType - Node payment type. Valid values:
PostPaid
,PrePaid
, default isPostPaid
. If value isPrePaid
, the argumentsperiod
,period_unit
,auto_renew
andauto_renew_period
are required. - Instance
Types []string - In the node instance specification list, you can select multiple instance specifications as alternatives. When each node is created, it will try to purchase from the first specification until it is created successfully. The final purchased instance specifications may vary with inventory changes.
- Instances []string
- The instance list. Add existing nodes under the same cluster VPC to the node pool.
- Internet
Charge stringType - The billing method for network usage. Valid values
PayByBandwidth
andPayByTraffic
. Conflict witheip_internet_charge_type
, EIP and public network IP can only choose one. - Internet
Max intBandwidth Out - The maximum bandwidth of the public IP address of the node. The unit is Mbps(Mega bit per second). The value range is:[1,100]
- Keep
Instance boolName - Add an existing instance to the node pool, whether to keep the original instance name. It is recommended to set to
true
. - Key
Name string - The name of the key pair. When the node pool is a managed node pool, only
key_name
is supported. - Kms
Encrypted stringPassword - An KMS encrypts password used to a cs kubernetes. You have to specify one of
password
key_name
kms_encrypted_password
fields. - Kms
Encryption map[string]stringContext - An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating a cs kubernetes withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set. - Kubelet
Configuration NodePool Kubelet Configuration Args - Kubelet configuration parameters for worker nodes. See
kubelet_configuration
below. More information in Kubelet Configuration. Seekubelet_configuration
below. - Labels
[]Node
Pool Label Args - A List of Kubernetes labels to assign to the nodes . Only labels that are applied with the ACK API are managed by this argument. Detailed below. More information in Labels. See
labels
below. - Login
As boolNon Root - Whether the ECS instance is logged on as a ecs-user user. Valid value:
true
andfalse
. - Management
Node
Pool Management Args - Managed node pool configuration. See
management
below. - Multi
Az stringPolicy - The scaling policy for ECS instances in a multi-zone scaling group. Valid value:
PRIORITY
,COST_OPTIMIZED
andBALANCE
.PRIORITY
: scales the capacity according to the virtual switches you define (VSwitchIds.N). When an ECS instance cannot be created in the zone where the higher-priority vSwitch is located, the next-priority vSwitch is automatically used to create an ECS instance.COST_OPTIMIZED
: try to create by vCPU unit price from low to high. When the scaling configuration is configured with multiple instances of preemptible billing, preemptible instances are created first. You can continue to use theCompensateWithOnDemand
parameter to specify whether to automatically try to create a preemptible instance by paying for it. It takes effect only when the scaling configuration has multi-instance specifications or preemptible instances.BALANCE
: distributes ECS instances evenly among the multi-zone specified by the scaling group. If the zones become unbalanced due to insufficient inventory, you can use the API RebalanceInstances to balance resources. - Name string
- . Field 'name' has been deprecated from provider version 1.219.0. New field 'node_pool_name' instead.
- Node
Count int - The worker node number of the node pool. From version 1.111.0,
node_count
is not required. - Node
Name stringMode - Each node name consists of a prefix, its private network IP, and a suffix, separated by commas. The input format is
customized,,ip,
.- The prefix and suffix can be composed of one or more parts separated by '.', each part can use lowercase letters, numbers and '-', and the beginning and end of the node name must be lowercase letters and numbers.
- The node IP address is the complete private IP address of the node.
- For example, if the string
customized,aliyun,ip,com
is passed in (where 'customized' and 'ip' are fixed strings, 'aliyun' is the prefix, and 'com' is the suffix), the name of the node isaliyun192.168.xxx.xxxcom
.
- Node
Pool stringId - The first ID of the resource.
- Node
Pool stringName - The name of node pool.
- On
Demand intBase Capacity - The minimum number of pay-as-you-go instances that must be kept in the scaling group. Valid values: 0 to 1000. If the number of pay-as-you-go instances is less than the value of this parameter, Auto Scaling preferably creates pay-as-you-go instances.
- On
Demand intPercentage Above Base Capacity - The percentage of pay-as-you-go instances among the extra instances that exceed the number specified by
on_demand_base_capacity
. Valid values: 0 to 100. - Password string
- The password of ssh login. You have to specify one of
password
andkey_name
fields. The password rule is 8 to 30 characters and contains at least three items (upper and lower case letters, numbers, and special symbols). - Period int
- Node payment period. Its valid value is one of {1, 2, 3, 6, 12}.
- Period
Unit string - Node payment period unit, valid value:
Month
. Default isMonth
. - Platform string
- Operating system release, using
image_type
instead. - Pre
User stringData - Node pre custom data, base64-encoded, the script executed before the node is initialized.
- Private
Pool NodeOptions Pool Private Pool Options Args - Private node pool configuration. See
private_pool_options
below. - Rds
Instances []string - The list of RDS instances.
- Resource
Group stringId - The ID of the resource group
- Rolling
Policy NodePool Rolling Policy Args - Rotary configuration. See
rolling_policy
below. - Runtime
Name string - The runtime name of containers. If not set, the cluster runtime will be used as the node pool runtime. If you select another container runtime, see Comparison of Docker, containerd, and Sandboxed-Container.
- Runtime
Version string - The runtime version of containers. If not set, the cluster runtime will be used as the node pool runtime.
- Scaling
Config NodePool Scaling Config Args - Automatic scaling configuration. See
scaling_config
below. - Scaling
Group stringId - The ID of the scaling group.
- Scaling
Policy string - Scaling group mode, default value:
release
. Valid values: - Security
Group stringId - The security group ID of the node pool. This field has been replaced by
security_group_ids
, please use thesecurity_group_ids
field instead. - Security
Group []stringIds - Multiple security groups can be configured for a node pool. If both
security_group_ids
andsecurity_group_id
are configured,security_group_ids
takes effect. This field cannot be modified. - Security
Hardening boolOs - Alibaba Cloud OS security reinforcement. Default value:
false
. Value: - Soc
Enabled bool Whether enable worker node to support soc security reinforcement, its valid value
true
orfalse
. Default tofalse
and apply to AliyunLinux series. See SOC Reinforcement.NOTE: It is forbidden to set both
security_hardening_os
andsoc_enabled
totrue
at the same time.- Spot
Instance intPools - The number of instance types that are available. Auto Scaling creates preemptible instances of multiple instance types that are available at the lowest cost. Valid values: 1 to 10.
- Spot
Instance boolRemedy - Specifies whether to supplement preemptible instances when the number of preemptible instances drops below the specified minimum number. If you set the value to true, Auto Scaling attempts to create a new preemptible instance when the system notifies that an existing preemptible instance is about to be reclaimed. Valid values:
true
: enables the supplementation of preemptible instances.false
: disables the supplementation of preemptible instances. - Spot
Price []NodeLimits Pool Spot Price Limit Args - The current single preemptible instance type market price range configuration. See
spot_price_limit
below. - Spot
Strategy string - The preemptible instance type. Value:
NoSpot
: Non-preemptible instance.SpotWithPriceLimit
: Set the upper limit of the preemptible instance price.SpotAsPriceGo
: The system automatically bids, following the actual price of the current market.
- System
Disk boolBursting Enabled - Specifies whether to enable the burst feature for system disks. Valid values:
true
: enables the burst feature.false
: disables the burst feature. This parameter is supported only whensystem_disk_category
is set tocloud_auto
. - System
Disk []stringCategories - The multi-disk categories of the system disk. When a high-priority disk type cannot be used, Auto Scaling automatically tries to create a system disk with the next priority disk category. Valid values:
cloud
: cloud disk.cloud_efficiency
: a high-efficiency cloud disk.cloud_ssd
:SSD cloud disk.cloud_essd
: ESSD cloud disk. - System
Disk stringCategory - The system disk category of worker node. Its valid value are
cloud_ssd
,cloud_efficiency
,cloud_essd
andcloud_auto
. - System
Disk stringEncrypt Algorithm - The encryption algorithm used by the system disk. Value range: aes-256.
- System
Disk boolEncrypted - Whether to encrypt the system disk. Value range:
true
: encryption.false
: Do not encrypt. - System
Disk stringKms Key - The ID of the KMS key used by the system disk.
- System
Disk stringPerformance Level - The system disk performance of the node takes effect only for the ESSD disk.
PL0
: maximum random read/write IOPS 10000 for a single disk.PL1
: maximum random read/write IOPS 50000 for a single disk.PL2
: highest random read/write IOPS 100000 for a single disk.PL3
: maximum random read/write IOPS 1 million for a single disk.
- System
Disk intProvisioned Iops - The predefined IOPS of a system disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. Baseline IOPS = min{1,800 + 50 × Capacity, 50,000}. This parameter is supported only when
system_disk_category
is set tocloud_auto
. - System
Disk intSize - The system disk category of worker node. Its valid value range [40~500] in GB. Default to
120
. - System
Disk stringSnapshot Policy Id - The ID of the automatic snapshot policy used by the system disk.
- map[string]string
- Add tags only for ECS instances. The maximum length of the tag key is 128 characters. The tag key and value cannot start with aliyun or acs:, or contain https:// or http://.
- Taints
[]Node
Pool Taint Args - A List of Kubernetes taints to assign to the nodes. Detailed below. More information in Taints and Toleration. See
taints
below. - Tee
Config NodePool Tee Config Args - The configuration about confidential computing for the cluster. See
tee_config
below. - Unschedulable bool
- Whether the node after expansion can be scheduled.
- Update
Nodes bool - Synchronously update node labels and taints.
- User
Data string - Node custom data, base64-encoded.
- Vswitch
Ids []string - The vswitches used by node pool workers.
- auto
Renew Boolean - Whether to enable automatic renewal for nodes in the node pool takes effect only when
instance_charge_type
is set toPrePaid
. Default value:false
. Valid values: - auto
Renew IntegerPeriod - The automatic renewal period of nodes in the node pool takes effect only when you select Prepaid and Automatic Renewal, and is a required value. When
PeriodUnit = Month
, the value range is {1, 2, 3, 6, 12}. Default value: 1. - cis
Enabled Boolean - Whether enable worker node to support cis security reinforcement, its valid value
true
orfalse
. Default tofalse
and apply to AliyunLinux series. Usesecurity_hardening_os
instead. - cluster
Id String - The id of kubernetes cluster.
- compensate
With BooleanOn Demand - Specifies whether to automatically create pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created due to reasons such as cost or insufficient inventory. This parameter takes effect when you set
multi_az_policy
toCOST_OPTIMIZED
. Valid values:true
: automatically creates pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created.false
: does not create pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created. - cpu
Policy String - Node CPU management policies. Default value:
none
. When the cluster version is 1.12.6 or later, the following two policies are supported: - data
Disks List<NodePool Data Disk> - Configure the data disk of the node in the node pool. See
data_disks
below. - deployment
Set StringId - The deployment set of node pool. Specify the deploymentSet to ensure that the nodes in the node pool can be distributed on different physical machines.
- desired
Size Integer - Number of expected nodes in the node pool.
- force
Delete Boolean - Whether to force deletion.
- format
Disk Boolean - After you select this check box, if data disks have been attached to the specified ECS instances and the file system of the last data disk is uninitialized, the system automatically formats the last data disk to ext4 and mounts the data disk to /var/lib/docker and /var/lib/kubelet. The original data on the disk will be cleared. Make sure that you back up data in advance. If no data disk is mounted on the ECS instance, no new data disk will be purchased. Default is
false
. - image
Id String - The custom image ID. The system-provided image is used by default.
- image
Type String - The operating system image type and the
platform
parameter can be selected from the following values:AliyunLinux
: Alinux2 image.AliyunLinux3
: Alinux3 image.AliyunLinux3Arm64
: Alinux3 mirror ARM version.AliyunLinuxUEFI
: Alinux2 Image UEFI version.CentOS
: CentOS image.Windows
: Windows image.WindowsCore
: WindowsCore image.ContainerOS
: container-optimized image.
- install
Cloud BooleanMonitor - Whether to install cloud monitoring on the ECS node. After installation, you can view the monitoring information of the created ECS instance in the cloud monitoring console and recommend enable it. Default value:
false
. Valid values: - instance
Charge StringType - Node payment type. Valid values:
PostPaid
,PrePaid
, default isPostPaid
. If value isPrePaid
, the argumentsperiod
,period_unit
,auto_renew
andauto_renew_period
are required. - instance
Types List<String> - In the node instance specification list, you can select multiple instance specifications as alternatives. When each node is created, it will try to purchase from the first specification until it is created successfully. The final purchased instance specifications may vary with inventory changes.
- instances List<String>
- The instance list. Add existing nodes under the same cluster VPC to the node pool.
- internet
Charge StringType - The billing method for network usage. Valid values
PayByBandwidth
andPayByTraffic
. Conflict witheip_internet_charge_type
, EIP and public network IP can only choose one. - internet
Max IntegerBandwidth Out - The maximum bandwidth of the public IP address of the node. The unit is Mbps(Mega bit per second). The value range is:[1,100]
- keep
Instance BooleanName - Add an existing instance to the node pool, whether to keep the original instance name. It is recommended to set to
true
. - key
Name String - The name of the key pair. When the node pool is a managed node pool, only
key_name
is supported. - kms
Encrypted StringPassword - An KMS encrypts password used to a cs kubernetes. You have to specify one of
password
key_name
kms_encrypted_password
fields. - kms
Encryption Map<String,String>Context - An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating a cs kubernetes withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set. - kubelet
Configuration NodePool Kubelet Configuration - Kubelet configuration parameters for worker nodes. See
kubelet_configuration
below. More information in Kubelet Configuration. Seekubelet_configuration
below. - labels
List<Node
Pool Label> - A List of Kubernetes labels to assign to the nodes . Only labels that are applied with the ACK API are managed by this argument. Detailed below. More information in Labels. See
labels
below. - login
As BooleanNon Root - Whether the ECS instance is logged on as a ecs-user user. Valid value:
true
andfalse
. - management
Node
Pool Management - Managed node pool configuration. See
management
below. - multi
Az StringPolicy - The scaling policy for ECS instances in a multi-zone scaling group. Valid value:
PRIORITY
,COST_OPTIMIZED
andBALANCE
.PRIORITY
: scales the capacity according to the virtual switches you define (VSwitchIds.N). When an ECS instance cannot be created in the zone where the higher-priority vSwitch is located, the next-priority vSwitch is automatically used to create an ECS instance.COST_OPTIMIZED
: try to create by vCPU unit price from low to high. When the scaling configuration is configured with multiple instances of preemptible billing, preemptible instances are created first. You can continue to use theCompensateWithOnDemand
parameter to specify whether to automatically try to create a preemptible instance by paying for it. It takes effect only when the scaling configuration has multi-instance specifications or preemptible instances.BALANCE
: distributes ECS instances evenly among the multi-zone specified by the scaling group. If the zones become unbalanced due to insufficient inventory, you can use the API RebalanceInstances to balance resources. - name String
- . Field 'name' has been deprecated from provider version 1.219.0. New field 'node_pool_name' instead.
- node
Count Integer - The worker node number of the node pool. From version 1.111.0,
node_count
is not required. - node
Name StringMode - Each node name consists of a prefix, its private network IP, and a suffix, separated by commas. The input format is
customized,,ip,
.- The prefix and suffix can be composed of one or more parts separated by '.', each part can use lowercase letters, numbers and '-', and the beginning and end of the node name must be lowercase letters and numbers.
- The node IP address is the complete private IP address of the node.
- For example, if the string
customized,aliyun,ip,com
is passed in (where 'customized' and 'ip' are fixed strings, 'aliyun' is the prefix, and 'com' is the suffix), the name of the node isaliyun192.168.xxx.xxxcom
.
- node
Pool StringId - The first ID of the resource.
- node
Pool StringName - The name of node pool.
- on
Demand IntegerBase Capacity - The minimum number of pay-as-you-go instances that must be kept in the scaling group. Valid values: 0 to 1000. If the number of pay-as-you-go instances is less than the value of this parameter, Auto Scaling preferably creates pay-as-you-go instances.
- on
Demand IntegerPercentage Above Base Capacity - The percentage of pay-as-you-go instances among the extra instances that exceed the number specified by
on_demand_base_capacity
. Valid values: 0 to 100. - password String
- The password of ssh login. You have to specify one of
password
andkey_name
fields. The password rule is 8 to 30 characters and contains at least three items (upper and lower case letters, numbers, and special symbols). - period Integer
- Node payment period. Its valid value is one of {1, 2, 3, 6, 12}.
- period
Unit String - Node payment period unit, valid value:
Month
. Default isMonth
. - platform String
- Operating system release, using
image_type
instead. - pre
User StringData - Node pre custom data, base64-encoded, the script executed before the node is initialized.
- private
Pool NodeOptions Pool Private Pool Options - Private node pool configuration. See
private_pool_options
below. - rds
Instances List<String> - The list of RDS instances.
- resource
Group StringId - The ID of the resource group
- rolling
Policy NodePool Rolling Policy - Rotary configuration. See
rolling_policy
below. - runtime
Name String - The runtime name of containers. If not set, the cluster runtime will be used as the node pool runtime. If you select another container runtime, see Comparison of Docker, containerd, and Sandboxed-Container.
- runtime
Version String - The runtime version of containers. If not set, the cluster runtime will be used as the node pool runtime.
- scaling
Config NodePool Scaling Config - Automatic scaling configuration. See
scaling_config
below. - scaling
Group StringId - The ID of the scaling group.
- scaling
Policy String - Scaling group mode, default value:
release
. Valid values: - security
Group StringId - The security group ID of the node pool. This field has been replaced by
security_group_ids
, please use thesecurity_group_ids
field instead. - security
Group List<String>Ids - Multiple security groups can be configured for a node pool. If both
security_group_ids
andsecurity_group_id
are configured,security_group_ids
takes effect. This field cannot be modified. - security
Hardening BooleanOs - Alibaba Cloud OS security reinforcement. Default value:
false
. Value: - soc
Enabled Boolean Whether enable worker node to support soc security reinforcement, its valid value
true
orfalse
. Default tofalse
and apply to AliyunLinux series. See SOC Reinforcement.NOTE: It is forbidden to set both
security_hardening_os
andsoc_enabled
totrue
at the same time.- spot
Instance IntegerPools - The number of instance types that are available. Auto Scaling creates preemptible instances of multiple instance types that are available at the lowest cost. Valid values: 1 to 10.
- spot
Instance BooleanRemedy - Specifies whether to supplement preemptible instances when the number of preemptible instances drops below the specified minimum number. If you set the value to true, Auto Scaling attempts to create a new preemptible instance when the system notifies that an existing preemptible instance is about to be reclaimed. Valid values:
true
: enables the supplementation of preemptible instances.false
: disables the supplementation of preemptible instances. - spot
Price List<NodeLimits Pool Spot Price Limit> - The current single preemptible instance type market price range configuration. See
spot_price_limit
below. - spot
Strategy String - The preemptible instance type. Value:
NoSpot
: Non-preemptible instance.SpotWithPriceLimit
: Set the upper limit of the preemptible instance price.SpotAsPriceGo
: The system automatically bids, following the actual price of the current market.
- system
Disk BooleanBursting Enabled - Specifies whether to enable the burst feature for system disks. Valid values:
true
: enables the burst feature.false
: disables the burst feature. This parameter is supported only whensystem_disk_category
is set tocloud_auto
. - system
Disk List<String>Categories - The multi-disk categories of the system disk. When a high-priority disk type cannot be used, Auto Scaling automatically tries to create a system disk with the next priority disk category. Valid values:
cloud
: cloud disk.cloud_efficiency
: a high-efficiency cloud disk.cloud_ssd
:SSD cloud disk.cloud_essd
: ESSD cloud disk. - system
Disk StringCategory - The system disk category of worker node. Its valid value are
cloud_ssd
,cloud_efficiency
,cloud_essd
andcloud_auto
. - system
Disk StringEncrypt Algorithm - The encryption algorithm used by the system disk. Value range: aes-256.
- system
Disk BooleanEncrypted - Whether to encrypt the system disk. Value range:
true
: encryption.false
: Do not encrypt. - system
Disk StringKms Key - The ID of the KMS key used by the system disk.
- system
Disk StringPerformance Level - The system disk performance of the node takes effect only for the ESSD disk.
PL0
: maximum random read/write IOPS 10000 for a single disk.PL1
: maximum random read/write IOPS 50000 for a single disk.PL2
: highest random read/write IOPS 100000 for a single disk.PL3
: maximum random read/write IOPS 1 million for a single disk.
- system
Disk IntegerProvisioned Iops - The predefined IOPS of a system disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. Baseline IOPS = min{1,800 + 50 × Capacity, 50,000}. This parameter is supported only when
system_disk_category
is set tocloud_auto
. - system
Disk IntegerSize - The system disk category of worker node. Its valid value range [40~500] in GB. Default to
120
. - system
Disk StringSnapshot Policy Id - The ID of the automatic snapshot policy used by the system disk.
- Map<String,String>
- Add tags only for ECS instances. The maximum length of the tag key is 128 characters. The tag key and value cannot start with aliyun or acs:, or contain https:// or http://.
- taints
List<Node
Pool Taint> - A List of Kubernetes taints to assign to the nodes. Detailed below. More information in Taints and Toleration. See
taints
below. - tee
Config NodePool Tee Config - The configuration about confidential computing for the cluster. See
tee_config
below. - unschedulable Boolean
- Whether the node after expansion can be scheduled.
- update
Nodes Boolean - Synchronously update node labels and taints.
- user
Data String - Node custom data, base64-encoded.
- vswitch
Ids List<String> - The vswitches used by node pool workers.
- auto
Renew boolean - Whether to enable automatic renewal for nodes in the node pool takes effect only when
instance_charge_type
is set toPrePaid
. Default value:false
. Valid values: - auto
Renew numberPeriod - The automatic renewal period of nodes in the node pool takes effect only when you select Prepaid and Automatic Renewal, and is a required value. When
PeriodUnit = Month
, the value range is {1, 2, 3, 6, 12}. Default value: 1. - cis
Enabled boolean - Whether enable worker node to support cis security reinforcement, its valid value
true
orfalse
. Default tofalse
and apply to AliyunLinux series. Usesecurity_hardening_os
instead. - cluster
Id string - The id of kubernetes cluster.
- compensate
With booleanOn Demand - Specifies whether to automatically create pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created due to reasons such as cost or insufficient inventory. This parameter takes effect when you set
multi_az_policy
toCOST_OPTIMIZED
. Valid values:true
: automatically creates pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created.false
: does not create pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created. - cpu
Policy string - Node CPU management policies. Default value:
none
. When the cluster version is 1.12.6 or later, the following two policies are supported: - data
Disks NodePool Data Disk[] - Configure the data disk of the node in the node pool. See
data_disks
below. - deployment
Set stringId - The deployment set of node pool. Specify the deploymentSet to ensure that the nodes in the node pool can be distributed on different physical machines.
- desired
Size number - Number of expected nodes in the node pool.
- force
Delete boolean - Whether to force deletion.
- format
Disk boolean - After you select this check box, if data disks have been attached to the specified ECS instances and the file system of the last data disk is uninitialized, the system automatically formats the last data disk to ext4 and mounts the data disk to /var/lib/docker and /var/lib/kubelet. The original data on the disk will be cleared. Make sure that you back up data in advance. If no data disk is mounted on the ECS instance, no new data disk will be purchased. Default is
false
. - image
Id string - The custom image ID. The system-provided image is used by default.
- image
Type string - The operating system image type and the
platform
parameter can be selected from the following values:AliyunLinux
: Alinux2 image.AliyunLinux3
: Alinux3 image.AliyunLinux3Arm64
: Alinux3 mirror ARM version.AliyunLinuxUEFI
: Alinux2 Image UEFI version.CentOS
: CentOS image.Windows
: Windows image.WindowsCore
: WindowsCore image.ContainerOS
: container-optimized image.
- install
Cloud booleanMonitor - Whether to install cloud monitoring on the ECS node. After installation, you can view the monitoring information of the created ECS instance in the cloud monitoring console and recommend enable it. Default value:
false
. Valid values: - instance
Charge stringType - Node payment type. Valid values:
PostPaid
,PrePaid
, default isPostPaid
. If value isPrePaid
, the argumentsperiod
,period_unit
,auto_renew
andauto_renew_period
are required. - instance
Types string[] - In the node instance specification list, you can select multiple instance specifications as alternatives. When each node is created, it will try to purchase from the first specification until it is created successfully. The final purchased instance specifications may vary with inventory changes.
- instances string[]
- The instance list. Add existing nodes under the same cluster VPC to the node pool.
- internet
Charge stringType - The billing method for network usage. Valid values
PayByBandwidth
andPayByTraffic
. Conflict witheip_internet_charge_type
, EIP and public network IP can only choose one. - internet
Max numberBandwidth Out - The maximum bandwidth of the public IP address of the node. The unit is Mbps(Mega bit per second). The value range is:[1,100]
- keep
Instance booleanName - Add an existing instance to the node pool, whether to keep the original instance name. It is recommended to set to
true
. - key
Name string - The name of the key pair. When the node pool is a managed node pool, only
key_name
is supported. - kms
Encrypted stringPassword - An KMS encrypts password used to a cs kubernetes. You have to specify one of
password
key_name
kms_encrypted_password
fields. - kms
Encryption {[key: string]: string}Context - An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating a cs kubernetes withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set. - kubelet
Configuration NodePool Kubelet Configuration - Kubelet configuration parameters for worker nodes. See
kubelet_configuration
below. More information in Kubelet Configuration. Seekubelet_configuration
below. - labels
Node
Pool Label[] - A List of Kubernetes labels to assign to the nodes . Only labels that are applied with the ACK API are managed by this argument. Detailed below. More information in Labels. See
labels
below. - login
As booleanNon Root - Whether the ECS instance is logged on as a ecs-user user. Valid value:
true
andfalse
. - management
Node
Pool Management - Managed node pool configuration. See
management
below. - multi
Az stringPolicy - The scaling policy for ECS instances in a multi-zone scaling group. Valid value:
PRIORITY
,COST_OPTIMIZED
andBALANCE
.PRIORITY
: scales the capacity according to the virtual switches you define (VSwitchIds.N). When an ECS instance cannot be created in the zone where the higher-priority vSwitch is located, the next-priority vSwitch is automatically used to create an ECS instance.COST_OPTIMIZED
: try to create by vCPU unit price from low to high. When the scaling configuration is configured with multiple instances of preemptible billing, preemptible instances are created first. You can continue to use theCompensateWithOnDemand
parameter to specify whether to automatically try to create a preemptible instance by paying for it. It takes effect only when the scaling configuration has multi-instance specifications or preemptible instances.BALANCE
: distributes ECS instances evenly among the multi-zone specified by the scaling group. If the zones become unbalanced due to insufficient inventory, you can use the API RebalanceInstances to balance resources. - name string
- . Field 'name' has been deprecated from provider version 1.219.0. New field 'node_pool_name' instead.
- node
Count number - The worker node number of the node pool. From version 1.111.0,
node_count
is not required. - node
Name stringMode - Each node name consists of a prefix, its private network IP, and a suffix, separated by commas. The input format is
customized,,ip,
.- The prefix and suffix can be composed of one or more parts separated by '.', each part can use lowercase letters, numbers and '-', and the beginning and end of the node name must be lowercase letters and numbers.
- The node IP address is the complete private IP address of the node.
- For example, if the string
customized,aliyun,ip,com
is passed in (where 'customized' and 'ip' are fixed strings, 'aliyun' is the prefix, and 'com' is the suffix), the name of the node isaliyun192.168.xxx.xxxcom
.
- node
Pool stringId - The first ID of the resource.
- node
Pool stringName - The name of node pool.
- on
Demand numberBase Capacity - The minimum number of pay-as-you-go instances that must be kept in the scaling group. Valid values: 0 to 1000. If the number of pay-as-you-go instances is less than the value of this parameter, Auto Scaling preferably creates pay-as-you-go instances.
- on
Demand numberPercentage Above Base Capacity - The percentage of pay-as-you-go instances among the extra instances that exceed the number specified by
on_demand_base_capacity
. Valid values: 0 to 100. - password string
- The password of ssh login. You have to specify one of
password
andkey_name
fields. The password rule is 8 to 30 characters and contains at least three items (upper and lower case letters, numbers, and special symbols). - period number
- Node payment period. Its valid value is one of {1, 2, 3, 6, 12}.
- period
Unit string - Node payment period unit, valid value:
Month
. Default isMonth
. - platform string
- Operating system release, using
image_type
instead. - pre
User stringData - Node pre custom data, base64-encoded, the script executed before the node is initialized.
- private
Pool NodeOptions Pool Private Pool Options - Private node pool configuration. See
private_pool_options
below. - rds
Instances string[] - The list of RDS instances.
- resource
Group stringId - The ID of the resource group
- rolling
Policy NodePool Rolling Policy - Rotary configuration. See
rolling_policy
below. - runtime
Name string - The runtime name of containers. If not set, the cluster runtime will be used as the node pool runtime. If you select another container runtime, see Comparison of Docker, containerd, and Sandboxed-Container.
- runtime
Version string - The runtime version of containers. If not set, the cluster runtime will be used as the node pool runtime.
- scaling
Config NodePool Scaling Config - Automatic scaling configuration. See
scaling_config
below. - scaling
Group stringId - The ID of the scaling group.
- scaling
Policy string - Scaling group mode, default value:
release
. Valid values: - security
Group stringId - The security group ID of the node pool. This field has been replaced by
security_group_ids
, please use thesecurity_group_ids
field instead. - security
Group string[]Ids - Multiple security groups can be configured for a node pool. If both
security_group_ids
andsecurity_group_id
are configured,security_group_ids
takes effect. This field cannot be modified. - security
Hardening booleanOs - Alibaba Cloud OS security reinforcement. Default value:
false
. Value: - soc
Enabled boolean Whether enable worker node to support soc security reinforcement, its valid value
true
orfalse
. Default tofalse
and apply to AliyunLinux series. See SOC Reinforcement.NOTE: It is forbidden to set both
security_hardening_os
andsoc_enabled
totrue
at the same time.- spot
Instance numberPools - The number of instance types that are available. Auto Scaling creates preemptible instances of multiple instance types that are available at the lowest cost. Valid values: 1 to 10.
- spot
Instance booleanRemedy - Specifies whether to supplement preemptible instances when the number of preemptible instances drops below the specified minimum number. If you set the value to true, Auto Scaling attempts to create a new preemptible instance when the system notifies that an existing preemptible instance is about to be reclaimed. Valid values:
true
: enables the supplementation of preemptible instances.false
: disables the supplementation of preemptible instances. - spot
Price NodeLimits Pool Spot Price Limit[] - The current single preemptible instance type market price range configuration. See
spot_price_limit
below. - spot
Strategy string - The preemptible instance type. Value:
NoSpot
: Non-preemptible instance.SpotWithPriceLimit
: Set the upper limit of the preemptible instance price.SpotAsPriceGo
: The system automatically bids, following the actual price of the current market.
- system
Disk booleanBursting Enabled - Specifies whether to enable the burst feature for system disks. Valid values:
true
: enables the burst feature.false
: disables the burst feature. This parameter is supported only whensystem_disk_category
is set tocloud_auto
. - system
Disk string[]Categories - The multi-disk categories of the system disk. When a high-priority disk type cannot be used, Auto Scaling automatically tries to create a system disk with the next priority disk category. Valid values:
cloud
: cloud disk.cloud_efficiency
: a high-efficiency cloud disk.cloud_ssd
:SSD cloud disk.cloud_essd
: ESSD cloud disk. - system
Disk stringCategory - The system disk category of worker node. Its valid value are
cloud_ssd
,cloud_efficiency
,cloud_essd
andcloud_auto
. - system
Disk stringEncrypt Algorithm - The encryption algorithm used by the system disk. Value range: aes-256.
- system
Disk booleanEncrypted - Whether to encrypt the system disk. Value range:
true
: encryption.false
: Do not encrypt. - system
Disk stringKms Key - The ID of the KMS key used by the system disk.
- system
Disk stringPerformance Level - The system disk performance of the node takes effect only for the ESSD disk.
PL0
: maximum random read/write IOPS 10000 for a single disk.PL1
: maximum random read/write IOPS 50000 for a single disk.PL2
: highest random read/write IOPS 100000 for a single disk.PL3
: maximum random read/write IOPS 1 million for a single disk.
- system
Disk numberProvisioned Iops - The predefined IOPS of a system disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. Baseline IOPS = min{1,800 + 50 × Capacity, 50,000}. This parameter is supported only when
system_disk_category
is set tocloud_auto
. - system
Disk numberSize - The system disk category of worker node. Its valid value range [40~500] in GB. Default to
120
. - system
Disk stringSnapshot Policy Id - The ID of the automatic snapshot policy used by the system disk.
- {[key: string]: string}
- Add tags only for ECS instances. The maximum length of the tag key is 128 characters. The tag key and value cannot start with aliyun or acs:, or contain https:// or http://.
- taints
Node
Pool Taint[] - A List of Kubernetes taints to assign to the nodes. Detailed below. More information in Taints and Toleration. See
taints
below. - tee
Config NodePool Tee Config - The configuration about confidential computing for the cluster. See
tee_config
below. - unschedulable boolean
- Whether the node after expansion can be scheduled.
- update
Nodes boolean - Synchronously update node labels and taints.
- user
Data string - Node custom data, base64-encoded.
- vswitch
Ids string[] - The vswitches used by node pool workers.
- auto_
renew bool - Whether to enable automatic renewal for nodes in the node pool takes effect only when
instance_charge_type
is set toPrePaid
. Default value:false
. Valid values: - auto_
renew_ intperiod - The automatic renewal period of nodes in the node pool takes effect only when you select Prepaid and Automatic Renewal, and is a required value. When
PeriodUnit = Month
, the value range is {1, 2, 3, 6, 12}. Default value: 1. - cis_
enabled bool - Whether enable worker node to support cis security reinforcement, its valid value
true
orfalse
. Default tofalse
and apply to AliyunLinux series. Usesecurity_hardening_os
instead. - cluster_
id str - The id of kubernetes cluster.
- compensate_
with_ boolon_ demand - Specifies whether to automatically create pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created due to reasons such as cost or insufficient inventory. This parameter takes effect when you set
multi_az_policy
toCOST_OPTIMIZED
. Valid values:true
: automatically creates pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created.false
: does not create pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created. - cpu_
policy str - Node CPU management policies. Default value:
none
. When the cluster version is 1.12.6 or later, the following two policies are supported: - data_
disks Sequence[NodePool Data Disk Args] - Configure the data disk of the node in the node pool. See
data_disks
below. - deployment_
set_ strid - The deployment set of node pool. Specify the deploymentSet to ensure that the nodes in the node pool can be distributed on different physical machines.
- desired_
size int - Number of expected nodes in the node pool.
- force_
delete bool - Whether to force deletion.
- format_
disk bool - After you select this check box, if data disks have been attached to the specified ECS instances and the file system of the last data disk is uninitialized, the system automatically formats the last data disk to ext4 and mounts the data disk to /var/lib/docker and /var/lib/kubelet. The original data on the disk will be cleared. Make sure that you back up data in advance. If no data disk is mounted on the ECS instance, no new data disk will be purchased. Default is
false
. - image_
id str - The custom image ID. The system-provided image is used by default.
- image_
type str - The operating system image type and the
platform
parameter can be selected from the following values:AliyunLinux
: Alinux2 image.AliyunLinux3
: Alinux3 image.AliyunLinux3Arm64
: Alinux3 mirror ARM version.AliyunLinuxUEFI
: Alinux2 Image UEFI version.CentOS
: CentOS image.Windows
: Windows image.WindowsCore
: WindowsCore image.ContainerOS
: container-optimized image.
- install_
cloud_ boolmonitor - Whether to install cloud monitoring on the ECS node. After installation, you can view the monitoring information of the created ECS instance in the cloud monitoring console and recommend enable it. Default value:
false
. Valid values: - instance_
charge_ strtype - Node payment type. Valid values:
PostPaid
,PrePaid
, default isPostPaid
. If value isPrePaid
, the argumentsperiod
,period_unit
,auto_renew
andauto_renew_period
are required. - instance_
types Sequence[str] - In the node instance specification list, you can select multiple instance specifications as alternatives. When each node is created, it will try to purchase from the first specification until it is created successfully. The final purchased instance specifications may vary with inventory changes.
- instances Sequence[str]
- The instance list. Add existing nodes under the same cluster VPC to the node pool.
- internet_
charge_ strtype - The billing method for network usage. Valid values
PayByBandwidth
andPayByTraffic
. Conflict witheip_internet_charge_type
, EIP and public network IP can only choose one. - internet_
max_ intbandwidth_ out - The maximum bandwidth of the public IP address of the node. The unit is Mbps(Mega bit per second). The value range is:[1,100]
- keep_
instance_ boolname - Add an existing instance to the node pool, whether to keep the original instance name. It is recommended to set to
true
. - key_
name str - The name of the key pair. When the node pool is a managed node pool, only
key_name
is supported. - kms_
encrypted_ strpassword - An KMS encrypts password used to a cs kubernetes. You have to specify one of
password
key_name
kms_encrypted_password
fields. - kms_
encryption_ Mapping[str, str]context - An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating a cs kubernetes withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set. - kubelet_
configuration NodePool Kubelet Configuration Args - Kubelet configuration parameters for worker nodes. See
kubelet_configuration
below. More information in Kubelet Configuration. Seekubelet_configuration
below. - labels
Sequence[Node
Pool Label Args] - A List of Kubernetes labels to assign to the nodes . Only labels that are applied with the ACK API are managed by this argument. Detailed below. More information in Labels. See
labels
below. - login_
as_ boolnon_ root - Whether the ECS instance is logged on as a ecs-user user. Valid value:
true
andfalse
. - management
Node
Pool Management Args - Managed node pool configuration. See
management
below. - multi_
az_ strpolicy - The scaling policy for ECS instances in a multi-zone scaling group. Valid value:
PRIORITY
,COST_OPTIMIZED
andBALANCE
.PRIORITY
: scales the capacity according to the virtual switches you define (VSwitchIds.N). When an ECS instance cannot be created in the zone where the higher-priority vSwitch is located, the next-priority vSwitch is automatically used to create an ECS instance.COST_OPTIMIZED
: try to create by vCPU unit price from low to high. When the scaling configuration is configured with multiple instances of preemptible billing, preemptible instances are created first. You can continue to use theCompensateWithOnDemand
parameter to specify whether to automatically try to create a preemptible instance by paying for it. It takes effect only when the scaling configuration has multi-instance specifications or preemptible instances.BALANCE
: distributes ECS instances evenly among the multi-zone specified by the scaling group. If the zones become unbalanced due to insufficient inventory, you can use the API RebalanceInstances to balance resources. - name str
- . Field 'name' has been deprecated from provider version 1.219.0. New field 'node_pool_name' instead.
- node_
count int - The worker node number of the node pool. From version 1.111.0,
node_count
is not required. - node_
name_ strmode - Each node name consists of a prefix, its private network IP, and a suffix, separated by commas. The input format is
customized,,ip,
.- The prefix and suffix can be composed of one or more parts separated by '.', each part can use lowercase letters, numbers and '-', and the beginning and end of the node name must be lowercase letters and numbers.
- The node IP address is the complete private IP address of the node.
- For example, if the string
customized,aliyun,ip,com
is passed in (where 'customized' and 'ip' are fixed strings, 'aliyun' is the prefix, and 'com' is the suffix), the name of the node isaliyun192.168.xxx.xxxcom
.
- node_
pool_ strid - The first ID of the resource.
- node_
pool_ strname - The name of node pool.
- on_
demand_ intbase_ capacity - The minimum number of pay-as-you-go instances that must be kept in the scaling group. Valid values: 0 to 1000. If the number of pay-as-you-go instances is less than the value of this parameter, Auto Scaling preferably creates pay-as-you-go instances.
- on_
demand_ intpercentage_ above_ base_ capacity - The percentage of pay-as-you-go instances among the extra instances that exceed the number specified by
on_demand_base_capacity
. Valid values: 0 to 100. - password str
- The password of ssh login. You have to specify one of
password
andkey_name
fields. The password rule is 8 to 30 characters and contains at least three items (upper and lower case letters, numbers, and special symbols). - period int
- Node payment period. Its valid value is one of {1, 2, 3, 6, 12}.
- period_
unit str - Node payment period unit, valid value:
Month
. Default isMonth
. - platform str
- Operating system release, using
image_type
instead. - pre_
user_ strdata - Node pre custom data, base64-encoded, the script executed before the node is initialized.
- private_
pool_ Nodeoptions Pool Private Pool Options Args - Private node pool configuration. See
private_pool_options
below. - rds_
instances Sequence[str] - The list of RDS instances.
- resource_
group_ strid - The ID of the resource group
- rolling_
policy NodePool Rolling Policy Args - Rotary configuration. See
rolling_policy
below. - runtime_
name str - The runtime name of containers. If not set, the cluster runtime will be used as the node pool runtime. If you select another container runtime, see Comparison of Docker, containerd, and Sandboxed-Container.
- runtime_
version str - The runtime version of containers. If not set, the cluster runtime will be used as the node pool runtime.
- scaling_
config NodePool Scaling Config Args - Automatic scaling configuration. See
scaling_config
below. - scaling_
group_ strid - The ID of the scaling group.
- scaling_
policy str - Scaling group mode, default value:
release
. Valid values: - security_
group_ strid - The security group ID of the node pool. This field has been replaced by
security_group_ids
, please use thesecurity_group_ids
field instead. - security_
group_ Sequence[str]ids - Multiple security groups can be configured for a node pool. If both
security_group_ids
andsecurity_group_id
are configured,security_group_ids
takes effect. This field cannot be modified. - security_
hardening_ boolos - Alibaba Cloud OS security reinforcement. Default value:
false
. Value: - soc_
enabled bool Whether enable worker node to support soc security reinforcement, its valid value
true
orfalse
. Default tofalse
and apply to AliyunLinux series. See SOC Reinforcement.NOTE: It is forbidden to set both
security_hardening_os
andsoc_enabled
totrue
at the same time.- spot_
instance_ intpools - The number of instance types that are available. Auto Scaling creates preemptible instances of multiple instance types that are available at the lowest cost. Valid values: 1 to 10.
- spot_
instance_ boolremedy - Specifies whether to supplement preemptible instances when the number of preemptible instances drops below the specified minimum number. If you set the value to true, Auto Scaling attempts to create a new preemptible instance when the system notifies that an existing preemptible instance is about to be reclaimed. Valid values:
true
: enables the supplementation of preemptible instances.false
: disables the supplementation of preemptible instances. - spot_
price_ Sequence[Nodelimits Pool Spot Price Limit Args] - The current single preemptible instance type market price range configuration. See
spot_price_limit
below. - spot_
strategy str - The preemptible instance type. Value:
NoSpot
: Non-preemptible instance.SpotWithPriceLimit
: Set the upper limit of the preemptible instance price.SpotAsPriceGo
: The system automatically bids, following the actual price of the current market.
- system_
disk_ boolbursting_ enabled - Specifies whether to enable the burst feature for system disks. Valid values:
true
: enables the burst feature.false
: disables the burst feature. This parameter is supported only whensystem_disk_category
is set tocloud_auto
. - system_
disk_ Sequence[str]categories - The multi-disk categories of the system disk. When a high-priority disk type cannot be used, Auto Scaling automatically tries to create a system disk with the next priority disk category. Valid values:
cloud
: cloud disk.cloud_efficiency
: a high-efficiency cloud disk.cloud_ssd
:SSD cloud disk.cloud_essd
: ESSD cloud disk. - system_
disk_ strcategory - The system disk category of worker node. Its valid value are
cloud_ssd
,cloud_efficiency
,cloud_essd
andcloud_auto
. - system_
disk_ strencrypt_ algorithm - The encryption algorithm used by the system disk. Value range: aes-256.
- system_
disk_ boolencrypted - Whether to encrypt the system disk. Value range:
true
: encryption.false
: Do not encrypt. - system_
disk_ strkms_ key - The ID of the KMS key used by the system disk.
- system_
disk_ strperformance_ level - The system disk performance of the node takes effect only for the ESSD disk.
PL0
: maximum random read/write IOPS 10000 for a single disk.PL1
: maximum random read/write IOPS 50000 for a single disk.PL2
: highest random read/write IOPS 100000 for a single disk.PL3
: maximum random read/write IOPS 1 million for a single disk.
- system_
disk_ intprovisioned_ iops - The predefined IOPS of a system disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. Baseline IOPS = min{1,800 + 50 × Capacity, 50,000}. This parameter is supported only when
system_disk_category
is set tocloud_auto
. - system_
disk_ intsize - The system disk category of worker node. Its valid value range [40~500] in GB. Default to
120
. - system_
disk_ strsnapshot_ policy_ id - The ID of the automatic snapshot policy used by the system disk.
- Mapping[str, str]
- Add tags only for ECS instances. The maximum length of the tag key is 128 characters. The tag key and value cannot start with aliyun or acs:, or contain https:// or http://.
- taints
Sequence[Node
Pool Taint Args] - A List of Kubernetes taints to assign to the nodes. Detailed below. More information in Taints and Toleration. See
taints
below. - tee_
config NodePool Tee Config Args - The configuration about confidential computing for the cluster. See
tee_config
below. - unschedulable bool
- Whether the node after expansion can be scheduled.
- update_
nodes bool - Synchronously update node labels and taints.
- user_
data str - Node custom data, base64-encoded.
- vswitch_
ids Sequence[str] - The vswitches used by node pool workers.
- auto
Renew Boolean - Whether to enable automatic renewal for nodes in the node pool takes effect only when
instance_charge_type
is set toPrePaid
. Default value:false
. Valid values: - auto
Renew NumberPeriod - The automatic renewal period of nodes in the node pool takes effect only when you select Prepaid and Automatic Renewal, and is a required value. When
PeriodUnit = Month
, the value range is {1, 2, 3, 6, 12}. Default value: 1. - cis
Enabled Boolean - Whether enable worker node to support cis security reinforcement, its valid value
true
orfalse
. Default tofalse
and apply to AliyunLinux series. Usesecurity_hardening_os
instead. - cluster
Id String - The id of kubernetes cluster.
- compensate
With BooleanOn Demand - Specifies whether to automatically create pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created due to reasons such as cost or insufficient inventory. This parameter takes effect when you set
multi_az_policy
toCOST_OPTIMIZED
. Valid values:true
: automatically creates pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created.false
: does not create pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created. - cpu
Policy String - Node CPU management policies. Default value:
none
. When the cluster version is 1.12.6 or later, the following two policies are supported: - data
Disks List<Property Map> - Configure the data disk of the node in the node pool. See
data_disks
below. - deployment
Set StringId - The deployment set of node pool. Specify the deploymentSet to ensure that the nodes in the node pool can be distributed on different physical machines.
- desired
Size Number - Number of expected nodes in the node pool.
- force
Delete Boolean - Whether to force deletion.
- format
Disk Boolean - After you select this check box, if data disks have been attached to the specified ECS instances and the file system of the last data disk is uninitialized, the system automatically formats the last data disk to ext4 and mounts the data disk to /var/lib/docker and /var/lib/kubelet. The original data on the disk will be cleared. Make sure that you back up data in advance. If no data disk is mounted on the ECS instance, no new data disk will be purchased. Default is
false
. - image
Id String - The custom image ID. The system-provided image is used by default.
- image
Type String - The operating system image type and the
platform
parameter can be selected from the following values:AliyunLinux
: Alinux2 image.AliyunLinux3
: Alinux3 image.AliyunLinux3Arm64
: Alinux3 mirror ARM version.AliyunLinuxUEFI
: Alinux2 Image UEFI version.CentOS
: CentOS image.Windows
: Windows image.WindowsCore
: WindowsCore image.ContainerOS
: container-optimized image.
- install
Cloud BooleanMonitor - Whether to install cloud monitoring on the ECS node. After installation, you can view the monitoring information of the created ECS instance in the cloud monitoring console and recommend enable it. Default value:
false
. Valid values: - instance
Charge StringType - Node payment type. Valid values:
PostPaid
,PrePaid
, default isPostPaid
. If value isPrePaid
, the argumentsperiod
,period_unit
,auto_renew
andauto_renew_period
are required. - instance
Types List<String> - In the node instance specification list, you can select multiple instance specifications as alternatives. When each node is created, it will try to purchase from the first specification until it is created successfully. The final purchased instance specifications may vary with inventory changes.
- instances List<String>
- The instance list. Add existing nodes under the same cluster VPC to the node pool.
- internet
Charge StringType - The billing method for network usage. Valid values
PayByBandwidth
andPayByTraffic
. Conflict witheip_internet_charge_type
, EIP and public network IP can only choose one. - internet
Max NumberBandwidth Out - The maximum bandwidth of the public IP address of the node. The unit is Mbps(Mega bit per second). The value range is:[1,100]
- keep
Instance BooleanName - Add an existing instance to the node pool, whether to keep the original instance name. It is recommended to set to
true
. - key
Name String - The name of the key pair. When the node pool is a managed node pool, only
key_name
is supported. - kms
Encrypted StringPassword - An KMS encrypts password used to a cs kubernetes. You have to specify one of
password
key_name
kms_encrypted_password
fields. - kms
Encryption Map<String>Context - An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating a cs kubernetes withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set. - kubelet
Configuration Property Map - Kubelet configuration parameters for worker nodes. See
kubelet_configuration
below. More information in Kubelet Configuration. Seekubelet_configuration
below. - labels List<Property Map>
- A List of Kubernetes labels to assign to the nodes . Only labels that are applied with the ACK API are managed by this argument. Detailed below. More information in Labels. See
labels
below. - login
As BooleanNon Root - Whether the ECS instance is logged on as a ecs-user user. Valid value:
true
andfalse
. - management Property Map
- Managed node pool configuration. See
management
below. - multi
Az StringPolicy - The scaling policy for ECS instances in a multi-zone scaling group. Valid value:
PRIORITY
,COST_OPTIMIZED
andBALANCE
.PRIORITY
: scales the capacity according to the virtual switches you define (VSwitchIds.N). When an ECS instance cannot be created in the zone where the higher-priority vSwitch is located, the next-priority vSwitch is automatically used to create an ECS instance.COST_OPTIMIZED
: try to create by vCPU unit price from low to high. When the scaling configuration is configured with multiple instances of preemptible billing, preemptible instances are created first. You can continue to use theCompensateWithOnDemand
parameter to specify whether to automatically try to create a preemptible instance by paying for it. It takes effect only when the scaling configuration has multi-instance specifications or preemptible instances.BALANCE
: distributes ECS instances evenly among the multi-zone specified by the scaling group. If the zones become unbalanced due to insufficient inventory, you can use the API RebalanceInstances to balance resources. - name String
- . Field 'name' has been deprecated from provider version 1.219.0. New field 'node_pool_name' instead.
- node
Count Number - The worker node number of the node pool. From version 1.111.0,
node_count
is not required. - node
Name StringMode - Each node name consists of a prefix, its private network IP, and a suffix, separated by commas. The input format is
customized,,ip,
.- The prefix and suffix can be composed of one or more parts separated by '.', each part can use lowercase letters, numbers and '-', and the beginning and end of the node name must be lowercase letters and numbers.
- The node IP address is the complete private IP address of the node.
- For example, if the string
customized,aliyun,ip,com
is passed in (where 'customized' and 'ip' are fixed strings, 'aliyun' is the prefix, and 'com' is the suffix), the name of the node isaliyun192.168.xxx.xxxcom
.
- node
Pool StringId - The first ID of the resource.
- node
Pool StringName - The name of node pool.
- on
Demand NumberBase Capacity - The minimum number of pay-as-you-go instances that must be kept in the scaling group. Valid values: 0 to 1000. If the number of pay-as-you-go instances is less than the value of this parameter, Auto Scaling preferably creates pay-as-you-go instances.
- on
Demand NumberPercentage Above Base Capacity - The percentage of pay-as-you-go instances among the extra instances that exceed the number specified by
on_demand_base_capacity
. Valid values: 0 to 100. - password String
- The password of ssh login. You have to specify one of
password
andkey_name
fields. The password rule is 8 to 30 characters and contains at least three items (upper and lower case letters, numbers, and special symbols). - period Number
- Node payment period. Its valid value is one of {1, 2, 3, 6, 12}.
- period
Unit String - Node payment period unit, valid value:
Month
. Default isMonth
. - platform String
- Operating system release, using
image_type
instead. - pre
User StringData - Node pre custom data, base64-encoded, the script executed before the node is initialized.
- private
Pool Property MapOptions - Private node pool configuration. See
private_pool_options
below. - rds
Instances List<String> - The list of RDS instances.
- resource
Group StringId - The ID of the resource group
- rolling
Policy Property Map - Rotary configuration. See
rolling_policy
below. - runtime
Name String - The runtime name of containers. If not set, the cluster runtime will be used as the node pool runtime. If you select another container runtime, see Comparison of Docker, containerd, and Sandboxed-Container.
- runtime
Version String - The runtime version of containers. If not set, the cluster runtime will be used as the node pool runtime.
- scaling
Config Property Map - Automatic scaling configuration. See
scaling_config
below. - scaling
Group StringId - The ID of the scaling group.
- scaling
Policy String - Scaling group mode, default value:
release
. Valid values: - security
Group StringId - The security group ID of the node pool. This field has been replaced by
security_group_ids
, please use thesecurity_group_ids
field instead. - security
Group List<String>Ids - Multiple security groups can be configured for a node pool. If both
security_group_ids
andsecurity_group_id
are configured,security_group_ids
takes effect. This field cannot be modified. - security
Hardening BooleanOs - Alibaba Cloud OS security reinforcement. Default value:
false
. Value: - soc
Enabled Boolean Whether enable worker node to support soc security reinforcement, its valid value
true
orfalse
. Default tofalse
and apply to AliyunLinux series. See SOC Reinforcement.NOTE: It is forbidden to set both
security_hardening_os
andsoc_enabled
totrue
at the same time.- spot
Instance NumberPools - The number of instance types that are available. Auto Scaling creates preemptible instances of multiple instance types that are available at the lowest cost. Valid values: 1 to 10.
- spot
Instance BooleanRemedy - Specifies whether to supplement preemptible instances when the number of preemptible instances drops below the specified minimum number. If you set the value to true, Auto Scaling attempts to create a new preemptible instance when the system notifies that an existing preemptible instance is about to be reclaimed. Valid values:
true
: enables the supplementation of preemptible instances.false
: disables the supplementation of preemptible instances. - spot
Price List<Property Map>Limits - The current single preemptible instance type market price range configuration. See
spot_price_limit
below. - spot
Strategy String - The preemptible instance type. Value:
NoSpot
: Non-preemptible instance.SpotWithPriceLimit
: Set the upper limit of the preemptible instance price.SpotAsPriceGo
: The system automatically bids, following the actual price of the current market.
- system
Disk BooleanBursting Enabled - Specifies whether to enable the burst feature for system disks. Valid values:
true
: enables the burst feature.false
: disables the burst feature. This parameter is supported only whensystem_disk_category
is set tocloud_auto
. - system
Disk List<String>Categories - The multi-disk categories of the system disk. When a high-priority disk type cannot be used, Auto Scaling automatically tries to create a system disk with the next priority disk category. Valid values:
cloud
: cloud disk.cloud_efficiency
: a high-efficiency cloud disk.cloud_ssd
:SSD cloud disk.cloud_essd
: ESSD cloud disk. - system
Disk StringCategory - The system disk category of worker node. Its valid value are
cloud_ssd
,cloud_efficiency
,cloud_essd
andcloud_auto
. - system
Disk StringEncrypt Algorithm - The encryption algorithm used by the system disk. Value range: aes-256.
- system
Disk BooleanEncrypted - Whether to encrypt the system disk. Value range:
true
: encryption.false
: Do not encrypt. - system
Disk StringKms Key - The ID of the KMS key used by the system disk.
- system
Disk StringPerformance Level - The system disk performance of the node takes effect only for the ESSD disk.
PL0
: maximum random read/write IOPS 10000 for a single disk.PL1
: maximum random read/write IOPS 50000 for a single disk.PL2
: highest random read/write IOPS 100000 for a single disk.PL3
: maximum random read/write IOPS 1 million for a single disk.
- system
Disk NumberProvisioned Iops - The predefined IOPS of a system disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. Baseline IOPS = min{1,800 + 50 × Capacity, 50,000}. This parameter is supported only when
system_disk_category
is set tocloud_auto
. - system
Disk NumberSize - The system disk category of worker node. Its valid value range [40~500] in GB. Default to
120
. - system
Disk StringSnapshot Policy Id - The ID of the automatic snapshot policy used by the system disk.
- Map<String>
- Add tags only for ECS instances. The maximum length of the tag key is 128 characters. The tag key and value cannot start with aliyun or acs:, or contain https:// or http://.
- taints List<Property Map>
- A List of Kubernetes taints to assign to the nodes. Detailed below. More information in Taints and Toleration. See
taints
below. - tee
Config Property Map - The configuration about confidential computing for the cluster. See
tee_config
below. - unschedulable Boolean
- Whether the node after expansion can be scheduled.
- update
Nodes Boolean - Synchronously update node labels and taints.
- user
Data String - Node custom data, base64-encoded.
- vswitch
Ids List<String> - The vswitches used by node pool workers.
Supporting Types
NodePoolDataDisk, NodePoolDataDiskArgs
- Auto
Format string - Whether to automatically mount the data disk. Valid values: true and false.
- Auto
Snapshot stringPolicy Id - The ID of the automatic snapshot policy that you want to apply to the system disk.
- Bursting
Enabled bool - Whether the data disk is enabled with Burst (performance Burst). This is configured when the disk type is cloud_auto.
- Category string
- The type of the data disks. Valid values:
cloud
,cloud_efficiency
,cloud_ssd
,cloud_essd
,cloud_auto
. - Device string
- The mount target of data disk N. Valid values of N: 1 to 16. If you do not specify this parameter, the system automatically assigns a mount target when Auto Scaling creates ECS instances. The name of the mount target ranges from /dev/xvdb to /dev/xvdz.
- Encrypted string
- Specifies whether to encrypt data disks. Valid values: true and false. Default to
false
. - File
System string - The Mount path. Works when auto_format is true.
- Kms
Key stringId - The kms key id used to encrypt the data disk. It takes effect when
encrypted
is true. - Mount
Target string - The type of the mounted file system. Works when auto_format is true. Optional value:
ext4
,xfs
. - Name string
- The length is 2~128 English or Chinese characters. It must start with an uppercase or lowr letter or a Chinese character and cannot start with http:// or https. Can contain numbers, colons (:), underscores (_), or dashes (-). It will be overwritten if auto_format is set.
- Performance
Level string - Worker node data disk performance level, when
category
valuescloud_essd
, the optional values arePL0
,PL1
,PL2
orPL3
, but the specific performance level is related to the disk capacity. For more information, see Enhanced SSDs. Default isPL1
. - Provisioned
Iops int - The read/write IOPS preconfigured for the data disk, which is configured when the disk type is cloud_auto.
- Size int
- The size of a data disk, Its valid value range [40~32768] in GB. Default to
40
. - Snapshot
Id string - The ID of the snapshot that you want to use to create data disk N. Valid values of N: 1 to 16. If you specify this parameter, DataDisk.N.Size is ignored. The size of the disk is the same as the size of the specified snapshot. If you specify a snapshot that is created on or before July 15, 2013, the operation fails and InvalidSnapshot.TooOld is returned.
- Auto
Format string - Whether to automatically mount the data disk. Valid values: true and false.
- Auto
Snapshot stringPolicy Id - The ID of the automatic snapshot policy that you want to apply to the system disk.
- Bursting
Enabled bool - Whether the data disk is enabled with Burst (performance Burst). This is configured when the disk type is cloud_auto.
- Category string
- The type of the data disks. Valid values:
cloud
,cloud_efficiency
,cloud_ssd
,cloud_essd
,cloud_auto
. - Device string
- The mount target of data disk N. Valid values of N: 1 to 16. If you do not specify this parameter, the system automatically assigns a mount target when Auto Scaling creates ECS instances. The name of the mount target ranges from /dev/xvdb to /dev/xvdz.
- Encrypted string
- Specifies whether to encrypt data disks. Valid values: true and false. Default to
false
. - File
System string - The Mount path. Works when auto_format is true.
- Kms
Key stringId - The kms key id used to encrypt the data disk. It takes effect when
encrypted
is true. - Mount
Target string - The type of the mounted file system. Works when auto_format is true. Optional value:
ext4
,xfs
. - Name string
- The length is 2~128 English or Chinese characters. It must start with an uppercase or lowr letter or a Chinese character and cannot start with http:// or https. Can contain numbers, colons (:), underscores (_), or dashes (-). It will be overwritten if auto_format is set.
- Performance
Level string - Worker node data disk performance level, when
category
valuescloud_essd
, the optional values arePL0
,PL1
,PL2
orPL3
, but the specific performance level is related to the disk capacity. For more information, see Enhanced SSDs. Default isPL1
. - Provisioned
Iops int - The read/write IOPS preconfigured for the data disk, which is configured when the disk type is cloud_auto.
- Size int
- The size of a data disk, Its valid value range [40~32768] in GB. Default to
40
. - Snapshot
Id string - The ID of the snapshot that you want to use to create data disk N. Valid values of N: 1 to 16. If you specify this parameter, DataDisk.N.Size is ignored. The size of the disk is the same as the size of the specified snapshot. If you specify a snapshot that is created on or before July 15, 2013, the operation fails and InvalidSnapshot.TooOld is returned.
- auto
Format String - Whether to automatically mount the data disk. Valid values: true and false.
- auto
Snapshot StringPolicy Id - The ID of the automatic snapshot policy that you want to apply to the system disk.
- bursting
Enabled Boolean - Whether the data disk is enabled with Burst (performance Burst). This is configured when the disk type is cloud_auto.
- category String
- The type of the data disks. Valid values:
cloud
,cloud_efficiency
,cloud_ssd
,cloud_essd
,cloud_auto
. - device String
- The mount target of data disk N. Valid values of N: 1 to 16. If you do not specify this parameter, the system automatically assigns a mount target when Auto Scaling creates ECS instances. The name of the mount target ranges from /dev/xvdb to /dev/xvdz.
- encrypted String
- Specifies whether to encrypt data disks. Valid values: true and false. Default to
false
. - file
System String - The Mount path. Works when auto_format is true.
- kms
Key StringId - The kms key id used to encrypt the data disk. It takes effect when
encrypted
is true. - mount
Target String - The type of the mounted file system. Works when auto_format is true. Optional value:
ext4
,xfs
. - name String
- The length is 2~128 English or Chinese characters. It must start with an uppercase or lowr letter or a Chinese character and cannot start with http:// or https. Can contain numbers, colons (:), underscores (_), or dashes (-). It will be overwritten if auto_format is set.
- performance
Level String - Worker node data disk performance level, when
category
valuescloud_essd
, the optional values arePL0
,PL1
,PL2
orPL3
, but the specific performance level is related to the disk capacity. For more information, see Enhanced SSDs. Default isPL1
. - provisioned
Iops Integer - The read/write IOPS preconfigured for the data disk, which is configured when the disk type is cloud_auto.
- size Integer
- The size of a data disk, Its valid value range [40~32768] in GB. Default to
40
. - snapshot
Id String - The ID of the snapshot that you want to use to create data disk N. Valid values of N: 1 to 16. If you specify this parameter, DataDisk.N.Size is ignored. The size of the disk is the same as the size of the specified snapshot. If you specify a snapshot that is created on or before July 15, 2013, the operation fails and InvalidSnapshot.TooOld is returned.
- auto
Format string - Whether to automatically mount the data disk. Valid values: true and false.
- auto
Snapshot stringPolicy Id - The ID of the automatic snapshot policy that you want to apply to the system disk.
- bursting
Enabled boolean - Whether the data disk is enabled with Burst (performance Burst). This is configured when the disk type is cloud_auto.
- category string
- The type of the data disks. Valid values:
cloud
,cloud_efficiency
,cloud_ssd
,cloud_essd
,cloud_auto
. - device string
- The mount target of data disk N. Valid values of N: 1 to 16. If you do not specify this parameter, the system automatically assigns a mount target when Auto Scaling creates ECS instances. The name of the mount target ranges from /dev/xvdb to /dev/xvdz.
- encrypted string
- Specifies whether to encrypt data disks. Valid values: true and false. Default to
false
. - file
System string - The Mount path. Works when auto_format is true.
- kms
Key stringId - The kms key id used to encrypt the data disk. It takes effect when
encrypted
is true. - mount
Target string - The type of the mounted file system. Works when auto_format is true. Optional value:
ext4
,xfs
. - name string
- The length is 2~128 English or Chinese characters. It must start with an uppercase or lowr letter or a Chinese character and cannot start with http:// or https. Can contain numbers, colons (:), underscores (_), or dashes (-). It will be overwritten if auto_format is set.
- performance
Level string - Worker node data disk performance level, when
category
valuescloud_essd
, the optional values arePL0
,PL1
,PL2
orPL3
, but the specific performance level is related to the disk capacity. For more information, see Enhanced SSDs. Default isPL1
. - provisioned
Iops number - The read/write IOPS preconfigured for the data disk, which is configured when the disk type is cloud_auto.
- size number
- The size of a data disk, Its valid value range [40~32768] in GB. Default to
40
. - snapshot
Id string - The ID of the snapshot that you want to use to create data disk N. Valid values of N: 1 to 16. If you specify this parameter, DataDisk.N.Size is ignored. The size of the disk is the same as the size of the specified snapshot. If you specify a snapshot that is created on or before July 15, 2013, the operation fails and InvalidSnapshot.TooOld is returned.
- auto_
format str - Whether to automatically mount the data disk. Valid values: true and false.
- auto_
snapshot_ strpolicy_ id - The ID of the automatic snapshot policy that you want to apply to the system disk.
- bursting_
enabled bool - Whether the data disk is enabled with Burst (performance Burst). This is configured when the disk type is cloud_auto.
- category str
- The type of the data disks. Valid values:
cloud
,cloud_efficiency
,cloud_ssd
,cloud_essd
,cloud_auto
. - device str
- The mount target of data disk N. Valid values of N: 1 to 16. If you do not specify this parameter, the system automatically assigns a mount target when Auto Scaling creates ECS instances. The name of the mount target ranges from /dev/xvdb to /dev/xvdz.
- encrypted str
- Specifies whether to encrypt data disks. Valid values: true and false. Default to
false
. - file_
system str - The Mount path. Works when auto_format is true.
- kms_
key_ strid - The kms key id used to encrypt the data disk. It takes effect when
encrypted
is true. - mount_
target str - The type of the mounted file system. Works when auto_format is true. Optional value:
ext4
,xfs
. - name str
- The length is 2~128 English or Chinese characters. It must start with an uppercase or lowr letter or a Chinese character and cannot start with http:// or https. Can contain numbers, colons (:), underscores (_), or dashes (-). It will be overwritten if auto_format is set.
- performance_
level str - Worker node data disk performance level, when
category
valuescloud_essd
, the optional values arePL0
,PL1
,PL2
orPL3
, but the specific performance level is related to the disk capacity. For more information, see Enhanced SSDs. Default isPL1
. - provisioned_
iops int - The read/write IOPS preconfigured for the data disk, which is configured when the disk type is cloud_auto.
- size int
- The size of a data disk, Its valid value range [40~32768] in GB. Default to
40
. - snapshot_
id str - The ID of the snapshot that you want to use to create data disk N. Valid values of N: 1 to 16. If you specify this parameter, DataDisk.N.Size is ignored. The size of the disk is the same as the size of the specified snapshot. If you specify a snapshot that is created on or before July 15, 2013, the operation fails and InvalidSnapshot.TooOld is returned.
- auto
Format String - Whether to automatically mount the data disk. Valid values: true and false.
- auto
Snapshot StringPolicy Id - The ID of the automatic snapshot policy that you want to apply to the system disk.
- bursting
Enabled Boolean - Whether the data disk is enabled with Burst (performance Burst). This is configured when the disk type is cloud_auto.
- category String
- The type of the data disks. Valid values:
cloud
,cloud_efficiency
,cloud_ssd
,cloud_essd
,cloud_auto
. - device String
- The mount target of data disk N. Valid values of N: 1 to 16. If you do not specify this parameter, the system automatically assigns a mount target when Auto Scaling creates ECS instances. The name of the mount target ranges from /dev/xvdb to /dev/xvdz.
- encrypted String
- Specifies whether to encrypt data disks. Valid values: true and false. Default to
false
. - file
System String - The Mount path. Works when auto_format is true.
- kms
Key StringId - The kms key id used to encrypt the data disk. It takes effect when
encrypted
is true. - mount
Target String - The type of the mounted file system. Works when auto_format is true. Optional value:
ext4
,xfs
. - name String
- The length is 2~128 English or Chinese characters. It must start with an uppercase or lowr letter or a Chinese character and cannot start with http:// or https. Can contain numbers, colons (:), underscores (_), or dashes (-). It will be overwritten if auto_format is set.
- performance
Level String - Worker node data disk performance level, when
category
valuescloud_essd
, the optional values arePL0
,PL1
,PL2
orPL3
, but the specific performance level is related to the disk capacity. For more information, see Enhanced SSDs. Default isPL1
. - provisioned
Iops Number - The read/write IOPS preconfigured for the data disk, which is configured when the disk type is cloud_auto.
- size Number
- The size of a data disk, Its valid value range [40~32768] in GB. Default to
40
. - snapshot
Id String - The ID of the snapshot that you want to use to create data disk N. Valid values of N: 1 to 16. If you specify this parameter, DataDisk.N.Size is ignored. The size of the disk is the same as the size of the specified snapshot. If you specify a snapshot that is created on or before July 15, 2013, the operation fails and InvalidSnapshot.TooOld is returned.
NodePoolKubeletConfiguration, NodePoolKubeletConfigurationArgs
- Allowed
Unsafe List<string>Sysctls - Allowed sysctl mode whitelist.
- Container
Log stringMax Files - The maximum number of log files that can exist in each container.
- Container
Log stringMax Size - The maximum size that can be reached before a log file is rotated.
- Cpu
Manager stringPolicy - Same as cpuManagerPolicy. The name of the policy to use. Requires the CPUManager feature gate to be enabled. Valid value is
none
orstatic
. - Event
Burst string - Same as eventBurst. The maximum size of a burst of event creations, temporarily allows event creations to burst to this number, while still not exceeding
event_record_qps
. It is only used whenevent_record_qps
is greater than 0. Valid value is[0-100]
. - Event
Record stringQps - Same as eventRecordQPS. The maximum event creations per second. If 0, there is no limit enforced. Valid value is
[0-50]
. - Eviction
Hard Dictionary<string, string> - Same as evictionHard. The map of signal names to quantities that defines hard eviction thresholds. For example:
{"memory.available" = "300Mi"}
. - Eviction
Soft Dictionary<string, string> - Same as evictionSoft. The map of signal names to quantities that defines soft eviction thresholds. For example:
{"memory.available" = "300Mi"}
. - Eviction
Soft Dictionary<string, string>Grace Period - Same as evictionSoftGracePeriod. The map of signal names to quantities that defines grace periods for each soft eviction signal. For example:
{"memory.available" = "30s"}
. - Feature
Gates Dictionary<string, bool> - Feature switch to enable configuration of experimental features.
- Kube
Api stringBurst - Same as kubeAPIBurst. The burst to allow while talking with kubernetes api-server. Valid value is
[0-100]
. - Kube
Api stringQps - Same as kubeAPIQPS. The QPS to use while talking with kubernetes api-server. Valid value is
[0-50]
. - Kube
Reserved Dictionary<string, string> - Same as kubeReserved. The set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=150G) pairs that describe resources reserved for kubernetes system components. Currently, cpu, memory and local storage for root file system are supported. See compute resources for more details.
- Max
Pods string - The maximum number of running pods.
- Read
Only stringPort - Read-only port number.
- Registry
Burst string - Same as registryBurst. The maximum size of burst pulls, temporarily allows pulls to burst to this number, while still not exceeding
registry_pull_qps
. Only used ifregistry_pull_qps
is greater than 0. Valid value is[0-100]
. - Registry
Pull stringQps - Same as registryPullQPS. The limit of registry pulls per second. Setting it to
0
means no limit. Valid value is[0-50]
. - Serialize
Image stringPulls - Same as serializeImagePulls. When enabled, it tells the Kubelet to pull images one at a time. We recommend not changing the default value on nodes that run docker daemon with version < 1.9 or an Aufs storage backend. Valid value is
true
orfalse
. - System
Reserved Dictionary<string, string> - Same as systemReserved. The set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=150G) pairs that describe resources reserved for non-kubernetes components. Currently, only cpu and memory are supported. See compute resources for more details.
- Allowed
Unsafe []stringSysctls - Allowed sysctl mode whitelist.
- Container
Log stringMax Files - The maximum number of log files that can exist in each container.
- Container
Log stringMax Size - The maximum size that can be reached before a log file is rotated.
- Cpu
Manager stringPolicy - Same as cpuManagerPolicy. The name of the policy to use. Requires the CPUManager feature gate to be enabled. Valid value is
none
orstatic
. - Event
Burst string - Same as eventBurst. The maximum size of a burst of event creations, temporarily allows event creations to burst to this number, while still not exceeding
event_record_qps
. It is only used whenevent_record_qps
is greater than 0. Valid value is[0-100]
. - Event
Record stringQps - Same as eventRecordQPS. The maximum event creations per second. If 0, there is no limit enforced. Valid value is
[0-50]
. - Eviction
Hard map[string]string - Same as evictionHard. The map of signal names to quantities that defines hard eviction thresholds. For example:
{"memory.available" = "300Mi"}
. - Eviction
Soft map[string]string - Same as evictionSoft. The map of signal names to quantities that defines soft eviction thresholds. For example:
{"memory.available" = "300Mi"}
. - Eviction
Soft map[string]stringGrace Period - Same as evictionSoftGracePeriod. The map of signal names to quantities that defines grace periods for each soft eviction signal. For example:
{"memory.available" = "30s"}
. - Feature
Gates map[string]bool - Feature switch to enable configuration of experimental features.
- Kube
Api stringBurst - Same as kubeAPIBurst. The burst to allow while talking with kubernetes api-server. Valid value is
[0-100]
. - Kube
Api stringQps - Same as kubeAPIQPS. The QPS to use while talking with kubernetes api-server. Valid value is
[0-50]
. - Kube
Reserved map[string]string - Same as kubeReserved. The set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=150G) pairs that describe resources reserved for kubernetes system components. Currently, cpu, memory and local storage for root file system are supported. See compute resources for more details.
- Max
Pods string - The maximum number of running pods.
- Read
Only stringPort - Read-only port number.
- Registry
Burst string - Same as registryBurst. The maximum size of burst pulls, temporarily allows pulls to burst to this number, while still not exceeding
registry_pull_qps
. Only used ifregistry_pull_qps
is greater than 0. Valid value is[0-100]
. - Registry
Pull stringQps - Same as registryPullQPS. The limit of registry pulls per second. Setting it to
0
means no limit. Valid value is[0-50]
. - Serialize
Image stringPulls - Same as serializeImagePulls. When enabled, it tells the Kubelet to pull images one at a time. We recommend not changing the default value on nodes that run docker daemon with version < 1.9 or an Aufs storage backend. Valid value is
true
orfalse
. - System
Reserved map[string]string - Same as systemReserved. The set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=150G) pairs that describe resources reserved for non-kubernetes components. Currently, only cpu and memory are supported. See compute resources for more details.
- allowed
Unsafe List<String>Sysctls - Allowed sysctl mode whitelist.
- container
Log StringMax Files - The maximum number of log files that can exist in each container.
- container
Log StringMax Size - The maximum size that can be reached before a log file is rotated.
- cpu
Manager StringPolicy - Same as cpuManagerPolicy. The name of the policy to use. Requires the CPUManager feature gate to be enabled. Valid value is
none
orstatic
. - event
Burst String - Same as eventBurst. The maximum size of a burst of event creations, temporarily allows event creations to burst to this number, while still not exceeding
event_record_qps
. It is only used whenevent_record_qps
is greater than 0. Valid value is[0-100]
. - event
Record StringQps - Same as eventRecordQPS. The maximum event creations per second. If 0, there is no limit enforced. Valid value is
[0-50]
. - eviction
Hard Map<String,String> - Same as evictionHard. The map of signal names to quantities that defines hard eviction thresholds. For example:
{"memory.available" = "300Mi"}
. - eviction
Soft Map<String,String> - Same as evictionSoft. The map of signal names to quantities that defines soft eviction thresholds. For example:
{"memory.available" = "300Mi"}
. - eviction
Soft Map<String,String>Grace Period - Same as evictionSoftGracePeriod. The map of signal names to quantities that defines grace periods for each soft eviction signal. For example:
{"memory.available" = "30s"}
. - feature
Gates Map<String,Boolean> - Feature switch to enable configuration of experimental features.
- kube
Api StringBurst - Same as kubeAPIBurst. The burst to allow while talking with kubernetes api-server. Valid value is
[0-100]
. - kube
Api StringQps - Same as kubeAPIQPS. The QPS to use while talking with kubernetes api-server. Valid value is
[0-50]
. - kube
Reserved Map<String,String> - Same as kubeReserved. The set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=150G) pairs that describe resources reserved for kubernetes system components. Currently, cpu, memory and local storage for root file system are supported. See compute resources for more details.
- max
Pods String - The maximum number of running pods.
- read
Only StringPort - Read-only port number.
- registry
Burst String - Same as registryBurst. The maximum size of burst pulls, temporarily allows pulls to burst to this number, while still not exceeding
registry_pull_qps
. Only used ifregistry_pull_qps
is greater than 0. Valid value is[0-100]
. - registry
Pull StringQps - Same as registryPullQPS. The limit of registry pulls per second. Setting it to
0
means no limit. Valid value is[0-50]
. - serialize
Image StringPulls - Same as serializeImagePulls. When enabled, it tells the Kubelet to pull images one at a time. We recommend not changing the default value on nodes that run docker daemon with version < 1.9 or an Aufs storage backend. Valid value is
true
orfalse
. - system
Reserved Map<String,String> - Same as systemReserved. The set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=150G) pairs that describe resources reserved for non-kubernetes components. Currently, only cpu and memory are supported. See compute resources for more details.
- allowed
Unsafe string[]Sysctls - Allowed sysctl mode whitelist.
- container
Log stringMax Files - The maximum number of log files that can exist in each container.
- container
Log stringMax Size - The maximum size that can be reached before a log file is rotated.
- cpu
Manager stringPolicy - Same as cpuManagerPolicy. The name of the policy to use. Requires the CPUManager feature gate to be enabled. Valid value is
none
orstatic
. - event
Burst string - Same as eventBurst. The maximum size of a burst of event creations, temporarily allows event creations to burst to this number, while still not exceeding
event_record_qps
. It is only used whenevent_record_qps
is greater than 0. Valid value is[0-100]
. - event
Record stringQps - Same as eventRecordQPS. The maximum event creations per second. If 0, there is no limit enforced. Valid value is
[0-50]
. - eviction
Hard {[key: string]: string} - Same as evictionHard. The map of signal names to quantities that defines hard eviction thresholds. For example:
{"memory.available" = "300Mi"}
. - eviction
Soft {[key: string]: string} - Same as evictionSoft. The map of signal names to quantities that defines soft eviction thresholds. For example:
{"memory.available" = "300Mi"}
. - eviction
Soft {[key: string]: string}Grace Period - Same as evictionSoftGracePeriod. The map of signal names to quantities that defines grace periods for each soft eviction signal. For example:
{"memory.available" = "30s"}
. - feature
Gates {[key: string]: boolean} - Feature switch to enable configuration of experimental features.
- kube
Api stringBurst - Same as kubeAPIBurst. The burst to allow while talking with kubernetes api-server. Valid value is
[0-100]
. - kube
Api stringQps - Same as kubeAPIQPS. The QPS to use while talking with kubernetes api-server. Valid value is
[0-50]
. - kube
Reserved {[key: string]: string} - Same as kubeReserved. The set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=150G) pairs that describe resources reserved for kubernetes system components. Currently, cpu, memory and local storage for root file system are supported. See compute resources for more details.
- max
Pods string - The maximum number of running pods.
- read
Only stringPort - Read-only port number.
- registry
Burst string - Same as registryBurst. The maximum size of burst pulls, temporarily allows pulls to burst to this number, while still not exceeding
registry_pull_qps
. Only used ifregistry_pull_qps
is greater than 0. Valid value is[0-100]
. - registry
Pull stringQps - Same as registryPullQPS. The limit of registry pulls per second. Setting it to
0
means no limit. Valid value is[0-50]
. - serialize
Image stringPulls - Same as serializeImagePulls. When enabled, it tells the Kubelet to pull images one at a time. We recommend not changing the default value on nodes that run docker daemon with version < 1.9 or an Aufs storage backend. Valid value is
true
orfalse
. - system
Reserved {[key: string]: string} - Same as systemReserved. The set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=150G) pairs that describe resources reserved for non-kubernetes components. Currently, only cpu and memory are supported. See compute resources for more details.
- allowed_
unsafe_ Sequence[str]sysctls - Allowed sysctl mode whitelist.
- container_
log_ strmax_ files - The maximum number of log files that can exist in each container.
- container_
log_ strmax_ size - The maximum size that can be reached before a log file is rotated.
- cpu_
manager_ strpolicy - Same as cpuManagerPolicy. The name of the policy to use. Requires the CPUManager feature gate to be enabled. Valid value is
none
orstatic
. - event_
burst str - Same as eventBurst. The maximum size of a burst of event creations, temporarily allows event creations to burst to this number, while still not exceeding
event_record_qps
. It is only used whenevent_record_qps
is greater than 0. Valid value is[0-100]
. - event_
record_ strqps - Same as eventRecordQPS. The maximum event creations per second. If 0, there is no limit enforced. Valid value is
[0-50]
. - eviction_
hard Mapping[str, str] - Same as evictionHard. The map of signal names to quantities that defines hard eviction thresholds. For example:
{"memory.available" = "300Mi"}
. - eviction_
soft Mapping[str, str] - Same as evictionSoft. The map of signal names to quantities that defines soft eviction thresholds. For example:
{"memory.available" = "300Mi"}
. - eviction_
soft_ Mapping[str, str]grace_ period - Same as evictionSoftGracePeriod. The map of signal names to quantities that defines grace periods for each soft eviction signal. For example:
{"memory.available" = "30s"}
. - feature_
gates Mapping[str, bool] - Feature switch to enable configuration of experimental features.
- kube_
api_ strburst - Same as kubeAPIBurst. The burst to allow while talking with kubernetes api-server. Valid value is
[0-100]
. - kube_
api_ strqps - Same as kubeAPIQPS. The QPS to use while talking with kubernetes api-server. Valid value is
[0-50]
. - kube_
reserved Mapping[str, str] - Same as kubeReserved. The set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=150G) pairs that describe resources reserved for kubernetes system components. Currently, cpu, memory and local storage for root file system are supported. See compute resources for more details.
- max_
pods str - The maximum number of running pods.
- read_
only_ strport - Read-only port number.
- registry_
burst str - Same as registryBurst. The maximum size of burst pulls, temporarily allows pulls to burst to this number, while still not exceeding
registry_pull_qps
. Only used ifregistry_pull_qps
is greater than 0. Valid value is[0-100]
. - registry_
pull_ strqps - Same as registryPullQPS. The limit of registry pulls per second. Setting it to
0
means no limit. Valid value is[0-50]
. - serialize_
image_ strpulls - Same as serializeImagePulls. When enabled, it tells the Kubelet to pull images one at a time. We recommend not changing the default value on nodes that run docker daemon with version < 1.9 or an Aufs storage backend. Valid value is
true
orfalse
. - system_
reserved Mapping[str, str] - Same as systemReserved. The set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=150G) pairs that describe resources reserved for non-kubernetes components. Currently, only cpu and memory are supported. See compute resources for more details.
- allowed
Unsafe List<String>Sysctls - Allowed sysctl mode whitelist.
- container
Log StringMax Files - The maximum number of log files that can exist in each container.
- container
Log StringMax Size - The maximum size that can be reached before a log file is rotated.
- cpu
Manager StringPolicy - Same as cpuManagerPolicy. The name of the policy to use. Requires the CPUManager feature gate to be enabled. Valid value is
none
orstatic
. - event
Burst String - Same as eventBurst. The maximum size of a burst of event creations, temporarily allows event creations to burst to this number, while still not exceeding
event_record_qps
. It is only used whenevent_record_qps
is greater than 0. Valid value is[0-100]
. - event
Record StringQps - Same as eventRecordQPS. The maximum event creations per second. If 0, there is no limit enforced. Valid value is
[0-50]
. - eviction
Hard Map<String> - Same as evictionHard. The map of signal names to quantities that defines hard eviction thresholds. For example:
{"memory.available" = "300Mi"}
. - eviction
Soft Map<String> - Same as evictionSoft. The map of signal names to quantities that defines soft eviction thresholds. For example:
{"memory.available" = "300Mi"}
. - eviction
Soft Map<String>Grace Period - Same as evictionSoftGracePeriod. The map of signal names to quantities that defines grace periods for each soft eviction signal. For example:
{"memory.available" = "30s"}
. - feature
Gates Map<Boolean> - Feature switch to enable configuration of experimental features.
- kube
Api StringBurst - Same as kubeAPIBurst. The burst to allow while talking with kubernetes api-server. Valid value is
[0-100]
. - kube
Api StringQps - Same as kubeAPIQPS. The QPS to use while talking with kubernetes api-server. Valid value is
[0-50]
. - kube
Reserved Map<String> - Same as kubeReserved. The set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=150G) pairs that describe resources reserved for kubernetes system components. Currently, cpu, memory and local storage for root file system are supported. See compute resources for more details.
- max
Pods String - The maximum number of running pods.
- read
Only StringPort - Read-only port number.
- registry
Burst String - Same as registryBurst. The maximum size of burst pulls, temporarily allows pulls to burst to this number, while still not exceeding
registry_pull_qps
. Only used ifregistry_pull_qps
is greater than 0. Valid value is[0-100]
. - registry
Pull StringQps - Same as registryPullQPS. The limit of registry pulls per second. Setting it to
0
means no limit. Valid value is[0-50]
. - serialize
Image StringPulls - Same as serializeImagePulls. When enabled, it tells the Kubelet to pull images one at a time. We recommend not changing the default value on nodes that run docker daemon with version < 1.9 or an Aufs storage backend. Valid value is
true
orfalse
. - system
Reserved Map<String> - Same as systemReserved. The set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=150G) pairs that describe resources reserved for non-kubernetes components. Currently, only cpu and memory are supported. See compute resources for more details.
NodePoolLabel, NodePoolLabelArgs
NodePoolManagement, NodePoolManagementArgs
- Auto
Repair bool - Whether to enable automatic repair. Valid values:
true
: Automatic repair.false
: not automatically repaired. - Auto
Repair Pulumi.Policy Ali Cloud. CS. Inputs. Node Pool Management Auto Repair Policy - Automatic repair node policy. See
auto_repair_policy
below. - Auto
Upgrade bool - Specifies whether to enable auto update. Valid values:
true
: enables auto update.false
: disables auto update. - Auto
Upgrade Pulumi.Policy Ali Cloud. CS. Inputs. Node Pool Management Auto Upgrade Policy - The auto update policy. See
auto_upgrade_policy
below. - Auto
Vul boolFix - Specifies whether to automatically patch CVE vulnerabilities. Valid values:
true
,false
. - Auto
Vul Pulumi.Fix Policy Ali Cloud. CS. Inputs. Node Pool Management Auto Vul Fix Policy - The auto CVE patching policy. See
auto_vul_fix_policy
below. - Enable bool
- Specifies whether to enable the managed node pool feature. Valid values:
true
: enables the managed node pool feature.false
: disables the managed node pool feature. Other parameters in this section take effect only when you specify enable=true. - int
- Maximum number of unavailable nodes. Default value: 1. Value range:[1,1000].
- Surge int
- Number of additional nodes. You have to specify one of surge, surge_percentage.
- Surge
Percentage int - Proportion of additional nodes. You have to specify one of surge, surge_percentage.
- Auto
Repair bool - Whether to enable automatic repair. Valid values:
true
: Automatic repair.false
: not automatically repaired. - Auto
Repair NodePolicy Pool Management Auto Repair Policy - Automatic repair node policy. See
auto_repair_policy
below. - Auto
Upgrade bool - Specifies whether to enable auto update. Valid values:
true
: enables auto update.false
: disables auto update. - Auto
Upgrade NodePolicy Pool Management Auto Upgrade Policy - The auto update policy. See
auto_upgrade_policy
below. - Auto
Vul boolFix - Specifies whether to automatically patch CVE vulnerabilities. Valid values:
true
,false
. - Auto
Vul NodeFix Policy Pool Management Auto Vul Fix Policy - The auto CVE patching policy. See
auto_vul_fix_policy
below. - Enable bool
- Specifies whether to enable the managed node pool feature. Valid values:
true
: enables the managed node pool feature.false
: disables the managed node pool feature. Other parameters in this section take effect only when you specify enable=true. - int
- Maximum number of unavailable nodes. Default value: 1. Value range:[1,1000].
- Surge int
- Number of additional nodes. You have to specify one of surge, surge_percentage.
- Surge
Percentage int - Proportion of additional nodes. You have to specify one of surge, surge_percentage.
- auto
Repair Boolean - Whether to enable automatic repair. Valid values:
true
: Automatic repair.false
: not automatically repaired. - auto
Repair NodePolicy Pool Management Auto Repair Policy - Automatic repair node policy. See
auto_repair_policy
below. - auto
Upgrade Boolean - Specifies whether to enable auto update. Valid values:
true
: enables auto update.false
: disables auto update. - auto
Upgrade NodePolicy Pool Management Auto Upgrade Policy - The auto update policy. See
auto_upgrade_policy
below. - auto
Vul BooleanFix - Specifies whether to automatically patch CVE vulnerabilities. Valid values:
true
,false
. - auto
Vul NodeFix Policy Pool Management Auto Vul Fix Policy - The auto CVE patching policy. See
auto_vul_fix_policy
below. - enable Boolean
- Specifies whether to enable the managed node pool feature. Valid values:
true
: enables the managed node pool feature.false
: disables the managed node pool feature. Other parameters in this section take effect only when you specify enable=true. - Integer
- Maximum number of unavailable nodes. Default value: 1. Value range:[1,1000].
- surge Integer
- Number of additional nodes. You have to specify one of surge, surge_percentage.
- surge
Percentage Integer - Proportion of additional nodes. You have to specify one of surge, surge_percentage.
- auto
Repair boolean - Whether to enable automatic repair. Valid values:
true
: Automatic repair.false
: not automatically repaired. - auto
Repair NodePolicy Pool Management Auto Repair Policy - Automatic repair node policy. See
auto_repair_policy
below. - auto
Upgrade boolean - Specifies whether to enable auto update. Valid values:
true
: enables auto update.false
: disables auto update. - auto
Upgrade NodePolicy Pool Management Auto Upgrade Policy - The auto update policy. See
auto_upgrade_policy
below. - auto
Vul booleanFix - Specifies whether to automatically patch CVE vulnerabilities. Valid values:
true
,false
. - auto
Vul NodeFix Policy Pool Management Auto Vul Fix Policy - The auto CVE patching policy. See
auto_vul_fix_policy
below. - enable boolean
- Specifies whether to enable the managed node pool feature. Valid values:
true
: enables the managed node pool feature.false
: disables the managed node pool feature. Other parameters in this section take effect only when you specify enable=true. - number
- Maximum number of unavailable nodes. Default value: 1. Value range:[1,1000].
- surge number
- Number of additional nodes. You have to specify one of surge, surge_percentage.
- surge
Percentage number - Proportion of additional nodes. You have to specify one of surge, surge_percentage.
- auto_
repair bool - Whether to enable automatic repair. Valid values:
true
: Automatic repair.false
: not automatically repaired. - auto_
repair_ Nodepolicy Pool Management Auto Repair Policy - Automatic repair node policy. See
auto_repair_policy
below. - auto_
upgrade bool - Specifies whether to enable auto update. Valid values:
true
: enables auto update.false
: disables auto update. - auto_
upgrade_ Nodepolicy Pool Management Auto Upgrade Policy - The auto update policy. See
auto_upgrade_policy
below. - auto_
vul_ boolfix - Specifies whether to automatically patch CVE vulnerabilities. Valid values:
true
,false
. - auto_
vul_ Nodefix_ policy Pool Management Auto Vul Fix Policy - The auto CVE patching policy. See
auto_vul_fix_policy
below. - enable bool
- Specifies whether to enable the managed node pool feature. Valid values:
true
: enables the managed node pool feature.false
: disables the managed node pool feature. Other parameters in this section take effect only when you specify enable=true. - int
- Maximum number of unavailable nodes. Default value: 1. Value range:[1,1000].
- surge int
- Number of additional nodes. You have to specify one of surge, surge_percentage.
- surge_
percentage int - Proportion of additional nodes. You have to specify one of surge, surge_percentage.
- auto
Repair Boolean - Whether to enable automatic repair. Valid values:
true
: Automatic repair.false
: not automatically repaired. - auto
Repair Property MapPolicy - Automatic repair node policy. See
auto_repair_policy
below. - auto
Upgrade Boolean - Specifies whether to enable auto update. Valid values:
true
: enables auto update.false
: disables auto update. - auto
Upgrade Property MapPolicy - The auto update policy. See
auto_upgrade_policy
below. - auto
Vul BooleanFix - Specifies whether to automatically patch CVE vulnerabilities. Valid values:
true
,false
. - auto
Vul Property MapFix Policy - The auto CVE patching policy. See
auto_vul_fix_policy
below. - enable Boolean
- Specifies whether to enable the managed node pool feature. Valid values:
true
: enables the managed node pool feature.false
: disables the managed node pool feature. Other parameters in this section take effect only when you specify enable=true. - Number
- Maximum number of unavailable nodes. Default value: 1. Value range:[1,1000].
- surge Number
- Number of additional nodes. You have to specify one of surge, surge_percentage.
- surge
Percentage Number - Proportion of additional nodes. You have to specify one of surge, surge_percentage.
NodePoolManagementAutoRepairPolicy, NodePoolManagementAutoRepairPolicyArgs
- Restart
Node bool - Specifies whether to automatically restart nodes after patching CVE vulnerabilities. Valid values:
true
,false
.
- Restart
Node bool - Specifies whether to automatically restart nodes after patching CVE vulnerabilities. Valid values:
true
,false
.
- restart
Node Boolean - Specifies whether to automatically restart nodes after patching CVE vulnerabilities. Valid values:
true
,false
.
- restart
Node boolean - Specifies whether to automatically restart nodes after patching CVE vulnerabilities. Valid values:
true
,false
.
- restart_
node bool - Specifies whether to automatically restart nodes after patching CVE vulnerabilities. Valid values:
true
,false
.
- restart
Node Boolean - Specifies whether to automatically restart nodes after patching CVE vulnerabilities. Valid values:
true
,false
.
NodePoolManagementAutoUpgradePolicy, NodePoolManagementAutoUpgradePolicyArgs
- Auto
Upgrade boolKubelet - Specifies whether to automatically update the kubelet. Valid values:
true
: yes;false
: no.
- Auto
Upgrade boolKubelet - Specifies whether to automatically update the kubelet. Valid values:
true
: yes;false
: no.
- auto
Upgrade BooleanKubelet - Specifies whether to automatically update the kubelet. Valid values:
true
: yes;false
: no.
- auto
Upgrade booleanKubelet - Specifies whether to automatically update the kubelet. Valid values:
true
: yes;false
: no.
- auto_
upgrade_ boolkubelet - Specifies whether to automatically update the kubelet. Valid values:
true
: yes;false
: no.
- auto
Upgrade BooleanKubelet - Specifies whether to automatically update the kubelet. Valid values:
true
: yes;false
: no.
NodePoolManagementAutoVulFixPolicy, NodePoolManagementAutoVulFixPolicyArgs
- Restart
Node bool - Specifies whether to automatically restart nodes after patching CVE vulnerabilities. Valid values:
true
,false
. - Vul
Level string - The severity levels of vulnerabilities that is allowed to automatically patch. Multiple severity levels are separated by commas (,).
- Restart
Node bool - Specifies whether to automatically restart nodes after patching CVE vulnerabilities. Valid values:
true
,false
. - Vul
Level string - The severity levels of vulnerabilities that is allowed to automatically patch. Multiple severity levels are separated by commas (,).
- restart
Node Boolean - Specifies whether to automatically restart nodes after patching CVE vulnerabilities. Valid values:
true
,false
. - vul
Level String - The severity levels of vulnerabilities that is allowed to automatically patch. Multiple severity levels are separated by commas (,).
- restart
Node boolean - Specifies whether to automatically restart nodes after patching CVE vulnerabilities. Valid values:
true
,false
. - vul
Level string - The severity levels of vulnerabilities that is allowed to automatically patch. Multiple severity levels are separated by commas (,).
- restart_
node bool - Specifies whether to automatically restart nodes after patching CVE vulnerabilities. Valid values:
true
,false
. - vul_
level str - The severity levels of vulnerabilities that is allowed to automatically patch. Multiple severity levels are separated by commas (,).
- restart
Node Boolean - Specifies whether to automatically restart nodes after patching CVE vulnerabilities. Valid values:
true
,false
. - vul
Level String - The severity levels of vulnerabilities that is allowed to automatically patch. Multiple severity levels are separated by commas (,).
NodePoolPrivatePoolOptions, NodePoolPrivatePoolOptionsArgs
- Private
Pool stringOptions Id - The ID of the private node pool.
- Private
Pool stringOptions Match Criteria - The type of private node pool. This parameter specifies the type of the private pool that you want to use to create instances. A private node pool is generated when an elasticity assurance or a capacity reservation service takes effect. The system selects a private node pool to launch instances. Valid values:
Open
: specifies an open private node pool. The system selects an open private node pool to launch instances. If no matching open private node pool is available, the resources in the public node pool are used.Target
: specifies a private node pool. The system uses the resources of the specified private node pool to launch instances. If the specified private node pool is unavailable, instances cannot be started.None
: no private node pool is used. The resources of private node pools are not used to launch the instances.
- Private
Pool stringOptions Id - The ID of the private node pool.
- Private
Pool stringOptions Match Criteria - The type of private node pool. This parameter specifies the type of the private pool that you want to use to create instances. A private node pool is generated when an elasticity assurance or a capacity reservation service takes effect. The system selects a private node pool to launch instances. Valid values:
Open
: specifies an open private node pool. The system selects an open private node pool to launch instances. If no matching open private node pool is available, the resources in the public node pool are used.Target
: specifies a private node pool. The system uses the resources of the specified private node pool to launch instances. If the specified private node pool is unavailable, instances cannot be started.None
: no private node pool is used. The resources of private node pools are not used to launch the instances.
- private
Pool StringOptions Id - The ID of the private node pool.
- private
Pool StringOptions Match Criteria - The type of private node pool. This parameter specifies the type of the private pool that you want to use to create instances. A private node pool is generated when an elasticity assurance or a capacity reservation service takes effect. The system selects a private node pool to launch instances. Valid values:
Open
: specifies an open private node pool. The system selects an open private node pool to launch instances. If no matching open private node pool is available, the resources in the public node pool are used.Target
: specifies a private node pool. The system uses the resources of the specified private node pool to launch instances. If the specified private node pool is unavailable, instances cannot be started.None
: no private node pool is used. The resources of private node pools are not used to launch the instances.
- private
Pool stringOptions Id - The ID of the private node pool.
- private
Pool stringOptions Match Criteria - The type of private node pool. This parameter specifies the type of the private pool that you want to use to create instances. A private node pool is generated when an elasticity assurance or a capacity reservation service takes effect. The system selects a private node pool to launch instances. Valid values:
Open
: specifies an open private node pool. The system selects an open private node pool to launch instances. If no matching open private node pool is available, the resources in the public node pool are used.Target
: specifies a private node pool. The system uses the resources of the specified private node pool to launch instances. If the specified private node pool is unavailable, instances cannot be started.None
: no private node pool is used. The resources of private node pools are not used to launch the instances.
- private_
pool_ stroptions_ id - The ID of the private node pool.
- private_
pool_ stroptions_ match_ criteria - The type of private node pool. This parameter specifies the type of the private pool that you want to use to create instances. A private node pool is generated when an elasticity assurance or a capacity reservation service takes effect. The system selects a private node pool to launch instances. Valid values:
Open
: specifies an open private node pool. The system selects an open private node pool to launch instances. If no matching open private node pool is available, the resources in the public node pool are used.Target
: specifies a private node pool. The system uses the resources of the specified private node pool to launch instances. If the specified private node pool is unavailable, instances cannot be started.None
: no private node pool is used. The resources of private node pools are not used to launch the instances.
- private
Pool StringOptions Id - The ID of the private node pool.
- private
Pool StringOptions Match Criteria - The type of private node pool. This parameter specifies the type of the private pool that you want to use to create instances. A private node pool is generated when an elasticity assurance or a capacity reservation service takes effect. The system selects a private node pool to launch instances. Valid values:
Open
: specifies an open private node pool. The system selects an open private node pool to launch instances. If no matching open private node pool is available, the resources in the public node pool are used.Target
: specifies a private node pool. The system uses the resources of the specified private node pool to launch instances. If the specified private node pool is unavailable, instances cannot be started.None
: no private node pool is used. The resources of private node pools are not used to launch the instances.
NodePoolRollingPolicy, NodePoolRollingPolicyArgs
- Max
Parallelism int - The maximum number of unusable nodes.
- Max
Parallelism int - The maximum number of unusable nodes.
- max
Parallelism Integer - The maximum number of unusable nodes.
- max
Parallelism number - The maximum number of unusable nodes.
- max_
parallelism int - The maximum number of unusable nodes.
- max
Parallelism Number - The maximum number of unusable nodes.
NodePoolScalingConfig, NodePoolScalingConfigArgs
- Eip
Bandwidth int - Peak EIP bandwidth. Its valid value range [1~500] in Mbps. It works if
is_bond_eip=true
. Default to5
. - Eip
Internet stringCharge Type - EIP billing type.
PayByBandwidth
: Charged at fixed bandwidth.PayByTraffic
: Billed as used traffic. Default:PayByBandwidth
. It works ifis_bond_eip=true
, conflict withinternet_charge_type
. EIP and public network IP can only choose one. - Enable bool
- Whether to enable automatic scaling. Value:
- Is
Bond boolEip - Whether to bind EIP for an instance. Default:
false
. - Max
Size int - Max number of instances in a auto scaling group, its valid value range [0~1000].
max_size
has to be greater thanmin_size
. - Min
Size int - Min number of instances in a auto scaling group, its valid value range [0~1000].
- Type string
- Instance classification, not required. Vaild value:
cpu
,gpu
,gpushare
andspot
. Default:cpu
. The actual instance type is determined byinstance_types
.
- Eip
Bandwidth int - Peak EIP bandwidth. Its valid value range [1~500] in Mbps. It works if
is_bond_eip=true
. Default to5
. - Eip
Internet stringCharge Type - EIP billing type.
PayByBandwidth
: Charged at fixed bandwidth.PayByTraffic
: Billed as used traffic. Default:PayByBandwidth
. It works ifis_bond_eip=true
, conflict withinternet_charge_type
. EIP and public network IP can only choose one. - Enable bool
- Whether to enable automatic scaling. Value:
- Is
Bond boolEip - Whether to bind EIP for an instance. Default:
false
. - Max
Size int - Max number of instances in a auto scaling group, its valid value range [0~1000].
max_size
has to be greater thanmin_size
. - Min
Size int - Min number of instances in a auto scaling group, its valid value range [0~1000].
- Type string
- Instance classification, not required. Vaild value:
cpu
,gpu
,gpushare
andspot
. Default:cpu
. The actual instance type is determined byinstance_types
.
- eip
Bandwidth Integer - Peak EIP bandwidth. Its valid value range [1~500] in Mbps. It works if
is_bond_eip=true
. Default to5
. - eip
Internet StringCharge Type - EIP billing type.
PayByBandwidth
: Charged at fixed bandwidth.PayByTraffic
: Billed as used traffic. Default:PayByBandwidth
. It works ifis_bond_eip=true
, conflict withinternet_charge_type
. EIP and public network IP can only choose one. - enable Boolean
- Whether to enable automatic scaling. Value:
- is
Bond BooleanEip - Whether to bind EIP for an instance. Default:
false
. - max
Size Integer - Max number of instances in a auto scaling group, its valid value range [0~1000].
max_size
has to be greater thanmin_size
. - min
Size Integer - Min number of instances in a auto scaling group, its valid value range [0~1000].
- type String
- Instance classification, not required. Vaild value:
cpu
,gpu
,gpushare
andspot
. Default:cpu
. The actual instance type is determined byinstance_types
.
- eip
Bandwidth number - Peak EIP bandwidth. Its valid value range [1~500] in Mbps. It works if
is_bond_eip=true
. Default to5
. - eip
Internet stringCharge Type - EIP billing type.
PayByBandwidth
: Charged at fixed bandwidth.PayByTraffic
: Billed as used traffic. Default:PayByBandwidth
. It works ifis_bond_eip=true
, conflict withinternet_charge_type
. EIP and public network IP can only choose one. - enable boolean
- Whether to enable automatic scaling. Value:
- is
Bond booleanEip - Whether to bind EIP for an instance. Default:
false
. - max
Size number - Max number of instances in a auto scaling group, its valid value range [0~1000].
max_size
has to be greater thanmin_size
. - min
Size number - Min number of instances in a auto scaling group, its valid value range [0~1000].
- type string
- Instance classification, not required. Vaild value:
cpu
,gpu
,gpushare
andspot
. Default:cpu
. The actual instance type is determined byinstance_types
.
- eip_
bandwidth int - Peak EIP bandwidth. Its valid value range [1~500] in Mbps. It works if
is_bond_eip=true
. Default to5
. - eip_
internet_ strcharge_ type - EIP billing type.
PayByBandwidth
: Charged at fixed bandwidth.PayByTraffic
: Billed as used traffic. Default:PayByBandwidth
. It works ifis_bond_eip=true
, conflict withinternet_charge_type
. EIP and public network IP can only choose one. - enable bool
- Whether to enable automatic scaling. Value:
- is_
bond_ booleip - Whether to bind EIP for an instance. Default:
false
. - max_
size int - Max number of instances in a auto scaling group, its valid value range [0~1000].
max_size
has to be greater thanmin_size
. - min_
size int - Min number of instances in a auto scaling group, its valid value range [0~1000].
- type str
- Instance classification, not required. Vaild value:
cpu
,gpu
,gpushare
andspot
. Default:cpu
. The actual instance type is determined byinstance_types
.
- eip
Bandwidth Number - Peak EIP bandwidth. Its valid value range [1~500] in Mbps. It works if
is_bond_eip=true
. Default to5
. - eip
Internet StringCharge Type - EIP billing type.
PayByBandwidth
: Charged at fixed bandwidth.PayByTraffic
: Billed as used traffic. Default:PayByBandwidth
. It works ifis_bond_eip=true
, conflict withinternet_charge_type
. EIP and public network IP can only choose one. - enable Boolean
- Whether to enable automatic scaling. Value:
- is
Bond BooleanEip - Whether to bind EIP for an instance. Default:
false
. - max
Size Number - Max number of instances in a auto scaling group, its valid value range [0~1000].
max_size
has to be greater thanmin_size
. - min
Size Number - Min number of instances in a auto scaling group, its valid value range [0~1000].
- type String
- Instance classification, not required. Vaild value:
cpu
,gpu
,gpushare
andspot
. Default:cpu
. The actual instance type is determined byinstance_types
.
NodePoolSpotPriceLimit, NodePoolSpotPriceLimitArgs
- Instance
Type string - The type of the preemptible instance.
- Price
Limit string - The maximum price of a single instance.
- Instance
Type string - The type of the preemptible instance.
- Price
Limit string - The maximum price of a single instance.
- instance
Type String - The type of the preemptible instance.
- price
Limit String - The maximum price of a single instance.
- instance
Type string - The type of the preemptible instance.
- price
Limit string - The maximum price of a single instance.
- instance_
type str - The type of the preemptible instance.
- price_
limit str - The maximum price of a single instance.
- instance
Type String - The type of the preemptible instance.
- price
Limit String - The maximum price of a single instance.
NodePoolTaint, NodePoolTaintArgs
NodePoolTeeConfig, NodePoolTeeConfigArgs
- Tee
Enable bool - Specifies whether to enable confidential computing for the cluster.
- Tee
Enable bool - Specifies whether to enable confidential computing for the cluster.
- tee
Enable Boolean - Specifies whether to enable confidential computing for the cluster.
- tee
Enable boolean - Specifies whether to enable confidential computing for the cluster.
- tee_
enable bool - Specifies whether to enable confidential computing for the cluster.
- tee
Enable Boolean - Specifies whether to enable confidential computing for the cluster.
Import
ACK Nodepool can be imported using the id, e.g.
$ pulumi import alicloud:cs/nodePool:NodePool example <cluster_id>:<node_pool_id>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
alicloud
Terraform Provider.