# CfnInstrumentationConfigProps

Properties for defining a `CfnInstrumentationConfig`.

Extends: CfnInstrumentationConfigProps
Used as props by: CfnInstrumentationConfig

- Source: Generated code
- Type last changed: v2.274.0 · 20 Oct 2026

## 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 cfnInstrumentationConfigProps: applicationsignals.CfnInstrumentationConfigProps = {
  captureConfiguration: {
    codeCapture: {
      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,
    },
  },
  environment: 'environment',
  instrumentationType: 'instrumentationType',
  location: {
    codeLocation: {
      filePath: 'filePath',
      language: 'language',

      // the properties below are optional
      className: 'className',
      codeUnit: 'codeUnit',
      lineNumber: 123,
      methodName: 'methodName',
    },
  },
  service: 'service',
  signalType: 'signalType',

  // the properties below are optional
  attributeFilters: [{
    attributeFiltersKey: 'attributeFilters',
  }],
  description: 'description',
  expiresAt: 'expiresAt',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
```

## Properties

- `attributeFilters`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | { [key: string]: string }[] — Client-side filters that target specific instances.

  Each object is AND-matched on keys, multiple objects are OR-matched.

- `captureConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnInstrumentationConfig.CaptureConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_applicationsignals.CfnInstrumentationConfig.CaptureConfigurationProperty.html) (required) — Specifies what to capture when the instrumentation point is hit.

- `description`: string — An optional short description that explains the purpose of this instrumentation.

- `environment`: string (required) — The environment that the service is running in.

- `expiresAt`: string — The timestamp after which this configuration is no longer served.

  For BREAKPOINT only; defaults to 24 hours.

- `instrumentationType`: string (required) — Type of instrumentation: BREAKPOINT (temporary, expires after 24 hours) or PROBE (permanent, persists until deleted).

- `location`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnInstrumentationConfig.LocationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_applicationsignals.CfnInstrumentationConfig.LocationProperty.html) (required) — The location where instrumentation should be applied.

- `service`: string (required) — The name of the service to instrument.

  This should match the service.name resource attribute reported by the application.

- `signalType`: string (required) — The telemetry signal type to emit for this instrumentation.

  The supported value is SNAPSHOT.

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — An optional list of key-value pairs to associate with the instrumentation configuration.