AssociateEncryptionConfig - Amazon EKS

AssociateEncryptionConfig

Associate encryption configuration to an existing cluster.

You can use this API to enable encryption on existing clusters which do not have encryption already enabled. This allows you to implement a defense-in-depth security strategy without migrating applications to new Amazon EKS clusters.

Request Syntax

POST /clusters/name/encryption-config/associate HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "encryptionConfig": [ { "provider": { "keyArn": "string" }, "resources": [ "string" ] } ] }

URI Request Parameters

The request uses the following URI parameters.

name

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientRequestToken

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

Type: String

Required: No

encryptionConfig

The configuration you are using for encryption.

Type: Array of EncryptionConfig objects

Array Members: Maximum number of 1 item.

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "update": { "createdAt": number, "errors": [ { "errorCode": "string", "errorMessage": "string", "resourceIds": [ "string" ] } ], "id": "string", "params": [ { "type": "string", "value": "string" } ], "status": "string", "type": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

update

An object representing an asynchronous update.

Type: Update object

Errors

For information about the errors that are common to all actions, see Common Errors.

ClientException

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

HTTP Status Code: 400

InvalidParameterException

The specified parameter is invalid. Review the available parameters for the API request.

HTTP Status Code: 400

InvalidRequestException

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

HTTP Status Code: 400

ResourceInUseException

The specified resource is in use.

HTTP Status Code: 409

ResourceNotFoundException

The specified resource could not be found. You can view your available clusters with ListClusters . You can view your available managed node groups with ListNodegroups . Amazon EKS clusters and node groups are Region-specific.

HTTP Status Code: 404

ServerException

These errors are usually caused by a server-side issue.

HTTP Status Code: 500

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: