Skip to content
v2.275.0

CodeCaptureConfigurationProperty Struct ​

Defines what data to capture for code-level instrumentation.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_applicationsignals as applicationsignals } from 'aws-cdk-lib';
const codeCaptureConfigurationProperty: applicationsignals.CfnInstrumentationConfig.CodeCaptureConfigurationProperty = {
  captureLimits: {
    maxCollectionDepth: 123,
    maxCollectionWidth: 123,
    maxFieldsPerObject: 123,
    maxHits: 123,
    maxObjectDepth: 123,
    maxStackFrames: 123,
    maxStackTraceSize: 123,
    maxStringLength: 123,
  },

  // the properties below are optional
  captureArguments: ['captureArguments'],
  captureLocals: ['captureLocals'],
  captureReturn: false,
  captureStackTrace: false,
};

Properties ​

captureArgumentsoptionalstring[]capture_argumentsoptionaltyping.List[str]captureArgumentsoptionalList<String>CaptureArgumentsoptionalstring[]CaptureArgumentsoptional*[]*string#
The function arguments to capture.
captureLimitsIResolvable | CfnInstrumentationConfig.CaptureLimitsConfigPropertycapture_limitstyping.Union[IResolvable, CaptureLimitsConfigProperty]captureLimitsIResolvableCaptureLimitsIResolvableCaptureLimitsinterface{}required#
Safety limits that bound what is captured.
captureLocalsoptionalstring[]capture_localsoptionaltyping.List[str]captureLocalsoptionalList<String>CaptureLocalsoptionalstring[]CaptureLocalsoptional*[]*string#
The local variables to capture by name.
captureReturnoptionalboolean | IResolvablecapture_returnoptionaltyping.Union[bool, IResolvable]captureReturnoptionalBooleanCaptureReturnoptionalboolCaptureReturnoptionalinterface{}#
Whether to capture the return value.

Defaults to false.

captureStackTraceoptionalboolean | IResolvablecapture_stack_traceoptionaltyping.Union[bool, IResolvable]captureStackTraceoptionalBooleanCaptureStackTraceoptionalboolCaptureStackTraceoptionalinterface{}#
Whether to capture a stack trace.

Defaults to true.