software.amazon.awscdk.services.eks

Interface ClusterOptions

All Superinterfaces:

CommonClusterOptions, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

ClusterProps, FargateClusterProps

All Known Implementing Classes:

ClusterOptions.Jsii$Proxy, ClusterProps.Jsii$Proxy, FargateClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:18.575Z")
 @Stability(value=Experimental)
public interface ClusterOptions
extends software.amazon.jsii.JsiiSerializable, CommonClusterOptions

(experimental) Options for EKS clusters.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ClusterOptions.Builder	builder()
default Map<String,String>	getClusterHandlerEnvironment() (experimental) Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle.
default CoreDnsComputeType	getCoreDnsComputeType() (experimental) Controls the "eks.amazonaws.com/compute-type" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS.
default EndpointAccess	getEndpointAccess() (experimental) Configure access to the Kubernetes API server endpoint..
default Map<String,String>	getKubectlEnvironment() (experimental) Environment variables for the kubectl execution.
default ILayerVersion	getKubectlLayer() (experimental) An AWS Lambda Layer which includes `kubectl`, Helm and the AWS CLI.
default Size	getKubectlMemory() (experimental) Amount of memory to allocate to the provider's lambda function.
default IRole	getMastersRole() (experimental) An IAM role that will be added to the `system:masters` Kubernetes RBAC group.
default Boolean	getOutputMastersRoleArn() (experimental) Determines whether a CloudFormation output with the ARN of the "masters" IAM role will be synthesized (if `mastersRole` is specified).
default Boolean	getPlaceClusterHandlerInVpc() (experimental) If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the `vpcSubnets` selection strategy.
default Boolean	getPrune() (experimental) Indicates whether Kubernetes resources added through `addManifest()` can be automatically pruned.
default IKey	getSecretsEncryptionKey() (experimental) KMS secret for envelope encryption for Kubernetes secrets.

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

getClusterHandlerEnvironment

@Stability(value=Experimental)
 @Nullable
default Map<String,String> getClusterHandlerEnvironment()

(experimental) Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle.

Default: - No environment variables.

getCoreDnsComputeType

@Stability(value=Experimental)
 @Nullable
default CoreDnsComputeType getCoreDnsComputeType()

(experimental) Controls the "eks.amazonaws.com/compute-type" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS.

Default: CoreDnsComputeType.EC2 (for `FargateCluster` the default is FARGATE)

getEndpointAccess

@Stability(value=Experimental)
 @Nullable
default EndpointAccess getEndpointAccess()

(experimental) Configure access to the Kubernetes API server endpoint..

Default: EndpointAccess.PUBLIC_AND_PRIVATE

See Also:

https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html

getKubectlEnvironment

@Stability(value=Experimental)
 @Nullable
default Map<String,String> getKubectlEnvironment()

(experimental) Environment variables for the kubectl execution.

Only relevant for kubectl enabled clusters.

Default: - No environment variables.

getKubectlLayer

@Stability(value=Experimental)
 @Nullable
default ILayerVersion getKubectlLayer()

(experimental) An AWS Lambda Layer which includes `kubectl`, Helm and the AWS CLI.

By default, the provider will use the layer included in the "aws-lambda-layer-kubectl" SAR application which is available in all commercial regions.

To deploy the layer locally, visit https://github.com/aws-samples/aws-lambda-layer-kubectl/blob/master/cdk/README.md for instructions on how to prepare the .zip file and then define it in your app as follows:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 LayerVersion layer = new LayerVersion(this, "kubectl-layer", new LayerVersionProps()
         .code(lambda.Code.fromAsset(String.format("%s/layer.zip", __dirname))));
 Object compatibleRuntimes;
 

Default: - the layer provided by the `aws-lambda-layer-kubectl` SAR app.

See Also:

https://github.com/aws-samples/aws-lambda-layer-kubectl

getKubectlMemory

@Stability(value=Experimental)
 @Nullable
default Size getKubectlMemory()

(experimental) Amount of memory to allocate to the provider's lambda function.

Default: Size.gibibytes(1)

getMastersRole

@Stability(value=Experimental)
 @Nullable
default IRole getMastersRole()

(experimental) An IAM role that will be added to the `system:masters` Kubernetes RBAC group.

Default: - a role that assumable by anyone with permissions in the same account will automatically be defined

See Also:

https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings

getOutputMastersRoleArn

@Stability(value=Experimental)
 @Nullable
default Boolean getOutputMastersRoleArn()

(experimental) Determines whether a CloudFormation output with the ARN of the "masters" IAM role will be synthesized (if `mastersRole` is specified).

Default: false

getPlaceClusterHandlerInVpc

@Stability(value=Experimental)
 @Nullable
default Boolean getPlaceClusterHandlerInVpc()

(experimental) If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the `vpcSubnets` selection strategy.

Default: false

getPrune

@Stability(value=Experimental)
 @Nullable
default Boolean getPrune()

(experimental) Indicates whether Kubernetes resources added through `addManifest()` can be automatically pruned.

When this is enabled (default), prune labels will be allocated and injected to each resource. These labels will then be used when issuing the kubectl apply operation with the --prune switch.

Default: true

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 ClusterOptions.Builder builder()

Specified by:

builder in interface CommonClusterOptions

Returns:

a ClusterOptions.Builder of ClusterOptions