Class ClusterProps
(deprecated) Properties to instantiate the Cluster.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.EKS.Legacy
Assembly: Amazon.CDK.AWS.EKS.Legacy.dll
Syntax (csharp)
public class ClusterProps : Object, IClusterProps
Syntax (vb)
Public Class ClusterProps
Inherits Object
Implements IClusterProps
Remarks
Stability: Deprecated
ExampleMetadata: infused
Examples
new Cluster(this, "cluster", new ClusterProps {
DefaultCapacity = 10,
DefaultCapacityInstance = new InstanceType("m2.xlarge")
});
Synopsis
Constructors
ClusterProps() |
Properties
ClusterName | (deprecated) Name for the cluster. |
DefaultCapacity | (deprecated) Number of instances to allocate as an initial capacity for this cluster. |
DefaultCapacityInstance | (deprecated) The instance type to use for the default capacity. |
KubectlEnabled | (deprecated) Allows defining |
MastersRole | (deprecated) An IAM role that will be added to the |
OutputClusterName | (deprecated) Determines whether a CloudFormation output with the name of the cluster will be synthesized. |
OutputConfigCommand | (deprecated) Determines whether a CloudFormation output with the |
OutputMastersRoleArn | (deprecated) Determines whether a CloudFormation output with the ARN of the "masters" IAM role will be synthesized (if |
Role | (deprecated) Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. |
SecurityGroup | (deprecated) Security Group to use for Control Plane ENIs. |
Version | (deprecated) The Kubernetes version to run in the cluster. |
Vpc | (deprecated) The VPC in which to create the Cluster. |
VpcSubnets | (deprecated) Where to place EKS Control Plane ENIs. |
Constructors
ClusterProps()
public ClusterProps()
Properties
ClusterName
(deprecated) Name for the cluster.
public string ClusterName { get; set; }
Property Value
System.String
Remarks
Default: - Automatically generated name
Stability: Deprecated
DefaultCapacity
(deprecated) Number of instances to allocate as an initial capacity for this cluster.
public Nullable<double> DefaultCapacity { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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
Stability: Deprecated
DefaultCapacityInstance
(deprecated) The instance type to use for the default capacity.
public InstanceType DefaultCapacityInstance { get; set; }
Property Value
Remarks
This will only be taken
into account if defaultCapacity
is > 0.
Default: m5.large
Stability: Deprecated
KubectlEnabled
(deprecated) Allows defining kubectrl
-related resources on this cluster.
public Nullable<bool> KubectlEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
If this is disabled, it will not be possible to use the following capabilities:
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.
Stability: Deprecated
MastersRole
(deprecated) An IAM role that will be added to the system:masters
Kubernetes RBAC group.
public IRole MastersRole { get; set; }
Property Value
Remarks
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.
Stability: Deprecated
See: https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings
OutputClusterName
(deprecated) Determines whether a CloudFormation output with the name of the cluster will be synthesized.
public Nullable<bool> OutputClusterName { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Stability: Deprecated
OutputConfigCommand
(deprecated) Determines whether a CloudFormation output with the aws eks update-kubeconfig
command will be synthesized.
public Nullable<bool> OutputConfigCommand { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
This command will include the cluster name and, if applicable, the ARN of the masters IAM role.
Default: true
Stability: Deprecated
OutputMastersRoleArn
(deprecated) Determines whether a CloudFormation output with the ARN of the "masters" IAM role will be synthesized (if mastersRole
is specified).
public Nullable<bool> OutputMastersRoleArn { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Stability: Deprecated
Role
(deprecated) Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
public IRole Role { get; set; }
Property Value
Remarks
Default: - A role is automatically created for you
Stability: Deprecated
SecurityGroup
(deprecated) Security Group to use for Control Plane ENIs.
public ISecurityGroup SecurityGroup { get; set; }
Property Value
Remarks
Default: - A security group is automatically created
Stability: Deprecated
Version
(deprecated) The Kubernetes version to run in the cluster.
public string Version { get; set; }
Property Value
System.String
Remarks
Default: - If not supplied, will use Amazon default version
Stability: Deprecated
Vpc
(deprecated) The VPC in which to create the Cluster.
public IVpc Vpc { get; set; }
Property Value
Remarks
Default: - a VPC with default configuration will be created and can be accessed through cluster.vpc
.
Stability: Deprecated
VpcSubnets
(deprecated) Where to place EKS Control Plane ENIs.
public ISubnetSelection[] VpcSubnets { get; set; }
Property Value
Remarks
If you want to create public load balancers, this must include public subnets.
For example, to only select private subnets, supply the following:
IDictionary<string, SubnetType>[] vpcSubnets = new [] { new Dictionary<string, SubnetType> { { "subnetType", SubnetType.PRIVATE_WITH_NAT } } };
Default: - All public and private subnets
Stability: Deprecated