AWS::XRay::TransactionSearchConfig - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::XRay::TransactionSearchConfig

Use the AWS::XRay::TransactionSearchConfig resource to configure the percentage of traces indexed from CloudWatch Logs to X-Ray for transaction search.

For more information, see Transaction Search in the Amazon CloudWatch User Guide.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::XRay::TransactionSearchConfig",
  "Properties" : {
      "IndexingPercentage" : Number
    }
}

YAML

Type: AWS::XRay::TransactionSearchConfig
Properties:
  IndexingPercentage: Number

Properties

IndexingPercentage

The percentage of spans to be indexed as trace summaries. The value can be set between 0 and 100.

Required: No

Type: Number

Minimum: 0

Maximum: 100

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the AWS account ID.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

AccountId

The AWS account ID associated with the transaction search configuration.