libZSservicesZSamazonka-eksZSamazonka-eks
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.EKS.Lens

Description

 
Synopsis

Operations

CreateAddon

createAddon_addonVersion :: Lens' CreateAddon (Maybe Text) Source #

The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions .

createAddon_serviceAccountRoleArn :: Lens' CreateAddon (Maybe Text) Source #

The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide.

To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see Enabling IAM roles for service accounts on your cluster in the Amazon EKS User Guide.

createAddon_resolveConflicts :: Lens' CreateAddon (Maybe ResolveConflicts) Source #

How to resolve parameter value conflicts when migrating an existing add-on to an Amazon EKS add-on.

createAddon_clientRequestToken :: Lens' CreateAddon (Maybe Text) Source #

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

createAddon_tags :: Lens' CreateAddon (Maybe (HashMap Text Text)) Source #

The metadata to 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.

createAddon_clusterName :: Lens' CreateAddon Text Source #

The name of the cluster to create the add-on for.

createAddon_addonName :: Lens' CreateAddon Text Source #

The name of the add-on. The name must match one of the names returned by DescribeAddonVersions .

DescribeFargateProfile

describeFargateProfile_clusterName :: Lens' DescribeFargateProfile Text Source #

The name of the Amazon EKS cluster associated with the Fargate profile.

DescribeUpdate

describeUpdate_addonName :: Lens' DescribeUpdate (Maybe Text) Source #

The name of the add-on. The name must match one of the names returned by ListAddons .

describeUpdate_nodegroupName :: Lens' DescribeUpdate (Maybe Text) Source #

The name of the Amazon EKS node group associated with the update.

describeUpdate_name :: Lens' DescribeUpdate Text Source #

The name of the Amazon EKS cluster associated with the update.

describeUpdate_updateId :: Lens' DescribeUpdate Text Source #

The ID of the update to describe.

describeUpdateResponse_update :: Lens' DescribeUpdateResponse (Maybe Update) Source #

The full description of the specified update.

UpdateNodegroupConfig

updateNodegroupConfig_taints :: Lens' UpdateNodegroupConfig (Maybe UpdateTaintsPayload) Source #

The Kubernetes taints to be applied to the nodes in the node group after the update.

updateNodegroupConfig_scalingConfig :: Lens' UpdateNodegroupConfig (Maybe NodegroupScalingConfig) Source #

The scaling configuration details for the Auto Scaling group after the update.

updateNodegroupConfig_labels :: Lens' UpdateNodegroupConfig (Maybe UpdateLabelsPayload) Source #

The Kubernetes labels to be applied to the nodes in the node group after the update.

updateNodegroupConfig_clientRequestToken :: Lens' UpdateNodegroupConfig (Maybe Text) Source #

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

updateNodegroupConfig_clusterName :: Lens' UpdateNodegroupConfig Text Source #

The name of the Amazon EKS cluster that the managed node group resides in.

updateNodegroupConfig_nodegroupName :: Lens' UpdateNodegroupConfig Text Source #

The name of the managed node group to update.

DescribeCluster

describeCluster_name :: Lens' DescribeCluster Text Source #

The name of the cluster to describe.

describeClusterResponse_cluster :: Lens' DescribeClusterResponse (Maybe Cluster) Source #

The full description of your specified cluster.

DeregisterCluster

deregisterCluster_name :: Lens' DeregisterCluster Text Source #

The name of the connected cluster to deregister.

DescribeNodegroup

describeNodegroup_clusterName :: Lens' DescribeNodegroup Text Source #

The name of the Amazon EKS cluster associated with the node group.

describeNodegroup_nodegroupName :: Lens' DescribeNodegroup Text Source #

The name of the node group to describe.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Amazon EKS clusters and managed node groups.

CreateFargateProfile

createFargateProfile_subnets :: Lens' CreateFargateProfile (Maybe [Text]) Source #

The IDs of subnets to launch your pods into. At this time, pods running on Fargate are not assigned public IP addresses, so only private subnets (with no direct route to an Internet Gateway) are accepted for this parameter.

createFargateProfile_clientRequestToken :: Lens' CreateFargateProfile (Maybe Text) Source #

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

createFargateProfile_selectors :: Lens' CreateFargateProfile (Maybe [FargateProfileSelector]) Source #

The selectors to match for pods to use this Fargate profile. Each selector must have an associated namespace. Optionally, you can also specify labels for a namespace. You may specify up to five selectors in a Fargate profile.

createFargateProfile_tags :: Lens' CreateFargateProfile (Maybe (HashMap Text Text)) Source #

The metadata to apply to the Fargate profile to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Fargate profile tags do not propagate to any other resources associated with the Fargate profile, such as the pods that are scheduled with it.

createFargateProfile_clusterName :: Lens' CreateFargateProfile Text Source #

The name of the Amazon EKS cluster to apply the Fargate profile to.

createFargateProfile_podExecutionRoleArn :: Lens' CreateFargateProfile Text Source #

The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile. The pod execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. For more information, see Pod Execution Role in the Amazon EKS User Guide.

DescribeIdentityProviderConfig

describeIdentityProviderConfig_clusterName :: Lens' DescribeIdentityProviderConfig Text Source #

The cluster name that the identity provider configuration is associated to.

DeleteFargateProfile

deleteFargateProfile_clusterName :: Lens' DeleteFargateProfile Text Source #

The name of the Amazon EKS cluster associated with the Fargate profile to delete.

deleteFargateProfile_fargateProfileName :: Lens' DeleteFargateProfile Text Source #

The name of the Fargate profile to delete.

DeleteCluster

deleteCluster_name :: Lens' DeleteCluster Text Source #

The name of the cluster to delete.

deleteClusterResponse_cluster :: Lens' DeleteClusterResponse (Maybe Cluster) Source #

The full description of the cluster to delete.

CreateCluster

createCluster_version :: Lens' CreateCluster (Maybe Text) Source #

The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.

createCluster_encryptionConfig :: Lens' CreateCluster (Maybe [EncryptionConfig]) Source #

The encryption configuration for the cluster.

createCluster_clientRequestToken :: Lens' CreateCluster (Maybe Text) Source #

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

createCluster_logging :: Lens' CreateCluster (Maybe Logging) Source #

Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster control plane logs in the /Amazon EKS User Guide/ .

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing.

createCluster_tags :: Lens' CreateCluster (Maybe (HashMap Text Text)) Source #

The metadata to 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.

createCluster_name :: Lens' CreateCluster Text Source #

The unique name to give to your cluster.

createCluster_roleArn :: Lens' CreateCluster Text Source #

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to Amazon Web Services API operations on your behalf. For more information, see Amazon EKS Service IAM Role in the /Amazon EKS User Guide/ .

createCluster_resourcesVpcConfig :: Lens' CreateCluster VpcConfigRequest Source #

The VPC configuration 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.

createClusterResponse_cluster :: Lens' CreateClusterResponse (Maybe Cluster) Source #

The full description of your new cluster.

UpdateClusterConfig

updateClusterConfig_clientRequestToken :: Lens' UpdateClusterConfig (Maybe Text) Source #

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

updateClusterConfig_logging :: Lens' UpdateClusterConfig (Maybe Logging) Source #

Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS cluster control plane logs in the /Amazon EKS User Guide/ .

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing.

updateClusterConfig_name :: Lens' UpdateClusterConfig Text Source #

The name of the Amazon EKS cluster to update.

ListAddons

listAddons_nextToken :: Lens' ListAddons (Maybe Text) Source #

The nextToken value returned from a previous paginated ListAddonsRequest where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

listAddons_maxResults :: Lens' ListAddons (Maybe Natural) Source #

The maximum number of add-on results returned by ListAddonsRequest in paginated output. When you use this parameter, ListAddonsRequest returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListAddonsRequest request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListAddonsRequest returns up to 100 results and a nextToken value, if applicable.

listAddons_clusterName :: Lens' ListAddons Text Source #

The name of the cluster.

listAddonsResponse_nextToken :: Lens' ListAddonsResponse (Maybe Text) Source #

The nextToken value returned from a previous paginated ListAddonsResponse where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

UpdateClusterVersion

updateClusterVersion_clientRequestToken :: Lens' UpdateClusterVersion (Maybe Text) Source #

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

updateClusterVersion_name :: Lens' UpdateClusterVersion Text Source #

The name of the Amazon EKS cluster to update.

updateClusterVersion_version :: Lens' UpdateClusterVersion Text Source #

The desired Kubernetes version following a successful update.

DescribeAddonVersions

describeAddonVersions_addonName :: Lens' DescribeAddonVersions (Maybe Text) Source #

The name of the add-on. The name must match one of the names returned by ListAddons .

describeAddonVersions_nextToken :: Lens' DescribeAddonVersions (Maybe Text) Source #

The nextToken value returned from a previous paginated DescribeAddonVersionsRequest where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

describeAddonVersions_kubernetesVersion :: Lens' DescribeAddonVersions (Maybe Text) Source #

The Kubernetes versions that the add-on can be used with.

describeAddonVersionsResponse_addons :: Lens' DescribeAddonVersionsResponse (Maybe [AddonInfo]) Source #

The list of available versions with Kubernetes version compatibility.

describeAddonVersionsResponse_nextToken :: Lens' DescribeAddonVersionsResponse (Maybe Text) Source #

The nextToken value returned from a previous paginated DescribeAddonVersionsResponse where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

UpdateNodegroupVersion

updateNodegroupVersion_force :: Lens' UpdateNodegroupVersion (Maybe Bool) Source #

Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. If an update fails because pods could not be drained, you can force the update after it fails to terminate the old node whether or not any pods are running on the node.

updateNodegroupVersion_releaseVersion :: Lens' UpdateNodegroupVersion (Maybe Text) Source #

The AMI version of the Amazon EKS optimized AMI to use for the update. By default, the latest available AMI version for the node group's Kubernetes version is used. For more information, see Amazon EKS optimized Amazon Linux 2 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 update will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

updateNodegroupVersion_version :: Lens' UpdateNodegroupVersion (Maybe Text) Source #

The Kubernetes version to update to. If no version is specified, then the Kubernetes version of the node group does not change. You can specify the Kubernetes version of the cluster to update the node group to the latest AMI version of the cluster's Kubernetes version. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify version, or the node group update will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

updateNodegroupVersion_launchTemplate :: Lens' UpdateNodegroupVersion (Maybe LaunchTemplateSpecification) Source #

An object representing a node group's launch template specification. You can only update a node group using a launch template if the node group was originally deployed with a launch template.

updateNodegroupVersion_clientRequestToken :: Lens' UpdateNodegroupVersion (Maybe Text) Source #

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

updateNodegroupVersion_clusterName :: Lens' UpdateNodegroupVersion Text Source #

The name of the Amazon EKS cluster that is associated with the managed node group to update.

updateNodegroupVersion_nodegroupName :: Lens' UpdateNodegroupVersion Text Source #

The name of the managed node group to update.

ListIdentityProviderConfigs

listIdentityProviderConfigs_nextToken :: Lens' ListIdentityProviderConfigs (Maybe Text) Source #

The nextToken value returned from a previous paginated IdentityProviderConfigsRequest where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

listIdentityProviderConfigs_maxResults :: Lens' ListIdentityProviderConfigs (Maybe Natural) Source #

The maximum number of identity provider configurations returned by ListIdentityProviderConfigs in paginated output. When you use this parameter, ListIdentityProviderConfigs returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListIdentityProviderConfigs request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListIdentityProviderConfigs returns up to 100 results and a nextToken value, if applicable.

listIdentityProviderConfigs_clusterName :: Lens' ListIdentityProviderConfigs Text Source #

The cluster name that you want to list identity provider configurations for.

listIdentityProviderConfigsResponse_nextToken :: Lens' ListIdentityProviderConfigsResponse (Maybe Text) Source #

The nextToken value returned from a previous paginated ListIdentityProviderConfigsResponse where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

DisassociateIdentityProviderConfig

disassociateIdentityProviderConfig_clientRequestToken :: Lens' DisassociateIdentityProviderConfig (Maybe Text) Source #

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

disassociateIdentityProviderConfig_clusterName :: Lens' DisassociateIdentityProviderConfig Text Source #

The name of the cluster to disassociate an identity provider from.

DescribeAddon

describeAddon_addonName :: Lens' DescribeAddon Text Source #

The name of the add-on. The name must match one of the names returned by ListAddons .

ListUpdates

listUpdates_addonName :: Lens' ListUpdates (Maybe Text) Source #

The names of the installed add-ons that have available updates.

listUpdates_nextToken :: Lens' ListUpdates (Maybe Text) Source #

The nextToken value returned from a previous paginated ListUpdates request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

listUpdates_nodegroupName :: Lens' ListUpdates (Maybe Text) Source #

The name of the Amazon EKS managed node group to list updates for.

listUpdates_maxResults :: Lens' ListUpdates (Maybe Natural) Source #

The maximum number of update results returned by ListUpdates in paginated output. When you use this parameter, ListUpdates returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListUpdates request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListUpdates returns up to 100 results and a nextToken value if applicable.

listUpdates_name :: Lens' ListUpdates Text Source #

The name of the Amazon EKS cluster to list updates for.

listUpdatesResponse_nextToken :: Lens' ListUpdatesResponse (Maybe Text) Source #

The nextToken value to include in a future ListUpdates request. When the results of a ListUpdates request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

listUpdatesResponse_updateIds :: Lens' ListUpdatesResponse (Maybe [Text]) Source #

A list of all the updates for the specified cluster and Region.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources are Amazon EKS clusters and managed node groups.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

The tags to add to the resource. A tag is an array of key-value pairs.

ListFargateProfiles

listFargateProfiles_nextToken :: Lens' ListFargateProfiles (Maybe Text) Source #

The nextToken value returned from a previous paginated ListFargateProfiles request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

listFargateProfiles_maxResults :: Lens' ListFargateProfiles (Maybe Natural) Source #

The maximum number of Fargate profile results returned by ListFargateProfiles in paginated output. When you use this parameter, ListFargateProfiles returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListFargateProfiles request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListFargateProfiles returns up to 100 results and a nextToken value if applicable.

listFargateProfiles_clusterName :: Lens' ListFargateProfiles Text Source #

The name of the Amazon EKS cluster that you would like to list Fargate profiles in.

listFargateProfilesResponse_nextToken :: Lens' ListFargateProfilesResponse (Maybe Text) Source #

The nextToken value to include in a future ListFargateProfiles request. When the results of a ListFargateProfiles request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

listFargateProfilesResponse_fargateProfileNames :: Lens' ListFargateProfilesResponse (Maybe [Text]) Source #

A list of all of the Fargate profiles associated with the specified cluster.

RegisterCluster

registerCluster_clientRequestToken :: Lens' RegisterCluster (Maybe Text) Source #

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

registerCluster_name :: Lens' RegisterCluster Text Source #

Define a unique name for this cluster within your AWS account.

registerCluster_connectorConfig :: Lens' RegisterCluster ConnectorConfigRequest Source #

The configuration settings required to connect the Kubernetes cluster to the Amazon EKS control plane.

ListClusters

listClusters_include :: Lens' ListClusters (Maybe [Text]) Source #

Indicates whether connected clusters are included in the returned list. Default value is 'ALL'.

listClusters_nextToken :: Lens' ListClusters (Maybe Text) Source #

The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

listClusters_maxResults :: Lens' ListClusters (Maybe Natural) Source #

The maximum number of cluster results returned by ListClusters in paginated output. When you use this parameter, ListClusters returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListClusters returns up to 100 results and a nextToken value if applicable.

listClustersResponse_nextToken :: Lens' ListClustersResponse (Maybe Text) Source #

The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

listClustersResponse_clusters :: Lens' ListClustersResponse (Maybe [Text]) Source #

A list of all of the clusters for your account in the specified Region.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported resources are Amazon EKS clusters and managed node groups.

untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #

The keys of the tags to be removed.

CreateNodegroup

createNodegroup_capacityType :: Lens' CreateNodegroup (Maybe CapacityTypes) Source #

The capacity type for your node group.

createNodegroup_instanceTypes :: Lens' CreateNodegroup (Maybe [Text]) Source #

Specify the instance types for a node group. If you specify a GPU instance type, be sure to specify AL2_x86_64_GPU 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.

createNodegroup_taints :: Lens' CreateNodegroup (Maybe [Taint]) Source #

The Kubernetes taints to be applied to the nodes in the node group.

createNodegroup_remoteAccess :: Lens' CreateNodegroup (Maybe RemoteAccessConfig) Source #

The remote access (SSH) configuration to use with your node group. 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.

createNodegroup_diskSize :: Lens' CreateNodegroup (Maybe Int) Source #

The root device disk size (in GiB) for your node group instances. The default disk size is 20 GiB. 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.

createNodegroup_releaseVersion :: Lens' CreateNodegroup (Maybe Text) Source #

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 more information, see Amazon EKS optimized Amazon Linux 2 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.

createNodegroup_scalingConfig :: Lens' CreateNodegroup (Maybe NodegroupScalingConfig) Source #

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

createNodegroup_version :: Lens' CreateNodegroup (Maybe Text) Source #

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.

createNodegroup_launchTemplate :: Lens' CreateNodegroup (Maybe LaunchTemplateSpecification) Source #

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.

createNodegroup_labels :: Lens' CreateNodegroup (Maybe (HashMap Text Text)) Source #

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

createNodegroup_amiType :: Lens' CreateNodegroup (Maybe AMITypes) Source #

The AMI type for your node group. GPU instance types should use the AL2_x86_64_GPU AMI type. Non-GPU instances should use the AL2_x86_64 AMI type. Arm instances should use the AL2_ARM_64 AMI type. All types use the Amazon EKS optimized Amazon Linux 2 AMI. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify amiType, 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.

createNodegroup_clientRequestToken :: Lens' CreateNodegroup (Maybe Text) Source #

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

createNodegroup_tags :: Lens' CreateNodegroup (Maybe (HashMap Text Text)) Source #

The metadata to apply to the node group to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.

createNodegroup_clusterName :: Lens' CreateNodegroup Text Source #

The name of the cluster to create the node group in.

createNodegroup_nodegroupName :: Lens' CreateNodegroup Text Source #

The unique name to give your node group.

createNodegroup_subnets :: Lens' CreateNodegroup [Text] Source #

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.

createNodegroup_nodeRole :: Lens' CreateNodegroup Text Source #

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.

createNodegroupResponse_nodegroup :: Lens' CreateNodegroupResponse (Maybe Nodegroup) Source #

The full description of your new node group.

ListNodegroups

listNodegroups_nextToken :: Lens' ListNodegroups (Maybe Text) Source #

The nextToken value returned from a previous paginated ListNodegroups request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

listNodegroups_maxResults :: Lens' ListNodegroups (Maybe Natural) Source #

The maximum number of node group results returned by ListNodegroups in paginated output. When you use this parameter, ListNodegroups returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListNodegroups request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListNodegroups returns up to 100 results and a nextToken value if applicable.

listNodegroups_clusterName :: Lens' ListNodegroups Text Source #

The name of the Amazon EKS cluster that you would like to list node groups in.

listNodegroupsResponse_nodegroups :: Lens' ListNodegroupsResponse (Maybe [Text]) Source #

A list of all of the node groups associated with the specified cluster.

listNodegroupsResponse_nextToken :: Lens' ListNodegroupsResponse (Maybe Text) Source #

The nextToken value to include in a future ListNodegroups request. When the results of a ListNodegroups request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

DeleteNodegroup

deleteNodegroup_clusterName :: Lens' DeleteNodegroup Text Source #

The name of the Amazon EKS cluster that is associated with your node group.

deleteNodegroup_nodegroupName :: Lens' DeleteNodegroup Text Source #

The name of the node group to delete.

deleteNodegroupResponse_nodegroup :: Lens' DeleteNodegroupResponse (Maybe Nodegroup) Source #

The full description of your deleted node group.

AssociateEncryptionConfig

associateEncryptionConfig_clientRequestToken :: Lens' AssociateEncryptionConfig (Maybe Text) Source #

The client request token you are using with the encryption configuration.

associateEncryptionConfig_clusterName :: Lens' AssociateEncryptionConfig Text Source #

The name of the cluster that you are associating with encryption configuration.

AssociateIdentityProviderConfig

associateIdentityProviderConfig_clientRequestToken :: Lens' AssociateIdentityProviderConfig (Maybe Text) Source #

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

associateIdentityProviderConfig_tags :: Lens' AssociateIdentityProviderConfig (Maybe (HashMap Text Text)) Source #

The metadata to apply to the configuration to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define.

associateIdentityProviderConfig_clusterName :: Lens' AssociateIdentityProviderConfig Text Source #

The name of the cluster to associate the configuration to.

associateIdentityProviderConfig_oidc :: Lens' AssociateIdentityProviderConfig OidcIdentityProviderConfigRequest Source #

An object that represents an OpenID Connect (OIDC) identity provider configuration.

DeleteAddon

deleteAddon_preserve :: Lens' DeleteAddon (Maybe Bool) Source #

Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on. If an IAM account is associated with the add-on, it is not removed.

deleteAddon_clusterName :: Lens' DeleteAddon Text Source #

The name of the cluster to delete the add-on from.

deleteAddon_addonName :: Lens' DeleteAddon Text Source #

The name of the add-on. The name must match one of the names returned by ListAddons .

UpdateAddon

updateAddon_addonVersion :: Lens' UpdateAddon (Maybe Text) Source #

The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions .

updateAddon_serviceAccountRoleArn :: Lens' UpdateAddon (Maybe Text) Source #

The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide.

To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see Enabling IAM roles for service accounts on your cluster in the Amazon EKS User Guide.

updateAddon_resolveConflicts :: Lens' UpdateAddon (Maybe ResolveConflicts) Source #

How to resolve parameter value conflicts when applying the new version of the add-on to the cluster.

updateAddon_clientRequestToken :: Lens' UpdateAddon (Maybe Text) Source #

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

updateAddon_addonName :: Lens' UpdateAddon Text Source #

The name of the add-on. The name must match one of the names returned by ListAddons .

Types

Addon

addon_modifiedAt :: Lens' Addon (Maybe UTCTime) Source #

The date and time that the add-on was last modified.

addon_status :: Lens' Addon (Maybe AddonStatus) Source #

The status of the add-on.

addon_addonName :: Lens' Addon (Maybe Text) Source #

The name of the add-on.

addon_addonVersion :: Lens' Addon (Maybe Text) Source #

The version of the add-on.

addon_createdAt :: Lens' Addon (Maybe UTCTime) Source #

The date and time that the add-on was created.

addon_serviceAccountRoleArn :: Lens' Addon (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role that is bound to the Kubernetes service account used by the add-on.

addon_health :: Lens' Addon (Maybe AddonHealth) Source #

An object that represents the health of the add-on.

addon_clusterName :: Lens' Addon (Maybe Text) Source #

The name of the cluster.

addon_addonArn :: Lens' Addon (Maybe Text) Source #

The Amazon Resource Name (ARN) of the add-on.

addon_tags :: Lens' Addon (Maybe (HashMap Text Text)) Source #

The metadata that you apply to the add-on to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Add-on tags do not propagate to any other resources associated with the cluster.

AddonHealth

addonHealth_issues :: Lens' AddonHealth (Maybe [AddonIssue]) Source #

An object that represents the add-on's health issues.

AddonInfo

addonInfo_addonName :: Lens' AddonInfo (Maybe Text) Source #

The name of the add-on.

addonInfo_type :: Lens' AddonInfo (Maybe Text) Source #

The type of the add-on.

addonInfo_addonVersions :: Lens' AddonInfo (Maybe [AddonVersionInfo]) Source #

An object that represents information about available add-on versions and compatible Kubernetes versions.

AddonIssue

addonIssue_resourceIds :: Lens' AddonIssue (Maybe [Text]) Source #

The resource IDs of the issue.

addonIssue_code :: Lens' AddonIssue (Maybe AddonIssueCode) Source #

A code that describes the type of issue.

addonIssue_message :: Lens' AddonIssue (Maybe Text) Source #

A message that provides details about the issue and what might cause it.

AddonVersionInfo

addonVersionInfo_architecture :: Lens' AddonVersionInfo (Maybe [Text]) Source #

The architectures that the version supports.

addonVersionInfo_compatibilities :: Lens' AddonVersionInfo (Maybe [Compatibility]) Source #

An object that represents the compatibilities of a version.

AutoScalingGroup

autoScalingGroup_name :: Lens' AutoScalingGroup (Maybe Text) Source #

The name of the Auto Scaling group associated with an Amazon EKS managed node group.

Certificate

certificate_data :: Lens' Certificate (Maybe Text) Source #

The Base64-encoded certificate data required to communicate with your cluster. Add this to the certificate-authority-data section of the kubeconfig file for your cluster.

Cluster

cluster_status :: Lens' Cluster (Maybe ClusterStatus) Source #

The current status of the cluster.

cluster_arn :: Lens' Cluster (Maybe Text) Source #

The Amazon Resource Name (ARN) of the cluster.

cluster_createdAt :: Lens' Cluster (Maybe UTCTime) Source #

The Unix epoch timestamp in seconds for when the cluster was created.

cluster_platformVersion :: Lens' Cluster (Maybe Text) Source #

The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the /Amazon EKS User Guide/ .

cluster_kubernetesNetworkConfig :: Lens' Cluster (Maybe KubernetesNetworkConfigResponse) Source #

The Kubernetes network configuration for the cluster.

cluster_connectorConfig :: Lens' Cluster (Maybe ConnectorConfigResponse) Source #

The configuration used to connect to a cluster for registration.

cluster_certificateAuthority :: Lens' Cluster (Maybe Certificate) Source #

The certificate-authority-data for your cluster.

cluster_name :: Lens' Cluster (Maybe Text) Source #

The name of the cluster.

cluster_version :: Lens' Cluster (Maybe Text) Source #

The Kubernetes server version for the cluster.

cluster_encryptionConfig :: Lens' Cluster (Maybe [EncryptionConfig]) Source #

The encryption configuration for the cluster.

cluster_endpoint :: Lens' Cluster (Maybe Text) Source #

The endpoint for your Kubernetes API server.

cluster_clientRequestToken :: Lens' Cluster (Maybe Text) Source #

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

cluster_logging :: Lens' Cluster (Maybe Logging) Source #

The logging configuration for your cluster.

cluster_identity :: Lens' Cluster (Maybe Identity) Source #

The identity provider information for the cluster.

cluster_resourcesVpcConfig :: Lens' Cluster (Maybe VpcConfigResponse) Source #

The VPC configuration 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.

cluster_tags :: Lens' Cluster (Maybe (HashMap Text Text)) Source #

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 do not propagate to any other resources associated with the cluster.

cluster_roleArn :: Lens' Cluster (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to Amazon Web Services API operations on your behalf.

Compatibility

compatibility_clusterVersion :: Lens' Compatibility (Maybe Text) Source #

The supported Kubernetes version of the cluster.

compatibility_platformVersions :: Lens' Compatibility (Maybe [Text]) Source #

The supported compute platform.

ConnectorConfigRequest

connectorConfigRequest_roleArn :: Lens' ConnectorConfigRequest Text Source #

The Amazon Resource Name (ARN) of the role that is authorized to request the connector configuration.

connectorConfigRequest_provider :: Lens' ConnectorConfigRequest ConnectorConfigProvider Source #

The cloud provider for the target cluster to connect.

ConnectorConfigResponse

connectorConfigResponse_activationCode :: Lens' ConnectorConfigResponse (Maybe Text) Source #

A unique code associated with the cluster for registration purposes.

connectorConfigResponse_activationId :: Lens' ConnectorConfigResponse (Maybe Text) Source #

A unique ID associated with the cluster for registration purposes.

connectorConfigResponse_activationExpiry :: Lens' ConnectorConfigResponse (Maybe UTCTime) Source #

The expiration time of the connected cluster. The cluster's YAML file must be applied through the native provider.

connectorConfigResponse_roleArn :: Lens' ConnectorConfigResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the role that is used by the EKS connector to communicate with AWS services from the connected Kubernetes cluster.

EncryptionConfig

encryptionConfig_resources :: Lens' EncryptionConfig (Maybe [Text]) Source #

Specifies the resources to be encrypted. The only supported value is "secrets".

encryptionConfig_provider :: Lens' EncryptionConfig (Maybe Provider) Source #

Key Management Service (KMS) key. Either the ARN or the alias can be used.

ErrorDetail

errorDetail_resourceIds :: Lens' ErrorDetail (Maybe [Text]) Source #

An optional field that contains the resource IDs associated with the error.

errorDetail_errorCode :: Lens' ErrorDetail (Maybe EKSErrorCode) Source #

A brief description of the error.

  • SubnetNotFound: We couldn't find one of the subnets associated with the cluster.
  • SecurityGroupNotFound: We couldn't find one of the security groups associated with the cluster.
  • EniLimitReached: You have reached the elastic network interface limit for your account.
  • IpNotAvailable: A subnet associated with the cluster doesn't have any free IP addresses.
  • AccessDenied: You don't have permissions to perform the specified operation.
  • OperationNotPermitted: The service role associated with the cluster doesn't have the required access permissions for Amazon EKS.
  • VpcIdNotFound: We couldn't find the VPC associated with the cluster.

errorDetail_errorMessage :: Lens' ErrorDetail (Maybe Text) Source #

A more complete description of the error.

FargateProfile

fargateProfile_fargateProfileArn :: Lens' FargateProfile (Maybe Text) Source #

The full Amazon Resource Name (ARN) of the Fargate profile.

fargateProfile_status :: Lens' FargateProfile (Maybe FargateProfileStatus) Source #

The current status of the Fargate profile.

fargateProfile_createdAt :: Lens' FargateProfile (Maybe UTCTime) Source #

The Unix epoch timestamp in seconds for when the Fargate profile was created.

fargateProfile_subnets :: Lens' FargateProfile (Maybe [Text]) Source #

The IDs of subnets to launch pods into.

fargateProfile_clusterName :: Lens' FargateProfile (Maybe Text) Source #

The name of the Amazon EKS cluster that the Fargate profile belongs to.

fargateProfile_podExecutionRoleArn :: Lens' FargateProfile (Maybe Text) Source #

The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile. For more information, see Pod Execution Role in the Amazon EKS User Guide.

fargateProfile_selectors :: Lens' FargateProfile (Maybe [FargateProfileSelector]) Source #

The selectors to match for pods to use this Fargate profile.

fargateProfile_tags :: Lens' FargateProfile (Maybe (HashMap Text Text)) Source #

The metadata applied to the Fargate profile to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Fargate profile tags do not propagate to any other resources associated with the Fargate profile, such as the pods that are scheduled with it.

FargateProfileSelector

fargateProfileSelector_namespace :: Lens' FargateProfileSelector (Maybe Text) Source #

The Kubernetes namespace that the selector should match.

fargateProfileSelector_labels :: Lens' FargateProfileSelector (Maybe (HashMap Text Text)) Source #

The Kubernetes labels that the selector should match. A pod must contain all of the labels that are specified in the selector for it to be considered a match.

Identity

identity_oidc :: Lens' Identity (Maybe OIDC) Source #

An object representing the OpenID Connect identity provider information.

IdentityProviderConfig

identityProviderConfig_type :: Lens' IdentityProviderConfig Text Source #

The type of the identity provider configuration.

identityProviderConfig_name :: Lens' IdentityProviderConfig Text Source #

The name of the identity provider configuration.

IdentityProviderConfigResponse

identityProviderConfigResponse_oidc :: Lens' IdentityProviderConfigResponse (Maybe OidcIdentityProviderConfig) Source #

An object that represents an OpenID Connect (OIDC) identity provider configuration.

Issue

issue_resourceIds :: Lens' Issue (Maybe [Text]) Source #

The Amazon Web Services resources that are afflicted by this issue.

issue_code :: Lens' Issue (Maybe NodegroupIssueCode) Source #

A brief description of the error.

  • AccessDenied: Amazon EKS or one or more of your managed nodes is failing to authenticate or authorize with your Kubernetes cluster API server.
  • AsgInstanceLaunchFailures: Your Auto Scaling group is experiencing failures while attempting to launch instances.
  • AutoScalingGroupNotFound: We couldn't find the Auto Scaling group associated with the managed node group. You may be able to recreate an Auto Scaling group with the same settings to recover.
  • ClusterUnreachable: Amazon EKS or one or more of your managed nodes is unable to to communicate with your Kubernetes cluster API server. This can happen if there are network disruptions or if API servers are timing out processing requests.
  • Ec2LaunchTemplateNotFound: We couldn't find the Amazon EC2 launch template for your managed node group. You may be able to recreate a launch template with the same settings to recover.
  • Ec2LaunchTemplateVersionMismatch: The Amazon EC2 launch template version for your managed node group does not match the version that Amazon EKS created. You may be able to revert to the version that Amazon EKS created to recover.
  • Ec2SecurityGroupDeletionFailure: We could not delete the remote access security group for your managed node group. Remove any dependencies from the security group.
  • Ec2SecurityGroupNotFound: We couldn't find the cluster security group for the cluster. You must recreate your cluster.
  • Ec2SubnetInvalidConfiguration: One or more Amazon EC2 subnets specified for a node group do not automatically assign public IP addresses to instances launched into it. If you want your instances to be assigned a public IP address, then you need to enable the auto-assign public IP address setting for the subnet. See Modifying the public IPv4 addressing attribute for your subnet in the Amazon VPC User Guide.
  • IamInstanceProfileNotFound: We couldn't find the IAM instance profile for your managed node group. You may be able to recreate an instance profile with the same settings to recover.
  • IamNodeRoleNotFound: We couldn't find the IAM role for your managed node group. You may be able to recreate an IAM role with the same settings to recover.
  • InstanceLimitExceeded: Your Amazon Web Services account is unable to launch any more instances of the specified instance type. You may be able to request an Amazon EC2 instance limit increase to recover.
  • InsufficientFreeAddresses: One or more of the subnets associated with your managed node group does not have enough available IP addresses for new nodes.
  • InternalFailure: These errors are usually caused by an Amazon EKS server-side issue.
  • NodeCreationFailure: Your launched instances are unable to register with your Amazon EKS cluster. Common causes of this failure are insufficient node IAM role permissions or lack of outbound internet access for the nodes.

issue_message :: Lens' Issue (Maybe Text) Source #

The error message associated with the issue.

KubernetesNetworkConfigRequest

kubernetesNetworkConfigRequest_serviceIpv4Cidr :: Lens' KubernetesNetworkConfigRequest (Maybe Text) Source #

The CIDR block to assign Kubernetes service IP addresses from. If you don't specify a block, Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. We recommend that you specify a block that does not overlap with resources in other networks that are peered or connected to your VPC. The block must meet the following requirements:

  • Within one of the following private IP address blocks: 10.0.0.0/8, 172.16.0.0.0/12, or 192.168.0.0/16.
  • Doesn't overlap with any CIDR block assigned to the VPC that you selected for VPC.
  • Between /24 and /12.

You can only specify a custom CIDR block when you create a cluster and can't change this value once the cluster is created.

KubernetesNetworkConfigResponse

kubernetesNetworkConfigResponse_serviceIpv4Cidr :: Lens' KubernetesNetworkConfigResponse (Maybe Text) Source #

The CIDR block that Kubernetes service IP addresses are assigned from. If you didn't specify a CIDR block when you created the cluster, then Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. If this was specified, then it was specified when the cluster was created and it cannot be changed.

LaunchTemplateSpecification

launchTemplateSpecification_version :: Lens' LaunchTemplateSpecification (Maybe Text) Source #

The version of the launch template to use. If no version is specified, then the template's default version is used.

LogSetup

logSetup_enabled :: Lens' LogSetup (Maybe Bool) Source #

If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs. If a log type isn't enabled, that log type doesn't export its control plane logs. Each individual log type can be enabled or disabled independently.

logSetup_types :: Lens' LogSetup (Maybe [LogType]) Source #

The available cluster control plane log types.

Logging

logging_clusterLogging :: Lens' Logging (Maybe [LogSetup]) Source #

The cluster control plane logging configuration for your cluster.

Nodegroup

nodegroup_modifiedAt :: Lens' Nodegroup (Maybe UTCTime) Source #

The Unix epoch timestamp in seconds for when the managed node group was last modified.

nodegroup_capacityType :: Lens' Nodegroup (Maybe CapacityTypes) Source #

The capacity type of your managed node group.

nodegroup_status :: Lens' Nodegroup (Maybe NodegroupStatus) Source #

The current status of the managed node group.

nodegroup_instanceTypes :: Lens' Nodegroup (Maybe [Text]) Source #

If the node group wasn't deployed with a launch template, then this is the instance type that is associated with the node group. If the node group was deployed with a launch template, then this is null.

nodegroup_createdAt :: Lens' Nodegroup (Maybe UTCTime) Source #

The Unix epoch timestamp in seconds for when the managed node group was created.

nodegroup_taints :: Lens' Nodegroup (Maybe [Taint]) Source #

The Kubernetes taints to be applied to the nodes in the node group when they are created. Effect is one of No_Schedule, Prefer_No_Schedule, or No_Execute. Kubernetes taints can be used together with tolerations to control how workloads are scheduled to your nodes.

nodegroup_subnets :: Lens' Nodegroup (Maybe [Text]) Source #

The subnets that were specified for the Auto Scaling group that is associated with your node group.

nodegroup_remoteAccess :: Lens' Nodegroup (Maybe RemoteAccessConfig) Source #

If the node group wasn't deployed with a launch template, then this is the remote access configuration that is associated with the node group. If the node group was deployed with a launch template, then this is null.

nodegroup_diskSize :: Lens' Nodegroup (Maybe Int) Source #

If the node group wasn't deployed with a launch template, then this is the disk size in the node group configuration. If the node group was deployed with a launch template, then this is null.

nodegroup_releaseVersion :: Lens' Nodegroup (Maybe Text) Source #

If the node group was deployed using a launch template with a custom AMI, then this is the AMI ID that was specified in the launch template. For node groups that weren't deployed using a launch template, this is the version of the Amazon EKS optimized AMI that the node group was deployed with.

nodegroup_resources :: Lens' Nodegroup (Maybe NodegroupResources) Source #

The resources associated with the node group, such as Auto Scaling groups and security groups for remote access.

nodegroup_health :: Lens' Nodegroup (Maybe NodegroupHealth) Source #

The health status of the node group. If there are issues with your node group's health, they are listed here.

nodegroup_nodeRole :: Lens' Nodegroup (Maybe Text) Source #

The IAM role associated with your node group. The Amazon EKS 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.

nodegroup_scalingConfig :: Lens' Nodegroup (Maybe NodegroupScalingConfig) Source #

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

nodegroup_version :: Lens' Nodegroup (Maybe Text) Source #

The Kubernetes version of the managed node group.

nodegroup_nodegroupArn :: Lens' Nodegroup (Maybe Text) Source #

The Amazon Resource Name (ARN) associated with the managed node group.

nodegroup_clusterName :: Lens' Nodegroup (Maybe Text) Source #

The name of the cluster that the managed node group resides in.

nodegroup_launchTemplate :: Lens' Nodegroup (Maybe LaunchTemplateSpecification) Source #

If a launch template was used to create the node group, then this is the launch template that was used.

nodegroup_labels :: Lens' Nodegroup (Maybe (HashMap Text Text)) Source #

The Kubernetes labels applied to the nodes in the node group.

Only labels that are applied with the Amazon EKS API are shown here. There may be other Kubernetes labels applied to the nodes in this group.

nodegroup_amiType :: Lens' Nodegroup (Maybe AMITypes) Source #

If the node group was deployed using a launch template with a custom AMI, then this is CUSTOM. For node groups that weren't deployed using a launch template, this is the AMI type that was specified in the node group configuration.

nodegroup_nodegroupName :: Lens' Nodegroup (Maybe Text) Source #

The name associated with an Amazon EKS managed node group.

nodegroup_updateConfig :: Lens' Nodegroup (Maybe NodegroupUpdateConfig) Source #

The node group update configuration.

nodegroup_tags :: Lens' Nodegroup (Maybe (HashMap Text Text)) Source #

The metadata applied to the node group to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.

NodegroupHealth

nodegroupHealth_issues :: Lens' NodegroupHealth (Maybe [Issue]) Source #

Any issues that are associated with the node group.

NodegroupResources

nodegroupResources_remoteAccessSecurityGroup :: Lens' NodegroupResources (Maybe Text) Source #

The remote access security group associated with the node group. This security group controls SSH access to the nodes.

nodegroupResources_autoScalingGroups :: Lens' NodegroupResources (Maybe [AutoScalingGroup]) Source #

The Auto Scaling groups associated with the node group.

NodegroupScalingConfig

nodegroupScalingConfig_desiredSize :: Lens' NodegroupScalingConfig (Maybe Natural) Source #

The current number of nodes that the managed node group should maintain.

nodegroupScalingConfig_maxSize :: Lens' NodegroupScalingConfig (Maybe Natural) Source #

The maximum number of nodes that the managed node group can scale out to. For information about the maximum number that you can specify, see Amazon EKS service quotas in the Amazon EKS User Guide.

nodegroupScalingConfig_minSize :: Lens' NodegroupScalingConfig (Maybe Natural) Source #

The minimum number of nodes that the managed node group can scale in to.

NodegroupUpdateConfig

nodegroupUpdateConfig_maxUnavailable :: Lens' NodegroupUpdateConfig (Maybe Natural) Source #

The maximum number of nodes unavailable at once during a version update. Nodes will be updated in parallel. This value or maxUnavailablePercentage is required to have a value.The maximum number is 100.

nodegroupUpdateConfig_maxUnavailablePercentage :: Lens' NodegroupUpdateConfig (Maybe Natural) Source #

The maximum percentage of nodes unavailable during a version update. This percentage of nodes will be updated in parallel, up to 100 nodes at once. This value or maxUnavailable is required to have a value.

OIDC

oidc_issuer :: Lens' OIDC (Maybe Text) Source #

The issuer URL for the OIDC identity provider.

OidcIdentityProviderConfig

oidcIdentityProviderConfig_groupsPrefix :: Lens' OidcIdentityProviderConfig (Maybe Text) Source #

The prefix that is prepended to group claims to prevent clashes with existing names (such as system: groups). For example, the value oidc: creates group names like oidc:engineering and oidc:infra. The prefix can't contain system:

oidcIdentityProviderConfig_usernameClaim :: Lens' OidcIdentityProviderConfig (Maybe Text) Source #

The JSON Web token (JWT) claim that is used as the username.

oidcIdentityProviderConfig_clientId :: Lens' OidcIdentityProviderConfig (Maybe Text) Source #

This is also known as audience. The ID of the client application that makes authentication requests to the OIDC identity provider.

oidcIdentityProviderConfig_issuerUrl :: Lens' OidcIdentityProviderConfig (Maybe Text) Source #

The URL of the OIDC identity provider that allows the API server to discover public signing keys for verifying tokens.

oidcIdentityProviderConfig_requiredClaims :: Lens' OidcIdentityProviderConfig (Maybe (HashMap Text Text)) Source #

The key-value pairs that describe required claims in the identity token. If set, each claim is verified to be present in the token with a matching value.

oidcIdentityProviderConfig_usernamePrefix :: Lens' OidcIdentityProviderConfig (Maybe Text) Source #

The prefix that is prepended to username claims to prevent clashes with existing names. The prefix can't contain system:

oidcIdentityProviderConfig_groupsClaim :: Lens' OidcIdentityProviderConfig (Maybe Text) Source #

The JSON web token (JWT) claim that the provider uses to return your groups.

oidcIdentityProviderConfig_clusterName :: Lens' OidcIdentityProviderConfig (Maybe Text) Source #

The cluster that the configuration is associated to.

oidcIdentityProviderConfig_tags :: Lens' OidcIdentityProviderConfig (Maybe (HashMap Text Text)) Source #

The metadata to apply to the provider configuration to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you defined.

OidcIdentityProviderConfigRequest

oidcIdentityProviderConfigRequest_groupsPrefix :: Lens' OidcIdentityProviderConfigRequest (Maybe Text) Source #

The prefix that is prepended to group claims to prevent clashes with existing names (such as system: groups). For example, the value oidc: will create group names like oidc:engineering and oidc:infra.

oidcIdentityProviderConfigRequest_usernameClaim :: Lens' OidcIdentityProviderConfigRequest (Maybe Text) Source #

The JSON Web Token (JWT) claim to use as the username. The default is sub, which is expected to be a unique identifier of the end user. You can choose other claims, such as email or name, depending on the OpenID identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins.

oidcIdentityProviderConfigRequest_requiredClaims :: Lens' OidcIdentityProviderConfigRequest (Maybe (HashMap Text Text)) Source #

The key value pairs that describe required claims in the identity token. If set, each claim is verified to be present in the token with a matching value. For the maximum number of claims that you can require, see Amazon EKS service quotas in the Amazon EKS User Guide.

oidcIdentityProviderConfigRequest_usernamePrefix :: Lens' OidcIdentityProviderConfigRequest (Maybe Text) Source #

The prefix that is prepended to username claims to prevent clashes with existing names. If you do not provide this field, and username is a value other than email, the prefix defaults to issuerurl#. You can use the value - to disable all prefixing.

oidcIdentityProviderConfigRequest_groupsClaim :: Lens' OidcIdentityProviderConfigRequest (Maybe Text) Source #

The JWT claim that the provider uses to return your groups.

oidcIdentityProviderConfigRequest_issuerUrl :: Lens' OidcIdentityProviderConfigRequest Text Source #

The URL of the OpenID identity provider that allows the API server to discover public signing keys for verifying tokens. The URL must begin with https:// and should correspond to the iss claim in the provider's OIDC ID tokens. Per the OIDC standard, path components are allowed but query parameters are not. Typically the URL consists of only a hostname, like https://server.example.org or https://example.com. This URL should point to the level below .well-known/openid-configuration and must be publicly accessible over the internet.

oidcIdentityProviderConfigRequest_clientId :: Lens' OidcIdentityProviderConfigRequest Text Source #

This is also known as audience. The ID for the client application that makes authentication requests to the OpenID identity provider.

Provider

provider_keyArn :: Lens' Provider (Maybe Text) Source #

Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric, created in the same region as the cluster, and if the KMS key was created in a different account, the user must have access to the KMS key. For more information, see Allowing Users in Other Accounts to Use a KMS key in the Key Management Service Developer Guide.

RemoteAccessConfig

remoteAccessConfig_sourceSecurityGroups :: Lens' RemoteAccessConfig (Maybe [Text]) Source #

The security groups that are allowed SSH access (port 22) to the nodes. If you specify an Amazon EC2 SSH key but do not specify a source security group when you create a managed node group, then port 22 on the nodes is opened to the internet (0.0.0.0/0). For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

remoteAccessConfig_ec2SshKey :: Lens' RemoteAccessConfig (Maybe Text) Source #

The Amazon EC2 SSH key that provides access for SSH communication with the nodes in the managed node group. For more information, see Amazon EC2 key pairs and Linux instances in the Amazon Elastic Compute Cloud User Guide for Linux Instances.

Taint

taint_effect :: Lens' Taint (Maybe TaintEffect) Source #

The effect of the taint.

taint_value :: Lens' Taint (Maybe Text) Source #

The value of the taint.

taint_key :: Lens' Taint (Maybe Text) Source #

The key of the taint.

Update

update_status :: Lens' Update (Maybe UpdateStatus) Source #

The current status of the update.

update_createdAt :: Lens' Update (Maybe UTCTime) Source #

The Unix epoch timestamp in seconds for when the update was created.

update_params :: Lens' Update (Maybe [UpdateParam]) Source #

A key-value map that contains the parameters associated with the update.

update_id :: Lens' Update (Maybe Text) Source #

A UUID that is used to track the update.

update_type :: Lens' Update (Maybe UpdateType) Source #

The type of the update.

update_errors :: Lens' Update (Maybe [ErrorDetail]) Source #

Any errors associated with a Failed update.

UpdateLabelsPayload

UpdateParam

updateParam_value :: Lens' UpdateParam (Maybe Text) Source #

The value of the keys submitted as part of an update request.

updateParam_type :: Lens' UpdateParam (Maybe UpdateParamType) Source #

The keys associated with an update request.

UpdateTaintsPayload

updateTaintsPayload_addOrUpdateTaints :: Lens' UpdateTaintsPayload (Maybe [Taint]) Source #

Kubernetes taints to be added or updated.

VpcConfigRequest

vpcConfigRequest_securityGroupIds :: Lens' VpcConfigRequest (Maybe [Text]) Source #

Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use that allow communication between your nodes and the Kubernetes control plane. If you don't specify any security groups, then familiarize yourself with the difference between Amazon EKS defaults for clusters deployed with Kubernetes:

  • 1.14 Amazon EKS platform version eks.2 and earlier
  • 1.14 Amazon EKS platform version eks.3 and later

For more information, see Amazon EKS security group considerations in the /Amazon EKS User Guide/ .

vpcConfigRequest_endpointPrivateAccess :: Lens' VpcConfigRequest (Maybe Bool) Source #

Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see Amazon EKS cluster endpoint access control in the /Amazon EKS User Guide/ .

vpcConfigRequest_publicAccessCidrs :: Lens' VpcConfigRequest (Maybe [Text]) Source #

The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have nodes or Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks. For more information, see Amazon EKS cluster endpoint access control in the /Amazon EKS User Guide/ .

vpcConfigRequest_subnetIds :: Lens' VpcConfigRequest (Maybe [Text]) Source #

Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane.

vpcConfigRequest_endpointPublicAccess :: Lens' VpcConfigRequest (Maybe Bool) Source #

Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server. For more information, see Amazon EKS cluster endpoint access control in the /Amazon EKS User Guide/ .

VpcConfigResponse

vpcConfigResponse_securityGroupIds :: Lens' VpcConfigResponse (Maybe [Text]) Source #

The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your nodes and the Kubernetes control plane.

vpcConfigResponse_endpointPrivateAccess :: Lens' VpcConfigResponse (Maybe Bool) Source #

This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster's VPC use the private VPC endpoint instead of traversing the internet. If this value is disabled and you have nodes or Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see Amazon EKS cluster endpoint access control in the /Amazon EKS User Guide/ .

vpcConfigResponse_publicAccessCidrs :: Lens' VpcConfigResponse (Maybe [Text]) Source #

The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the listed CIDR blocks is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have nodes or Fargate pods in the cluster, then ensure that the necessary CIDR blocks are listed. For more information, see Amazon EKS cluster endpoint access control in the /Amazon EKS User Guide/ .

vpcConfigResponse_subnetIds :: Lens' VpcConfigResponse (Maybe [Text]) Source #

The subnets associated with your cluster.

vpcConfigResponse_vpcId :: Lens' VpcConfigResponse (Maybe Text) Source #

The VPC associated with your cluster.

vpcConfigResponse_clusterSecurityGroupId :: Lens' VpcConfigResponse (Maybe Text) Source #

The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control-plane-to-data-plane communication.

vpcConfigResponse_endpointPublicAccess :: Lens' VpcConfigResponse (Maybe Bool) Source #

This parameter indicates whether the Amazon EKS public API server endpoint is enabled. If the Amazon EKS public API server endpoint is disabled, your cluster's Kubernetes API server can only receive requests that originate from within the cluster VPC.