nodegroups_list_only

Lists nodegroups in a region or regions, for all properties use nodegroups

Overview

Name	nodegroups_list_only
Type	Resource
Description	Resource schema for AWS::EKS::Nodegroup
Id	aws.eks.nodegroups_list_only

Fields

Name	Datatype	Description
ami_type	string	The AMI type for your node group.
capacity_type	string	The capacity type of your managed node group.
cluster_name	string	Name of the cluster to create the node group in.
disk_size	integer	The root device disk size (in GiB) for your node group instances.
force_update_enabled	boolean	Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue.
instance_types	array	Specify the instance types for a node group.
labels	object	The Kubernetes labels to be applied to the nodes in the node group when they are created.
launch_template	object	An object representing a node group's launch template specification.
nodegroup_name	string	The unique name to give your node group.
node_role	string	The Amazon Resource Name (ARN) of the IAM role to associate with your node group.
release_version	string	The AMI version of the Amazon EKS-optimized AMI to use with your node group.
remote_access	object	The remote access (SSH) configuration to use with your node group.
scaling_config	object	The scaling configuration details for the Auto Scaling group that is created for your node group.
subnets	array	The subnets to use for the Auto Scaling group that is created for your node group.
tags	object	The metadata, as key-value pairs, to apply to the node group to assist with categorization and organization. Follows same schema as Labels for consistency.
taints	array	The Kubernetes taints to be applied to the nodes in the node group when they are created.
update_config	object	The node group update configuration.
version	string	The Kubernetes version to use for your managed nodes.
id	string
arn	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
list_resources	SELECT	region

SELECT examples

Lists all nodegroups in a region.

SELECT
region,
id
FROM aws.eks.nodegroups_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the nodegroups_list_only resource, see nodegroups