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.14.1 (build 828de8a)",
           date="2020-11-24T22:28:23.718Z")
 @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 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 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).

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

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
 var layer = LayerVersion.Builder.create(this, "kubectl-layer")
         .code(lambda.Code.fromAsset(__dirname + "/layer.zip"))
         .build();
 var compatibleRuntimes = ;
 

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

See Also:

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

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

builder

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

Specified by:

builder in interface CommonClusterOptions

Returns:

a ClusterOptions.Builder of ClusterOptions