Interface CfnClusterProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnClusterProps.Jsii$Proxy
CfnCluster
.
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.eks.*; CfnClusterProps cfnClusterProps = CfnClusterProps.builder() .resourcesVpcConfig(ResourcesVpcConfigProperty.builder() .subnetIds(List.of("subnetIds")) // the properties below are optional .endpointPrivateAccess(false) .endpointPublicAccess(false) .publicAccessCidrs(List.of("publicAccessCidrs")) .securityGroupIds(List.of("securityGroupIds")) .build()) .roleArn("roleArn") // the properties below are optional .accessConfig(AccessConfigProperty.builder() .authenticationMode("authenticationMode") .bootstrapClusterCreatorAdminPermissions(false) .build()) .bootstrapSelfManagedAddons(false) .encryptionConfig(List.of(EncryptionConfigProperty.builder() .provider(ProviderProperty.builder() .keyArn("keyArn") .build()) .resources(List.of("resources")) .build())) .kubernetesNetworkConfig(KubernetesNetworkConfigProperty.builder() .ipFamily("ipFamily") .serviceIpv4Cidr("serviceIpv4Cidr") .serviceIpv6Cidr("serviceIpv6Cidr") .build()) .logging(LoggingProperty.builder() .clusterLogging(ClusterLoggingProperty.builder() .enabledTypes(List.of(LoggingTypeConfigProperty.builder() .type("type") .build())) .build()) .build()) .name("name") .outpostConfig(OutpostConfigProperty.builder() .controlPlaneInstanceType("controlPlaneInstanceType") .outpostArns(List.of("outpostArns")) // the properties below are optional .controlPlanePlacement(ControlPlanePlacementProperty.builder() .groupName("groupName") .build()) .build()) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .upgradePolicy(UpgradePolicyProperty.builder() .supportType("supportType") .build()) .version("version") .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnClusterProps
static final class
An implementation forCfnClusterProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnClusterProps.Builder
builder()
default Object
The access configuration for the cluster.default Object
If you set this value toFalse
when creating a cluster, the default networking add-ons will not be installed.default Object
The encryption configuration for the cluster.default Object
The Kubernetes network configuration for the cluster.default Object
The logging configuration for your cluster.default String
getName()
The unique name to give to your cluster.default Object
An object representing the configuration of your local Amazon EKS cluster on an AWS Outpost.The VPC configuration that's used by the cluster control plane.The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.getTags()
The metadata that you apply to the cluster to assist with categorization and organization.default Object
This value indicates if extended support is enabled or disabled for the cluster.default String
The desired Kubernetes version for your cluster.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getResourcesVpcConfig
The VPC configuration that's used by the cluster control plane.Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide . You must specify at least two subnets. You can specify up to five security groups, but we recommend that you use a dedicated security group for your cluster control plane.
- See Also:
-
getRoleArn
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.For more information, see Amazon EKS Service IAM Role in the Amazon EKS User Guide .
- See Also:
-
getAccessConfig
The access configuration for the cluster.- See Also:
-
getBootstrapSelfManagedAddons
If you set this value toFalse
when creating a cluster, the default networking add-ons will not be installed.The default networking addons include vpc-cni, coredns, and kube-proxy.
Use this option when you plan to install third-party alternative add-ons or self-manage the default networking add-ons.
- See Also:
-
getEncryptionConfig
The encryption configuration for the cluster.- See Also:
-
getKubernetesNetworkConfig
The Kubernetes network configuration for the cluster.- See Also:
-
getLogging
The logging configuration for your cluster.- See Also:
-
getName
The unique name to give to your cluster.- See Also:
-
getOutpostConfig
An object representing the configuration of your local Amazon EKS cluster on an AWS Outpost.This object isn't available for clusters on the AWS cloud.
- See Also:
-
getTags
The metadata that you apply to the cluster to assist with categorization and organization.Each tag consists of a key and an optional value, both of which you define. Cluster tags don't propagate to any other resources associated with the cluster.
You must have the
eks:TagResource
andeks:UntagResource
permissions for your IAM principal to manage the AWS CloudFormation stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update.- See Also:
-
getUpgradePolicy
This value indicates if extended support is enabled or disabled for the cluster.Learn more about EKS Extended Support in the EKS User Guide.
- See Also:
-
getVersion
The desired Kubernetes version for your cluster.If you don't specify a value here, the default version available in Amazon EKS is used.
The default version might not be the latest version available.
- See Also:
-
builder
- Returns:
- a
CfnClusterProps.Builder
ofCfnClusterProps
-