AWS CDK Reference

Appearance

v2.273.0

OutpostConfigProperty Struct ​

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.

Source
Generated code
Type last changed
v2.268.0 · 2 Sep 2026

Example ​

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

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

Properties ​

controlPlaneInstanceTypestringcontrol_plane_instance_typestrcontrolPlaneInstanceTypeStringControlPlaneInstanceTypestringControlPlaneInstanceType*stringrequired#
The Amazon EC2 instance type that you want to use for your local Amazon EKS cluster on Outposts.
notes

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.

controlPlanePlacementIResolvable | CfnCluster.ControlPlanePlacementPropertycontrol_plane_placementtyping.Union[IResolvable, ControlPlanePlacementProperty]controlPlanePlacementIResolvableControlPlanePlacementIResolvableControlPlanePlacementinterface{}#
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 .

etcdInstanceTypestringetcd_instance_typestretcdInstanceTypeStringEtcdInstanceTypestringEtcdInstanceType*string#
The EC2 instance type for etcd instances of your local Amazon EKS cluster on AWS Outposts.

This instance type applies to all etcd instances and cannot be changed after cluster creation.

etcdPlacementIResolvable | CfnCluster.EtcdPlacementPropertyetcd_placementtyping.Union[IResolvable, EtcdPlacementProperty]etcdPlacementIResolvableEtcdPlacementIResolvableEtcdPlacementinterface{}#
The placement configuration for the etcd instances of your local Amazon EKS cluster on an AWS Outpost.
outpostArnsstring[]outpost_arnstyping.List[str]outpostArnsList<String>OutpostArnsstring[]OutpostArns*[]*stringrequired#
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.