ManagedEdgeKubernetesCluster
- Implements: IManagedEdgeKubernetesCluster
This class encapsulates and extends the ROS resource type ALIYUN::CS::ManagedEdgeKubernetesClusterUse , which to create an ACK managed edge Kubernetes cluster.
Initializers
import ros_cdk_cs
ros_cdk_cs.ManagedEdgeKubernetesCluster(
scope: Construct,
id: str,
name: typing.Union[str, IResolvable],
addons: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, AddonsProperty]]] = None,
cloud_monitor_flags: typing.Union[bool, IResolvable] = None,
cluster_spec: typing.Union[str, IResolvable] = None,
container_cidr: typing.Union[str, IResolvable] = None,
deletion_protection: typing.Union[bool, IResolvable] = None,
encryption_provider_key: typing.Union[str, IResolvable] = None,
endpoint_public_access: typing.Union[bool, IResolvable] = None,
ip_stack: typing.Union[str, IResolvable] = None,
is_enterprise_security_group: typing.Union[bool, IResolvable] = None,
key_pair: typing.Union[str, IResolvable] = None,
kubernetes_version: typing.Union[str, IResolvable] = None,
login_password: typing.Union[str, IResolvable] = None,
maintenance_window: typing.Union[IResolvable, MaintenanceWindowProperty] = None,
node_cidr_mask: typing.Union[str, IResolvable] = None,
node_pools: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, NodePoolsProperty]]] = None,
profile: typing.Union[str, IResolvable] = None,
proxy_mode: typing.Union[str, IResolvable] = None,
resource_group_id: typing.Union[str, IResolvable] = None,
rrsa_config: typing.Union[IResolvable, RrsaConfigProperty] = None,
service_cidr: typing.Union[str, IResolvable] = None,
snat_entry: typing.Union[bool, IResolvable] = None,
tags: typing.List[TagsProperty] = None,
timeout_mins: typing.Union[typing.Union[int, float], IResolvable] = None,
vpc_id: typing.Union[str, IResolvable] = None,
v_switch_ids: typing.Union[typing.List[typing.Any], IResolvable] = None,
zone_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
enable_resource_property_constraint: bool = None
)
| Name | Type | Description |
|---|---|---|
scope | ros_cdk_core.Construct | No description. |
id | str | No description. |
name | typing.Union[str, ros_cdk_core.IResolvable] | Property name: The name of the cluster. |
addons | typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, AddonsProperty]]] | Property addons: The add-ons to be installed for the cluster. |
cloud_monitor_flags | typing.Union[bool, ros_cdk_core.IResolvable] | Property cloudMonitorFlags: Whether to install the cloud monitoring plugin: true: indicates installation false: Do not install Default to false. |
cluster_spec | typing.Union[str, ros_cdk_core.IResolvable] | Property clusterSpec: The edge managed cluster spec. |
container_cidr | typing.Union[str, ros_cdk_core.IResolvable] | Property containerCidr: The container network segment cannot conflict with the VPC network segment. |
deletion_protection | typing.Union[bool, ros_cdk_core.IResolvable] | Property deletionProtection: Specifies whether to enable deletion protection for the cluster. |
encryption_provider_key | typing.Union[str, ros_cdk_core.IResolvable] | Property encryptionProviderKey: The ID of the key that is managed by Key Management Service (KMS). |
endpoint_public_access | typing.Union[bool, ros_cdk_core.IResolvable] | Property endpointPublicAccess: Whether to enable the public network API Server: true: which means that the public network API Server is open. |
ip_stack | typing.Union[str, ros_cdk_core.IResolvable] | Property ipStack: The IP stack of the cluster. |
is_enterprise_security_group | typing.Union[bool, ros_cdk_core.IResolvable] | Property isEnterpriseSecurityGroup: Specifies whether to create an advanced security group. |
key_pair | typing.Union[str, ros_cdk_core.IResolvable] | Property keyPair: Key pair name. |
kubernetes_version | typing.Union[str, ros_cdk_core.IResolvable] | Property kubernetesVersion: The version of the Kubernetes cluster. |
login_password | typing.Union[str, ros_cdk_core.IResolvable] | Property loginPassword: SSH login password. |
maintenance_window | typing.Union[ros_cdk_core.IResolvable, MaintenanceWindowProperty] | Property maintenanceWindow: Cluster maintenance window. |
node_cidr_mask | typing.Union[str, ros_cdk_core.IResolvable] | Property nodeCidrMask: The maximum number of IP addresses that can be assigned to nodes. |
node_pools | typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, NodePoolsProperty]]] | Property nodePools: The configurations of Node pools. |
profile | typing.Union[str, ros_cdk_core.IResolvable] | Property profile: Edge cluster ID. |
proxy_mode | typing.Union[str, ros_cdk_core.IResolvable] | Property proxyMode: kube-proxy proxy mode, supports both iptables and ipvs modes. |
resource_group_id | typing.Union[str, ros_cdk_core.IResolvable] | Property resourceGroupId: The ID of resource group. |
rrsa_config | typing.Union[ros_cdk_core.IResolvable, RrsaConfigProperty] | Property rrsaConfig: The configuration of RRSA. |
service_cidr | typing.Union[str, ros_cdk_core.IResolvable] | Property serviceCidr: The service network segment cannot conflict with the VPC network segment and the container network segment. |
snat_entry | typing.Union[bool, ros_cdk_core.IResolvable] | Property snatEntry: Whether to configure SNAT for the network. |
tags | typing.List[TagsProperty] | Property tags: Tag the cluster. |
timeout_mins | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property timeoutMins: Cluster resource stack creation timeout, in minutes. |
vpc_id | typing.Union[str, ros_cdk_core.IResolvable] | Property vpcId: VPC ID. |
v_switch_ids | typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable] | Property vSwitchIds: The virtual switch ID of the worker node. |
zone_ids | typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] | Property zoneIds: Zone ids of worker node virtual switches belongs to. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
nameRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property name: The name of the cluster.
The cluster name can use uppercase and lowercase letters, Chinese characters, numbers, and dashes.
addonsOptional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, AddonsProperty]]]
Property addons: The add-ons to be installed for the cluster.
cloud_monitor_flagsOptional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property cloudMonitorFlags: Whether to install the cloud monitoring plugin: true: indicates installation false: Do not install Default to false.
cluster_specOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property clusterSpec: The edge managed cluster spec.
Value: ack.pro.small: Professional hosting cluster, namely: "ACK Pro version cluster". ack.standard: Standard hosting cluster. Default value: ack.standard. The value can be empty. When it is empty, a standard managed cluster will be created.
container_cidrOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property containerCidr: The container network segment cannot conflict with the VPC network segment.
When the system is selected to automatically create a VPC, the network segment 172.16.0.0/16 is used by default.
deletion_protectionOptional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property deletionProtection: Specifies whether to enable deletion protection for the cluster.
After deletion protection is enabled, the cluster cannot be deleted in the ACK console or by calling API operations. Valid values:true: enables deletion protection for the cluster. false: disables deletion protection for the cluster. Default value: false.
encryption_provider_keyOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property encryptionProviderKey: The ID of the key that is managed by Key Management Service (KMS).
This key is used to encrypt data disks.You can use KMS in only professional managed Kubernetes clusters.
endpoint_public_accessOptional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property endpointPublicAccess: Whether to enable the public network API Server: true: which means that the public network API Server is open.
false: If set to false, the API server on the public network will not be created, only the API server on the private network will be created.Default to true.
ip_stackOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property ipStack: The IP stack of the cluster.
Value: ipv4 (Single stack) or ipv6 (Dual Stack). Default value: ipv4
is_enterprise_security_groupOptional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property isEnterpriseSecurityGroup: Specifies whether to create an advanced security group.
This parameter takes effect only if security_group_id is left empty. Note You must specify an advanced security group for a cluster that has Terway installed. true: creates an advanced security group. false: does not create an advanced security group. Default value: false.
key_pairOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property keyPair: Key pair name.
Specify one of KeyPair or LoginPassword.
kubernetes_versionOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property kubernetesVersion: The version of the Kubernetes cluster.
login_passwordOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property loginPassword: SSH login password.
Password rules are 8-30 characters and contain three items (upper and lower case letters, numbers, and special symbols). Specify one of KeyPair or LoginPassword.
maintenance_windowOptional
- Type: typing.Union[ros_cdk_core.IResolvable, MaintenanceWindowProperty]
Property maintenanceWindow: Cluster maintenance window.
node_cidr_maskOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property nodeCidrMask: The maximum number of IP addresses that can be assigned to nodes.
This number is determined by the specified pod CIDR block. This parameter takes effect only if the cluster uses the Flannel plug-in.Default value: 25.
node_poolsOptional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, NodePoolsProperty]]]
Property nodePools: The configurations of Node pools.
profileOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property profile: Edge cluster ID.
The default value is Edge.
proxy_modeOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property proxyMode: kube-proxy proxy mode, supports both iptables and ipvs modes.
The default is iptables.
resource_group_idOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property resourceGroupId: The ID of resource group.
rrsa_configOptional
- Type: typing.Union[ros_cdk_core.IResolvable, RrsaConfigProperty]
Property rrsaConfig: The configuration of RRSA.
service_cidrOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property serviceCidr: The service network segment cannot conflict with the VPC network segment and the container network segment.
When the system is selected to automatically create a VPC, the network segment 172.19.0.0/20 is used by default.
snat_entryOptional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property snatEntry: Whether to configure SNAT for the network.
When a VPC can access the public network environment, set it to false. When an existing VPC cannot access the public network environment: When set to True, SNAT is configured and the public network environment can be accessed at this time. If set to false, it means that SNAT is not configured and the public network environment cannot be accessed at this time. Default to true.
tagsOptional
- Type: typing.List[TagsProperty]
Property tags: Tag the cluster.
timeout_minsOptional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property timeoutMins: Cluster resource stack creation timeout, in minutes.
The default value is 60.
vpc_idOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property vpcId: VPC ID.
If not set, the system will automatically create a VPC, and the VPC network segment created by the system is 192.168.0.0/16. VpcId and VSwitchId can only be empty at the same time or set the corresponding values at the same time.
v_switch_idsOptional
- Type: typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable]
Property vSwitchIds: The virtual switch ID of the worker node.
zone_idsOptional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]
Property zoneIds: Zone ids of worker node virtual switches belongs to.
enable_resource_property_constraintOptional
- Type: bool
Methods
| Name | Description |
|---|---|
to_string | Returns a string representation of this construct. |
synthesize | Allows this construct to emit artifacts into the cloud assembly during synthesis. |
add_condition | No description. |
add_count | No description. |
add_dependency | No description. |
add_resource_desc | No description. |
apply_removal_policy | No description. |
fetch_condition | No description. |
fetch_dependency | No description. |
fetch_resource_desc | No description. |
get_att | No description. |
set_metadata | No description. |
to_string
def to_string() -> str
Returns a string representation of this construct.
synthesize
def synthesize(
session: ISynthesisSession
) -> None
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- Type: ros_cdk_core.RemovalPolicy
fetch_condition
def fetch_condition() -> RosCondition
fetch_dependency
def fetch_dependency() -> typing.List[str]
fetch_resource_desc
def fetch_resource_desc() -> str
get_att
def get_att(
name: str
) -> IResolvable
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
| Name | Description |
|---|---|
is_construct | Return whether the given object is a Construct. |
is_construct
import ros_cdk_cs
ros_cdk_cs.ManagedEdgeKubernetesCluster.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- Type: typing.Any
Properties
| Name | Type | Description |
|---|---|---|
node | ros_cdk_core.ConstructNode | The construct tree node associated with this construct. |
env | ros_cdk_core.IResourceEnvironment | The environment this resource belongs to. |
ref | str | No description. |
stack | ros_cdk_core.Stack | The stack in which this resource is defined. |
resource | ros_cdk_core.RosResource | No description. |
attr_api_server_slb_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute APIServerSLBId: The id of API server SLB. |
attr_cluster_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ClusterId: Cluster instance ID. |
attr_default_user_kube_config | typing.Union[str, ros_cdk_core.IResolvable] | Attribute DefaultUserKubeConfig: Default user kubernetes config which is used for configuring cluster credentials. |
attr_ingress_slb_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute IngressSLBId: The id of ingress SLB. |
attr_nodes | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Nodes: The list of cluster nodes. |
attr_private_user_kub_config | typing.Union[str, ros_cdk_core.IResolvable] | Attribute PrivateUserKubConfig: Private user kubernetes config which is used for configuring cluster credentials. |
attr_scaling_configuration_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ScalingConfigurationId: Scaling configuration id. |
attr_scaling_group_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ScalingGroupId: Scaling group id. |
attr_scaling_rule_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ScalingRuleId: Scaling rule id. |
attr_task_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute TaskId: Task ID. |
attr_worker_ram_role_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute WorkerRamRoleName: Worker ram role name. |
props | ManagedEdgeKubernetesClusterProps | No description. |
nodeRequired
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
envRequired
env: IResourceEnvironment
- Type: ros_cdk_core.IResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
refRequired
ref: str
- Type: str
stackRequired
stack: Stack
- Type: ros_cdk_core.Stack
The stack in which this resource is defined.
resourceOptional
resource: RosResource
- Type: ros_cdk_core.RosResource
attr_api_server_slb_idRequired
attr_api_server_slb_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute APIServerSLBId: The id of API server SLB.
attr_cluster_idRequired
attr_cluster_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ClusterId: Cluster instance ID.
attr_default_user_kube_configRequired
attr_default_user_kube_config: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute DefaultUserKubeConfig: Default user kubernetes config which is used for configuring cluster credentials.
attr_ingress_slb_idRequired
attr_ingress_slb_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute IngressSLBId: The id of ingress SLB.
attr_nodesRequired
attr_nodes: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Nodes: The list of cluster nodes.
attr_private_user_kub_configRequired
attr_private_user_kub_config: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute PrivateUserKubConfig: Private user kubernetes config which is used for configuring cluster credentials.
attr_scaling_configuration_idRequired
attr_scaling_configuration_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ScalingConfigurationId: Scaling configuration id.
attr_scaling_group_idRequired
attr_scaling_group_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ScalingGroupId: Scaling group id.
attr_scaling_rule_idRequired
attr_scaling_rule_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ScalingRuleId: Scaling rule id.
attr_task_idRequired
attr_task_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute TaskId: Task ID.
Automatically assigned by the system, the user queries the task status.
attr_worker_ram_role_nameRequired
attr_worker_ram_role_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute WorkerRamRoleName: Worker ram role name.
propsRequired
props: ManagedEdgeKubernetesClusterProps