@Stability(value=Experimental) @Internal public static final class ClusterProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements ClusterProps
ClusterPropssoftware.amazon.jsii.JsiiObject.InitializationModeClusterProps.Builder, ClusterProps.Jsii$Proxy| 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(Number defaultCapacity,
InstanceType defaultCapacityInstance,
DefaultCapacityType defaultCapacityType,
Boolean kubectlEnabled,
IKey secretsEncryptionKey,
CoreDnsComputeType coreDnsComputeType,
EndpointAccess endpointAccess,
Map<String,String> kubectlEnvironment,
ILayerVersion kubectlLayer,
IRole mastersRole,
Boolean outputMastersRoleArn,
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
ClusterProps.Builder. |
| Modifier and Type | Method and Description |
|---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(Object o) |
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.
|
Number |
getDefaultCapacity()
(experimental) Number of instances to allocate as an initial capacity for this cluster.
|
InstanceType |
getDefaultCapacityInstance()
(experimental) The instance type to use for the default capacity.
|
DefaultCapacityType |
getDefaultCapacityType()
(experimental) The default capacity type for the cluster.
|
EndpointAccess |
getEndpointAccess()
(experimental) Configure access to the Kubernetes API server endpoint..
|
Boolean |
getKubectlEnabled()
(deprecated) NOT SUPPORTED: We no longer allow disabling kubectl-support.
|
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.
|
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).
|
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() |
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitbuilderprotected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef - Reference to the JSII managed object.protected Jsii$Proxy(Number defaultCapacity, InstanceType defaultCapacityInstance, DefaultCapacityType defaultCapacityType, Boolean kubectlEnabled, IKey secretsEncryptionKey, CoreDnsComputeType coreDnsComputeType, EndpointAccess endpointAccess, Map<String,String> kubectlEnvironment, ILayerVersion kubectlLayer, IRole mastersRole, Boolean outputMastersRoleArn, KubernetesVersion version, String clusterName, Boolean outputClusterName, Boolean outputConfigCommand, IRole role, ISecurityGroup securityGroup, IVpc vpc, List<? extends SubnetSelection> vpcSubnets)
ClusterProps.Builder.public final Number getDefaultCapacity()
ClusterProps
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
getDefaultCapacity in interface ClusterPropspublic final InstanceType getDefaultCapacityInstance()
ClusterProps
This will only be taken
into account if defaultCapacity is > 0.
Default: m5.large
getDefaultCapacityInstance in interface ClusterPropspublic final DefaultCapacityType getDefaultCapacityType()
ClusterPropsDefault: NODEGROUP
getDefaultCapacityType in interface ClusterPropspublic final Boolean getKubectlEnabled()
ClusterProps
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
getKubectlEnabled in interface ClusterPropshttps://github.com/aws/aws-cdk/issues/9332public final IKey getSecretsEncryptionKey()
ClusterPropsDefault: - 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.
getSecretsEncryptionKey in interface ClusterPropspublic final CoreDnsComputeType getCoreDnsComputeType()
ClusterOptionsDefault: CoreDnsComputeType.EC2 (for `FargateCluster` the default is FARGATE)
getCoreDnsComputeType in interface ClusterOptionspublic final EndpointAccess getEndpointAccess()
ClusterOptionsDefault: EndpointAccess.PUBLIC_AND_PRIVATE
getEndpointAccess in interface ClusterOptionshttps://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.htmlpublic final Map<String,String> getKubectlEnvironment()
ClusterOptionsOnly relevant for kubectl enabled clusters.
Default: - No environment variables.
getKubectlEnvironment in interface ClusterOptionspublic final ILayerVersion getKubectlLayer()
ClusterOptionsBy 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.
getKubectlLayer in interface ClusterOptionshttps://github.com/aws-samples/aws-lambda-layer-kubectlpublic final IRole getMastersRole()
ClusterOptionsDefault: - a role that assumable by anyone with permissions in the same account will automatically be defined
getMastersRole in interface ClusterOptionshttps://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindingspublic final Boolean getOutputMastersRoleArn()
ClusterOptionsDefault: false
getOutputMastersRoleArn in interface ClusterOptionspublic final KubernetesVersion getVersion()
CommonClusterOptionsgetVersion in interface CommonClusterOptionspublic final String getClusterName()
CommonClusterOptionsDefault: - Automatically generated name
getClusterName in interface CommonClusterOptionspublic final Boolean getOutputClusterName()
CommonClusterOptionsDefault: false
getOutputClusterName in interface CommonClusterOptionspublic final Boolean getOutputConfigCommand()
CommonClusterOptionsThis command will include the cluster name and, if applicable, the ARN of the masters IAM role.
Default: true
getOutputConfigCommand in interface CommonClusterOptionspublic final IRole getRole()
CommonClusterOptionsDefault: - A role is automatically created for you
getRole in interface CommonClusterOptionspublic final ISecurityGroup getSecurityGroup()
CommonClusterOptionsDefault: - A security group is automatically created
getSecurityGroup in interface CommonClusterOptionspublic final IVpc getVpc()
CommonClusterOptionsDefault: - a VPC with default configuration will be created and can be accessed through `cluster.vpc`.
getVpc in interface CommonClusterOptionspublic final List<SubnetSelection> getVpcSubnets()
CommonClusterOptionsIf 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
getVpcSubnets in interface CommonClusterOptions@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
$jsii$toJson in interface software.amazon.jsii.JsiiSerializableCopyright © 2020. All rights reserved.