Interface CfnClusterProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnClusterProps.Jsii$Proxy
CfnCluster.
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.*;
CfnClusterProps cfnClusterProps = CfnClusterProps.builder()
.resourcesVpcConfig(ResourcesVpcConfigProperty.builder()
.subnetIds(List.of("subnetIds"))
// the properties below are optional
.endpointPrivateAccess(false)
.endpointPublicAccess(false)
.publicAccessCidrs(List.of("publicAccessCidrs"))
.securityGroupIds(List.of("securityGroupIds"))
.build())
.roleArn("roleArn")
// the properties below are optional
.accessConfig(AccessConfigProperty.builder()
.authenticationMode("authenticationMode")
.bootstrapClusterCreatorAdminPermissions(false)
.build())
.bootstrapSelfManagedAddons(false)
.computeConfig(ComputeConfigProperty.builder()
.enabled(false)
.nodePools(List.of("nodePools"))
.nodeRoleArn("nodeRoleArn")
.build())
.deletionProtection(false)
.encryptionConfig(List.of(EncryptionConfigProperty.builder()
.provider(ProviderProperty.builder()
.keyArn("keyArn")
.build())
.resources(List.of("resources"))
.build()))
.force(false)
.kubernetesNetworkConfig(KubernetesNetworkConfigProperty.builder()
.elasticLoadBalancing(ElasticLoadBalancingProperty.builder()
.enabled(false)
.build())
.ipFamily("ipFamily")
.serviceIpv4Cidr("serviceIpv4Cidr")
.serviceIpv6Cidr("serviceIpv6Cidr")
.build())
.logging(LoggingProperty.builder()
.clusterLogging(ClusterLoggingProperty.builder()
.enabledTypes(List.of(LoggingTypeConfigProperty.builder()
.type("type")
.build()))
.build())
.build())
.name("name")
.outpostConfig(OutpostConfigProperty.builder()
.controlPlaneInstanceType("controlPlaneInstanceType")
.outpostArns(List.of("outpostArns"))
// the properties below are optional
.controlPlanePlacement(ControlPlanePlacementProperty.builder()
.groupName("groupName")
.build())
.build())
.remoteNetworkConfig(RemoteNetworkConfigProperty.builder()
.remoteNodeNetworks(List.of(RemoteNodeNetworkProperty.builder()
.cidrs(List.of("cidrs"))
.build()))
// the properties below are optional
.remotePodNetworks(List.of(RemotePodNetworkProperty.builder()
.cidrs(List.of("cidrs"))
.build()))
.build())
.storageConfig(StorageConfigProperty.builder()
.blockStorage(BlockStorageProperty.builder()
.enabled(false)
.build())
.build())
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.upgradePolicy(UpgradePolicyProperty.builder()
.supportType("supportType")
.build())
.version("version")
.zonalShiftConfig(ZonalShiftConfigProperty.builder()
.enabled(false)
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnClusterPropsstatic final classAn implementation forCfnClusterProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnClusterProps.Builderbuilder()default ObjectThe access configuration for the cluster.default ObjectIf you set this value toFalsewhen creating a cluster, the default networking add-ons will not be installed.default ObjectIndicates the current configuration of the compute capability on your EKS Auto Mode cluster.default ObjectThe current deletion protection setting for the cluster.default ObjectThe encryption configuration for the cluster.default ObjectgetForce()Set this value totrueto override upgrade-blocking readiness checks when updating a cluster.default ObjectThe Kubernetes network configuration for the cluster.default ObjectThe logging configuration for your cluster.default StringgetName()The unique name to give to your cluster.default ObjectAn object representing the configuration of your local Amazon EKS cluster on an AWS Outpost.default ObjectThe configuration in the cluster for EKS Hybrid Nodes.The VPC configuration that's used by the cluster control plane.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.default ObjectIndicates the current configuration of the block storage capability on your EKS Auto Mode cluster.getTags()The metadata that you apply to the cluster to assist with categorization and organization.default ObjectThis value indicates if extended support is enabled or disabled for the cluster.default StringThe desired Kubernetes version for your cluster.default ObjectThe configuration for zonal shift for the cluster.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getResourcesVpcConfig
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 union: either
IResolvableorCfnCluster.ResourcesVpcConfigProperty- See Also:
-
getRoleArn
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 .
- See Also:
-
getAccessConfig
The access configuration for the cluster.Returns union: either
IResolvableorCfnCluster.AccessConfigProperty- See Also:
-
getBootstrapSelfManagedAddons
If you set this value toFalsewhen creating a cluster, the default networking add-ons will not be installed.The default networking add-ons include
vpc-cni,coredns, andkube-proxy.Use this option when you plan to install third-party alternative add-ons or self-manage the default networking add-ons.
Returns union: either
BooleanorIResolvable- See Also:
-
getComputeConfig
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 union: either
IResolvableorCfnCluster.ComputeConfigProperty- See Also:
-
getDeletionProtection
The current deletion protection setting for the cluster.When
true, deletion protection is enabled and the cluster cannot be deleted until protection is disabled. Whenfalse, the cluster can be deleted normally. This setting only applies to clusters in an active state.Returns union: either
BooleanorIResolvable- See Also:
-
getEncryptionConfig
The encryption configuration for the cluster.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnCluster.EncryptionConfigProperty>- See Also:
-
getForce
Set this value totrueto override upgrade-blocking readiness checks when updating a cluster.Returns union: either
BooleanorIResolvableDefault: - false
- See Also:
-
getKubernetesNetworkConfig
The Kubernetes network configuration for the cluster.Returns union: either
IResolvableorCfnCluster.KubernetesNetworkConfigProperty- See Also:
-
getLogging
The logging configuration for your cluster.Returns union: either
IResolvableorCfnCluster.LoggingProperty- See Also:
-
getName
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 .
- See Also:
-
getOutpostConfig
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 union: either
IResolvableorCfnCluster.OutpostConfigProperty- See Also:
-
getRemoteNetworkConfig
The configuration in the cluster for EKS Hybrid Nodes.You can add, change, or remove this configuration after the cluster is created.
Returns union: either
IResolvableorCfnCluster.RemoteNetworkConfigProperty- See Also:
-
getStorageConfig
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 union: either
IResolvableorCfnCluster.StorageConfigProperty- See Also:
-
getTags
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:TagResourceandeks:UntagResourcepermissions 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.- See Also:
-
getUpgradePolicy
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 union: either
IResolvableorCfnCluster.UpgradePolicyProperty- See Also:
-
getVersion
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.
- See Also:
-
getZonalShiftConfig
The configuration for zonal shift for the cluster.Returns union: either
IResolvableorCfnCluster.ZonalShiftConfigProperty- See Also:
-
builder
- Returns:
- a
CfnClusterProps.BuilderofCfnClusterProps
-