software.amazon.awscdk.services.eks.legacy

Class ClusterProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.eks.legacy.ClusterProps.Jsii$Proxy

All Implemented Interfaces:

ClusterProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

ClusterProps

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

An implementation for ClusterProps

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.legacy.ClusterProps

ClusterProps.Builder, ClusterProps.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(String clusterName, Number defaultCapacity, InstanceType defaultCapacityInstance, Boolean kubectlEnabled, IRole mastersRole, Boolean outputClusterName, Boolean outputConfigCommand, Boolean outputMastersRoleArn, IRole role, ISecurityGroup securityGroup, String version, IVpc vpc, List<? extends SubnetSelection> vpcSubnets) Constructor that initializes the object based on literal property values passed by the ClusterProps.Builder.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
String	getClusterName() (experimental) Name for the cluster.
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.
Boolean	getKubectlEnabled() (experimental) Allows defining `kubectrl`-related resources on this cluster.
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.
ISecurityGroup	getSecurityGroup() (experimental) Security Group to use for Control Plane ENIs.
String	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.legacy.ClusterProps

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(String clusterName,
                     Number defaultCapacity,
                     InstanceType defaultCapacityInstance,
                     Boolean kubectlEnabled,
                     IRole mastersRole,
                     Boolean outputClusterName,
                     Boolean outputConfigCommand,
                     Boolean outputMastersRoleArn,
                     IRole role,
                     ISecurityGroup securityGroup,
                     String version,
                     IVpc vpc,
                     List<? extends SubnetSelection> vpcSubnets)

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

Method Detail

getClusterName

public final String getClusterName()

Description copied from interface: ClusterProps

(experimental) Name for the cluster.

Default: - Automatically generated name

Specified by:

getClusterName in interface ClusterProps

getDefaultCapacity

public final Number getDefaultCapacity()

Description copied from interface: ClusterProps

(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.addCapacity to add additional customized capacity. Set this to 0 is you wish to avoid the initial capacity allocation.

Default: 2

Specified by:

getDefaultCapacity in interface ClusterProps

getDefaultCapacityInstance

public final InstanceType getDefaultCapacityInstance()

Description copied from interface: ClusterProps

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

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

Default: m5.large

Specified by:

getDefaultCapacityInstance in interface ClusterProps

getKubectlEnabled

public final Boolean getKubectlEnabled()

Description copied from interface: ClusterProps

(experimental) Allows defining `kubectrl`-related resources on this cluster.

If this is disabled, it will not be possible to use the following capabilities:

• addResource
• addRoleMapping
• addUserMapping
• addMastersRole and props.mastersRole

If this is disabled, the cluster can only be managed by issuing kubectl commands from a session that uses the IAM role/user that created the account.

NOTE: changing this value will destoy the cluster. This is because a managable cluster must be created using an AWS CloudFormation custom resource which executes with an IAM role owned by the CDK app.

Default: true The cluster can be managed by the AWS CDK application.

Specified by:

getKubectlEnabled in interface ClusterProps

getMastersRole

public final IRole getMastersRole()

Description copied from interface: ClusterProps

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

Default: - By default, it will only possible to update this Kubernetes system by adding resources to this cluster via `addResource` or by defining `KubernetesResource` resources in your AWS CDK app. Use this if you wish to grant cluster administration privileges to another role.

Specified by:

getMastersRole in interface ClusterProps

See Also:

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

getOutputClusterName

public final Boolean getOutputClusterName()

Description copied from interface: ClusterProps

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

Default: false

Specified by:

getOutputClusterName in interface ClusterProps

getOutputConfigCommand

public final Boolean getOutputConfigCommand()

Description copied from interface: ClusterProps

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

getOutputMastersRoleArn

public final Boolean getOutputMastersRoleArn()

Description copied from interface: ClusterProps

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

getRole

public final IRole getRole()

Description copied from interface: ClusterProps

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

getSecurityGroup

public final ISecurityGroup getSecurityGroup()

Description copied from interface: ClusterProps

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

Default: - A security group is automatically created

Specified by:

getSecurityGroup in interface ClusterProps

getVersion

public final String getVersion()

Description copied from interface: ClusterProps

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

Default: - If not supplied, will use Amazon default version

Specified by:

getVersion in interface ClusterProps

getVpc

public final IVpc getVpc()

Description copied from interface: ClusterProps

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

getVpcSubnets

public final List<SubnetSelection> getVpcSubnets()

Description copied from interface: ClusterProps

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

$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