software.amazon.awscdk.services.eks

Interface CfnClusterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:46.642Z")
 @Stability(value=Stable)
public interface CfnClusterProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `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
         .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()))
         .version("version")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnClusterProps.Builder A builder for CfnClusterProps
static class	CfnClusterProps.Jsii$Proxy An implementation for CfnClusterProps

Method Summary

Modifier and Type	Method and Description
static CfnClusterProps.Builder	builder()
default Object	getEncryptionConfig() The encryption configuration for the cluster.
default Object	getKubernetesNetworkConfig() The Kubernetes network configuration for the cluster.
default Object	getLogging() The logging configuration for your cluster.
default String	getName() The unique name to give to your cluster.
default Object	getOutpostConfig() An object representing the configuration of your local Amazon EKS cluster on an AWS Outpost.
Object	getResourcesVpcConfig() The VPC configuration that's used by the cluster control plane.
String	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.
default List<CfnTag>	getTags() The metadata that you apply to the cluster to assist with categorization and organization.
default String	getVersion() The desired Kubernetes version for your cluster.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getResourcesVpcConfig

@Stability(value=Stable)
 @NotNull
Object 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.

Updates require replacement of the SecurityGroupIds and SubnetIds sub-properties.

getRoleArn

@Stability(value=Stable)
 @NotNull
String 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 .

getEncryptionConfig

@Stability(value=Stable)
 @Nullable
default Object getEncryptionConfig()

The encryption configuration for the cluster.

getKubernetesNetworkConfig

@Stability(value=Stable)
 @Nullable
default Object getKubernetesNetworkConfig()

The Kubernetes network configuration for the cluster.

getLogging

@Stability(value=Stable)
 @Nullable
default Object getLogging()

The logging configuration for your cluster.

getName

@Stability(value=Stable)
 @Nullable
default String getName()

The unique name to give to your cluster.

getOutpostConfig

@Stability(value=Stable)
 @Nullable
default Object 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.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> 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 and eks:UntagResource permissions in your IAM user or IAM role used to manage the 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.

getVersion

@Stability(value=Stable)
 @Nullable
default String 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.

builder

@Stability(value=Stable)
static CfnClusterProps.Builder builder()

Returns:

a CfnClusterProps.Builder of CfnClusterProps