Interface CloudWatchLogsConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<CloudWatchLogsConfiguration.Builder,CloudWatchLogsConfiguration>, SdkBuilder<CloudWatchLogsConfiguration.Builder,CloudWatchLogsConfiguration>, SdkPojo
Enclosing class:
CloudWatchLogsConfiguration
@Mutable @NotThreadSafe public static interface CloudWatchLogsConfiguration.Builder extends SdkPojo, CopyableBuilder<CloudWatchLogsConfiguration.Builder,CloudWatchLogsConfiguration>

  • Method Details

    • spansLogGroupKmsKeyId

      CloudWatchLogsConfiguration.Builder spansLogGroupKmsKeyId(String spansLogGroupKmsKeyId)

      The ARN of an AWS Key Management Service (AWS KMS) key that you create and manage, in the same account and Region, used to encrypt the aws/spans log group. Key IDs and alias ARNs are not supported.

      X-Ray applies the key only when it creates aws/spans. If the account already has an aws/spans log group, X-Ray fails the request with an InvalidRequestException and does not change the log group. To enable Transaction Search with the existing log group as it is, call UpdateTraceSegmentDestination again without SpansLogGroupKmsKeyId. To set or change the key of the existing log group, use the CloudWatch Logs AssociateKmsKey operation.

      You need kms:DescribeKey permission on the key, and the key policy must allow CloudWatch Logs to use the key. For more information, see Encrypt log data in CloudWatch Logs using AWS Key Management Service.

      Parameters:
      spansLogGroupKmsKeyId - The ARN of an AWS Key Management Service (AWS KMS) key that you create and manage, in the same account and Region, used to encrypt the aws/spans log group. Key IDs and alias ARNs are not supported.

      X-Ray applies the key only when it creates aws/spans. If the account already has an aws/spans log group, X-Ray fails the request with an InvalidRequestException and does not change the log group. To enable Transaction Search with the existing log group as it is, call UpdateTraceSegmentDestination again without SpansLogGroupKmsKeyId. To set or change the key of the existing log group, use the CloudWatch Logs AssociateKmsKey operation.

      You need kms:DescribeKey permission on the key, and the key policy must allow CloudWatch Logs to use the key. For more information, see Encrypt log data in CloudWatch Logs using AWS Key Management Service.

      Returns:
      Returns a reference to this object so that method calls can be chained together.