software.amazon.awscdk.services.eks

Interface ClusterProps

All Superinterfaces:

ClusterOptions, CommonClusterOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.14.1 (build 828de8a)",
           date="2020-11-24T22:28:23.719Z")
 @Stability(value=Experimental)
public interface ClusterProps
extends software.amazon.jsii.JsiiSerializable, ClusterOptions

(experimental) Common configuration props for EKS clusters.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ClusterProps.Builder	builder()
default Number	getDefaultCapacity() (experimental) Number of instances to allocate as an initial capacity for this cluster.
default InstanceType	getDefaultCapacityInstance() (experimental) The instance type to use for the default capacity.
default DefaultCapacityType	getDefaultCapacityType() (experimental) The default capacity type for the cluster.
default Boolean	getKubectlEnabled() Deprecated. `eks.LegacyCluster` is __temporarily__ provided as a drop-in replacement until you are able to migrate to `eks.Cluster`.
default IKey	getSecretsEncryptionKey() (experimental) KMS secret for envelope encryption for Kubernetes secrets.

Methods inherited from interface software.amazon.awscdk.services.eks.ClusterOptions

getCoreDnsComputeType, getEndpointAccess, getKubectlEnvironment, getKubectlLayer, getMastersRole, getOutputMastersRoleArn

Methods inherited from interface software.amazon.awscdk.services.eks.CommonClusterOptions

getClusterName, getOutputClusterName, getOutputConfigCommand, getRole, getSecurityGroup, getVersion, getVpc, getVpcSubnets

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDefaultCapacity

@Stability(value=Experimental)
 @Nullable
default Number getDefaultCapacity()

(experimental) Number of instances to allocate as an initial capacity for this cluster.

Instance type can be configured through defaultCapacityInstanceType, which defaults to m5.large.

Use cluster.addAutoScalingGroupCapacity to add additional customized capacity. Set this to 0 is you wish to avoid the initial capacity allocation.

Default: 2

getDefaultCapacityInstance

@Stability(value=Experimental)
 @Nullable
default InstanceType getDefaultCapacityInstance()

(experimental) The instance type to use for the default capacity.

This will only be taken into account if defaultCapacity is > 0.

Default: m5.large

getDefaultCapacityType

@Stability(value=Experimental)
 @Nullable
default DefaultCapacityType getDefaultCapacityType()

(experimental) The default capacity type for the cluster.

Default: NODEGROUP

getKubectlEnabled

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default Boolean getKubectlEnabled()

Deprecated. `eks.LegacyCluster` is __temporarily__ provided as a drop-in replacement until you are able to migrate to `eks.Cluster`.

(deprecated) NOT SUPPORTED: We no longer allow disabling kubectl-support. Setting this option to `false` will throw an error.

To temporary allow you to retain existing clusters created with kubectlEnabled: false, you can use eks.LegacyCluster class, which is a drop-in replacement for eks.Cluster with kubectlEnabled: false.

Bear in mind that this is a temporary workaround. We have plans to remove eks.LegacyCluster. If you have a use case for using eks.LegacyCluster, please add a comment here https://github.com/aws/aws-cdk/issues/9332 and let us know so we can make sure to continue to support your use case with eks.Cluster. This issue also includes additional context into why this class is being removed.

Default: true

See Also:

https://github.com/aws/aws-cdk/issues/9332

getSecretsEncryptionKey

@Stability(value=Experimental)
 @Nullable
default IKey getSecretsEncryptionKey()

(experimental) KMS secret for envelope encryption for Kubernetes secrets.

Default: - By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys.

builder

@Stability(value=Experimental)
static ClusterProps.Builder builder()

Specified by:

builder in interface ClusterOptions

Specified by:

builder in interface CommonClusterOptions

Returns:

a ClusterProps.Builder of ClusterProps