Package software.amazon.awscdk.cfnpropertymixins.services.eks

Class CfnClusterMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.eks.CfnClusterMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnClusterMixinProps>

Enclosing interface:

CfnClusterMixinProps

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

A builder for CfnClusterMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnClusterMixinProps.Builder	accessConfig(CfnClusterPropsMixin.AccessConfigProperty accessConfig)	Sets the value of CfnClusterMixinProps.getAccessConfig()
CfnClusterMixinProps.Builder	accessConfig(IResolvable accessConfig)	Sets the value of CfnClusterMixinProps.getAccessConfig()
CfnClusterMixinProps.Builder	bootstrapSelfManagedAddons(Boolean bootstrapSelfManagedAddons)	Sets the value of CfnClusterMixinProps.getBootstrapSelfManagedAddons()
CfnClusterMixinProps.Builder	bootstrapSelfManagedAddons(IResolvable bootstrapSelfManagedAddons)	Sets the value of CfnClusterMixinProps.getBootstrapSelfManagedAddons()
CfnClusterMixinProps	build()	Builds the configured instance.
CfnClusterMixinProps.Builder	computeConfig(CfnClusterPropsMixin.ComputeConfigProperty computeConfig)	Sets the value of CfnClusterMixinProps.getComputeConfig()
CfnClusterMixinProps.Builder	computeConfig(IResolvable computeConfig)	Sets the value of CfnClusterMixinProps.getComputeConfig()
CfnClusterMixinProps.Builder	controlPlaneScalingConfig(CfnClusterPropsMixin.ControlPlaneScalingConfigProperty controlPlaneScalingConfig)	Sets the value of CfnClusterMixinProps.getControlPlaneScalingConfig()
CfnClusterMixinProps.Builder	controlPlaneScalingConfig(IResolvable controlPlaneScalingConfig)	Sets the value of CfnClusterMixinProps.getControlPlaneScalingConfig()
CfnClusterMixinProps.Builder	deletionProtection(Boolean deletionProtection)	Sets the value of CfnClusterMixinProps.getDeletionProtection()
CfnClusterMixinProps.Builder	deletionProtection(IResolvable deletionProtection)	Sets the value of CfnClusterMixinProps.getDeletionProtection()
CfnClusterMixinProps.Builder	encryptionConfig(List<? extends Object> encryptionConfig)	Sets the value of CfnClusterMixinProps.getEncryptionConfig()
CfnClusterMixinProps.Builder	encryptionConfig(IResolvable encryptionConfig)	Sets the value of CfnClusterMixinProps.getEncryptionConfig()
CfnClusterMixinProps.Builder	force(Boolean force)	Sets the value of CfnClusterMixinProps.getForce()
CfnClusterMixinProps.Builder	force(IResolvable force)	Sets the value of CfnClusterMixinProps.getForce()
CfnClusterMixinProps.Builder	kubernetesNetworkConfig(CfnClusterPropsMixin.KubernetesNetworkConfigProperty kubernetesNetworkConfig)	Sets the value of CfnClusterMixinProps.getKubernetesNetworkConfig()
CfnClusterMixinProps.Builder	kubernetesNetworkConfig(IResolvable kubernetesNetworkConfig)	Sets the value of CfnClusterMixinProps.getKubernetesNetworkConfig()
CfnClusterMixinProps.Builder	logging(CfnClusterPropsMixin.LoggingProperty logging)	Sets the value of CfnClusterMixinProps.getLogging()
CfnClusterMixinProps.Builder	logging(IResolvable logging)	Sets the value of CfnClusterMixinProps.getLogging()
CfnClusterMixinProps.Builder	name(String name)	Sets the value of CfnClusterMixinProps.getName()
CfnClusterMixinProps.Builder	outpostConfig(CfnClusterPropsMixin.OutpostConfigProperty outpostConfig)	Sets the value of CfnClusterMixinProps.getOutpostConfig()
CfnClusterMixinProps.Builder	outpostConfig(IResolvable outpostConfig)	Sets the value of CfnClusterMixinProps.getOutpostConfig()
CfnClusterMixinProps.Builder	remoteNetworkConfig(CfnClusterPropsMixin.RemoteNetworkConfigProperty remoteNetworkConfig)	Sets the value of CfnClusterMixinProps.getRemoteNetworkConfig()
CfnClusterMixinProps.Builder	remoteNetworkConfig(IResolvable remoteNetworkConfig)	Sets the value of CfnClusterMixinProps.getRemoteNetworkConfig()
CfnClusterMixinProps.Builder	resourcesVpcConfig(CfnClusterPropsMixin.ResourcesVpcConfigProperty resourcesVpcConfig)	Sets the value of CfnClusterMixinProps.getResourcesVpcConfig()
CfnClusterMixinProps.Builder	resourcesVpcConfig(IResolvable resourcesVpcConfig)	Sets the value of CfnClusterMixinProps.getResourcesVpcConfig()
CfnClusterMixinProps.Builder	roleArn(String roleArn)	Sets the value of CfnClusterMixinProps.getRoleArn()
CfnClusterMixinProps.Builder	roleArn(IRoleRef roleArn)	Sets the value of CfnClusterMixinProps.getRoleArn()
CfnClusterMixinProps.Builder	storageConfig(CfnClusterPropsMixin.StorageConfigProperty storageConfig)	Sets the value of CfnClusterMixinProps.getStorageConfig()
CfnClusterMixinProps.Builder	storageConfig(IResolvable storageConfig)	Sets the value of CfnClusterMixinProps.getStorageConfig()
CfnClusterMixinProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnClusterMixinProps.getTags()
CfnClusterMixinProps.Builder	upgradePolicy(CfnClusterPropsMixin.UpgradePolicyProperty upgradePolicy)	Sets the value of CfnClusterMixinProps.getUpgradePolicy()
CfnClusterMixinProps.Builder	upgradePolicy(IResolvable upgradePolicy)	Sets the value of CfnClusterMixinProps.getUpgradePolicy()
CfnClusterMixinProps.Builder	version(String version)	Sets the value of CfnClusterMixinProps.getVersion()
CfnClusterMixinProps.Builder	zonalShiftConfig(CfnClusterPropsMixin.ZonalShiftConfigProperty zonalShiftConfig)	Sets the value of CfnClusterMixinProps.getZonalShiftConfig()
CfnClusterMixinProps.Builder	zonalShiftConfig(IResolvable zonalShiftConfig)	Sets the value of CfnClusterMixinProps.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

accessConfig

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

Sets the value of CfnClusterMixinProps.getAccessConfig()

Parameters:

accessConfig - The access configuration for the cluster.

Returns:

this

accessConfig

@Stability(Stable)
public CfnClusterMixinProps.Builder accessConfig(CfnClusterPropsMixin.AccessConfigProperty accessConfig)

Sets the value of CfnClusterMixinProps.getAccessConfig()

Parameters:

accessConfig - The access configuration for the cluster.

Returns:

this

bootstrapSelfManagedAddons

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

Sets the value of CfnClusterMixinProps.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 add-ons 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 CfnClusterMixinProps.Builder bootstrapSelfManagedAddons(IResolvable bootstrapSelfManagedAddons)

Sets the value of CfnClusterMixinProps.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 add-ons 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

computeConfig

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

Sets the value of CfnClusterMixinProps.getComputeConfig()

Parameters:

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 .

Returns:

this

computeConfig

@Stability(Stable)
public CfnClusterMixinProps.Builder computeConfig(CfnClusterPropsMixin.ComputeConfigProperty computeConfig)

Sets the value of CfnClusterMixinProps.getComputeConfig()

Parameters:

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 .

Returns:

this

controlPlaneScalingConfig

@Stability(Stable)
public CfnClusterMixinProps.Builder controlPlaneScalingConfig(IResolvable controlPlaneScalingConfig)

Sets the value of CfnClusterMixinProps.getControlPlaneScalingConfig()

Parameters:

controlPlaneScalingConfig - The control plane scaling tier configuration. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide.

Returns:

this

controlPlaneScalingConfig

@Stability(Stable)
public CfnClusterMixinProps.Builder controlPlaneScalingConfig(CfnClusterPropsMixin.ControlPlaneScalingConfigProperty controlPlaneScalingConfig)

Sets the value of CfnClusterMixinProps.getControlPlaneScalingConfig()

Parameters:

controlPlaneScalingConfig - The control plane scaling tier configuration. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide.

Returns:

this

deletionProtection

@Stability(Stable)
public CfnClusterMixinProps.Builder deletionProtection(Boolean deletionProtection)

Sets the value of CfnClusterMixinProps.getDeletionProtection()

Parameters:

deletionProtection - The current deletion protection setting for the cluster. When true , deletion protection is enabled and the cluster cannot be deleted until protection is disabled. When false , the cluster can be deleted normally. This setting only applies to clusters in an active state.

Returns:

this

deletionProtection

@Stability(Stable)
public CfnClusterMixinProps.Builder deletionProtection(IResolvable deletionProtection)

Sets the value of CfnClusterMixinProps.getDeletionProtection()

Parameters:

deletionProtection - The current deletion protection setting for the cluster. When true , deletion protection is enabled and the cluster cannot be deleted until protection is disabled. When false , the cluster can be deleted normally. This setting only applies to clusters in an active state.

Returns:

this

encryptionConfig

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

Sets the value of CfnClusterMixinProps.getEncryptionConfig()

Parameters:

encryptionConfig - The encryption configuration for the cluster.

Returns:

this

encryptionConfig

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

Sets the value of CfnClusterMixinProps.getEncryptionConfig()

Parameters:

encryptionConfig - The encryption configuration for the cluster.

Returns:

this

force

@Stability(Stable)
public CfnClusterMixinProps.Builder force(Boolean force)

Sets the value of CfnClusterMixinProps.getForce()

Parameters:

force - Set this value to true to override upgrade-blocking readiness checks when updating a cluster.

Returns:

this

force

@Stability(Stable)
public CfnClusterMixinProps.Builder force(IResolvable force)

Sets the value of CfnClusterMixinProps.getForce()

Parameters:

force - Set this value to true to override upgrade-blocking readiness checks when updating a cluster.

Returns:

this

kubernetesNetworkConfig

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

Sets the value of CfnClusterMixinProps.getKubernetesNetworkConfig()

Parameters:

kubernetesNetworkConfig - The Kubernetes network configuration for the cluster.

Returns:

this

kubernetesNetworkConfig

@Stability(Stable)
public CfnClusterMixinProps.Builder kubernetesNetworkConfig(CfnClusterPropsMixin.KubernetesNetworkConfigProperty kubernetesNetworkConfig)

Sets the value of CfnClusterMixinProps.getKubernetesNetworkConfig()

Parameters:

kubernetesNetworkConfig - The Kubernetes network configuration for the cluster.

Returns:

this

logging

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

Sets the value of CfnClusterMixinProps.getLogging()

Parameters:

logging - The logging configuration for your cluster.

Returns:

this

logging

@Stability(Stable)
public CfnClusterMixinProps.Builder logging(CfnClusterPropsMixin.LoggingProperty logging)

Sets the value of CfnClusterMixinProps.getLogging()

Parameters:

logging - The logging configuration for your cluster.

Returns:

this

name

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

Sets the value of CfnClusterMixinProps.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 CloudFormation .

Returns:

this

outpostConfig

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

Sets the value of CfnClusterMixinProps.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 CfnClusterMixinProps.Builder outpostConfig(CfnClusterPropsMixin.OutpostConfigProperty outpostConfig)

Sets the value of CfnClusterMixinProps.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

remoteNetworkConfig

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

Sets the value of CfnClusterMixinProps.getRemoteNetworkConfig()

Parameters:

remoteNetworkConfig - The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.

Returns:

this

remoteNetworkConfig

@Stability(Stable)
public CfnClusterMixinProps.Builder remoteNetworkConfig(CfnClusterPropsMixin.RemoteNetworkConfigProperty remoteNetworkConfig)

Sets the value of CfnClusterMixinProps.getRemoteNetworkConfig()

Parameters:

remoteNetworkConfig - The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.

Returns:

this

resourcesVpcConfig

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

Sets the value of CfnClusterMixinProps.getResourcesVpcConfig()

Parameters:

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.

Returns:

this

resourcesVpcConfig

@Stability(Stable)
public CfnClusterMixinProps.Builder resourcesVpcConfig(CfnClusterPropsMixin.ResourcesVpcConfigProperty resourcesVpcConfig)

Sets the value of CfnClusterMixinProps.getResourcesVpcConfig()

Parameters:

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.

Returns:

this

roleArn

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

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

Returns:

this

roleArn

@Stability(Stable)
public CfnClusterMixinProps.Builder roleArn(IRoleRef roleArn)

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

Returns:

this

storageConfig

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

Sets the value of CfnClusterMixinProps.getStorageConfig()

Parameters:

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 .

Returns:

this

storageConfig

@Stability(Stable)
public CfnClusterMixinProps.Builder storageConfig(CfnClusterPropsMixin.StorageConfigProperty storageConfig)

Sets the value of CfnClusterMixinProps.getStorageConfig()

Parameters:

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 .

Returns:

this

tags

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

Sets the value of CfnClusterMixinProps.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 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 CfnClusterMixinProps.Builder upgradePolicy(IResolvable upgradePolicy)

Sets the value of CfnClusterMixinProps.getUpgradePolicy()

Parameters:

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 .

Returns:

this

upgradePolicy

@Stability(Stable)
public CfnClusterMixinProps.Builder upgradePolicy(CfnClusterPropsMixin.UpgradePolicyProperty upgradePolicy)

Sets the value of CfnClusterMixinProps.getUpgradePolicy()

Parameters:

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 .

Returns:

this

version

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

Sets the value of CfnClusterMixinProps.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 CfnClusterMixinProps.Builder zonalShiftConfig(IResolvable zonalShiftConfig)

Sets the value of CfnClusterMixinProps.getZonalShiftConfig()

Parameters:

zonalShiftConfig - The configuration for zonal shift for the cluster.

Returns:

this

zonalShiftConfig

@Stability(Stable)
public CfnClusterMixinProps.Builder zonalShiftConfig(CfnClusterPropsMixin.ZonalShiftConfigProperty zonalShiftConfig)

Sets the value of CfnClusterMixinProps.getZonalShiftConfig()

Parameters:

zonalShiftConfig - The configuration for zonal shift for the cluster.

Returns:

this

build

@Stability(Stable)
public CfnClusterMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnClusterMixinProps

Throws:

NullPointerException - if any required attribute was not provided