software.amazon.awscdk.services.eks

Interface CfnNodegroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnNodegroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:06.349Z")
 @Stability(value=Stable)
public interface CfnNodegroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::EKS::Nodegroup`.

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.*;
 Object labels;
 Object tags;
 CfnNodegroupProps cfnNodegroupProps = CfnNodegroupProps.builder()
         .clusterName("clusterName")
         .nodeRole("nodeRole")
         .subnets(List.of("subnets"))
         // the properties below are optional
         .amiType("amiType")
         .capacityType("capacityType")
         .diskSize(123)
         .forceUpdateEnabled(false)
         .instanceTypes(List.of("instanceTypes"))
         .labels(labels)
         .launchTemplate(LaunchTemplateSpecificationProperty.builder()
                 .id("id")
                 .name("name")
                 .version("version")
                 .build())
         .nodegroupName("nodegroupName")
         .releaseVersion("releaseVersion")
         .remoteAccess(RemoteAccessProperty.builder()
                 .ec2SshKey("ec2SshKey")
                 // the properties below are optional
                 .sourceSecurityGroups(List.of("sourceSecurityGroups"))
                 .build())
         .scalingConfig(ScalingConfigProperty.builder()
                 .desiredSize(123)
                 .maxSize(123)
                 .minSize(123)
                 .build())
         .tags(tags)
         .taints(List.of(TaintProperty.builder()
                 .effect("effect")
                 .key("key")
                 .value("value")
                 .build()))
         .updateConfig(UpdateConfigProperty.builder()
                 .maxUnavailable(123)
                 .maxUnavailablePercentage(123)
                 .build())
         .version("version")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnNodegroupProps.Builder	builder()
default String	getAmiType() `AWS::EKS::Nodegroup.AmiType`.
default String	getCapacityType() `AWS::EKS::Nodegroup.CapacityType`.
String	getClusterName() `AWS::EKS::Nodegroup.ClusterName`.
default Number	getDiskSize() `AWS::EKS::Nodegroup.DiskSize`.
default Object	getForceUpdateEnabled() `AWS::EKS::Nodegroup.ForceUpdateEnabled`.
default List<String>	getInstanceTypes() `AWS::EKS::Nodegroup.InstanceTypes`.
default Object	getLabels() `AWS::EKS::Nodegroup.Labels`.
default Object	getLaunchTemplate() `AWS::EKS::Nodegroup.LaunchTemplate`.
default String	getNodegroupName() `AWS::EKS::Nodegroup.NodegroupName`.
String	getNodeRole() `AWS::EKS::Nodegroup.NodeRole`.
default String	getReleaseVersion() `AWS::EKS::Nodegroup.ReleaseVersion`.
default Object	getRemoteAccess() `AWS::EKS::Nodegroup.RemoteAccess`.
default Object	getScalingConfig() `AWS::EKS::Nodegroup.ScalingConfig`.
List<String>	getSubnets() `AWS::EKS::Nodegroup.Subnets`.
default Object	getTags() `AWS::EKS::Nodegroup.Tags`.
default Object	getTaints() `AWS::EKS::Nodegroup.Taints`.
default Object	getUpdateConfig() `AWS::EKS::Nodegroup.UpdateConfig`.
default String	getVersion() `AWS::EKS::Nodegroup.Version`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAmiType

@Stability(value=Stable)
 @Nullable
default String getAmiType()

`AWS::EKS::Nodegroup.AmiType`.

getCapacityType

@Stability(value=Stable)
 @Nullable
default String getCapacityType()

`AWS::EKS::Nodegroup.CapacityType`.

getClusterName

@Stability(value=Stable)
 @NotNull
String getClusterName()

`AWS::EKS::Nodegroup.ClusterName`.

getDiskSize

@Stability(value=Stable)
 @Nullable
default Number getDiskSize()

`AWS::EKS::Nodegroup.DiskSize`.

getForceUpdateEnabled

@Stability(value=Stable)
 @Nullable
default Object getForceUpdateEnabled()

`AWS::EKS::Nodegroup.ForceUpdateEnabled`.

getInstanceTypes

@Stability(value=Stable)
 @Nullable
default List<String> getInstanceTypes()

`AWS::EKS::Nodegroup.InstanceTypes`.

getLabels

@Stability(value=Stable)
 @Nullable
default Object getLabels()

`AWS::EKS::Nodegroup.Labels`.

getLaunchTemplate

@Stability(value=Stable)
 @Nullable
default Object getLaunchTemplate()

`AWS::EKS::Nodegroup.LaunchTemplate`.

getNodegroupName

@Stability(value=Stable)
 @Nullable
default String getNodegroupName()

`AWS::EKS::Nodegroup.NodegroupName`.

getNodeRole

@Stability(value=Stable)
 @NotNull
String getNodeRole()

`AWS::EKS::Nodegroup.NodeRole`.

getReleaseVersion

@Stability(value=Stable)
 @Nullable
default String getReleaseVersion()

`AWS::EKS::Nodegroup.ReleaseVersion`.

getRemoteAccess

@Stability(value=Stable)
 @Nullable
default Object getRemoteAccess()

`AWS::EKS::Nodegroup.RemoteAccess`.

getScalingConfig

@Stability(value=Stable)
 @Nullable
default Object getScalingConfig()

`AWS::EKS::Nodegroup.ScalingConfig`.

getSubnets

@Stability(value=Stable)
 @NotNull
List<String> getSubnets()

`AWS::EKS::Nodegroup.Subnets`.

getTags

@Stability(value=Stable)
 @Nullable
default Object getTags()

`AWS::EKS::Nodegroup.Tags`.

getTaints

@Stability(value=Stable)
 @Nullable
default Object getTaints()

`AWS::EKS::Nodegroup.Taints`.

getUpdateConfig

@Stability(value=Stable)
 @Nullable
default Object getUpdateConfig()

`AWS::EKS::Nodegroup.UpdateConfig`.

getVersion

@Stability(value=Stable)
 @Nullable
default String getVersion()

`AWS::EKS::Nodegroup.Version`.

builder

@Stability(value=Stable)
static CfnNodegroupProps.Builder builder()

Returns:

a CfnNodegroupProps.Builder of CfnNodegroupProps