@aws-sdk/client-eks

import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { EKSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EKSClient"; import { UpdateClusterConfigRequest, UpdateClusterConfigResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link UpdateClusterConfigCommand}. */ export interface UpdateClusterConfigCommandInput extends UpdateClusterConfigRequest { } /** * @public * * The output of {@link UpdateClusterConfigCommand}. */ export interface UpdateClusterConfigCommandOutput extends UpdateClusterConfigResponse, __MetadataBearer { } declare const UpdateClusterConfigCommand_base: { new (input: UpdateClusterConfigCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateClusterConfigCommandInput, UpdateClusterConfigCommandOutput, EKSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; new (__0_0: UpdateClusterConfigCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateClusterConfigCommandInput, UpdateClusterConfigCommandOutput, EKSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * 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 <code>DescribeUpdate</code>"/>. * 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 * * Amazon EKS User Guide * . * <note> * 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>. * </note> * 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 * Amazon EKS User Guide * . * You can also use this API operation to choose different subnets and security groups * for the cluster. You must specify at least two subnets that are in different Availability Zones. You * can't change which VPC the subnets are from, the subnets must be in the same VPC as the * subnets that the cluster was created with. For more information about the VPC * requirements, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html">https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html</a> in the * Amazon EKS User Guide * . * You can also use this API operation to enable or disable ARC zonal shift. If zonal * shift is enabled, Amazon Web Services configures zonal autoshift for the cluster. * 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 * <code>Successful</code>), the cluster status moves to <code>Active</code>. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { EKSClient, UpdateClusterConfigCommand } from "@aws-sdk/client-eks"; // ES Modules import * // const { EKSClient, UpdateClusterConfigCommand } = require("@aws-sdk/client-eks"); // CommonJS import * const client = new EKSClient(config); * const input = { // UpdateClusterConfigRequest * name: "STRING_VALUE", // required * resourcesVpcConfig: { // VpcConfigRequest * subnetIds: [ // StringList * "STRING_VALUE", * ], * securityGroupIds: [ * "STRING_VALUE", * ], * endpointPublicAccess: true || false, * endpointPrivateAccess: true || false, * publicAccessCidrs: [ * "STRING_VALUE", * ], * }, * logging: { // Logging * clusterLogging: [ // LogSetups * { // LogSetup * types: [ // LogTypes * "api" || "audit" || "authenticator" || "controllerManager" || "scheduler", * ], * enabled: true || false, * }, * ], * }, * clientRequestToken: "STRING_VALUE", * accessConfig: { // UpdateAccessConfigRequest * authenticationMode: "API" || "API_AND_CONFIG_MAP" || "CONFIG_MAP", * }, * upgradePolicy: { // UpgradePolicyRequest * supportType: "STANDARD" || "EXTENDED", * }, * zonalShiftConfig: { // ZonalShiftConfigRequest * enabled: true || false, * }, * computeConfig: { // ComputeConfigRequest * enabled: true || false, * nodePools: [ * "STRING_VALUE", * ], * nodeRoleArn: "STRING_VALUE", * }, * kubernetesNetworkConfig: { // KubernetesNetworkConfigRequest * serviceIpv4Cidr: "STRING_VALUE", * ipFamily: "ipv4" || "ipv6", * elasticLoadBalancing: { // ElasticLoadBalancing * enabled: true || false, * }, * }, * storageConfig: { // StorageConfigRequest * blockStorage: { // BlockStorage * enabled: true || false, * }, * }, * }; * const command = new UpdateClusterConfigCommand(input); * const response = await client.send(command); * // { // UpdateClusterConfigResponse * // update: { // Update * // id: "STRING_VALUE", * // status: "InProgress" || "Failed" || "Cancelled" || "Successful", * // type: "VersionUpdate" || "EndpointAccessUpdate" || "LoggingUpdate" || "ConfigUpdate" || "AssociateIdentityProviderConfig" || "DisassociateIdentityProviderConfig" || "AssociateEncryptionConfig" || "AddonUpdate" || "VpcConfigUpdate" || "AccessConfigUpdate" || "UpgradePolicyUpdate" || "ZonalShiftConfigUpdate" || "AutoModeUpdate", * // params: [ // UpdateParams * // { // UpdateParam * // type: "Version" || "PlatformVersion" || "EndpointPrivateAccess" || "EndpointPublicAccess" || "ClusterLogging" || "DesiredSize" || "LabelsToAdd" || "LabelsToRemove" || "TaintsToAdd" || "TaintsToRemove" || "MaxSize" || "MinSize" || "ReleaseVersion" || "PublicAccessCidrs" || "LaunchTemplateName" || "LaunchTemplateVersion" || "IdentityProviderConfig" || "EncryptionConfig" || "AddonVersion" || "ServiceAccountRoleArn" || "ResolveConflicts" || "MaxUnavailable" || "MaxUnavailablePercentage" || "NodeRepairEnabled" || "UpdateStrategy" || "ConfigurationValues" || "SecurityGroups" || "Subnets" || "AuthenticationMode" || "PodIdentityAssociations" || "UpgradePolicy" || "ZonalShiftConfig" || "ComputeConfig" || "StorageConfig" || "KubernetesNetworkConfig", * // value: "STRING_VALUE", * // }, * // ], * // createdAt: new Date("TIMESTAMP"), * // errors: [ // ErrorDetails * // { // ErrorDetail * // errorCode: "SubnetNotFound" || "SecurityGroupNotFound" || "EniLimitReached" || "IpNotAvailable" || "AccessDenied" || "OperationNotPermitted" || "VpcIdNotFound" || "Unknown" || "NodeCreationFailure" || "PodEvictionFailure" || "InsufficientFreeAddresses" || "ClusterUnreachable" || "InsufficientNumberOfReplicas" || "ConfigurationConflict" || "AdmissionRequestDenied" || "UnsupportedAddonModification" || "K8sResourceNotFound", * // errorMessage: "STRING_VALUE", * // resourceIds: [ // StringList * // "STRING_VALUE", * // ], * // }, * // ], * // }, * // }; * * ``` * * @param UpdateClusterConfigCommandInput - {@link UpdateClusterConfigCommandInput} * @returns {@link UpdateClusterConfigCommandOutput} * @see {@link UpdateClusterConfigCommandInput} for command's `input` shape. * @see {@link UpdateClusterConfigCommandOutput} for command's `response` shape. * @see {@link EKSClientResolvedConfig | config} for EKSClient's `config` shape. * * @throws {@link ClientException} (client fault) * 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. * * @throws {@link InvalidParameterException} (client fault) * The specified parameter is invalid. Review the available parameters for the API * request. * * @throws {@link InvalidRequestException} (client fault) * The request is invalid given the state of the cluster. Check the state of the cluster * and the associated operations. * * @throws {@link ResourceInUseException} (client fault) * The specified resource is in use. * * @throws {@link ResourceNotFoundException} (client fault) * 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. * * @throws {@link ServerException} (server fault) * These errors are usually caused by a server-side issue. * * @throws {@link EKSServiceException} * Base exception class for all service exceptions from EKS service. * * @public */ export declare class UpdateClusterConfigCommand extends UpdateClusterConfigCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: UpdateClusterConfigRequest; output: UpdateClusterConfigResponse; }; sdk: { input: UpdateClusterConfigCommandInput; output: UpdateClusterConfigCommandOutput; }; }; }