CommonClusterOptions

class aws_cdk.aws_eks.CommonClusterOptions(*, version, cluster_name=None, output_cluster_name=None, output_config_command=None, role=None, security_group=None, vpc=None, vpc_subnets=None)

Bases: object

(experimental) Options for configuring an EKS cluster.

Parameters
  • version (KubernetesVersion) – (experimental) The Kubernetes version to run in the cluster.

  • cluster_name (Optional[str]) – (experimental) Name for the cluster. Default: - Automatically generated name

  • output_cluster_name (Optional[bool]) – (experimental) Determines whether a CloudFormation output with the name of the cluster will be synthesized. Default: false

  • output_config_command (Optional[bool]) – (experimental) Determines whether a CloudFormation output with the aws eks update-kubeconfig command will be synthesized. This command will include the cluster name and, if applicable, the ARN of the masters IAM role. Default: true

  • role (Optional[IRole]) – (experimental) Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. Default: - A role is automatically created for you

  • security_group (Optional[ISecurityGroup]) – (experimental) Security Group to use for Control Plane ENIs. Default: - A security group is automatically created

  • vpc (Optional[IVpc]) – (experimental) The VPC in which to create the Cluster. Default: - a VPC with default configuration will be created and can be accessed through cluster.vpc.

  • vpc_subnets (Optional[List[SubnetSelection]]) – (experimental) Where to place EKS Control Plane ENIs. If you want to create public load balancers, this must include public subnets. For example, to only select private subnets, supply the following:: vpcSubnets: [ { subnetType: ec2.SubnetType.Private } ] Default: - All public and private subnets

Stability

experimental

Attributes

cluster_name

(experimental) Name for the cluster.

Default
  • Automatically generated name

Stability

experimental

Return type

Optional[str]

output_cluster_name

(experimental) Determines whether a CloudFormation output with the name of the cluster will be synthesized.

Default

false

Stability

experimental

Return type

Optional[bool]

output_config_command

(experimental) Determines whether a CloudFormation output with the aws eks update-kubeconfig command will be synthesized.

This command will include the cluster name and, if applicable, the ARN of the masters IAM role.

Default

true

Stability

experimental

Return type

Optional[bool]

role

(experimental) Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

Default
  • A role is automatically created for you

Stability

experimental

Return type

Optional[IRole]

security_group

(experimental) Security Group to use for Control Plane ENIs.

Default
  • A security group is automatically created

Stability

experimental

Return type

Optional[ISecurityGroup]

version

(experimental) The Kubernetes version to run in the cluster.

Stability

experimental

Return type

KubernetesVersion

vpc

(experimental) The VPC in which to create the Cluster.

Default
  • a VPC with default configuration will be created and can be accessed through cluster.vpc.

Stability

experimental

Return type

Optional[IVpc]

vpc_subnets

(experimental) Where to place EKS Control Plane ENIs.

If you want to create public load balancers, this must include public subnets.

For example, to only select private subnets, supply the following:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
vpcSubnets: [
   { subnetType: ec2.SubnetType.Private }
]
Default
  • All public and private subnets

Stability

experimental

Return type

Optional[List[SubnetSelection]]