Package software.amazon.awscdk.services.eks

Class CfnClusterProps.Builder

java.lang.Object

software.amazon.awscdk.services.eks.CfnClusterProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnClusterProps>

Enclosing interface:

CfnClusterProps

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

A builder for CfnClusterProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnClusterProps.Builder	accessConfig(IResolvable accessConfig)	Sets the value of CfnClusterProps.getAccessConfig()
CfnClusterProps.Builder	accessConfig(CfnCluster.AccessConfigProperty accessConfig)	Sets the value of CfnClusterProps.getAccessConfig()
CfnClusterProps.Builder	bootstrapSelfManagedAddons(Boolean bootstrapSelfManagedAddons)	Sets the value of CfnClusterProps.getBootstrapSelfManagedAddons()
CfnClusterProps.Builder	bootstrapSelfManagedAddons(IResolvable bootstrapSelfManagedAddons)	Sets the value of CfnClusterProps.getBootstrapSelfManagedAddons()
CfnClusterProps	build()	Builds the configured instance.
CfnClusterProps.Builder	encryptionConfig(List<? extends Object> encryptionConfig)	Sets the value of CfnClusterProps.getEncryptionConfig()
CfnClusterProps.Builder	encryptionConfig(IResolvable encryptionConfig)	Sets the value of CfnClusterProps.getEncryptionConfig()
CfnClusterProps.Builder	kubernetesNetworkConfig(IResolvable kubernetesNetworkConfig)	Sets the value of CfnClusterProps.getKubernetesNetworkConfig()
CfnClusterProps.Builder	kubernetesNetworkConfig(CfnCluster.KubernetesNetworkConfigProperty kubernetesNetworkConfig)	Sets the value of CfnClusterProps.getKubernetesNetworkConfig()
CfnClusterProps.Builder	logging(IResolvable logging)	Sets the value of CfnClusterProps.getLogging()
CfnClusterProps.Builder	logging(CfnCluster.LoggingProperty logging)	Sets the value of CfnClusterProps.getLogging()
CfnClusterProps.Builder	name(String name)	Sets the value of CfnClusterProps.getName()
CfnClusterProps.Builder	outpostConfig(IResolvable outpostConfig)	Sets the value of CfnClusterProps.getOutpostConfig()
CfnClusterProps.Builder	outpostConfig(CfnCluster.OutpostConfigProperty outpostConfig)	Sets the value of CfnClusterProps.getOutpostConfig()
CfnClusterProps.Builder	resourcesVpcConfig(IResolvable resourcesVpcConfig)	Sets the value of CfnClusterProps.getResourcesVpcConfig()
CfnClusterProps.Builder	resourcesVpcConfig(CfnCluster.ResourcesVpcConfigProperty resourcesVpcConfig)	Sets the value of CfnClusterProps.getResourcesVpcConfig()
CfnClusterProps.Builder	roleArn(String roleArn)	Sets the value of CfnClusterProps.getRoleArn()
CfnClusterProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnClusterProps.getTags()
CfnClusterProps.Builder	upgradePolicy(IResolvable upgradePolicy)	Sets the value of CfnClusterProps.getUpgradePolicy()
CfnClusterProps.Builder	upgradePolicy(CfnCluster.UpgradePolicyProperty upgradePolicy)	Sets the value of CfnClusterProps.getUpgradePolicy()
CfnClusterProps.Builder	version(String version)	Sets the value of CfnClusterProps.getVersion()
CfnClusterProps.Builder	zonalShiftConfig(IResolvable zonalShiftConfig)	Sets the value of CfnClusterProps.getZonalShiftConfig()
CfnClusterProps.Builder	zonalShiftConfig(CfnCluster.ZonalShiftConfigProperty zonalShiftConfig)	Sets the value of CfnClusterProps.getZonalShiftConfig()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

resourcesVpcConfig

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

Sets the value of CfnClusterProps.getResourcesVpcConfig()

Parameters:

resourcesVpcConfig - The VPC configuration that's used by the cluster control plane. This parameter is required. 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.

Returns:

this

resourcesVpcConfig

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

Sets the value of CfnClusterProps.getResourcesVpcConfig()

Parameters:

resourcesVpcConfig - The VPC configuration that's used by the cluster control plane. This parameter is required. 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.

Returns:

this

roleArn

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

Sets the value of CfnClusterProps.getRoleArn()

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. For more information, see Amazon EKS Service IAM Role in the Amazon EKS User Guide .

Returns:

this

accessConfig

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

Sets the value of CfnClusterProps.getAccessConfig()

Parameters:

accessConfig - The access configuration for the cluster.

Returns:

this

accessConfig

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

Sets the value of CfnClusterProps.getAccessConfig()

Parameters:

accessConfig - The access configuration for the cluster.

Returns:

this

bootstrapSelfManagedAddons

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

Sets the value of CfnClusterProps.getBootstrapSelfManagedAddons()

Parameters:

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.

Returns:

this

bootstrapSelfManagedAddons

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

Sets the value of CfnClusterProps.getBootstrapSelfManagedAddons()

Parameters:

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.

Returns:

this

encryptionConfig

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

Sets the value of CfnClusterProps.getEncryptionConfig()

Parameters:

encryptionConfig - The encryption configuration for the cluster.

Returns:

this

encryptionConfig

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

Sets the value of CfnClusterProps.getEncryptionConfig()

Parameters:

encryptionConfig - The encryption configuration for the cluster.

Returns:

this

kubernetesNetworkConfig

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

Sets the value of CfnClusterProps.getKubernetesNetworkConfig()

Parameters:

kubernetesNetworkConfig - The Kubernetes network configuration for the cluster.

Returns:

this

kubernetesNetworkConfig

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

Sets the value of CfnClusterProps.getKubernetesNetworkConfig()

Parameters:

kubernetesNetworkConfig - The Kubernetes network configuration for the cluster.

Returns:

this

logging

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

Sets the value of CfnClusterProps.getLogging()

Parameters:

logging - The logging configuration for your cluster.

Returns:

this

logging

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

Sets the value of CfnClusterProps.getLogging()

Parameters:

logging - The logging configuration for your cluster.

Returns:

this

name

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

Sets the value of CfnClusterProps.getName()

Parameters:

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 .

Returns:

this

outpostConfig

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

Sets the value of CfnClusterProps.getOutpostConfig()

Parameters:

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.

Returns:

this

outpostConfig

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

Sets the value of CfnClusterProps.getOutpostConfig()

Parameters:

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.

Returns:

this

tags

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

Sets the value of CfnClusterProps.getTags()

Parameters:

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.

Returns:

this

upgradePolicy

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

Sets the value of CfnClusterProps.getUpgradePolicy()

Parameters:

upgradePolicy - This value indicates if extended support is enabled or disabled for the cluster. Learn more about EKS Extended Support in the EKS User Guide.

Returns:

this

upgradePolicy

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

Sets the value of CfnClusterProps.getUpgradePolicy()

Parameters:

upgradePolicy - This value indicates if extended support is enabled or disabled for the cluster. Learn more about EKS Extended Support in the EKS User Guide.

Returns:

this

version

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

Sets the value of CfnClusterProps.getVersion()

Parameters:

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.

Returns:

this

zonalShiftConfig

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

Sets the value of CfnClusterProps.getZonalShiftConfig()

Parameters:

zonalShiftConfig - The configuration for zonal shift for the cluster.

Returns:

this

zonalShiftConfig

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

Sets the value of CfnClusterProps.getZonalShiftConfig()

Parameters:

zonalShiftConfig - The configuration for zonal shift for the cluster.

Returns:

this

build

@Stability(Stable)
public CfnClusterProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnClusterProps

Throws:

NullPointerException - if any required attribute was not provided