Package software.amazon.awscdk.services.xray

Class CfnTransactionSearchConfig

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.xray.CfnTransactionSearchConfig

All Implemented Interfaces:

IEnvironmentAware, IInspectable, ITransactionSearchConfigRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:52.457Z")
@Stability(Stable)
public class CfnTransactionSearchConfig
extends CfnResource
implements IInspectable, ITransactionSearchConfigRef

This schema provides construct and validation rules for AWS-XRay TransactionSearchConfig resource parameters.

Example:

 // 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.*;
 CfnTransactionSearchConfig cfnTransactionSearchConfig = CfnTransactionSearchConfig.Builder.create(this, "MyCfnTransactionSearchConfig")
         .indexingPercentage(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-transactionsearchconfig.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnTransactionSearchConfig.Builder	A fluent builder for CfnTransactionSearchConfig.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.xray.ITransactionSearchConfigRef

ITransactionSearchConfigRef.Jsii$Default, ITransactionSearchConfigRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnTransactionSearchConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTransactionSearchConfig(software.amazon.jsii.JsiiObjectRef objRef)
	CfnTransactionSearchConfig(software.constructs.Construct scope, String id)
	CfnTransactionSearchConfig(software.constructs.Construct scope, String id, CfnTransactionSearchConfigProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrAccountId()	User account id, used as the primary identifier for the resource.
protected Map<String,Object>	getCfnProperties()
Number	getIndexingPercentage()	Determines the percentage of traces indexed from CloudWatch Logs to X-Ray.
TransactionSearchConfigReference	getTransactionSearchConfigRef()	A reference to a TransactionSearchConfig resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setIndexingPercentage(Number value)	Determines the percentage of traces indexed from CloudWatch Logs to X-Ray.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnTransactionSearchConfig

protected CfnTransactionSearchConfig(software.amazon.jsii.JsiiObjectRef objRef)

CfnTransactionSearchConfig

protected CfnTransactionSearchConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnTransactionSearchConfig

@Stability(Stable)
public CfnTransactionSearchConfig(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnTransactionSearchConfigProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties.

CfnTransactionSearchConfig

@Stability(Stable)
public CfnTransactionSearchConfig(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAccountId

@Stability(Stable)
@NotNull
public String getAttrAccountId()

User account id, used as the primary identifier for the resource.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTransactionSearchConfigRef

@Stability(Stable)
@NotNull
public TransactionSearchConfigReference getTransactionSearchConfigRef()

A reference to a TransactionSearchConfig resource.

Specified by:

getTransactionSearchConfigRef in interface ITransactionSearchConfigRef

getIndexingPercentage

@Stability(Stable)
@Nullable
public Number getIndexingPercentage()

Determines the percentage of traces indexed from CloudWatch Logs to X-Ray.

setIndexingPercentage

@Stability(Stable)
public void setIndexingPercentage(@Nullable
 Number value)

Determines the percentage of traces indexed from CloudWatch Logs to X-Ray.