Skip to content
v2.277.0

CloudWatchLogsConfigurationProperty Struct ​

Configuration for the CloudWatch Logs log group that X-Ray creates when this resource enables Transaction Search.

It is used only at that time and is never returned

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_xray as xray } from 'aws-cdk-lib';
const cloudWatchLogsConfigurationProperty: xray.CfnTransactionSearchConfig.CloudWatchLogsConfigurationProperty = {
  spansLogGroupKmsKeyId: 'spansLogGroupKmsKeyId',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_xray as xray

cloud_watch_logs_configuration_property = xray.CfnTransactionSearchConfig.CloudWatchLogsConfigurationProperty(
    spans_log_group_kms_key_id="spansLogGroupKmsKeyId"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.xray.*;

CloudWatchLogsConfigurationProperty cloudWatchLogsConfigurationProperty = CloudWatchLogsConfigurationProperty.builder()
        .spansLogGroupKmsKeyId("spansLogGroupKmsKeyId")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.XRay;

var cloudWatchLogsConfigurationProperty = new CloudWatchLogsConfigurationProperty {
    SpansLogGroupKmsKeyId = "spansLogGroupKmsKeyId"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cloudWatchLogsConfigurationProperty := &CloudWatchLogsConfigurationProperty{
	SpansLogGroupKmsKeyId: jsii.String("spansLogGroupKmsKeyId"),
}

Properties ​

spansLogGroupKmsKeyIdoptionalstringspans_log_group_kms_key_idoptionalstrspansLogGroupKmsKeyIdoptionalStringSpansLogGroupKmsKeyIdoptionalstringSpansLogGroupKmsKeyIdoptional*string #
The ARN of a symmetric customer managed AWS KMS key in the same account and Region, used to encrypt the aws/spans log group.
notes

Key IDs and alias ARNs are not supported, so for an AWS::KMS::Key use Fn::GetAtt Arn, not Ref. X-Ray applies the key only when it creates aws/spans while enabling Transaction Search. If aws/spans already exists, for example from an earlier enablement or an earlier create that failed partway, the create fails and X-Ray does not enable Transaction Search or change the log group. Remove this property to use the existing log group with its current encryption, and use the CloudWatch Logs AssociateKmsKey API to change its key. The caller needs kms:DescribeKey on the key, and the key policy must allow CloudWatch Logs to use it. Adding, changing or removing this property replaces the resource, which fails while Transaction Search is enabled