@aws-sdk/client-eks
Version:
AWS SDK for JavaScript Eks Client for Node.js, Browser and React Native
170 lines (169 loc) • 8.28 kB
TypeScript
import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
import { EKSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EKSClient";
import { DeleteNodegroupRequest, DeleteNodegroupResponse } from "../models/models_0";
/**
* @public
*/
export type { __MetadataBearer };
export { $Command };
/**
* @public
*
* The input for {@link DeleteNodegroupCommand}.
*/
export interface DeleteNodegroupCommandInput extends DeleteNodegroupRequest {
}
/**
* @public
*
* The output of {@link DeleteNodegroupCommand}.
*/
export interface DeleteNodegroupCommandOutput extends DeleteNodegroupResponse, __MetadataBearer {
}
declare const DeleteNodegroupCommand_base: {
new (input: DeleteNodegroupCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteNodegroupCommandInput, DeleteNodegroupCommandOutput, EKSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
new (__0_0: DeleteNodegroupCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteNodegroupCommandInput, DeleteNodegroupCommandOutput, EKSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
};
/**
* <p>Deletes a managed node group.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { EKSClient, DeleteNodegroupCommand } from "@aws-sdk/client-eks"; // ES Modules import
* // const { EKSClient, DeleteNodegroupCommand } = require("@aws-sdk/client-eks"); // CommonJS import
* const client = new EKSClient(config);
* const input = { // DeleteNodegroupRequest
* clusterName: "STRING_VALUE", // required
* nodegroupName: "STRING_VALUE", // required
* };
* const command = new DeleteNodegroupCommand(input);
* const response = await client.send(command);
* // { // DeleteNodegroupResponse
* // nodegroup: { // Nodegroup
* // nodegroupName: "STRING_VALUE",
* // nodegroupArn: "STRING_VALUE",
* // clusterName: "STRING_VALUE",
* // version: "STRING_VALUE",
* // releaseVersion: "STRING_VALUE",
* // createdAt: new Date("TIMESTAMP"),
* // modifiedAt: new Date("TIMESTAMP"),
* // status: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "CREATE_FAILED" || "DELETE_FAILED" || "DEGRADED",
* // capacityType: "ON_DEMAND" || "SPOT" || "CAPACITY_BLOCK",
* // scalingConfig: { // NodegroupScalingConfig
* // minSize: Number("int"),
* // maxSize: Number("int"),
* // desiredSize: Number("int"),
* // },
* // instanceTypes: [ // StringList
* // "STRING_VALUE",
* // ],
* // subnets: [
* // "STRING_VALUE",
* // ],
* // remoteAccess: { // RemoteAccessConfig
* // ec2SshKey: "STRING_VALUE",
* // sourceSecurityGroups: [
* // "STRING_VALUE",
* // ],
* // },
* // amiType: "AL2_x86_64" || "AL2_x86_64_GPU" || "AL2_ARM_64" || "CUSTOM" || "BOTTLEROCKET_ARM_64" || "BOTTLEROCKET_x86_64" || "BOTTLEROCKET_ARM_64_NVIDIA" || "BOTTLEROCKET_x86_64_NVIDIA" || "WINDOWS_CORE_2019_x86_64" || "WINDOWS_FULL_2019_x86_64" || "WINDOWS_CORE_2022_x86_64" || "WINDOWS_FULL_2022_x86_64" || "AL2023_x86_64_STANDARD" || "AL2023_ARM_64_STANDARD" || "AL2023_x86_64_NEURON" || "AL2023_x86_64_NVIDIA",
* // nodeRole: "STRING_VALUE",
* // labels: { // labelsMap
* // "<keys>": "STRING_VALUE",
* // },
* // taints: [ // taintsList
* // { // Taint
* // key: "STRING_VALUE",
* // value: "STRING_VALUE",
* // effect: "NO_SCHEDULE" || "NO_EXECUTE" || "PREFER_NO_SCHEDULE",
* // },
* // ],
* // resources: { // NodegroupResources
* // autoScalingGroups: [ // AutoScalingGroupList
* // { // AutoScalingGroup
* // name: "STRING_VALUE",
* // },
* // ],
* // remoteAccessSecurityGroup: "STRING_VALUE",
* // },
* // diskSize: Number("int"),
* // health: { // NodegroupHealth
* // issues: [ // IssueList
* // { // Issue
* // code: "AutoScalingGroupNotFound" || "AutoScalingGroupInvalidConfiguration" || "Ec2SecurityGroupNotFound" || "Ec2SecurityGroupDeletionFailure" || "Ec2LaunchTemplateNotFound" || "Ec2LaunchTemplateVersionMismatch" || "Ec2SubnetNotFound" || "Ec2SubnetInvalidConfiguration" || "IamInstanceProfileNotFound" || "Ec2SubnetMissingIpv6Assignment" || "IamLimitExceeded" || "IamNodeRoleNotFound" || "NodeCreationFailure" || "AsgInstanceLaunchFailures" || "InstanceLimitExceeded" || "InsufficientFreeAddresses" || "AccessDenied" || "InternalFailure" || "ClusterUnreachable" || "AmiIdNotFound" || "AutoScalingGroupOptInRequired" || "AutoScalingGroupRateLimitExceeded" || "Ec2LaunchTemplateDeletionFailure" || "Ec2LaunchTemplateInvalidConfiguration" || "Ec2LaunchTemplateMaxLimitExceeded" || "Ec2SubnetListTooLong" || "IamThrottling" || "NodeTerminationFailure" || "PodEvictionFailure" || "SourceEc2LaunchTemplateNotFound" || "LimitExceeded" || "Unknown" || "AutoScalingGroupInstanceRefreshActive" || "KubernetesLabelInvalid" || "Ec2LaunchTemplateVersionMaxLimitExceeded" || "Ec2InstanceTypeDoesNotExist",
* // message: "STRING_VALUE",
* // resourceIds: "<StringList>",
* // },
* // ],
* // },
* // updateConfig: { // NodegroupUpdateConfig
* // maxUnavailable: Number("int"),
* // maxUnavailablePercentage: Number("int"),
* // updateStrategy: "DEFAULT" || "MINIMAL",
* // },
* // nodeRepairConfig: { // NodeRepairConfig
* // enabled: true || false,
* // },
* // launchTemplate: { // LaunchTemplateSpecification
* // name: "STRING_VALUE",
* // version: "STRING_VALUE",
* // id: "STRING_VALUE",
* // },
* // tags: { // TagMap
* // "<keys>": "STRING_VALUE",
* // },
* // },
* // };
*
* ```
*
* @param DeleteNodegroupCommandInput - {@link DeleteNodegroupCommandInput}
* @returns {@link DeleteNodegroupCommandOutput}
* @see {@link DeleteNodegroupCommandInput} for command's `input` shape.
* @see {@link DeleteNodegroupCommandOutput} for command's `response` shape.
* @see {@link EKSClientResolvedConfig | config} for EKSClient's `config` shape.
*
* @throws {@link ClientException} (client fault)
* <p>These errors are usually caused by a client action. Actions can include using an
* action or resource on behalf of an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html">IAM principal</a> that doesn't have permissions to use
* the action or resource or specifying an identifier that is not valid.</p>
*
* @throws {@link InvalidParameterException} (client fault)
* <p>The specified parameter is invalid. Review the available parameters for the API
* request.</p>
*
* @throws {@link ResourceInUseException} (client fault)
* <p>The specified resource is in use.</p>
*
* @throws {@link ResourceNotFoundException} (client fault)
* <p>The specified resource could not be found. You can view your available clusters with
* <code>ListClusters</code>. You can view your available managed node groups with
* <code>ListNodegroups</code>. Amazon EKS clusters and node groups are Amazon Web Services Region
* specific.</p>
*
* @throws {@link ServerException} (server fault)
* <p>These errors are usually caused by a server-side issue.</p>
*
* @throws {@link ServiceUnavailableException} (server fault)
* <p>The service is unavailable. Back off and retry the operation.</p>
*
* @throws {@link EKSServiceException}
* <p>Base exception class for all service exceptions from EKS service.</p>
*
* @public
*/
export declare class DeleteNodegroupCommand extends DeleteNodegroupCommand_base {
/** @internal type navigation helper, not in runtime. */
protected static __types: {
api: {
input: DeleteNodegroupRequest;
output: DeleteNodegroupResponse;
};
sdk: {
input: DeleteNodegroupCommandInput;
output: DeleteNodegroupCommandOutput;
};
};
}