@aws-sdk/client-eks 3.45.0 → 3.46.0

package/dist-types/commands/CreateFargateProfileCommand.d.ts

@@ -7,30 +7,34 @@ export interface CreateFargateProfileCommandInput extends CreateFargateProfileRe
 export interface CreateFargateProfileCommandOutput extends CreateFargateProfileResponse, __MetadataBearer {
 }
 /**
- * <p>Creates an Fargate profile for your Amazon EKS cluster. You must have at least one Fargate
- *             profile in a cluster to be able to run pods on Fargate.</p>
- *         <p>The Fargate profile allows an administrator to declare which pods run on Fargate and specify
- *             which pods run on which Fargate profile. This declaration is done through the profile’s
- *             selectors. Each profile can have up to five selectors that contain a namespace and
- *             labels. A namespace is required for every selector. The label field consists of multiple
- *             optional key-value pairs. Pods that match the selectors are scheduled on Fargate. If a
- *             to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is
- *             run on Fargate.</p>
- *         <p>When you create a Fargate profile, you must specify a pod execution role to use with the
- *             pods that are scheduled with the profile. This role is added to the cluster's Kubernetes
- *                 <a href="https://kubernetes.io/docs/admin/authorization/rbac/">Role Based Access
- *                 Control</a> (RBAC) for authorization so that the <code>kubelet</code> that is
- *             running on the Fargate infrastructure can register with your Amazon EKS cluster so that it can
- *             appear in your cluster as a node. The pod execution role also provides IAM permissions
- *             to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For more
- *             information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html">Pod Execution Role</a> in the <i>Amazon EKS User Guide</i>.</p>
- *         <p>Fargate profiles are immutable. However, you can create a new updated profile to replace
- *             an existing profile and then delete the original after the updated profile has finished
- *             creating.</p>
- *         <p>If any Fargate profiles in a cluster are in the <code>DELETING</code> status, you must
- *             wait for that Fargate profile to finish deleting before you can create any other profiles
- *             in that cluster.</p>
- *         <p>For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html">Fargate Profile</a> in the <i>Amazon EKS User Guide</i>.</p>
+ * <p>Creates an Fargate profile for your Amazon EKS cluster. You
+ *             must have at least one Fargate profile in a cluster to be able to run
+ *             pods on Fargate.</p>
+ *         <p>The Fargate profile allows an administrator to declare which pods run
+ *             on Fargate and specify which pods run on which Fargate
+ *             profile. This declaration is done through the profile’s selectors. Each profile can have
+ *             up to five selectors that contain a namespace and labels. A namespace is required for
+ *             every selector. The label field consists of multiple optional key-value pairs. Pods that
+ *             match the selectors are scheduled on Fargate. If a to-be-scheduled pod
+ *             matches any of the selectors in the Fargate profile, then that pod is run
+ *             on Fargate.</p>
+ *         <p>When you create a Fargate profile, you must specify a pod execution
+ *             role to use with the pods that are scheduled with the profile. This role is added to the
+ *             cluster's Kubernetes <a href="https://kubernetes.io/docs/admin/authorization/rbac/">Role Based Access Control</a> (RBAC) for authorization so that the
+ *                 <code>kubelet</code> that is running on the Fargate infrastructure
+ *             can register with your Amazon EKS cluster so that it can appear in your cluster
+ *             as a node. The pod execution role also provides IAM permissions to the
+ *                 Fargate infrastructure to allow read access to Amazon ECR
+ *             image repositories. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html">Pod
+ *                 Execution Role</a> in the <i>Amazon EKS User Guide</i>.</p>
+ *         <p>Fargate profiles are immutable. However, you can create a new updated
+ *             profile to replace an existing profile and then delete the original after the updated
+ *             profile has finished creating.</p>
+ *         <p>If any Fargate profiles in a cluster are in the <code>DELETING</code>
+ *             status, you must wait for that Fargate profile to finish deleting before
+ *             you can create any other profiles in that cluster.</p>
+ *         <p>For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html">Fargate Profile</a> in the
+ *             <i>Amazon EKS User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/CreateNodegroupCommand.d.ts

@@ -7,15 +7,16 @@ export interface CreateNodegroupCommandInput extends CreateNodegroupRequest {
 export interface CreateNodegroupCommandOutput extends CreateNodegroupResponse, __MetadataBearer {
 }
 /**
- * <p>Creates a managed node group for an Amazon EKS cluster. You can only create a node group
- *             for your cluster that is equal to the current Kubernetes version for the cluster. All
- *             node groups are created with the latest AMI release version for the respective minor
- *             Kubernetes version of the cluster, unless you deploy a custom AMI using a launch
- *             template. For more information about using launch templates, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html">Launch
+ * <p>Creates a managed node group for an Amazon EKS cluster. You can only create a
+ *             node group for your cluster that is equal to the current Kubernetes version for the
+ *             cluster. All node groups are created with the latest AMI release version for the
+ *             respective minor Kubernetes version of the cluster, unless you deploy a custom AMI using
+ *             a launch template. For more information about using launch templates, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html">Launch
  *                 template support</a>.</p>
- *         <p>An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that
- *             are managed by Amazon Web Services for an Amazon EKS cluster. Each node group uses a version of the Amazon EKS
- *             optimized Amazon Linux 2 AMI. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html">Managed
+ *         <p>An Amazon EKS managed node group is an Amazon EC2
+ *             Auto Scaling group and associated Amazon EC2 instances that are managed by
+ *                 Amazon Web Services for an Amazon EKS cluster. Each node group uses a version
+ *             of the Amazon EKS optimized Amazon Linux 2 AMI. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html">Managed
  *                 Node Groups</a> in the <i>Amazon EKS User Guide</i>. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

package/dist-types/commands/DeleteClusterCommand.d.ts

@@ -13,8 +13,8 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met
  *             are deleted properly. Otherwise, you can have orphaned resources in your VPC that
  *             prevent you from being able to delete the VPC. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html">Deleting a
  *                 Cluster</a> in the <i>Amazon EKS User Guide</i>.</p>
- *         <p>If you have managed node groups or Fargate profiles attached to the cluster, you must
- *             delete them first. For more information, see <a>DeleteNodegroup</a> and <a>DeleteFargateProfile</a>.</p>
+ *         <p>If you have managed node groups or Fargate profiles attached to the
+ *             cluster, you must delete them first. For more information, see <a>DeleteNodegroup</a> and <a>DeleteFargateProfile</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/DeleteFargateProfileCommand.d.ts

@@ -8,13 +8,14 @@ export interface DeleteFargateProfileCommandOutput extends DeleteFargateProfileR
 }
 /**
  * <p>Deletes an Fargate profile.</p>
- *         <p>When you delete a Fargate profile, any pods running on Fargate that were created with the
- *             profile are deleted. If those pods match another Fargate profile, then they are scheduled
- *             on Fargate with that profile. If they no longer match any Fargate profiles, then they are not
- *             scheduled on Fargate and they may remain in a pending state.</p>
- *         <p>Only one Fargate profile in a cluster can be in the <code>DELETING</code> status at a
- *             time. You must wait for a Fargate profile to finish deleting before you can delete any
- *             other profiles in that cluster.</p>
+ *         <p>When you delete a Fargate profile, any pods running on Fargate that were created with the profile are deleted. If those pods match
+ *             another Fargate profile, then they are scheduled on Fargate with that profile. If they no longer match any Fargate profiles, then
+ *             they are not scheduled on Fargate and they may remain in a pending
+ *             state.</p>
+ *         <p>Only one Fargate profile in a cluster can be in the
+ *                 <code>DELETING</code> status at a time. You must wait for a Fargate
+ *             profile to finish deleting before you can delete any other profiles in that
+ *             cluster.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/DeregisterClusterCommand.d.ts

@@ -7,7 +7,8 @@ export interface DeregisterClusterCommandInput extends DeregisterClusterRequest
 export interface DeregisterClusterCommandOutput extends DeregisterClusterResponse, __MetadataBearer {
 }
 /**
- * <p>Deregisters a connected cluster to remove it from the Amazon EKS control plane.</p>
+ * <p>Deregisters a connected cluster to remove it from the Amazon EKS control
+ *             plane.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/DescribeUpdateCommand.d.ts

@@ -7,8 +7,8 @@ export interface DescribeUpdateCommandInput extends DescribeUpdateRequest {
 export interface DescribeUpdateCommandOutput extends DescribeUpdateResponse, __MetadataBearer {
 }
 /**
- * <p>Returns descriptive information about an update against your Amazon EKS cluster or
- *             associated managed node group.</p>
+ * <p>Returns descriptive information about an update against your Amazon EKS
+ *             cluster or associated managed node group.</p>
  *         <p>When the status of the update is <code>Succeeded</code>, the update is complete. If an
  *             update fails, the status is <code>Failed</code>, and an error detail explains the reason
  *             for the failure.</p>

package/dist-types/commands/DisassociateIdentityProviderConfigCommand.d.ts

@@ -9,8 +9,8 @@ export interface DisassociateIdentityProviderConfigCommandOutput extends Disasso
 /**
  * <p>Disassociates an identity provider configuration from a cluster. If you disassociate
  *             an identity provider from your cluster, users included in the provider can no longer
- *             access the cluster. However, you can still access the cluster with Amazon Web Services IAM
- *             users.</p>
+ *             access the cluster. However, you can still access the cluster with Amazon Web Services
+ *             IAM users.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/ListClustersCommand.d.ts

@@ -7,7 +7,8 @@ export interface ListClustersCommandInput extends ListClustersRequest {
 export interface ListClustersCommandOutput extends ListClustersResponse, __MetadataBearer {
 }
 /**
- * <p>Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.</p>
+ * <p>Lists the Amazon EKS clusters in your Amazon Web Services account in the
+ *             specified Region.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/ListFargateProfilesCommand.d.ts

@@ -7,8 +7,8 @@ export interface ListFargateProfilesCommandInput extends ListFargateProfilesRequ
 export interface ListFargateProfilesCommandOutput extends ListFargateProfilesResponse, __MetadataBearer {
 }
 /**
- * <p>Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services
- *             account in the specified Region.</p>
+ * <p>Lists the Fargate profiles associated with the specified cluster in
+ *             your Amazon Web Services account in the specified Region.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/ListNodegroupsCommand.d.ts

@@ -7,8 +7,9 @@ export interface ListNodegroupsCommandInput extends ListNodegroupsRequest {
 export interface ListNodegroupsCommandOutput extends ListNodegroupsResponse, __MetadataBearer {
 }
 /**
- * <p>Lists the Amazon EKS managed node groups associated with the specified cluster in your
- *             Amazon Web Services account in the specified Region. Self-managed node groups are not listed.</p>
+ * <p>Lists the Amazon EKS managed node groups associated with the specified cluster
+ *             in your Amazon Web Services account in the specified Region. Self-managed node groups are
+ *             not listed.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/ListUpdatesCommand.d.ts

@@ -7,8 +7,8 @@ export interface ListUpdatesCommandInput extends ListUpdatesRequest {
 export interface ListUpdatesCommandOutput extends ListUpdatesResponse, __MetadataBearer {
 }
 /**
- * <p>Lists the updates associated with an Amazon EKS cluster or managed node group in your Amazon Web Services
- *             account, in the specified Region.</p>
+ * <p>Lists the updates associated with an Amazon EKS cluster or managed node group
+ *             in your Amazon Web Services account, in the specified Region.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/RegisterClusterCommand.d.ts

@@ -8,14 +8,18 @@ export interface RegisterClusterCommandOutput extends RegisterClusterResponse, _
 }
 /**
  * <p>Connects a Kubernetes cluster to the Amazon EKS control plane. </p>
- *         <p>Any Kubernetes cluster can be connected to the Amazon EKS control plane to view current information about the cluster and its nodes.
- *          </p>
+ *         <p>Any Kubernetes cluster can be connected to the Amazon EKS control plane to
+ *             view current information about the cluster and its nodes. </p>
  *         <p>Cluster connection requires two steps. First, send a <code>
  *                <a>RegisterClusterRequest</a>
- *             </code> to add it to the Amazon EKS control plane.</p>
- *         <p>Second, a <a href="https://amazon-eks.s3.us-west-2.amazonaws.com/eks-connector/manifests/eks-connector/latest/eks-connector.yaml">Manifest</a> containing the <code>activationID</code> and <code>activationCode</code> must be applied to the Kubernetes cluster through it's native provider to provide visibility.</p>
+ *             </code> to add it to the Amazon EKS
+ *             control plane.</p>
+ *         <p>Second, a <a href="https://amazon-eks.s3.us-west-2.amazonaws.com/eks-connector/manifests/eks-connector/latest/eks-connector.yaml">Manifest</a> containing the <code>activationID</code> and
+ *                 <code>activationCode</code> must be applied to the Kubernetes cluster through it's
+ *             native provider to provide visibility.</p>
  *
- *         <p>After the Manifest is updated and applied, then the connected cluster is visible to the Amazon EKS control plane. If the Manifest is not applied within three days,
+ *         <p>After the Manifest is updated and applied, then the connected cluster is visible to
+ *             the Amazon EKS control plane. If the Manifest is not applied within three days,
  *             then the connected cluster will no longer be visible and must be deregistered. See <a>DeregisterCluster</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

package/dist-types/commands/TagResourceCommand.d.ts

@@ -10,10 +10,9 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  * <p>Associates the specified tags to a resource with the specified
  *                 <code>resourceArn</code>. If existing tags on a resource are not specified in the
  *             request parameters, they are not changed. When a resource is deleted, the tags
- *             associated with that resource are deleted as well. Tags that you create for Amazon EKS
- *             resources do not propagate to any other resources associated with the cluster. For
- *             example, if you tag a cluster with this operation, that tag does not automatically
- *             propagate to the subnets and nodes associated with the cluster.</p>
+ *             associated with that resource are deleted as well. Tags that you create for Amazon EKS resources do not propagate to any other resources associated with the
+ *             cluster. For example, if you tag a cluster with this operation, that tag does not
+ *             automatically propagate to the subnets and nodes associated with the cluster.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UpdateClusterConfigCommand.d.ts

@@ -7,24 +7,25 @@ export interface UpdateClusterConfigCommandInput extends UpdateClusterConfigRequ
 export interface UpdateClusterConfigCommandOutput extends UpdateClusterConfigResponse, __MetadataBearer {
 }
 /**
- * <p>Updates an Amazon EKS cluster configuration. Your cluster continues to function during the
- *             update. The response output includes an update ID that you can use to track the status
- *             of your cluster update with the <a>DescribeUpdate</a> API operation.</p>
+ * <p>Updates an Amazon EKS cluster configuration. Your cluster continues to
+ *             function during the update. The response output includes an update ID that you can use
+ *             to track the status of your cluster update with the <a>DescribeUpdate</a> API
+ *             operation.</p>
  *         <p>You can use this API operation to 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 <a href="https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html">Amazon EKS
- *                 Cluster Control Plane Logs</a> in the
- *             <i>
+ *             plane logs for your cluster to CloudWatch Logs. By default, cluster control plane
+ *             logs aren't exported to CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html">Amazon EKS Cluster Control Plane Logs</a> in the
+ *                 <i>
  *                <i>Amazon EKS User Guide</i>
  *             </i>.</p>
  *         <note>
- *             <p>CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported
- *                 control plane logs. For more information, see <a href="http://aws.amazon.com/cloudwatch/pricing/">CloudWatch Pricing</a>.</p>
+ *             <p>CloudWatch Logs ingestion, archive storage, and data scanning rates apply to
+ *                 exported control plane logs. For more information, see <a href="http://aws.amazon.com/cloudwatch/pricing/">CloudWatch
+ *                 Pricing</a>.</p>
  *         </note>
  *         <p>You can also use this API operation to enable or disable public and private access to
  *             your cluster's Kubernetes API server endpoint. By default, public access is enabled, and
- *             private access is disabled. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html">Amazon EKS cluster
- *                 endpoint access control</a> in the <i>
+ *             private access is disabled. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html">Amazon EKS cluster endpoint access control</a> in the
+ *                 <i>
  *                <i>Amazon EKS User Guide</i>
  *             </i>. </p>
  *         <important>

package/dist-types/commands/UpdateClusterVersionCommand.d.ts

@@ -7,10 +7,9 @@ export interface UpdateClusterVersionCommandInput extends UpdateClusterVersionRe
 export interface UpdateClusterVersionCommandOutput extends UpdateClusterVersionResponse, __MetadataBearer {
 }
 /**
- * <p>Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues
- *             to function during the update. The response output includes an update ID that you can
- *             use to track the status of your cluster update with the <a>DescribeUpdate</a>
- *             API operation.</p>
+ * <p>Updates an Amazon EKS cluster to the specified Kubernetes version. Your
+ *             cluster continues to function during the update. The response output includes an update
+ *             ID that you can use to track the status of your cluster update with the <a>DescribeUpdate</a> API operation.</p>
  *         <p>Cluster updates are asynchronous, and they should finish within a few minutes. During
  *             an update, the cluster status moves to <code>UPDATING</code> (this status transition is
  *             eventually consistent). When the update is complete (either <code>Failed</code> or

package/dist-types/commands/UpdateNodegroupConfigCommand.d.ts

@@ -7,11 +7,10 @@ export interface UpdateNodegroupConfigCommandInput extends UpdateNodegroupConfig
 export interface UpdateNodegroupConfigCommandOutput extends UpdateNodegroupConfigResponse, __MetadataBearer {
 }
 /**
- * <p>Updates an Amazon EKS managed node group configuration. Your node group continues to
- *             function during the update. The response output includes an update ID that you can use
- *             to track the status of your node group update with the <a>DescribeUpdate</a>
- *             API operation. Currently you can update the Kubernetes labels for a node group or the
- *             scaling configuration.</p>
+ * <p>Updates an Amazon EKS managed node group configuration. Your node group
+ *             continues to function during the update. The response output includes an update ID that
+ *             you can use to track the status of your node group update with the <a>DescribeUpdate</a> API operation. Currently you can update the Kubernetes
+ *             labels for a node group or the scaling configuration.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UpdateNodegroupVersionCommand.d.ts

@@ -7,7 +7,8 @@ export interface UpdateNodegroupVersionCommandInput extends UpdateNodegroupVersi
 export interface UpdateNodegroupVersionCommandOutput extends UpdateNodegroupVersionResponse, __MetadataBearer {
 }
 /**
- * <p>Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.</p>
+ * <p>Updates the Kubernetes version or AMI version of an Amazon EKS managed node
+ *             group.</p>
  *         <p>You can update a node group using a launch template only if the node group was
  *             originally deployed with a launch template. If you need to update a custom AMI in a node
  *             group that was deployed with a launch template, then update your custom AMI, specify the
@@ -17,14 +18,14 @@ export interface UpdateNodegroupVersionCommandOutput extends UpdateNodegroupVers
  *             AMI version of a node group's current Kubernetes version by not specifying a Kubernetes
  *             version in the request. You can update to the latest AMI version of your cluster's
  *             current Kubernetes version by specifying your cluster's Kubernetes version in the
- *             request. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html">Amazon EKS
- *                 optimized Amazon Linux 2 AMI versions</a> in the <i>Amazon EKS User Guide</i>.</p>
+ *             request. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html">Amazon EKS optimized Amazon Linux 2 AMI versions</a> in the <i>Amazon EKS User Guide</i>.</p>
  *         <p>You cannot roll back a node group to an earlier Kubernetes version or AMI
  *             version.</p>
  *         <p>When a node in a managed node group is terminated due to a scaling action or update,
- *             the pods in that node are drained first. Amazon EKS attempts to drain the nodes gracefully
- *             and will fail if it is unable to do so. You can <code>force</code> the update if Amazon EKS
- *             is unable to drain the nodes as a result of a pod disruption budget issue.</p>
+ *             the pods in that node are drained first. Amazon EKS attempts to drain the nodes
+ *             gracefully and will fail if it is unable to do so. You can <code>force</code> the update
+ *             if Amazon EKS is unable to drain the nodes as a result of a pod disruption
+ *             budget issue.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript