Struct aws_sdk_eks::operation::create_nodegroup::CreateNodegroupInput

#[non_exhaustive]
pub struct CreateNodegroupInput {

    pub cluster_name: Option<String>,
    pub nodegroup_name: Option<String>,
    pub scaling_config: Option<NodegroupScalingConfig>,
    pub disk_size: Option<i32>,
    pub subnets: Option<Vec<String>>,
    pub instance_types: Option<Vec<String>>,
    pub ami_type: Option<AmiTypes>,
    pub remote_access: Option<RemoteAccessConfig>,
    pub node_role: Option<String>,
    pub labels: Option<HashMap<String, String>>,
    pub taints: Option<Vec<Taint>>,
    pub tags: Option<HashMap<String, String>>,
    pub client_request_token: Option<String>,
    pub launch_template: Option<LaunchTemplateSpecification>,
    pub update_config: Option<NodegroupUpdateConfig>,
    pub capacity_type: Option<CapacityTypes>,
    pub version: Option<String>,
    pub release_version: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

cluster_name: Option<String>

The name of your cluster.

nodegroup_name: Option<String>

The unique name to give your node group.

scaling_config: Option<NodegroupScalingConfig>

The scaling configuration details for the Auto Scaling group that is created for your node group.

disk_size: Option<i32>

The root device disk size (in GiB) for your node group instances. The default disk size is 20 GiB for Linux and Bottlerocket. The default disk size is 50 GiB for Windows. If you specify launchTemplate, then don't specify diskSize, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

subnets: Option<Vec<String>>

The subnets to use for the Auto Scaling group that is created for your node group. If you specify launchTemplate, then don't specify SubnetId in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

instance_types: Option<Vec<String>>

Specify the instance types for a node group. If you specify a GPU instance type, make sure to also specify an applicable GPU AMI type with the amiType parameter. If you specify launchTemplate, then you can specify zero or one instance type in your launch template or you can specify 0-20 instance types for instanceTypes. If however, you specify an instance type in your launch template and specify any instanceTypes, the node group deployment will fail. If you don't specify an instance type in a launch template or for instanceTypes, then t3.medium is used, by default. If you specify Spot for capacityType, then we recommend specifying multiple values for instanceTypes. For more information, see Managed node group capacity types and Launch template support in the Amazon EKS User Guide.

ami_type: Option<AmiTypes>

The AMI type for your node group. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify amiType, or the node group deployment will fail. If your launch template uses a Windows custom AMI, then add eks:kube-proxy-windows to your Windows nodes rolearn in the aws-auth ConfigMap. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

remote_access: Option<RemoteAccessConfig>

The remote access configuration to use with your node group. For Linux, the protocol is SSH. For Windows, the protocol is RDP. If you specify launchTemplate, then don't specify remoteAccess, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

node_role: Option<String>

The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The Amazon EKS worker node kubelet daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch nodes and register them into a cluster, you must create an IAM role for those nodes to use when they are launched. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide . If you specify launchTemplate, then don't specify IamInstanceProfile in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

labels: Option<HashMap<String, String>>

The Kubernetes labels to apply to the nodes in the node group when they are created.

taints: Option<Vec<Taint>>

The Kubernetes taints to be applied to the nodes in the node group. For more information, see Node taints on managed node groups.

tags: Option<HashMap<String, String>>

Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.

client_request_token: Option<String>

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

launch_template: Option<LaunchTemplateSpecification>

An object representing a node group's launch template specification. If specified, then do not specify instanceTypes, diskSize, or remoteAccess and make sure that the launch template meets the requirements in launchTemplateSpecification.

update_config: Option<NodegroupUpdateConfig>

The node group update configuration.

capacity_type: Option<CapacityTypes>

The capacity type for your node group.

version: Option<String>

The Kubernetes version to use for your managed nodes. By default, the Kubernetes version of the cluster is used, and this is the only accepted specified value. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify version, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

release_version: Option<String>

The AMI version of the Amazon EKS optimized AMI to use with your node group. By default, the latest available AMI version for the node group's current Kubernetes version is used. For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. Amazon EKS managed node groups support the November 2022 and later releases of the Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the Amazon EKS User Guide.

If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify releaseVersion, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

Implementations

impl CreateNodegroupInput

pub fn cluster_name(&self) -> Option<&str>

The name of your cluster.

pub fn nodegroup_name(&self) -> Option<&str>

The unique name to give your node group.

pub fn scaling_config(&self) -> Option<&NodegroupScalingConfig>

The scaling configuration details for the Auto Scaling group that is created for your node group.

pub fn disk_size(&self) -> Option<i32>

The root device disk size (in GiB) for your node group instances. The default disk size is 20 GiB for Linux and Bottlerocket. The default disk size is 50 GiB for Windows. If you specify launchTemplate, then don't specify diskSize, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

pub fn subnets(&self) -> &[String]

The subnets to use for the Auto Scaling group that is created for your node group. If you specify launchTemplate, then don't specify SubnetId in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .subnets.is_none().

pub fn instance_types(&self) -> &[String]

Specify the instance types for a node group. If you specify a GPU instance type, make sure to also specify an applicable GPU AMI type with the amiType parameter. If you specify launchTemplate, then you can specify zero or one instance type in your launch template or you can specify 0-20 instance types for instanceTypes. If however, you specify an instance type in your launch template and specify any instanceTypes, the node group deployment will fail. If you don't specify an instance type in a launch template or for instanceTypes, then t3.medium is used, by default. If you specify Spot for capacityType, then we recommend specifying multiple values for instanceTypes. For more information, see Managed node group capacity types and Launch template support in the Amazon EKS User Guide.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .instance_types.is_none().

pub fn ami_type(&self) -> Option<&AmiTypes>

The AMI type for your node group. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify amiType, or the node group deployment will fail. If your launch template uses a Windows custom AMI, then add eks:kube-proxy-windows to your Windows nodes rolearn in the aws-auth ConfigMap. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

pub fn remote_access(&self) -> Option<&RemoteAccessConfig>

The remote access configuration to use with your node group. For Linux, the protocol is SSH. For Windows, the protocol is RDP. If you specify launchTemplate, then don't specify remoteAccess, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

pub fn node_role(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The Amazon EKS worker node kubelet daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch nodes and register them into a cluster, you must create an IAM role for those nodes to use when they are launched. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide . If you specify launchTemplate, then don't specify IamInstanceProfile in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

pub fn labels(&self) -> Option<&HashMap<String, String>>

The Kubernetes labels to apply to the nodes in the node group when they are created.

pub fn taints(&self) -> &[Taint]

The Kubernetes taints to be applied to the nodes in the node group. For more information, see Node taints on managed node groups.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .taints.is_none().

pub fn tags(&self) -> Option<&HashMap<String, String>>

Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.

pub fn client_request_token(&self) -> Option<&str>

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

pub fn launch_template(&self) -> Option<&LaunchTemplateSpecification>

An object representing a node group's launch template specification. If specified, then do not specify instanceTypes, diskSize, or remoteAccess and make sure that the launch template meets the requirements in launchTemplateSpecification.

pub fn update_config(&self) -> Option<&NodegroupUpdateConfig>

The node group update configuration.

pub fn capacity_type(&self) -> Option<&CapacityTypes>

The capacity type for your node group.

pub fn version(&self) -> Option<&str>

The Kubernetes version to use for your managed nodes. By default, the Kubernetes version of the cluster is used, and this is the only accepted specified value. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify version, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

pub fn release_version(&self) -> Option<&str>

The AMI version of the Amazon EKS optimized AMI to use with your node group. By default, the latest available AMI version for the node group's current Kubernetes version is used. For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. Amazon EKS managed node groups support the November 2022 and later releases of the Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the Amazon EKS User Guide.

If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify releaseVersion, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

impl CreateNodegroupInput

pub fn builder() -> CreateNodegroupInputBuilder

Creates a new builder-style object to manufacture CreateNodegroupInput.

Trait Implementations

impl Clone for CreateNodegroupInput

fn clone(&self) -> CreateNodegroupInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateNodegroupInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateNodegroupInput

fn eq(&self, other: &CreateNodegroupInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateNodegroupInput