| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.EKS.UpdateClusterConfig
Description
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 DescribeUpdate API operation.
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 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.
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 Amazon EKS cluster endpoint access control in the /Amazon EKS User Guide/ .
You can't update the subnets or security group IDs for an existing cluster.
Cluster updates are asynchronous, and they should finish within a few
minutes. During an update, the cluster status moves to UPDATING (this
status transition is eventually consistent). When the update is complete
(either Failed or Successful), the cluster status moves to Active.
Synopsis
- data UpdateClusterConfig = UpdateClusterConfig' {}
- newUpdateClusterConfig :: Text -> UpdateClusterConfig
- updateClusterConfig_clientRequestToken :: Lens' UpdateClusterConfig (Maybe Text)
- updateClusterConfig_logging :: Lens' UpdateClusterConfig (Maybe Logging)
- updateClusterConfig_resourcesVpcConfig :: Lens' UpdateClusterConfig (Maybe VpcConfigRequest)
- updateClusterConfig_name :: Lens' UpdateClusterConfig Text
- data UpdateClusterConfigResponse = UpdateClusterConfigResponse' {
- update :: Maybe Update
- httpStatus :: Int
- newUpdateClusterConfigResponse :: Int -> UpdateClusterConfigResponse
- updateClusterConfigResponse_update :: Lens' UpdateClusterConfigResponse (Maybe Update)
- updateClusterConfigResponse_httpStatus :: Lens' UpdateClusterConfigResponse Int
Creating a Request
data UpdateClusterConfig Source #
See: newUpdateClusterConfig smart constructor.
Constructors
| UpdateClusterConfig' | |
Fields
| |
Instances
newUpdateClusterConfig Source #
Arguments
| :: Text | |
| -> UpdateClusterConfig |
Create a value of UpdateClusterConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:UpdateClusterConfig', updateClusterConfig_clientRequestToken - Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
$sel:logging:UpdateClusterConfig', updateClusterConfig_logging - 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.
$sel:resourcesVpcConfig:UpdateClusterConfig', updateClusterConfig_resourcesVpcConfig - Undocumented member.
$sel:name:UpdateClusterConfig', updateClusterConfig_name - The name of the Amazon EKS cluster to update.
Request Lenses
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_resourcesVpcConfig :: Lens' UpdateClusterConfig (Maybe VpcConfigRequest) Source #
Undocumented member.
updateClusterConfig_name :: Lens' UpdateClusterConfig Text Source #
The name of the Amazon EKS cluster to update.
Destructuring the Response
data UpdateClusterConfigResponse Source #
See: newUpdateClusterConfigResponse smart constructor.
Constructors
| UpdateClusterConfigResponse' | |
Fields
| |
Instances
newUpdateClusterConfigResponse Source #
Create a value of UpdateClusterConfigResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:update:UpdateClusterConfigResponse', updateClusterConfigResponse_update - Undocumented member.
$sel:httpStatus:UpdateClusterConfigResponse', updateClusterConfigResponse_httpStatus - The response's http status code.
Response Lenses
updateClusterConfigResponse_update :: Lens' UpdateClusterConfigResponse (Maybe Update) Source #
Undocumented member.
updateClusterConfigResponse_httpStatus :: Lens' UpdateClusterConfigResponse Int Source #
The response's http status code.