Package software.amazon.awscdk.services.eks.legacy

Interface CfnCluster.OutpostConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCluster.OutpostConfigProperty.Jsii$Proxy

Enclosing class:

CfnCluster

@Stability(Stable)
public static interface CfnCluster.OutpostConfigProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.eks.legacy.*;
 OutpostConfigProperty outpostConfigProperty = OutpostConfigProperty.builder()
         .controlPlaneInstanceType("controlPlaneInstanceType")
         .outpostArns(List.of("outpostArns"))
         // the properties below are optional
         .controlPlanePlacement(ControlPlanePlacementProperty.builder()
                 .groupName("groupName")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCluster.OutpostConfigProperty.Builder	A builder for CfnCluster.OutpostConfigProperty
static final class	CfnCluster.OutpostConfigProperty.Jsii$Proxy	An implementation for CfnCluster.OutpostConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnCluster.OutpostConfigProperty.Builder	builder()
String	getControlPlaneInstanceType()	The Amazon EC2 instance type that you want to use for your local Amazon EKS cluster on Outposts.
default Object	getControlPlanePlacement()	An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on an AWS Outpost.
List<String>	getOutpostArns()	The ARN of the Outpost that you want to use for your local Amazon EKS cluster on Outposts.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getControlPlaneInstanceType

@Stability(Stable)
@NotNull
String getControlPlaneInstanceType()

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.

getOutpostArns

@Stability(Stable)
@NotNull
List<String> getOutpostArns()

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.

getControlPlanePlacement

@Stability(Stable)
@Nullable
default Object getControlPlanePlacement()

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 .

builder

@Stability(Stable)
static CfnCluster.OutpostConfigProperty.Builder builder()

Returns:

a CfnCluster.OutpostConfigProperty.Builder of CfnCluster.OutpostConfigProperty