1.204.0

interface OutpostConfigProperty

LanguageType name
.NETAmazon.CDK.AWS.EKS.Legacy.CfnCluster.OutpostConfigProperty
Javasoftware.amazon.awscdk.services.eks.legacy.CfnCluster.OutpostConfigProperty
Pythonaws_cdk.aws_eks_legacy.CfnCluster.OutpostConfigProperty
TypeScript @aws-cdk/aws-eks-legacy » CfnCluster » OutpostConfigProperty

The configuration of your local Amazon EKS cluster on an AWS Outpost.

Before creating a cluster on an Outpost, review Creating a local cluster on an Outpost in the Amazon EKS User Guide . This API isn't available for Amazon EKS clusters on the AWS cloud.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as eks_legacy from '@aws-cdk/aws-eks-legacy';
const outpostConfigProperty: eks_legacy.CfnCluster.OutpostConfigProperty = {
  controlPlaneInstanceType: 'controlPlaneInstanceType',
  outpostArns: ['outpostArns'],

  // the properties below are optional
  controlPlanePlacement: {
    groupName: 'groupName',
  },
};

Properties

NameTypeDescription
controlPlaneInstanceTypestringThe Amazon EC2 instance type that you want to use for your local Amazon EKS cluster on Outposts.
outpostArnsstring[]The ARN of the Outpost that you want to use for your local Amazon EKS cluster on Outposts.
controlPlanePlacement?IResolvable | ControlPlanePlacementPropertyAn object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on an AWS Outpost.

controlPlaneInstanceType

Type: string

The Amazon EC2 instance type that you want to use for your local Amazon EKS cluster on Outposts.

Choose an instance type based on the number of nodes that your cluster will have. For more information, see Capacity considerations in the Amazon EKS User Guide .

The instance type that you specify is used for all Kubernetes control plane instances. The instance type can't be changed after cluster creation. The control plane is not automatically scaled by Amazon EKS.

outpostArns

Type: string[]

The ARN of the Outpost that you want to use for your local Amazon EKS cluster on Outposts.

Only a single Outpost ARN is supported.

controlPlanePlacement?

Type: IResolvable | ControlPlanePlacementProperty (optional)

An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on an AWS Outpost.

For more information, see Capacity considerations in the Amazon EKS User Guide .

← PreviousNext →