interface ClusterAttributes
| Language | Type name |
|---|---|
 Python | aws_cdk.aws_eks.ClusterAttributes |
 Java | software.amazon.awscdk.services.eks.ClusterAttributes |
 .NET | Amazon.CDK.AWS.EKS.ClusterAttributes |
 TypeScript (source) | @aws-cdk/aws-eks.ClusterAttributes |
Attributes for EKS clusters.
Properties
| Name | Type | Description |
|---|---|---|
| cluster | string | The physical name of the Cluster. |
| cluster | string | The certificate-authority-data for your cluster. |
| cluster | string | Amazon Resource Name (ARN) or alias of the customer master key (CMK). |
| cluster | string | The API Server endpoint URL. |
| cluster | string | The cluster security group that was created by Amazon EKS for the cluster. |
| kubectl | { [string]: string } | Environment variables to use when running kubectl against this cluster. |
| kubectl | ILayer | An AWS Lambda Layer which includes kubectl, Helm and the AWS CLI. |
| kubectl | string[] | Subnets to host the kubectl compute resources. |
| kubectl | string | An IAM role with cluster administrator and "system:masters" permissions. |
| kubectl | string | A security group to use for kubectl execution. |
| security | string[] | Additional security groups associated with this cluster. |
| vpc? | IVpc | The VPC in which this Cluster was created. |
clusterName
Type:
string
The physical name of the Cluster.
clusterCertificateAuthorityData?
Type:
string
(optional, default: if not specified cluster.clusterCertificateAuthorityData will
throw an error)
The certificate-authority-data for your cluster.
clusterEncryptionConfigKeyArn?
Type:
string
(optional, default: if not specified cluster.clusterEncryptionConfigKeyArn will
throw an error)
Amazon Resource Name (ARN) or alias of the customer master key (CMK).
clusterEndpoint?
Type:
string
(optional, default: if not specified cluster.clusterEndpoint will throw an error.)
The API Server endpoint URL.
clusterSecurityGroupId?
Type:
string
(optional, default: if not specified cluster.clusterSecurityGroupId will throw an
error)
The cluster security group that was created by Amazon EKS for the cluster.
kubectlEnvironment?
Type:
{ [string]: string }
(optional, default: no additional variables)
Environment variables to use when running kubectl against this cluster.
kubectlLayer?
Type:
ILayer
(optional, default: the layer provided by the aws-lambda-layer-kubectl SAR app.)
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:
const layer = new lambda.LayerVersion(this, 'kubectl-layer', {
code: lambda.Code.fromAsset(`${__dirname}/layer.zip`)),
compatibleRuntimes: [lambda.Runtime.PROVIDED]
});
Or you can use the standard layer like this (with options
to customize the version and SAR application ID):
```ts
const layer = new eks.KubectlLayer(this, 'KubectlLayer');
kubectlPrivateSubnetIds?
Type:
string[]
(optional, default: k8s endpoint is expected to be accessible publicly)
Subnets to host the kubectl compute resources.
If not specified, the k8s endpoint is expected to be accessible publicly.
kubectlRoleArn?
Type:
string
(optional, default: if not specified, it not be possible to issue kubectl commands
against an imported cluster.)
An IAM role with cluster administrator and "system:masters" permissions.
kubectlSecurityGroupId?
Type:
string
(optional, default: k8s endpoint is expected to be accessible publicly)
A security group to use for kubectl execution.
If not specified, the k8s endpoint is expected to be accessible publicly.
securityGroupIds?
Type:
string[]
(optional, default: if not specified, no additional security groups will be
considered in cluster.connections.)
Additional security groups associated with this cluster.
vpc?
Type:
IVpc
(optional, default: if not specified cluster.vpc will throw an error)
The VPC in which this Cluster was created.