software.amazon.awscdk.services.eks

Class ClusterOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.eks.ClusterOptions.Jsii$Proxy

All Implemented Interfaces:

ClusterOptions, CommonClusterOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

ClusterOptions

@Stability(value=Experimental)
 @Internal
public static final class ClusterOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements ClusterOptions

An implementation for ClusterOptions

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.eks.ClusterOptions

ClusterOptions.Builder, ClusterOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.
protected	Jsii$Proxy(Map<String,String> clusterHandlerEnvironment, CoreDnsComputeType coreDnsComputeType, EndpointAccess endpointAccess, Map<String,String> kubectlEnvironment, ILayerVersion kubectlLayer, Size kubectlMemory, IRole mastersRole, Boolean outputMastersRoleArn, Boolean placeClusterHandlerInVpc, Boolean prune, IKey secretsEncryptionKey, KubernetesVersion version, String clusterName, Boolean outputClusterName, Boolean outputConfigCommand, IRole role, ISecurityGroup securityGroup, IVpc vpc, List<? extends SubnetSelection> vpcSubnets) Constructor that initializes the object based on literal property values passed by the ClusterOptions.Builder.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
Map<String,String>	getClusterHandlerEnvironment() (experimental) Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle.
String	getClusterName() (experimental) Name for the cluster.
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.
EndpointAccess	getEndpointAccess() (experimental) Configure access to the Kubernetes API server endpoint..
Map<String,String>	getKubectlEnvironment() (experimental) Environment variables for the kubectl execution.
ILayerVersion	getKubectlLayer() (experimental) An AWS Lambda Layer which includes `kubectl`, Helm and the AWS CLI.
Size	getKubectlMemory() (experimental) Amount of memory to allocate to the provider's lambda function.
IRole	getMastersRole() (experimental) An IAM role that will be added to the `system:masters` Kubernetes RBAC group.
Boolean	getOutputClusterName() (experimental) Determines whether a CloudFormation output with the name of the cluster will be synthesized.
Boolean	getOutputConfigCommand() (experimental) Determines whether a CloudFormation output with the `aws eks update-kubeconfig` command will be synthesized.
Boolean	getOutputMastersRoleArn() (experimental) Determines whether a CloudFormation output with the ARN of the "masters" IAM role will be synthesized (if `mastersRole` is specified).
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.
Boolean	getPrune() (experimental) Indicates whether Kubernetes resources added through `addManifest()` can be automatically pruned.
IRole	getRole() (experimental) Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
IKey	getSecretsEncryptionKey() (experimental) KMS secret for envelope encryption for Kubernetes secrets.
ISecurityGroup	getSecurityGroup() (experimental) Security Group to use for Control Plane ENIs.
KubernetesVersion	getVersion() (experimental) The Kubernetes version to run in the cluster.
IVpc	getVpc() (experimental) The VPC in which to create the Cluster.
List<SubnetSelection>	getVpcSubnets() (experimental) Where to place EKS Control Plane ENIs.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(Map<String,String> clusterHandlerEnvironment,
                     CoreDnsComputeType coreDnsComputeType,
                     EndpointAccess endpointAccess,
                     Map<String,String> kubectlEnvironment,
                     ILayerVersion kubectlLayer,
                     Size kubectlMemory,
                     IRole mastersRole,
                     Boolean outputMastersRoleArn,
                     Boolean placeClusterHandlerInVpc,
                     Boolean prune,
                     IKey secretsEncryptionKey,
                     KubernetesVersion version,
                     String clusterName,
                     Boolean outputClusterName,
                     Boolean outputConfigCommand,
                     IRole role,
                     ISecurityGroup securityGroup,
                     IVpc vpc,
                     List<? extends SubnetSelection> vpcSubnets)

Constructor that initializes the object based on literal property values passed by the ClusterOptions.Builder.

Method Detail

getClusterHandlerEnvironment

public final Map<String,String> getClusterHandlerEnvironment()

Description copied from interface: ClusterOptions

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

Default: - No environment variables.

Specified by:

getClusterHandlerEnvironment in interface ClusterOptions

getCoreDnsComputeType

public final CoreDnsComputeType getCoreDnsComputeType()

Description copied from interface: ClusterOptions

(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)

Specified by:

getCoreDnsComputeType in interface ClusterOptions

getEndpointAccess

public final EndpointAccess getEndpointAccess()

Description copied from interface: ClusterOptions

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

Default: EndpointAccess.PUBLIC_AND_PRIVATE

Specified by:

getEndpointAccess in interface ClusterOptions

See Also:

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

getKubectlEnvironment

public final Map<String,String> getKubectlEnvironment()

Description copied from interface: ClusterOptions

(experimental) Environment variables for the kubectl execution.

Only relevant for kubectl enabled clusters.

Default: - No environment variables.

Specified by:

getKubectlEnvironment in interface ClusterOptions

getKubectlLayer

public final ILayerVersion getKubectlLayer()

Description copied from interface: ClusterOptions

(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.

Specified by:

getKubectlLayer in interface ClusterOptions

See Also:

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

getKubectlMemory

public final Size getKubectlMemory()

Description copied from interface: ClusterOptions

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

Default: Size.gibibytes(1)

Specified by:

getKubectlMemory in interface ClusterOptions

getMastersRole

public final IRole getMastersRole()

Description copied from interface: ClusterOptions

(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

Specified by:

getMastersRole in interface ClusterOptions

See Also:

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

getOutputMastersRoleArn

public final Boolean getOutputMastersRoleArn()

Description copied from interface: ClusterOptions

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

Default: false

Specified by:

getOutputMastersRoleArn in interface ClusterOptions

getPlaceClusterHandlerInVpc

public final Boolean getPlaceClusterHandlerInVpc()

Description copied from interface: ClusterOptions

(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

Specified by:

getPlaceClusterHandlerInVpc in interface ClusterOptions

getPrune

public final Boolean getPrune()

Description copied from interface: ClusterOptions

(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

Specified by:

getPrune in interface ClusterOptions

getSecretsEncryptionKey

public final IKey getSecretsEncryptionKey()

Description copied from interface: ClusterOptions

(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.

Specified by:

getSecretsEncryptionKey in interface ClusterOptions

getVersion

public final KubernetesVersion getVersion()

Description copied from interface: CommonClusterOptions

(experimental) The Kubernetes version to run in the cluster.

Specified by:

getVersion in interface CommonClusterOptions

getClusterName

public final String getClusterName()

Description copied from interface: CommonClusterOptions

(experimental) Name for the cluster.

Default: - Automatically generated name

Specified by:

getClusterName in interface CommonClusterOptions

getOutputClusterName

public final Boolean getOutputClusterName()

Description copied from interface: CommonClusterOptions

(experimental) Determines whether a CloudFormation output with the name of the cluster will be synthesized.

Default: false

Specified by:

getOutputClusterName in interface CommonClusterOptions

getOutputConfigCommand

public final Boolean getOutputConfigCommand()

Description copied from interface: CommonClusterOptions

(experimental) Determines whether a CloudFormation output with the `aws eks update-kubeconfig` command will be synthesized.

This command will include the cluster name and, if applicable, the ARN of the masters IAM role.

Default: true

Specified by:

getOutputConfigCommand in interface CommonClusterOptions

getRole

public final IRole getRole()

Description copied from interface: CommonClusterOptions

(experimental) Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

Default: - A role is automatically created for you

Specified by:

getRole in interface CommonClusterOptions

getSecurityGroup

public final ISecurityGroup getSecurityGroup()

Description copied from interface: CommonClusterOptions

(experimental) Security Group to use for Control Plane ENIs.

Default: - A security group is automatically created

Specified by:

getSecurityGroup in interface CommonClusterOptions

getVpc

public final IVpc getVpc()

Description copied from interface: CommonClusterOptions

(experimental) The VPC in which to create the Cluster.

Default: - a VPC with default configuration will be created and can be accessed through `cluster.vpc`.

Specified by:

getVpc in interface CommonClusterOptions

getVpcSubnets

public final List<SubnetSelection> getVpcSubnets()

Description copied from interface: CommonClusterOptions

(experimental) Where to place EKS Control Plane ENIs.

If you want to create public load balancers, this must include public subnets.

For example, to only select private subnets, supply the following:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 vpcSubnets: [
    { subnetType: ec2.SubnetType.Private }
 ]
 

Default: - All public and private subnets

Specified by:

getVpcSubnets in interface CommonClusterOptions

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object