Interface CommonClusterOptions
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Subinterfaces:
ClusterOptions
,ClusterProps
,FargateClusterProps
- All Known Implementing Classes:
ClusterOptions.Jsii$Proxy
,ClusterProps.Jsii$Proxy
,CommonClusterOptions.Jsii$Proxy
,FargateClusterProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-12-11T23:26:33.175Z")
@Stability(Stable)
public interface CommonClusterOptions
extends software.amazon.jsii.JsiiSerializable
Options for configuring an EKS cluster.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.ec2.*; import software.amazon.awscdk.services.eks.*; import software.amazon.awscdk.services.iam.*; KubernetesVersion kubernetesVersion; Role role; SecurityGroup securityGroup; Subnet subnet; SubnetFilter subnetFilter; Vpc vpc; CommonClusterOptions commonClusterOptions = CommonClusterOptions.builder() .version(kubernetesVersion) // the properties below are optional .clusterName("clusterName") .outputClusterName(false) .outputConfigCommand(false) .role(role) .securityGroup(securityGroup) .vpc(vpc) .vpcSubnets(List.of(SubnetSelection.builder() .availabilityZones(List.of("availabilityZones")) .onePerAz(false) .subnetFilters(List.of(subnetFilter)) .subnetGroupName("subnetGroupName") .subnets(List.of(subnet)) .subnetType(SubnetType.PRIVATE_ISOLATED) .build())) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCommonClusterOptions
static final class
An implementation forCommonClusterOptions
-
Method Summary
Modifier and TypeMethodDescriptionstatic CommonClusterOptions.Builder
builder()
default String
Name for the cluster.default Boolean
Determines whether a CloudFormation output with the name of the cluster will be synthesized.default Boolean
Determines whether a CloudFormation output with theaws eks update-kubeconfig
command will be synthesized.default IRole
getRole()
Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.default ISecurityGroup
Security Group to use for Control Plane ENIs.The Kubernetes version to run in the cluster.default IVpc
getVpc()
The VPC in which to create the Cluster.default List<SubnetSelection>
Where to place EKS Control Plane ENIs.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getVersion
The Kubernetes version to run in the cluster. -
getClusterName
Name for the cluster.Default: - Automatically generated name
-
getOutputClusterName
Determines whether a CloudFormation output with the name of the cluster will be synthesized.Default: false
-
getOutputConfigCommand
Determines whether a CloudFormation output with theaws 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
-
getRole
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
-
getSecurityGroup
Security Group to use for Control Plane ENIs.Default: - A security group is automatically created
-
getVpc
The VPC in which to create the Cluster.Default: - a VPC with default configuration will be created and can be accessed through `cluster.vpc`.
-
getVpcSubnets
Where to place EKS Control Plane ENIs.For example, to only select private subnets, supply the following:
vpcSubnets: [{ subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS }]
Default: - All public and private subnets
-
builder
- Returns:
- a
CommonClusterOptions.Builder
ofCommonClusterOptions
-