AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs query insights results in the account.
When you use AssociateKmsKey, you specify either the logGroupName parameter
or the resourceIdentifier parameter. You can't specify both of those parameters
in the same operation.
Specify the logGroupName parameter to cause all log events stored in the log
group to be encrypted with that key. Only the log events ingested after the key is
associated are encrypted with that key.
Associating a KMS key with a log group overrides any existing associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
Associating a key with a log group does not cause the results of queries of that log
group to be encrypted with that key. To have query results encrypted with a KMS key,
you must use an AssociateKmsKey operation with the resourceIdentifier
parameter that specifies a query-result resource.
Specify the resourceIdentifier parameter with a query-result resource,
to use that key to encrypt the stored results of all future StartQuery
operations in the account. The response from a GetQueryResults
operation will still return the query results in plain text.
Even if you have not associated a key with your query results, the query results are encrypted when stored, using the default CloudWatch Logs method.
If you run a query from a monitoring account that queries logs in a source account, the query results key from the monitoring account, if any, is used.
If you delete the key that is used to encrypt log events or log group query results, then all the associated stored log events or query results that were encrypted with that key will be unencryptable and unusable.
CloudWatch Logs supports only symmetric KMS keys. Do not use an associate an asymmetric KMS key with your log group or query results. For more information, see Using Symmetric and Asymmetric Keys.
It can take up to 5 minutes for this operation to take effect.
If you attempt to associate a KMS key with a log group but the KMS key does not exist
or the KMS key is disabled, you receive an InvalidParameterException error.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginAssociateKmsKey and EndAssociateKmsKey.
Namespace: Amazon.CloudWatchLogs
Assembly: AWSSDK.CloudWatchLogs.dll
Version: 3.x.y.z
public virtual Task<AssociateKmsKeyResponse> AssociateKmsKeyAsync( AssociateKmsKeyRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the AssociateKmsKey service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| InvalidParameterException | A parameter is specified incorrectly. |
| OperationAbortedException | Multiple concurrent requests to update the same resource were in conflict. |
| ResourceNotFoundException | The specified resource does not exist. |
| ServiceUnavailableException | The service cannot complete the request. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5