CfnNodegroupProps

class aws_cdk.aws_eks.CfnNodegroupProps(*, ami_type=None, capacity_type=None, cluster_name, disk_size=None, force_update_enabled=None, instance_types=None, labels=None, launch_template=None, nodegroup_name=None, node_role, release_version=None, remote_access=None, scaling_config=None, subnets, tags=None, taints=None, update_config=None, version=None)

Bases: object

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

Parameters
  • ami_type (Optional[str]) – AWS::EKS::Nodegroup.AmiType.

  • capacity_type (Optional[str]) – AWS::EKS::Nodegroup.CapacityType.

  • cluster_name (str) – AWS::EKS::Nodegroup.ClusterName.

  • disk_size (Union[int, float, None]) – AWS::EKS::Nodegroup.DiskSize.

  • force_update_enabled (Union[bool, IResolvable, None]) – AWS::EKS::Nodegroup.ForceUpdateEnabled.

  • instance_types (Optional[Sequence[str]]) – AWS::EKS::Nodegroup.InstanceTypes.

  • labels (Optional[Any]) – AWS::EKS::Nodegroup.Labels.

  • launch_template (Union[IResolvable, LaunchTemplateSpecificationProperty, None]) – AWS::EKS::Nodegroup.LaunchTemplate.

  • nodegroup_name (Optional[str]) – AWS::EKS::Nodegroup.NodegroupName.

  • node_role (str) – AWS::EKS::Nodegroup.NodeRole.

  • release_version (Optional[str]) – AWS::EKS::Nodegroup.ReleaseVersion.

  • remote_access (Union[IResolvable, RemoteAccessProperty, None]) – AWS::EKS::Nodegroup.RemoteAccess.

  • scaling_config (Union[IResolvable, ScalingConfigProperty, None]) – AWS::EKS::Nodegroup.ScalingConfig.

  • subnets (Sequence[str]) – AWS::EKS::Nodegroup.Subnets.

  • tags (Optional[Any]) – AWS::EKS::Nodegroup.Tags.

  • taints (Union[IResolvable, Sequence[Union[IResolvable, TaintProperty]], None]) – AWS::EKS::Nodegroup.Taints.

  • update_config (Union[IResolvable, UpdateConfigProperty, None]) – AWS::EKS::Nodegroup.UpdateConfig.

  • version (Optional[str]) – AWS::EKS::Nodegroup.Version.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_eks as eks

# labels is of type object
# tags is of type object

cfn_nodegroup_props = eks.CfnNodegroupProps(
    cluster_name="clusterName",
    node_role="nodeRole",
    subnets=["subnets"],

    # the properties below are optional
    ami_type="amiType",
    capacity_type="capacityType",
    disk_size=123,
    force_update_enabled=False,
    instance_types=["instanceTypes"],
    labels=labels,
    launch_template=eks.CfnNodegroup.LaunchTemplateSpecificationProperty(
        id="id",
        name="name",
        version="version"
    ),
    nodegroup_name="nodegroupName",
    release_version="releaseVersion",
    remote_access=eks.CfnNodegroup.RemoteAccessProperty(
        ec2_ssh_key="ec2SshKey",

        # the properties below are optional
        source_security_groups=["sourceSecurityGroups"]
    ),
    scaling_config=eks.CfnNodegroup.ScalingConfigProperty(
        desired_size=123,
        max_size=123,
        min_size=123
    ),
    tags=tags,
    taints=[eks.CfnNodegroup.TaintProperty(
        effect="effect",
        key="key",
        value="value"
    )],
    update_config=eks.CfnNodegroup.UpdateConfigProperty(
        max_unavailable=123,
        max_unavailable_percentage=123
    ),
    version="version"
)

Attributes

ami_type

AWS::EKS::Nodegroup.AmiType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-amitype

Return type

Optional[str]

capacity_type

AWS::EKS::Nodegroup.CapacityType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-capacitytype

Return type

Optional[str]

cluster_name

AWS::EKS::Nodegroup.ClusterName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-clustername

Return type

str

disk_size

AWS::EKS::Nodegroup.DiskSize.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-disksize

Return type

Union[int, float, None]

force_update_enabled

AWS::EKS::Nodegroup.ForceUpdateEnabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-forceupdateenabled

Return type

Union[bool, IResolvable, None]

instance_types

AWS::EKS::Nodegroup.InstanceTypes.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes

Return type

Optional[List[str]]

labels

AWS::EKS::Nodegroup.Labels.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-labels

Return type

Any

launch_template

AWS::EKS::Nodegroup.LaunchTemplate.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-launchtemplate

Return type

Union[IResolvable, LaunchTemplateSpecificationProperty, None]

node_role

AWS::EKS::Nodegroup.NodeRole.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-noderole

Return type

str

nodegroup_name

AWS::EKS::Nodegroup.NodegroupName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-nodegroupname

Return type

Optional[str]

release_version

AWS::EKS::Nodegroup.ReleaseVersion.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-releaseversion

Return type

Optional[str]

remote_access

AWS::EKS::Nodegroup.RemoteAccess.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-remoteaccess

Return type

Union[IResolvable, RemoteAccessProperty, None]

scaling_config

AWS::EKS::Nodegroup.ScalingConfig.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-scalingconfig

Return type

Union[IResolvable, ScalingConfigProperty, None]

subnets

AWS::EKS::Nodegroup.Subnets.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-subnets

Return type

List[str]

tags

AWS::EKS::Nodegroup.Tags.

Link

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

Return type

Any

taints

AWS::EKS::Nodegroup.Taints.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-taints

Return type

Union[IResolvable, List[Union[IResolvable, TaintProperty]], None]

update_config

AWS::EKS::Nodegroup.UpdateConfig.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-updateconfig

Return type

Union[IResolvable, UpdateConfigProperty, None]

version

AWS::EKS::Nodegroup.Version.

Link

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

Return type

Optional[str]