Package software.amazon.awscdk.services.eks

Class CfnCluster.Builder

java.lang.Object

software.amazon.awscdk.services.eks.CfnCluster.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCluster>

Enclosing class:

CfnCluster

@Stability(Stable)
public static final class CfnCluster.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCluster>

A fluent builder for CfnCluster.

Method Summary

Modifier and Type	Method	Description
CfnCluster.Builder	accessConfig(IResolvable accessConfig)	The access configuration for the cluster.
CfnCluster.Builder	accessConfig(CfnCluster.AccessConfigProperty accessConfig)	The access configuration for the cluster.
CfnCluster.Builder	bootstrapSelfManagedAddons(Boolean bootstrapSelfManagedAddons)	If you set this value to False when creating a cluster, the default networking add-ons will not be installed.
CfnCluster.Builder	bootstrapSelfManagedAddons(IResolvable bootstrapSelfManagedAddons)	If you set this value to False when creating a cluster, the default networking add-ons will not be installed.
CfnCluster	build()
CfnCluster.Builder	computeConfig(IResolvable computeConfig)	Indicates the current configuration of the compute capability on your EKS Auto Mode cluster.
CfnCluster.Builder	computeConfig(CfnCluster.ComputeConfigProperty computeConfig)	Indicates the current configuration of the compute capability on your EKS Auto Mode cluster.
static CfnCluster.Builder	create(software.constructs.Construct scope, String id)
CfnCluster.Builder	encryptionConfig(List<? extends Object> encryptionConfig)	The encryption configuration for the cluster.
CfnCluster.Builder	encryptionConfig(IResolvable encryptionConfig)	The encryption configuration for the cluster.
CfnCluster.Builder	kubernetesNetworkConfig(IResolvable kubernetesNetworkConfig)	The Kubernetes network configuration for the cluster.
CfnCluster.Builder	kubernetesNetworkConfig(CfnCluster.KubernetesNetworkConfigProperty kubernetesNetworkConfig)	The Kubernetes network configuration for the cluster.
CfnCluster.Builder	logging(IResolvable logging)	The logging configuration for your cluster.
CfnCluster.Builder	logging(CfnCluster.LoggingProperty logging)	The logging configuration for your cluster.
CfnCluster.Builder	name(String name)	The unique name to give to your cluster.
CfnCluster.Builder	outpostConfig(IResolvable outpostConfig)	An object representing the configuration of your local Amazon EKS cluster on an AWS Outpost.
CfnCluster.Builder	outpostConfig(CfnCluster.OutpostConfigProperty outpostConfig)	An object representing the configuration of your local Amazon EKS cluster on an AWS Outpost.
CfnCluster.Builder	remoteNetworkConfig(IResolvable remoteNetworkConfig)	The configuration in the cluster for EKS Hybrid Nodes.
CfnCluster.Builder	remoteNetworkConfig(CfnCluster.RemoteNetworkConfigProperty remoteNetworkConfig)	The configuration in the cluster for EKS Hybrid Nodes.
CfnCluster.Builder	resourcesVpcConfig(IResolvable resourcesVpcConfig)	The VPC configuration that's used by the cluster control plane.
CfnCluster.Builder	resourcesVpcConfig(CfnCluster.ResourcesVpcConfigProperty resourcesVpcConfig)	The VPC configuration that's used by the cluster control plane.
CfnCluster.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
CfnCluster.Builder	storageConfig(IResolvable storageConfig)	Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster.
CfnCluster.Builder	storageConfig(CfnCluster.StorageConfigProperty storageConfig)	Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster.
CfnCluster.Builder	tags(List<? extends CfnTag> tags)	The metadata that you apply to the cluster to assist with categorization and organization.
CfnCluster.Builder	upgradePolicy(IResolvable upgradePolicy)	This value indicates if extended support is enabled or disabled for the cluster.
CfnCluster.Builder	upgradePolicy(CfnCluster.UpgradePolicyProperty upgradePolicy)	This value indicates if extended support is enabled or disabled for the cluster.
CfnCluster.Builder	version(String version)	The desired Kubernetes version for your cluster.
CfnCluster.Builder	zonalShiftConfig(IResolvable zonalShiftConfig)	The configuration for zonal shift for the cluster.
CfnCluster.Builder	zonalShiftConfig(CfnCluster.ZonalShiftConfigProperty zonalShiftConfig)	The configuration for zonal shift for the cluster.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnCluster.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnCluster.Builder.

resourcesVpcConfig

@Stability(Stable)
public CfnCluster.Builder resourcesVpcConfig(IResolvable resourcesVpcConfig)

The VPC configuration that's used by the cluster control plane.

Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide . You must specify at least two subnets. You can specify up to five security groups, but we recommend that you use a dedicated security group for your cluster control plane.

Parameters:

resourcesVpcConfig - The VPC configuration that's used by the cluster control plane. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-resourcesvpcconfig

resourcesVpcConfig

@Stability(Stable)
public CfnCluster.Builder resourcesVpcConfig(CfnCluster.ResourcesVpcConfigProperty resourcesVpcConfig)

The VPC configuration that's used by the cluster control plane.

Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide . You must specify at least two subnets. You can specify up to five security groups, but we recommend that you use a dedicated security group for your cluster control plane.

Parameters:

resourcesVpcConfig - The VPC configuration that's used by the cluster control plane. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-resourcesvpcconfig

roleArn

@Stability(Stable)
public CfnCluster.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

For more information, see Amazon EKS Service IAM Role in the Amazon EKS User Guide .

Parameters:

roleArn - The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-rolearn

accessConfig

@Stability(Stable)
public CfnCluster.Builder accessConfig(IResolvable accessConfig)

The access configuration for the cluster.

Parameters:

accessConfig - The access configuration for the cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-accessconfig

accessConfig

@Stability(Stable)
public CfnCluster.Builder accessConfig(CfnCluster.AccessConfigProperty accessConfig)

The access configuration for the cluster.

Parameters:

accessConfig - The access configuration for the cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-accessconfig

bootstrapSelfManagedAddons

@Stability(Stable)
public CfnCluster.Builder bootstrapSelfManagedAddons(Boolean bootstrapSelfManagedAddons)

If you set this value to False when creating a cluster, the default networking add-ons will not be installed.

The default networking addons include vpc-cni, coredns, and kube-proxy.

Use this option when you plan to install third-party alternative add-ons or self-manage the default networking add-ons.

Parameters:

bootstrapSelfManagedAddons - If you set this value to False when creating a cluster, the default networking add-ons will not be installed. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-bootstrapselfmanagedaddons

bootstrapSelfManagedAddons

@Stability(Stable)
public CfnCluster.Builder bootstrapSelfManagedAddons(IResolvable bootstrapSelfManagedAddons)

If you set this value to False when creating a cluster, the default networking add-ons will not be installed.

The default networking addons include vpc-cni, coredns, and kube-proxy.

Use this option when you plan to install third-party alternative add-ons or self-manage the default networking add-ons.

Parameters:

bootstrapSelfManagedAddons - If you set this value to False when creating a cluster, the default networking add-ons will not be installed. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-bootstrapselfmanagedaddons

computeConfig

@Stability(Stable)
public CfnCluster.Builder computeConfig(IResolvable computeConfig)

Indicates the current configuration of the compute capability on your EKS Auto Mode cluster.

For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your AWS account. For more information, see EKS Auto Mode compute capability in the Amazon EKS User Guide .

Parameters:

computeConfig - Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-computeconfig

computeConfig

@Stability(Stable)
public CfnCluster.Builder computeConfig(CfnCluster.ComputeConfigProperty computeConfig)

Indicates the current configuration of the compute capability on your EKS Auto Mode cluster.

For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your AWS account. For more information, see EKS Auto Mode compute capability in the Amazon EKS User Guide .

Parameters:

computeConfig - Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-computeconfig

encryptionConfig

@Stability(Stable)
public CfnCluster.Builder encryptionConfig(IResolvable encryptionConfig)

The encryption configuration for the cluster.

Parameters:

encryptionConfig - The encryption configuration for the cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-encryptionconfig

encryptionConfig

@Stability(Stable)
public CfnCluster.Builder encryptionConfig(List<? extends Object> encryptionConfig)

The encryption configuration for the cluster.

Parameters:

encryptionConfig - The encryption configuration for the cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-encryptionconfig

kubernetesNetworkConfig

@Stability(Stable)
public CfnCluster.Builder kubernetesNetworkConfig(IResolvable kubernetesNetworkConfig)

The Kubernetes network configuration for the cluster.

Parameters:

kubernetesNetworkConfig - The Kubernetes network configuration for the cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-kubernetesnetworkconfig

kubernetesNetworkConfig

@Stability(Stable)
public CfnCluster.Builder kubernetesNetworkConfig(CfnCluster.KubernetesNetworkConfigProperty kubernetesNetworkConfig)

The Kubernetes network configuration for the cluster.

Parameters:

kubernetesNetworkConfig - The Kubernetes network configuration for the cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-kubernetesnetworkconfig

logging

@Stability(Stable)
public CfnCluster.Builder logging(IResolvable logging)

The logging configuration for your cluster.

Parameters:

logging - The logging configuration for your cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-logging

logging

@Stability(Stable)
public CfnCluster.Builder logging(CfnCluster.LoggingProperty logging)

The logging configuration for your cluster.

Parameters:

logging - The logging configuration for your cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-logging

name

@Stability(Stable)
public CfnCluster.Builder name(String name)

The unique name to give to your cluster.

The name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphanumeric character and can't be longer than 100 characters. The name must be unique within the AWS Region and AWS account that you're creating the cluster in. Note that underscores can't be used in AWS CloudFormation .

Parameters:

name - The unique name to give to your cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-name

outpostConfig

@Stability(Stable)
public CfnCluster.Builder outpostConfig(IResolvable outpostConfig)

An object representing the configuration of your local Amazon EKS cluster on an AWS Outpost.

This object isn't available for clusters on the AWS cloud.

Parameters:

outpostConfig - An object representing the configuration of your local Amazon EKS cluster on an AWS Outpost. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-outpostconfig

outpostConfig

@Stability(Stable)
public CfnCluster.Builder outpostConfig(CfnCluster.OutpostConfigProperty outpostConfig)

An object representing the configuration of your local Amazon EKS cluster on an AWS Outpost.

This object isn't available for clusters on the AWS cloud.

Parameters:

outpostConfig - An object representing the configuration of your local Amazon EKS cluster on an AWS Outpost. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-outpostconfig

remoteNetworkConfig

@Stability(Stable)
public CfnCluster.Builder remoteNetworkConfig(IResolvable remoteNetworkConfig)

The configuration in the cluster for EKS Hybrid Nodes.

You can't change or update this configuration after the cluster is created.

Parameters:

remoteNetworkConfig - The configuration in the cluster for EKS Hybrid Nodes. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-remotenetworkconfig

remoteNetworkConfig

@Stability(Stable)
public CfnCluster.Builder remoteNetworkConfig(CfnCluster.RemoteNetworkConfigProperty remoteNetworkConfig)

The configuration in the cluster for EKS Hybrid Nodes.

You can't change or update this configuration after the cluster is created.

Parameters:

remoteNetworkConfig - The configuration in the cluster for EKS Hybrid Nodes. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-remotenetworkconfig

storageConfig

@Stability(Stable)
public CfnCluster.Builder storageConfig(IResolvable storageConfig)

Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster.

For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your AWS account. For more information, see EKS Auto Mode block storage capability in the Amazon EKS User Guide .

Parameters:

storageConfig - Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-storageconfig

storageConfig

@Stability(Stable)
public CfnCluster.Builder storageConfig(CfnCluster.StorageConfigProperty storageConfig)

Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster.

For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your AWS account. For more information, see EKS Auto Mode block storage capability in the Amazon EKS User Guide .

Parameters:

storageConfig - Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-storageconfig

tags

@Stability(Stable)
public CfnCluster.Builder tags(List<? extends CfnTag> tags)

The metadata that you apply to the cluster to assist with categorization and organization.

Each tag consists of a key and an optional value, both of which you define. Cluster tags don't propagate to any other resources associated with the cluster.

You must have the eks:TagResource and eks:UntagResource permissions for your IAM principal to manage the AWS CloudFormation stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update.

Parameters:

tags - The metadata that you apply to the cluster to assist with categorization and organization. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-tags

upgradePolicy

@Stability(Stable)
public CfnCluster.Builder upgradePolicy(IResolvable upgradePolicy)

This value indicates if extended support is enabled or disabled for the cluster.

Learn more about EKS Extended Support in the Amazon EKS User Guide .

Parameters:

upgradePolicy - This value indicates if extended support is enabled or disabled for the cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-upgradepolicy

upgradePolicy

@Stability(Stable)
public CfnCluster.Builder upgradePolicy(CfnCluster.UpgradePolicyProperty upgradePolicy)

This value indicates if extended support is enabled or disabled for the cluster.

Learn more about EKS Extended Support in the Amazon EKS User Guide .

Parameters:

upgradePolicy - This value indicates if extended support is enabled or disabled for the cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-upgradepolicy

version

@Stability(Stable)
public CfnCluster.Builder version(String version)

The desired Kubernetes version for your cluster.

If you don't specify a value here, the default version available in Amazon EKS is used.

The default version might not be the latest version available.

Parameters:

version - The desired Kubernetes version for your cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-version

zonalShiftConfig

@Stability(Stable)
public CfnCluster.Builder zonalShiftConfig(IResolvable zonalShiftConfig)

The configuration for zonal shift for the cluster.

Parameters:

zonalShiftConfig - The configuration for zonal shift for the cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-zonalshiftconfig

zonalShiftConfig

@Stability(Stable)
public CfnCluster.Builder zonalShiftConfig(CfnCluster.ZonalShiftConfigProperty zonalShiftConfig)

The configuration for zonal shift for the cluster.

Parameters:

zonalShiftConfig - The configuration for zonal shift for the cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-zonalshiftconfig

build

@Stability(Stable)
public CfnCluster build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnCluster>

Returns:

a newly built instance of CfnCluster.