published on Thursday, Apr 23, 2026 by Volcengine
published on Thursday, Apr 23, 2026 by Volcengine
Container Service deeply integrates next-generation cloud-native technologies to provide high-performance Kubernetes cluster management centered on containers. Build highly available Kubernetes clusters in the cloud with one click and achieve visualized full lifecycle management of containerized applications, helping users quickly build containerized applications.
Example Usage
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
resources:
vKEClusterDemo:
type: volcenginecc:vke:Cluster
name: VKEClusterDemo
properties:
projectName: default
name: VKEClusterDemo
description: VKEClusterDemo
deleteProtectionEnabled: true
clusterConfig:
subnet_ids:
- subnet-***
api_server_public_access_enabled: true
api_server_public_access_config:
publicAccessNetworkConfig:
billingType: 3
bandwidth: 1
isp: BGP
resource_public_access_default_enabled: true
podsConfig:
pod_network_mode: VpcCniShared
vpc_cni_config:
subnetIds:
- subnet-***
trunkEniEnabled: false
servicesConfig:
service_cidrsv_4:
- 172.22.xxx.0/22
tags:
- key: env
value: test
kubernetesVersionCreate: '1.30'
Create Cluster Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);@overload
def Cluster(resource_name: str,
args: ClusterArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Cluster(resource_name: str,
opts: Optional[ResourceOptions] = None,
name: Optional[str] = None,
monitoring_config: Optional[ClusterMonitoringConfigArgs] = None,
description: Optional[str] = None,
irsa_config: Optional[ClusterIrsaConfigArgs] = None,
kubernetes_version_create: Optional[str] = None,
logging_config: Optional[ClusterLoggingConfigArgs] = None,
cluster_config: Optional[ClusterClusterConfigArgs] = None,
delete_protection_enabled: Optional[bool] = None,
pods_config: Optional[ClusterPodsConfigArgs] = None,
project_name: Optional[str] = None,
services_config: Optional[ClusterServicesConfigArgs] = None,
source_region: Optional[str] = None,
tags: Optional[Sequence[ClusterTagArgs]] = None)func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)
type: volcenginecc:vke:Cluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ClusterArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ClusterArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ClusterArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClusterArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ClusterArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Cluster Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Cluster resource accepts the following input properties:
- Name string
- Cluster name. Must be unique within the same region. Supports uppercase and lowercase English letters, Chinese characters, numbers, and hyphens (-). Length must be 2–64 characters.
- Cluster
Config Volcengine.Cluster Cluster Config - Network configuration for the cluster control plane and some nodes.
- Delete
Protection boolEnabled - Cluster deletion protection. Values: false (default): Deletion protection is disabled. true: Deletion protection is enabled; the cluster cannot be deleted directly.
- Description string
- Cluster description. Maximum length is 300 characters.
- Irsa
Config Volcengine.Cluster Irsa Config - IRSA (IAM Role for Service Account) capability parameter configuration
- Kubernetes
Version stringCreate - Kubernetes version of the cluster, in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version. (For creation)
- Logging
Config Volcengine.Cluster Logging Config - Cluster log configuration information.
- Monitoring
Config Volcengine.Cluster Monitoring Config - Monitoring configuration information.
- Pods
Config Volcengine.Cluster Pods Config - Pod network configuration.
- Project
Name string - Project name to which the cluster belongs. A cluster can belong to only one project. Only English letters, numbers, underscores (_), periods (.), and hyphens (-) are allowed. Maximum length: 64 characters. Default: default.
- Services
Config Volcengine.Cluster Services Config - Network configuration for the service.
- Source
Region string - Cluster source region
-
List<Volcengine.
Cluster Tag>
- Name string
- Cluster name. Must be unique within the same region. Supports uppercase and lowercase English letters, Chinese characters, numbers, and hyphens (-). Length must be 2–64 characters.
- Cluster
Config ClusterCluster Config Args - Network configuration for the cluster control plane and some nodes.
- Delete
Protection boolEnabled - Cluster deletion protection. Values: false (default): Deletion protection is disabled. true: Deletion protection is enabled; the cluster cannot be deleted directly.
- Description string
- Cluster description. Maximum length is 300 characters.
- Irsa
Config ClusterIrsa Config Args - IRSA (IAM Role for Service Account) capability parameter configuration
- Kubernetes
Version stringCreate - Kubernetes version of the cluster, in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version. (For creation)
- Logging
Config ClusterLogging Config Args - Cluster log configuration information.
- Monitoring
Config ClusterMonitoring Config Args - Monitoring configuration information.
- Pods
Config ClusterPods Config Args - Pod network configuration.
- Project
Name string - Project name to which the cluster belongs. A cluster can belong to only one project. Only English letters, numbers, underscores (_), periods (.), and hyphens (-) are allowed. Maximum length: 64 characters. Default: default.
- Services
Config ClusterServices Config Args - Network configuration for the service.
- Source
Region string - Cluster source region
-
[]Cluster
Tag Args
- name String
- Cluster name. Must be unique within the same region. Supports uppercase and lowercase English letters, Chinese characters, numbers, and hyphens (-). Length must be 2–64 characters.
- cluster
Config ClusterCluster Config - Network configuration for the cluster control plane and some nodes.
- delete
Protection BooleanEnabled - Cluster deletion protection. Values: false (default): Deletion protection is disabled. true: Deletion protection is enabled; the cluster cannot be deleted directly.
- description String
- Cluster description. Maximum length is 300 characters.
- irsa
Config ClusterIrsa Config - IRSA (IAM Role for Service Account) capability parameter configuration
- kubernetes
Version StringCreate - Kubernetes version of the cluster, in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version. (For creation)
- logging
Config ClusterLogging Config - Cluster log configuration information.
- monitoring
Config ClusterMonitoring Config - Monitoring configuration information.
- pods
Config ClusterPods Config - Pod network configuration.
- project
Name String - Project name to which the cluster belongs. A cluster can belong to only one project. Only English letters, numbers, underscores (_), periods (.), and hyphens (-) are allowed. Maximum length: 64 characters. Default: default.
- services
Config ClusterServices Config - Network configuration for the service.
- source
Region String - Cluster source region
-
List<Cluster
Tag>
- name string
- Cluster name. Must be unique within the same region. Supports uppercase and lowercase English letters, Chinese characters, numbers, and hyphens (-). Length must be 2–64 characters.
- cluster
Config ClusterCluster Config - Network configuration for the cluster control plane and some nodes.
- delete
Protection booleanEnabled - Cluster deletion protection. Values: false (default): Deletion protection is disabled. true: Deletion protection is enabled; the cluster cannot be deleted directly.
- description string
- Cluster description. Maximum length is 300 characters.
- irsa
Config ClusterIrsa Config - IRSA (IAM Role for Service Account) capability parameter configuration
- kubernetes
Version stringCreate - Kubernetes version of the cluster, in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version. (For creation)
- logging
Config ClusterLogging Config - Cluster log configuration information.
- monitoring
Config ClusterMonitoring Config - Monitoring configuration information.
- pods
Config ClusterPods Config - Pod network configuration.
- project
Name string - Project name to which the cluster belongs. A cluster can belong to only one project. Only English letters, numbers, underscores (_), periods (.), and hyphens (-) are allowed. Maximum length: 64 characters. Default: default.
- services
Config ClusterServices Config - Network configuration for the service.
- source
Region string - Cluster source region
-
Cluster
Tag[]
- name str
- Cluster name. Must be unique within the same region. Supports uppercase and lowercase English letters, Chinese characters, numbers, and hyphens (-). Length must be 2–64 characters.
- cluster_
config ClusterCluster Config Args - Network configuration for the cluster control plane and some nodes.
- delete_
protection_ boolenabled - Cluster deletion protection. Values: false (default): Deletion protection is disabled. true: Deletion protection is enabled; the cluster cannot be deleted directly.
- description str
- Cluster description. Maximum length is 300 characters.
- irsa_
config ClusterIrsa Config Args - IRSA (IAM Role for Service Account) capability parameter configuration
- kubernetes_
version_ strcreate - Kubernetes version of the cluster, in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version. (For creation)
- logging_
config ClusterLogging Config Args - Cluster log configuration information.
- monitoring_
config ClusterMonitoring Config Args - Monitoring configuration information.
- pods_
config ClusterPods Config Args - Pod network configuration.
- project_
name str - Project name to which the cluster belongs. A cluster can belong to only one project. Only English letters, numbers, underscores (_), periods (.), and hyphens (-) are allowed. Maximum length: 64 characters. Default: default.
- services_
config ClusterServices Config Args - Network configuration for the service.
- source_
region str - Cluster source region
-
Sequence[Cluster
Tag Args]
- name String
- Cluster name. Must be unique within the same region. Supports uppercase and lowercase English letters, Chinese characters, numbers, and hyphens (-). Length must be 2–64 characters.
- cluster
Config Property Map - Network configuration for the cluster control plane and some nodes.
- delete
Protection BooleanEnabled - Cluster deletion protection. Values: false (default): Deletion protection is disabled. true: Deletion protection is enabled; the cluster cannot be deleted directly.
- description String
- Cluster description. Maximum length is 300 characters.
- irsa
Config Property Map - IRSA (IAM Role for Service Account) capability parameter configuration
- kubernetes
Version StringCreate - Kubernetes version of the cluster, in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version. (For creation)
- logging
Config Property Map - Cluster log configuration information.
- monitoring
Config Property Map - Monitoring configuration information.
- pods
Config Property Map - Pod network configuration.
- project
Name String - Project name to which the cluster belongs. A cluster can belong to only one project. Only English letters, numbers, underscores (_), periods (.), and hyphens (-) are allowed. Maximum length: 64 characters. Default: default.
- services
Config Property Map - Network configuration for the service.
- source
Region String - Cluster source region
- List<Property Map>
Outputs
All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:
- Cluster
Id string - Cluster ID.
- Created
Time string - Cluster creation time. Standard RFC3339 format, UTC+0.
- Id string
- The provider-assigned unique ID for this managed resource.
- Kubernetes
Version string - Cluster Kubernetes version in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version (for query use)
- Message string
- Cluster status description.
- Node
Statistics Volcengine.Cluster Node Statistics - Statistics of node counts for each main status in the cluster.
- Status
Volcengine.
Cluster Status - Cluster status.
- Type string
- Cluster type.
- Updated
Time string - Last update time of the cluster. Standard RFC3339 format, UTC+0.
- Cluster
Id string - Cluster ID.
- Created
Time string - Cluster creation time. Standard RFC3339 format, UTC+0.
- Id string
- The provider-assigned unique ID for this managed resource.
- Kubernetes
Version string - Cluster Kubernetes version in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version (for query use)
- Message string
- Cluster status description.
- Node
Statistics ClusterNode Statistics - Statistics of node counts for each main status in the cluster.
- Status
Cluster
Status - Cluster status.
- Type string
- Cluster type.
- Updated
Time string - Last update time of the cluster. Standard RFC3339 format, UTC+0.
- cluster
Id String - Cluster ID.
- created
Time String - Cluster creation time. Standard RFC3339 format, UTC+0.
- id String
- The provider-assigned unique ID for this managed resource.
- kubernetes
Version String - Cluster Kubernetes version in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version (for query use)
- message String
- Cluster status description.
- node
Statistics ClusterNode Statistics - Statistics of node counts for each main status in the cluster.
- status
Cluster
Status - Cluster status.
- type String
- Cluster type.
- updated
Time String - Last update time of the cluster. Standard RFC3339 format, UTC+0.
- cluster
Id string - Cluster ID.
- created
Time string - Cluster creation time. Standard RFC3339 format, UTC+0.
- id string
- The provider-assigned unique ID for this managed resource.
- kubernetes
Version string - Cluster Kubernetes version in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version (for query use)
- message string
- Cluster status description.
- node
Statistics ClusterNode Statistics - Statistics of node counts for each main status in the cluster.
- status
Cluster
Status - Cluster status.
- type string
- Cluster type.
- updated
Time string - Last update time of the cluster. Standard RFC3339 format, UTC+0.
- cluster_
id str - Cluster ID.
- created_
time str - Cluster creation time. Standard RFC3339 format, UTC+0.
- id str
- The provider-assigned unique ID for this managed resource.
- kubernetes_
version str - Cluster Kubernetes version in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version (for query use)
- message str
- Cluster status description.
- node_
statistics ClusterNode Statistics - Statistics of node counts for each main status in the cluster.
- status
Cluster
Status - Cluster status.
- type str
- Cluster type.
- updated_
time str - Last update time of the cluster. Standard RFC3339 format, UTC+0.
- cluster
Id String - Cluster ID.
- created
Time String - Cluster creation time. Standard RFC3339 format, UTC+0.
- id String
- The provider-assigned unique ID for this managed resource.
- kubernetes
Version String - Cluster Kubernetes version in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version (for query use)
- message String
- Cluster status description.
- node
Statistics Property Map - Statistics of node counts for each main status in the cluster.
- status Property Map
- Cluster status.
- type String
- Cluster type.
- updated
Time String - Last update time of the cluster. Standard RFC3339 format, UTC+0.
Look up Existing Cluster Resource
Get an existing Cluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ClusterState, opts?: CustomResourceOptions): Cluster@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
cluster_config: Optional[ClusterClusterConfigArgs] = None,
cluster_id: Optional[str] = None,
created_time: Optional[str] = None,
delete_protection_enabled: Optional[bool] = None,
description: Optional[str] = None,
irsa_config: Optional[ClusterIrsaConfigArgs] = None,
kubernetes_version: Optional[str] = None,
kubernetes_version_create: Optional[str] = None,
logging_config: Optional[ClusterLoggingConfigArgs] = None,
message: Optional[str] = None,
monitoring_config: Optional[ClusterMonitoringConfigArgs] = None,
name: Optional[str] = None,
node_statistics: Optional[ClusterNodeStatisticsArgs] = None,
pods_config: Optional[ClusterPodsConfigArgs] = None,
project_name: Optional[str] = None,
services_config: Optional[ClusterServicesConfigArgs] = None,
source_region: Optional[str] = None,
status: Optional[ClusterStatusArgs] = None,
tags: Optional[Sequence[ClusterTagArgs]] = None,
type: Optional[str] = None,
updated_time: Optional[str] = None) -> Clusterfunc GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)public static Cluster get(String name, Output<String> id, ClusterState state, CustomResourceOptions options)resources: _: type: volcenginecc:vke:Cluster get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Cluster
Config Volcengine.Cluster Cluster Config - Network configuration for the cluster control plane and some nodes.
- Cluster
Id string - Cluster ID.
- Created
Time string - Cluster creation time. Standard RFC3339 format, UTC+0.
- Delete
Protection boolEnabled - Cluster deletion protection. Values: false (default): Deletion protection is disabled. true: Deletion protection is enabled; the cluster cannot be deleted directly.
- Description string
- Cluster description. Maximum length is 300 characters.
- Irsa
Config Volcengine.Cluster Irsa Config - IRSA (IAM Role for Service Account) capability parameter configuration
- Kubernetes
Version string - Cluster Kubernetes version in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version (for query use)
- Kubernetes
Version stringCreate - Kubernetes version of the cluster, in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version. (For creation)
- Logging
Config Volcengine.Cluster Logging Config - Cluster log configuration information.
- Message string
- Cluster status description.
- Monitoring
Config Volcengine.Cluster Monitoring Config - Monitoring configuration information.
- Name string
- Cluster name. Must be unique within the same region. Supports uppercase and lowercase English letters, Chinese characters, numbers, and hyphens (-). Length must be 2–64 characters.
- Node
Statistics Volcengine.Cluster Node Statistics - Statistics of node counts for each main status in the cluster.
- Pods
Config Volcengine.Cluster Pods Config - Pod network configuration.
- Project
Name string - Project name to which the cluster belongs. A cluster can belong to only one project. Only English letters, numbers, underscores (_), periods (.), and hyphens (-) are allowed. Maximum length: 64 characters. Default: default.
- Services
Config Volcengine.Cluster Services Config - Network configuration for the service.
- Source
Region string - Cluster source region
- Status
Volcengine.
Cluster Status - Cluster status.
-
List<Volcengine.
Cluster Tag> - Type string
- Cluster type.
- Updated
Time string - Last update time of the cluster. Standard RFC3339 format, UTC+0.
- Cluster
Config ClusterCluster Config Args - Network configuration for the cluster control plane and some nodes.
- Cluster
Id string - Cluster ID.
- Created
Time string - Cluster creation time. Standard RFC3339 format, UTC+0.
- Delete
Protection boolEnabled - Cluster deletion protection. Values: false (default): Deletion protection is disabled. true: Deletion protection is enabled; the cluster cannot be deleted directly.
- Description string
- Cluster description. Maximum length is 300 characters.
- Irsa
Config ClusterIrsa Config Args - IRSA (IAM Role for Service Account) capability parameter configuration
- Kubernetes
Version string - Cluster Kubernetes version in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version (for query use)
- Kubernetes
Version stringCreate - Kubernetes version of the cluster, in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version. (For creation)
- Logging
Config ClusterLogging Config Args - Cluster log configuration information.
- Message string
- Cluster status description.
- Monitoring
Config ClusterMonitoring Config Args - Monitoring configuration information.
- Name string
- Cluster name. Must be unique within the same region. Supports uppercase and lowercase English letters, Chinese characters, numbers, and hyphens (-). Length must be 2–64 characters.
- Node
Statistics ClusterNode Statistics Args - Statistics of node counts for each main status in the cluster.
- Pods
Config ClusterPods Config Args - Pod network configuration.
- Project
Name string - Project name to which the cluster belongs. A cluster can belong to only one project. Only English letters, numbers, underscores (_), periods (.), and hyphens (-) are allowed. Maximum length: 64 characters. Default: default.
- Services
Config ClusterServices Config Args - Network configuration for the service.
- Source
Region string - Cluster source region
- Status
Cluster
Status Args - Cluster status.
-
[]Cluster
Tag Args - Type string
- Cluster type.
- Updated
Time string - Last update time of the cluster. Standard RFC3339 format, UTC+0.
- cluster
Config ClusterCluster Config - Network configuration for the cluster control plane and some nodes.
- cluster
Id String - Cluster ID.
- created
Time String - Cluster creation time. Standard RFC3339 format, UTC+0.
- delete
Protection BooleanEnabled - Cluster deletion protection. Values: false (default): Deletion protection is disabled. true: Deletion protection is enabled; the cluster cannot be deleted directly.
- description String
- Cluster description. Maximum length is 300 characters.
- irsa
Config ClusterIrsa Config - IRSA (IAM Role for Service Account) capability parameter configuration
- kubernetes
Version String - Cluster Kubernetes version in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version (for query use)
- kubernetes
Version StringCreate - Kubernetes version of the cluster, in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version. (For creation)
- logging
Config ClusterLogging Config - Cluster log configuration information.
- message String
- Cluster status description.
- monitoring
Config ClusterMonitoring Config - Monitoring configuration information.
- name String
- Cluster name. Must be unique within the same region. Supports uppercase and lowercase English letters, Chinese characters, numbers, and hyphens (-). Length must be 2–64 characters.
- node
Statistics ClusterNode Statistics - Statistics of node counts for each main status in the cluster.
- pods
Config ClusterPods Config - Pod network configuration.
- project
Name String - Project name to which the cluster belongs. A cluster can belong to only one project. Only English letters, numbers, underscores (_), periods (.), and hyphens (-) are allowed. Maximum length: 64 characters. Default: default.
- services
Config ClusterServices Config - Network configuration for the service.
- source
Region String - Cluster source region
- status
Cluster
Status - Cluster status.
-
List<Cluster
Tag> - type String
- Cluster type.
- updated
Time String - Last update time of the cluster. Standard RFC3339 format, UTC+0.
- cluster
Config ClusterCluster Config - Network configuration for the cluster control plane and some nodes.
- cluster
Id string - Cluster ID.
- created
Time string - Cluster creation time. Standard RFC3339 format, UTC+0.
- delete
Protection booleanEnabled - Cluster deletion protection. Values: false (default): Deletion protection is disabled. true: Deletion protection is enabled; the cluster cannot be deleted directly.
- description string
- Cluster description. Maximum length is 300 characters.
- irsa
Config ClusterIrsa Config - IRSA (IAM Role for Service Account) capability parameter configuration
- kubernetes
Version string - Cluster Kubernetes version in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version (for query use)
- kubernetes
Version stringCreate - Kubernetes version of the cluster, in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version. (For creation)
- logging
Config ClusterLogging Config - Cluster log configuration information.
- message string
- Cluster status description.
- monitoring
Config ClusterMonitoring Config - Monitoring configuration information.
- name string
- Cluster name. Must be unique within the same region. Supports uppercase and lowercase English letters, Chinese characters, numbers, and hyphens (-). Length must be 2–64 characters.
- node
Statistics ClusterNode Statistics - Statistics of node counts for each main status in the cluster.
- pods
Config ClusterPods Config - Pod network configuration.
- project
Name string - Project name to which the cluster belongs. A cluster can belong to only one project. Only English letters, numbers, underscores (_), periods (.), and hyphens (-) are allowed. Maximum length: 64 characters. Default: default.
- services
Config ClusterServices Config - Network configuration for the service.
- source
Region string - Cluster source region
- status
Cluster
Status - Cluster status.
-
Cluster
Tag[] - type string
- Cluster type.
- updated
Time string - Last update time of the cluster. Standard RFC3339 format, UTC+0.
- cluster_
config ClusterCluster Config Args - Network configuration for the cluster control plane and some nodes.
- cluster_
id str - Cluster ID.
- created_
time str - Cluster creation time. Standard RFC3339 format, UTC+0.
- delete_
protection_ boolenabled - Cluster deletion protection. Values: false (default): Deletion protection is disabled. true: Deletion protection is enabled; the cluster cannot be deleted directly.
- description str
- Cluster description. Maximum length is 300 characters.
- irsa_
config ClusterIrsa Config Args - IRSA (IAM Role for Service Account) capability parameter configuration
- kubernetes_
version str - Cluster Kubernetes version in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version (for query use)
- kubernetes_
version_ strcreate - Kubernetes version of the cluster, in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version. (For creation)
- logging_
config ClusterLogging Config Args - Cluster log configuration information.
- message str
- Cluster status description.
- monitoring_
config ClusterMonitoring Config Args - Monitoring configuration information.
- name str
- Cluster name. Must be unique within the same region. Supports uppercase and lowercase English letters, Chinese characters, numbers, and hyphens (-). Length must be 2–64 characters.
- node_
statistics ClusterNode Statistics Args - Statistics of node counts for each main status in the cluster.
- pods_
config ClusterPods Config Args - Pod network configuration.
- project_
name str - Project name to which the cluster belongs. A cluster can belong to only one project. Only English letters, numbers, underscores (_), periods (.), and hyphens (-) are allowed. Maximum length: 64 characters. Default: default.
- services_
config ClusterServices Config Args - Network configuration for the service.
- source_
region str - Cluster source region
- status
Cluster
Status Args - Cluster status.
-
Sequence[Cluster
Tag Args] - type str
- Cluster type.
- updated_
time str - Last update time of the cluster. Standard RFC3339 format, UTC+0.
- cluster
Config Property Map - Network configuration for the cluster control plane and some nodes.
- cluster
Id String - Cluster ID.
- created
Time String - Cluster creation time. Standard RFC3339 format, UTC+0.
- delete
Protection BooleanEnabled - Cluster deletion protection. Values: false (default): Deletion protection is disabled. true: Deletion protection is enabled; the cluster cannot be deleted directly.
- description String
- Cluster description. Maximum length is 300 characters.
- irsa
Config Property Map - IRSA (IAM Role for Service Account) capability parameter configuration
- kubernetes
Version String - Cluster Kubernetes version in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version (for query use)
- kubernetes
Version StringCreate - Kubernetes version of the cluster, in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version. (For creation)
- logging
Config Property Map - Cluster log configuration information.
- message String
- Cluster status description.
- monitoring
Config Property Map - Monitoring configuration information.
- name String
- Cluster name. Must be unique within the same region. Supports uppercase and lowercase English letters, Chinese characters, numbers, and hyphens (-). Length must be 2–64 characters.
- node
Statistics Property Map - Statistics of node counts for each main status in the cluster.
- pods
Config Property Map - Pod network configuration.
- project
Name String - Project name to which the cluster belongs. A cluster can belong to only one project. Only English letters, numbers, underscores (_), periods (.), and hyphens (-) are allowed. Maximum length: 64 characters. Default: default.
- services
Config Property Map - Network configuration for the service.
- source
Region String - Cluster source region
- status Property Map
- Cluster status.
- List<Property Map>
- type String
- Cluster type.
- updated
Time String - Last update time of the cluster. Standard RFC3339 format, UTC+0.
Supporting Types
ClusterClusterConfig, ClusterClusterConfigArgs
- Api
Server Volcengine.Endpoints Cluster Cluster Config Api Server Endpoints - Cluster API Server access IPv4 address information
- Api
Server Volcengine.Public Access Config Cluster Cluster Config Api Server Public Access Config - Cluster API Server public access configuration. This parameter is returned only when ApiServerPublicAccessEnable=true
- Api
Server boolPublic Access Enabled - Node public access configuration. Parameter value description: false: Disabled. true: Enabled
- Ip
Family string - Cluster network protocol stack. Parameter value description: Ipv4: Ipv4 single stack. Ipv6: [Invitation test · Trial application] Ipv6 single stack. DualStack: [Invitation test · Trial application] Ipv4 and Ipv6 dual stack
- Resource
Public boolAccess Default Enabled - Node public access configuration. Parameter value description: false: Disabled. true: Enabled
- Security
Group List<string>Ids - Security group used by the cluster control plane and nodes.
- Subnet
Ids List<string> - Subnet ID for cluster control plane communication within the private network.
- Vpc
Id string - Private network (VPC) ID where the cluster control plane and some nodes are located.
- Api
Server ClusterEndpoints Cluster Config Api Server Endpoints - Cluster API Server access IPv4 address information
- Api
Server ClusterPublic Access Config Cluster Config Api Server Public Access Config - Cluster API Server public access configuration. This parameter is returned only when ApiServerPublicAccessEnable=true
- Api
Server boolPublic Access Enabled - Node public access configuration. Parameter value description: false: Disabled. true: Enabled
- Ip
Family string - Cluster network protocol stack. Parameter value description: Ipv4: Ipv4 single stack. Ipv6: [Invitation test · Trial application] Ipv6 single stack. DualStack: [Invitation test · Trial application] Ipv4 and Ipv6 dual stack
- Resource
Public boolAccess Default Enabled - Node public access configuration. Parameter value description: false: Disabled. true: Enabled
- Security
Group []stringIds - Security group used by the cluster control plane and nodes.
- Subnet
Ids []string - Subnet ID for cluster control plane communication within the private network.
- Vpc
Id string - Private network (VPC) ID where the cluster control plane and some nodes are located.
- api
Server ClusterEndpoints Cluster Config Api Server Endpoints - Cluster API Server access IPv4 address information
- api
Server ClusterPublic Access Config Cluster Config Api Server Public Access Config - Cluster API Server public access configuration. This parameter is returned only when ApiServerPublicAccessEnable=true
- api
Server BooleanPublic Access Enabled - Node public access configuration. Parameter value description: false: Disabled. true: Enabled
- ip
Family String - Cluster network protocol stack. Parameter value description: Ipv4: Ipv4 single stack. Ipv6: [Invitation test · Trial application] Ipv6 single stack. DualStack: [Invitation test · Trial application] Ipv4 and Ipv6 dual stack
- resource
Public BooleanAccess Default Enabled - Node public access configuration. Parameter value description: false: Disabled. true: Enabled
- security
Group List<String>Ids - Security group used by the cluster control plane and nodes.
- subnet
Ids List<String> - Subnet ID for cluster control plane communication within the private network.
- vpc
Id String - Private network (VPC) ID where the cluster control plane and some nodes are located.
- api
Server ClusterEndpoints Cluster Config Api Server Endpoints - Cluster API Server access IPv4 address information
- api
Server ClusterPublic Access Config Cluster Config Api Server Public Access Config - Cluster API Server public access configuration. This parameter is returned only when ApiServerPublicAccessEnable=true
- api
Server booleanPublic Access Enabled - Node public access configuration. Parameter value description: false: Disabled. true: Enabled
- ip
Family string - Cluster network protocol stack. Parameter value description: Ipv4: Ipv4 single stack. Ipv6: [Invitation test · Trial application] Ipv6 single stack. DualStack: [Invitation test · Trial application] Ipv4 and Ipv6 dual stack
- resource
Public booleanAccess Default Enabled - Node public access configuration. Parameter value description: false: Disabled. true: Enabled
- security
Group string[]Ids - Security group used by the cluster control plane and nodes.
- subnet
Ids string[] - Subnet ID for cluster control plane communication within the private network.
- vpc
Id string - Private network (VPC) ID where the cluster control plane and some nodes are located.
- api_
server_ Clusterendpoints Cluster Config Api Server Endpoints - Cluster API Server access IPv4 address information
- api_
server_ Clusterpublic_ access_ config Cluster Config Api Server Public Access Config - Cluster API Server public access configuration. This parameter is returned only when ApiServerPublicAccessEnable=true
- api_
server_ boolpublic_ access_ enabled - Node public access configuration. Parameter value description: false: Disabled. true: Enabled
- ip_
family str - Cluster network protocol stack. Parameter value description: Ipv4: Ipv4 single stack. Ipv6: [Invitation test · Trial application] Ipv6 single stack. DualStack: [Invitation test · Trial application] Ipv4 and Ipv6 dual stack
- resource_
public_ boolaccess_ default_ enabled - Node public access configuration. Parameter value description: false: Disabled. true: Enabled
- security_
group_ Sequence[str]ids - Security group used by the cluster control plane and nodes.
- subnet_
ids Sequence[str] - Subnet ID for cluster control plane communication within the private network.
- vpc_
id str - Private network (VPC) ID where the cluster control plane and some nodes are located.
- api
Server Property MapEndpoints - Cluster API Server access IPv4 address information
- api
Server Property MapPublic Access Config - Cluster API Server public access configuration. This parameter is returned only when ApiServerPublicAccessEnable=true
- api
Server BooleanPublic Access Enabled - Node public access configuration. Parameter value description: false: Disabled. true: Enabled
- ip
Family String - Cluster network protocol stack. Parameter value description: Ipv4: Ipv4 single stack. Ipv6: [Invitation test · Trial application] Ipv6 single stack. DualStack: [Invitation test · Trial application] Ipv4 and Ipv6 dual stack
- resource
Public BooleanAccess Default Enabled - Node public access configuration. Parameter value description: false: Disabled. true: Enabled
- security
Group List<String>Ids - Security group used by the cluster control plane and nodes.
- subnet
Ids List<String> - Subnet ID for cluster control plane communication within the private network.
- vpc
Id String - Private network (VPC) ID where the cluster control plane and some nodes are located.
ClusterClusterConfigApiServerEndpoints, ClusterClusterConfigApiServerEndpointsArgs
- Private
Ip Volcengine.Cluster Cluster Config Api Server Endpoints Private Ip - Cluster API Server private IPv4 address.
- Public
Ip Volcengine.Cluster Cluster Config Api Server Endpoints Public Ip - Cluster API Server public IPv4 address
- Private
Ip ClusterCluster Config Api Server Endpoints Private Ip - Cluster API Server private IPv4 address.
- Public
Ip ClusterCluster Config Api Server Endpoints Public Ip - Cluster API Server public IPv4 address
- private
Ip ClusterCluster Config Api Server Endpoints Private Ip - Cluster API Server private IPv4 address.
- public
Ip ClusterCluster Config Api Server Endpoints Public Ip - Cluster API Server public IPv4 address
- private
Ip ClusterCluster Config Api Server Endpoints Private Ip - Cluster API Server private IPv4 address.
- public
Ip ClusterCluster Config Api Server Endpoints Public Ip - Cluster API Server public IPv4 address
- private_
ip ClusterCluster Config Api Server Endpoints Private Ip - Cluster API Server private IPv4 address.
- public_
ip ClusterCluster Config Api Server Endpoints Public Ip - Cluster API Server public IPv4 address
- private
Ip Property Map - Cluster API Server private IPv4 address.
- public
Ip Property Map - Cluster API Server public IPv4 address
ClusterClusterConfigApiServerEndpointsPrivateIp, ClusterClusterConfigApiServerEndpointsPrivateIpArgs
- Ipv4 string
- IPv4 address of the private network IP.
- Ipv4 string
- IPv4 address of the private network IP.
- ipv4 String
- IPv4 address of the private network IP.
- ipv4 string
- IPv4 address of the private network IP.
- ipv4 str
- IPv4 address of the private network IP.
- ipv4 String
- IPv4 address of the private network IP.
ClusterClusterConfigApiServerEndpointsPublicIp, ClusterClusterConfigApiServerEndpointsPublicIpArgs
- Ipv4 string
- IPv4 address of the public IP.
- Ipv4 string
- IPv4 address of the public IP.
- ipv4 String
- IPv4 address of the public IP.
- ipv4 string
- IPv4 address of the public IP.
- ipv4 str
- IPv4 address of the public IP.
- ipv4 String
- IPv4 address of the public IP.
ClusterClusterConfigApiServerPublicAccessConfig, ClusterClusterConfigApiServerPublicAccessConfigArgs
- Public
Access Volcengine.Network Config Cluster Cluster Config Api Server Public Access Config Public Access Network Config - Public access network configuration. This parameter is returned only when ApiServerPublicAccessEnable=true
- Public
Access ClusterNetwork Config Cluster Config Api Server Public Access Config Public Access Network Config - Public access network configuration. This parameter is returned only when ApiServerPublicAccessEnable=true
- public
Access ClusterNetwork Config Cluster Config Api Server Public Access Config Public Access Network Config - Public access network configuration. This parameter is returned only when ApiServerPublicAccessEnable=true
- public
Access ClusterNetwork Config Cluster Config Api Server Public Access Config Public Access Network Config - Public access network configuration. This parameter is returned only when ApiServerPublicAccessEnable=true
- public_
access_ Clusternetwork_ config Cluster Config Api Server Public Access Config Public Access Network Config - Public access network configuration. This parameter is returned only when ApiServerPublicAccessEnable=true
- public
Access Property MapNetwork Config - Public access network configuration. This parameter is returned only when ApiServerPublicAccessEnable=true
ClusterClusterConfigApiServerPublicAccessConfigPublicAccessNetworkConfig, ClusterClusterConfigApiServerPublicAccessConfigPublicAccessNetworkConfigArgs
- Bandwidth int
- Peak bandwidth of the public IP, unit: Mbps
- Billing
Type int - Billing type for public IP: 2: Pay-as-you-go by bandwidth cap. 3: Pay-as-you-go by actual traffic.
- Isp string
- Line type of the public IP. Parameter value description: BGP: BGP (multi-line)
- Bandwidth int
- Peak bandwidth of the public IP, unit: Mbps
- Billing
Type int - Billing type for public IP: 2: Pay-as-you-go by bandwidth cap. 3: Pay-as-you-go by actual traffic.
- Isp string
- Line type of the public IP. Parameter value description: BGP: BGP (multi-line)
- bandwidth Integer
- Peak bandwidth of the public IP, unit: Mbps
- billing
Type Integer - Billing type for public IP: 2: Pay-as-you-go by bandwidth cap. 3: Pay-as-you-go by actual traffic.
- isp String
- Line type of the public IP. Parameter value description: BGP: BGP (multi-line)
- bandwidth number
- Peak bandwidth of the public IP, unit: Mbps
- billing
Type number - Billing type for public IP: 2: Pay-as-you-go by bandwidth cap. 3: Pay-as-you-go by actual traffic.
- isp string
- Line type of the public IP. Parameter value description: BGP: BGP (multi-line)
- bandwidth int
- Peak bandwidth of the public IP, unit: Mbps
- billing_
type int - Billing type for public IP: 2: Pay-as-you-go by bandwidth cap. 3: Pay-as-you-go by actual traffic.
- isp str
- Line type of the public IP. Parameter value description: BGP: BGP (multi-line)
- bandwidth Number
- Peak bandwidth of the public IP, unit: Mbps
- billing
Type Number - Billing type for public IP: 2: Pay-as-you-go by bandwidth cap. 3: Pay-as-you-go by actual traffic.
- isp String
- Line type of the public IP. Parameter value description: BGP: BGP (multi-line)
ClusterIrsaConfig, ClusterIrsaConfigArgs
- Audience string
- Identifier for accepting tokens
- Enabled bool
- Whether to enable IRSA feature. Parameter values: true: enabled; false: not enabled.
- Issuer string
- OIDC (OpenID Connect) provider URL, the unique identifier for the OIDC provider.
- Jwks
Url string - JWKS (JSON Web Key Set) URL. The public keys in the file are used to verify any JWT (JSON Web Tokens) returned from the OIDC provider.
- Oidc
Trn string - OIDC provider TRN.
- Open
Id stringConfig Url - OIDC provider configuration document in JSON format, containing information about the OIDC provider.
- Audience string
- Identifier for accepting tokens
- Enabled bool
- Whether to enable IRSA feature. Parameter values: true: enabled; false: not enabled.
- Issuer string
- OIDC (OpenID Connect) provider URL, the unique identifier for the OIDC provider.
- Jwks
Url string - JWKS (JSON Web Key Set) URL. The public keys in the file are used to verify any JWT (JSON Web Tokens) returned from the OIDC provider.
- Oidc
Trn string - OIDC provider TRN.
- Open
Id stringConfig Url - OIDC provider configuration document in JSON format, containing information about the OIDC provider.
- audience String
- Identifier for accepting tokens
- enabled Boolean
- Whether to enable IRSA feature. Parameter values: true: enabled; false: not enabled.
- issuer String
- OIDC (OpenID Connect) provider URL, the unique identifier for the OIDC provider.
- jwks
Url String - JWKS (JSON Web Key Set) URL. The public keys in the file are used to verify any JWT (JSON Web Tokens) returned from the OIDC provider.
- oidc
Trn String - OIDC provider TRN.
- open
Id StringConfig Url - OIDC provider configuration document in JSON format, containing information about the OIDC provider.
- audience string
- Identifier for accepting tokens
- enabled boolean
- Whether to enable IRSA feature. Parameter values: true: enabled; false: not enabled.
- issuer string
- OIDC (OpenID Connect) provider URL, the unique identifier for the OIDC provider.
- jwks
Url string - JWKS (JSON Web Key Set) URL. The public keys in the file are used to verify any JWT (JSON Web Tokens) returned from the OIDC provider.
- oidc
Trn string - OIDC provider TRN.
- open
Id stringConfig Url - OIDC provider configuration document in JSON format, containing information about the OIDC provider.
- audience str
- Identifier for accepting tokens
- enabled bool
- Whether to enable IRSA feature. Parameter values: true: enabled; false: not enabled.
- issuer str
- OIDC (OpenID Connect) provider URL, the unique identifier for the OIDC provider.
- jwks_
url str - JWKS (JSON Web Key Set) URL. The public keys in the file are used to verify any JWT (JSON Web Tokens) returned from the OIDC provider.
- oidc_
trn str - OIDC provider TRN.
- open_
id_ strconfig_ url - OIDC provider configuration document in JSON format, containing information about the OIDC provider.
- audience String
- Identifier for accepting tokens
- enabled Boolean
- Whether to enable IRSA feature. Parameter values: true: enabled; false: not enabled.
- issuer String
- OIDC (OpenID Connect) provider URL, the unique identifier for the OIDC provider.
- jwks
Url String - JWKS (JSON Web Key Set) URL. The public keys in the file are used to verify any JWT (JSON Web Tokens) returned from the OIDC provider.
- oidc
Trn String - OIDC provider TRN.
- open
Id StringConfig Url - OIDC provider configuration document in JSON format, containing information about the OIDC provider.
ClusterLoggingConfig, ClusterLoggingConfigArgs
- Log
Project stringId - Cluster log project (Log Project) ID. If empty, the cluster log project has not been created.
- Log
Setups List<Volcengine.Cluster Logging Config Log Setup>
- Log
Project stringId - Cluster log project (Log Project) ID. If empty, the cluster log project has not been created.
- Log
Setups []ClusterLogging Config Log Setup
- log
Project StringId - Cluster log project (Log Project) ID. If empty, the cluster log project has not been created.
- log
Setups List<ClusterLogging Config Log Setup>
- log
Project stringId - Cluster log project (Log Project) ID. If empty, the cluster log project has not been created.
- log
Setups ClusterLogging Config Log Setup[]
- log_
project_ strid - Cluster log project (Log Project) ID. If empty, the cluster log project has not been created.
- log_
setups Sequence[ClusterLogging Config Log Setup]
- log
Project StringId - Cluster log project (Log Project) ID. If empty, the cluster log project has not been created.
- log
Setups List<Property Map>
ClusterLoggingConfigLogSetup, ClusterLoggingConfigLogSetupArgs
- Enabled bool
- Whether to enable this log option. Parameter values: true: enabled; false: not enabled.
- Log
Ttl int - Retention period of logs in log service, in days. 3650 days means permanent storage.
- Log
Type string - Currently enabled log types. Parameter values: Audit: cluster audit log; KubeApiServer: kube-apiserver component log; KubeScheduler: kube-scheduler component log; KubeControllerManager: kube-controller-manager component log.
- Enabled bool
- Whether to enable this log option. Parameter values: true: enabled; false: not enabled.
- Log
Ttl int - Retention period of logs in log service, in days. 3650 days means permanent storage.
- Log
Type string - Currently enabled log types. Parameter values: Audit: cluster audit log; KubeApiServer: kube-apiserver component log; KubeScheduler: kube-scheduler component log; KubeControllerManager: kube-controller-manager component log.
- enabled Boolean
- Whether to enable this log option. Parameter values: true: enabled; false: not enabled.
- log
Ttl Integer - Retention period of logs in log service, in days. 3650 days means permanent storage.
- log
Type String - Currently enabled log types. Parameter values: Audit: cluster audit log; KubeApiServer: kube-apiserver component log; KubeScheduler: kube-scheduler component log; KubeControllerManager: kube-controller-manager component log.
- enabled boolean
- Whether to enable this log option. Parameter values: true: enabled; false: not enabled.
- log
Ttl number - Retention period of logs in log service, in days. 3650 days means permanent storage.
- log
Type string - Currently enabled log types. Parameter values: Audit: cluster audit log; KubeApiServer: kube-apiserver component log; KubeScheduler: kube-scheduler component log; KubeControllerManager: kube-controller-manager component log.
- enabled bool
- Whether to enable this log option. Parameter values: true: enabled; false: not enabled.
- log_
ttl int - Retention period of logs in log service, in days. 3650 days means permanent storage.
- log_
type str - Currently enabled log types. Parameter values: Audit: cluster audit log; KubeApiServer: kube-apiserver component log; KubeScheduler: kube-scheduler component log; KubeControllerManager: kube-controller-manager component log.
- enabled Boolean
- Whether to enable this log option. Parameter values: true: enabled; false: not enabled.
- log
Ttl Number - Retention period of logs in log service, in days. 3650 days means permanent storage.
- log
Type String - Currently enabled log types. Parameter values: Audit: cluster audit log; KubeApiServer: kube-apiserver component log; KubeScheduler: kube-scheduler component log; KubeControllerManager: kube-controller-manager component log.
ClusterMonitoringConfig, ClusterMonitoringConfigArgs
- Component
Configs List<Volcengine.Cluster Monitoring Config Component Config> - Enable
Metrics boolExternal Collection - Whether to enable external Prometheus to collect control plane component metrics for the cluster. Parameter values: true: enabled. false: not enabled.
- Workspace
Id string - Workspace ID to which the monitoring data belongs.
- Component
Configs []ClusterMonitoring Config Component Config - Enable
Metrics boolExternal Collection - Whether to enable external Prometheus to collect control plane component metrics for the cluster. Parameter values: true: enabled. false: not enabled.
- Workspace
Id string - Workspace ID to which the monitoring data belongs.
- component
Configs List<ClusterMonitoring Config Component Config> - enable
Metrics BooleanExternal Collection - Whether to enable external Prometheus to collect control plane component metrics for the cluster. Parameter values: true: enabled. false: not enabled.
- workspace
Id String - Workspace ID to which the monitoring data belongs.
- component
Configs ClusterMonitoring Config Component Config[] - enable
Metrics booleanExternal Collection - Whether to enable external Prometheus to collect control plane component metrics for the cluster. Parameter values: true: enabled. false: not enabled.
- workspace
Id string - Workspace ID to which the monitoring data belongs.
- component_
configs Sequence[ClusterMonitoring Config Component Config] - enable_
metrics_ boolexternal_ collection - Whether to enable external Prometheus to collect control plane component metrics for the cluster. Parameter values: true: enabled. false: not enabled.
- workspace_
id str - Workspace ID to which the monitoring data belongs.
- component
Configs List<Property Map> - enable
Metrics BooleanExternal Collection - Whether to enable external Prometheus to collect control plane component metrics for the cluster. Parameter values: true: enabled. false: not enabled.
- workspace
Id String - Workspace ID to which the monitoring data belongs.
ClusterMonitoringConfigComponentConfig, ClusterMonitoringConfigComponentConfigArgs
ClusterNodeStatistics, ClusterNodeStatisticsArgs
- Creating
Count int - Total number of nodes in Phase=Creating.
- Deleting
Count int - Total number of nodes with Phase=Deleting.
- Failed
Count int - Total number of nodes with Phase=Failed.
- Running
Count int - Total number of nodes with Phase=Running.
- Total
Count int - Total number of nodes.
- Updating
Count int - Total number of nodes in Phase=Updating.
- Creating
Count int - Total number of nodes in Phase=Creating.
- Deleting
Count int - Total number of nodes with Phase=Deleting.
- Failed
Count int - Total number of nodes with Phase=Failed.
- Running
Count int - Total number of nodes with Phase=Running.
- Total
Count int - Total number of nodes.
- Updating
Count int - Total number of nodes in Phase=Updating.
- creating
Count Integer - Total number of nodes in Phase=Creating.
- deleting
Count Integer - Total number of nodes with Phase=Deleting.
- failed
Count Integer - Total number of nodes with Phase=Failed.
- running
Count Integer - Total number of nodes with Phase=Running.
- total
Count Integer - Total number of nodes.
- updating
Count Integer - Total number of nodes in Phase=Updating.
- creating
Count number - Total number of nodes in Phase=Creating.
- deleting
Count number - Total number of nodes with Phase=Deleting.
- failed
Count number - Total number of nodes with Phase=Failed.
- running
Count number - Total number of nodes with Phase=Running.
- total
Count number - Total number of nodes.
- updating
Count number - Total number of nodes in Phase=Updating.
- creating_
count int - Total number of nodes in Phase=Creating.
- deleting_
count int - Total number of nodes with Phase=Deleting.
- failed_
count int - Total number of nodes with Phase=Failed.
- running_
count int - Total number of nodes with Phase=Running.
- total_
count int - Total number of nodes.
- updating_
count int - Total number of nodes in Phase=Updating.
- creating
Count Number - Total number of nodes in Phase=Creating.
- deleting
Count Number - Total number of nodes with Phase=Deleting.
- failed
Count Number - Total number of nodes with Phase=Failed.
- running
Count Number - Total number of nodes with Phase=Running.
- total
Count Number - Total number of nodes.
- updating
Count Number - Total number of nodes in Phase=Updating.
ClusterPodsConfig, ClusterPodsConfigArgs
- Flannel
Config Volcengine.Cluster Pods Config Flannel Config - Flannel network configuration.
- Pod
Network stringMode - Container (Pod) network model (CNI). Parameter values: Flannel: Flannel network model, an independent underlay container network model. VpcCniShared: VPC-CNI network model, an underlay container network model implemented with ENI (Elastic Network Interface) on a private network.
- Vpc
Cni Volcengine.Config Cluster Pods Config Vpc Cni Config - VPC-CNI network configuration.
- Flannel
Config ClusterPods Config Flannel Config - Flannel network configuration.
- Pod
Network stringMode - Container (Pod) network model (CNI). Parameter values: Flannel: Flannel network model, an independent underlay container network model. VpcCniShared: VPC-CNI network model, an underlay container network model implemented with ENI (Elastic Network Interface) on a private network.
- Vpc
Cni ClusterConfig Pods Config Vpc Cni Config - VPC-CNI network configuration.
- flannel
Config ClusterPods Config Flannel Config - Flannel network configuration.
- pod
Network StringMode - Container (Pod) network model (CNI). Parameter values: Flannel: Flannel network model, an independent underlay container network model. VpcCniShared: VPC-CNI network model, an underlay container network model implemented with ENI (Elastic Network Interface) on a private network.
- vpc
Cni ClusterConfig Pods Config Vpc Cni Config - VPC-CNI network configuration.
- flannel
Config ClusterPods Config Flannel Config - Flannel network configuration.
- pod
Network stringMode - Container (Pod) network model (CNI). Parameter values: Flannel: Flannel network model, an independent underlay container network model. VpcCniShared: VPC-CNI network model, an underlay container network model implemented with ENI (Elastic Network Interface) on a private network.
- vpc
Cni ClusterConfig Pods Config Vpc Cni Config - VPC-CNI network configuration.
- flannel_
config ClusterPods Config Flannel Config - Flannel network configuration.
- pod_
network_ strmode - Container (Pod) network model (CNI). Parameter values: Flannel: Flannel network model, an independent underlay container network model. VpcCniShared: VPC-CNI network model, an underlay container network model implemented with ENI (Elastic Network Interface) on a private network.
- vpc_
cni_ Clusterconfig Pods Config Vpc Cni Config - VPC-CNI network configuration.
- flannel
Config Property Map - Flannel network configuration.
- pod
Network StringMode - Container (Pod) network model (CNI). Parameter values: Flannel: Flannel network model, an independent underlay container network model. VpcCniShared: VPC-CNI network model, an underlay container network model implemented with ENI (Elastic Network Interface) on a private network.
- vpc
Cni Property MapConfig - VPC-CNI network configuration.
ClusterPodsConfigFlannelConfig, ClusterPodsConfigFlannelConfigArgs
- Max
Pods intPer Node - Maximum number of Pod instances per node for the Flannel container network model. Values: 64 (default), 16, 32, 128, 256.
- Pod
Cidrs List<string> - Pod CIDR for Flannel container network.
- Subnet
Ids List<string> - List of Pod subnet IDs for the Flannel container network model.
- Max
Pods intPer Node - Maximum number of Pod instances per node for the Flannel container network model. Values: 64 (default), 16, 32, 128, 256.
- Pod
Cidrs []string - Pod CIDR for Flannel container network.
- Subnet
Ids []string - List of Pod subnet IDs for the Flannel container network model.
- max
Pods IntegerPer Node - Maximum number of Pod instances per node for the Flannel container network model. Values: 64 (default), 16, 32, 128, 256.
- pod
Cidrs List<String> - Pod CIDR for Flannel container network.
- subnet
Ids List<String> - List of Pod subnet IDs for the Flannel container network model.
- max
Pods numberPer Node - Maximum number of Pod instances per node for the Flannel container network model. Values: 64 (default), 16, 32, 128, 256.
- pod
Cidrs string[] - Pod CIDR for Flannel container network.
- subnet
Ids string[] - List of Pod subnet IDs for the Flannel container network model.
- max_
pods_ intper_ node - Maximum number of Pod instances per node for the Flannel container network model. Values: 64 (default), 16, 32, 128, 256.
- pod_
cidrs Sequence[str] - Pod CIDR for Flannel container network.
- subnet_
ids Sequence[str] - List of Pod subnet IDs for the Flannel container network model.
- max
Pods NumberPer Node - Maximum number of Pod instances per node for the Flannel container network model. Values: 64 (default), 16, 32, 128, 256.
- pod
Cidrs List<String> - Pod CIDR for Flannel container network.
- subnet
Ids List<String> - List of Pod subnet IDs for the Flannel container network model.
ClusterPodsConfigVpcCniConfig, ClusterPodsConfigVpcCniConfigArgs
- Subnet
Ids List<string> - List of Pod subnet IDs for the VPC-CNI container network model.
- Trunk
Eni boolEnabled - Whether to enable Trunk mode for the VPC-CNI container network model
- Subnet
Ids []string - List of Pod subnet IDs for the VPC-CNI container network model.
- Trunk
Eni boolEnabled - Whether to enable Trunk mode for the VPC-CNI container network model
- subnet
Ids List<String> - List of Pod subnet IDs for the VPC-CNI container network model.
- trunk
Eni BooleanEnabled - Whether to enable Trunk mode for the VPC-CNI container network model
- subnet
Ids string[] - List of Pod subnet IDs for the VPC-CNI container network model.
- trunk
Eni booleanEnabled - Whether to enable Trunk mode for the VPC-CNI container network model
- subnet_
ids Sequence[str] - List of Pod subnet IDs for the VPC-CNI container network model.
- trunk_
eni_ boolenabled - Whether to enable Trunk mode for the VPC-CNI container network model
- subnet
Ids List<String> - List of Pod subnet IDs for the VPC-CNI container network model.
- trunk
Eni BooleanEnabled - Whether to enable Trunk mode for the VPC-CNI container network model
ClusterServicesConfig, ClusterServicesConfigArgs
- Service
Cidrsv4s List<string> - IPv4 private network address exposed by Kubernetes Service.
- Service
Cidrsv4s []string - IPv4 private network address exposed by Kubernetes Service.
- service
Cidrsv4s List<String> - IPv4 private network address exposed by Kubernetes Service.
- service
Cidrsv4s string[] - IPv4 private network address exposed by Kubernetes Service.
- service_
cidrsv4s Sequence[str] - IPv4 private network address exposed by Kubernetes Service.
- service
Cidrsv4s List<String> - IPv4 private network address exposed by Kubernetes Service.
ClusterStatus, ClusterStatusArgs
- Conditions
List<Volcengine.
Cluster Status Condition> - Phase string
- Cluster status phase.
- Conditions
[]Cluster
Status Condition - Phase string
- Cluster status phase.
- conditions
List<Cluster
Status Condition> - phase String
- Cluster status phase.
- conditions
Cluster
Status Condition[] - phase string
- Cluster status phase.
- conditions
Sequence[Cluster
Status Condition] - phase str
- Cluster status phase.
- conditions List<Property Map>
- phase String
- Cluster status phase.
ClusterStatusCondition, ClusterStatusConditionArgs
- Type string
- Condition type
- Type string
- Condition type
- type String
- Condition type
- type string
- Condition type
- type str
- Condition type
- type String
- Condition type
ClusterTag, ClusterTagArgs
Import
$ pulumi import volcenginecc:vke/cluster:Cluster example "cluster_id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- volcenginecc volcengine/pulumi-volcenginecc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
volcengineccTerraform Provider.
published on Thursday, Apr 23, 2026 by Volcengine
