instrumentation_configurations

Creates, updates, deletes, gets or lists an instrumentation_configurations resource.

Overview

Name	instrumentation_configurations
Type	Resource
Id	aws.application_signals.instrumentation_configurations

Fields

The following fields are returned by SELECT queries:

get_instrumentation_configuration

Name	Datatype	Description
arn	string	ARN for the instrumentation configuration (pattern: <code>arn:[^:]+:application-signals:[^:]+:[0-9]{12}:instrumentationConfig/.+/[0-9a-f]{16}</code>)
attribute_filters	array	An array of attribute filter groups used to target specific instances. Each filter group must match all of its keys (AND), and multiple groups are OR-matched to decide whether an instance applies the instrumentation. Filters are evaluated client-side by the SDK.
capture_configuration	object	A union that defines what data to capture when the instrumentation point is hit. Specify CodeCapture for code-level capture settings.
created_at	string (date-time)	The timestamp when this instrumentation configuration was created.
description	string	An optional short description of the instrumentation configuration.
environment	string	The environment where the service is running.
expires_at	string (date-time)	The timestamp when this configuration expires.
instrumentation_type	string	Type of instrumentation configuration (BREAKPOINT, PROBE)
location	object	A union that identifies the location to instrument. Specify a CodeLocation for code-level instrumentation.
location_hash	string	The stable hash derived from the location that uniquely identifies this instrumentation point within the service and environment.
service	string	The service that this instrumentation configuration targets.
signal_type	string	The telemetry signal type for instrumentation. SNAPSHOT - Captures a snapshot of the instrumentation point. (SNAPSHOT)

list_instrumentation_configurations

Name	Datatype	Description
arn	string	ARN for the instrumentation configuration (pattern: <code>arn:[^:]+:application-signals:[^:]+:[0-9]{12}:instrumentationConfig/.+/[0-9a-f]{16}</code>)
attribute_filters	array	An array of attribute filter groups used to target specific instances. Each filter group must match all of its keys (AND), and multiple groups are OR-matched to decide whether an instance applies the instrumentation. Filters are evaluated client-side by the SDK.
capture_configuration	object	A union that defines what data to capture when the instrumentation point is hit. Specify CodeCapture for code-level capture settings.
created_at	string (date-time)	The timestamp when this instrumentation configuration was created.
description	string	An optional short description of the instrumentation configuration.
expires_at	string (date-time)	The timestamp when this configuration expires.
instrumentation_type	string	Type of instrumentation configuration (BREAKPOINT, PROBE)
location	object	A union that identifies the location to instrument. Specify a CodeLocation for code-level instrumentation.
location_hash	string	The stable hash derived from the location that identifies this instrumentation point.
signal_type	string	The telemetry signal type for instrumentation. SNAPSHOT - Captures a snapshot of the instrumentation point. (SNAPSHOT)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_instrumentation_configuration	select	region		Returns the details of a single instrumentation configuration identified by service, environment, signal type, and location. Use this to audit or display configuration details.
list_instrumentation_configurations	select	region		Returns all active instrumentation configurations for a service and environment. SDKs use this operation to sync configurations and apply client-side filters locally. Include the previous SyncedAt value to perform incremental syncs. When no changes are detected, the response sets Changed to false and omits configuration details.
create_instrumentation_configuration	insert	region, InstrumentationType, SignalType, CaptureConfiguration		Creates a dynamic instrumentation configuration for a specific code or endpoint location within a service and environment. Configurations are immutable after creation. For BREAKPOINT type configurations, they expire after 24 hours unless a shorter expiration is provided. For PROBE type configurations, they persist until explicitly deleted; an expiration cannot be set for PROBE configurations. If a configuration already exists for the same service, environment, signal type, and location, this operation returns a conflict instead of overwriting it. Use attribute filters and capture settings to control where the instrumentation runs and which data is collected.
delete_instrumentation_configuration	delete	region		Deletes the specified instrumentation configuration. SDKs remove the instrumentation during their next sync after the configuration is deleted or expires.
batch_delete_instrumentation_configurations	exec	region, DeletionTarget		Deletes multiple instrumentation configurations in a single request. Supports two mutually exclusive selection methods: By scope: Delete all configurations matching a Service + Environment + InstrumentationType By ARN list: Delete specific configurations by providing a list of resource ARNs

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_instrumentation_configuration

Returns the details of a single instrumentation configuration identified by service, environment, signal type, and location. Use this to audit or display configuration details.

SELECT
arn,
attribute_filters,
capture_configuration,
created_at,
description,
environment,
expires_at,
instrumentation_type,
location,
location_hash,
service,
signal_type
FROM aws.application_signals.instrumentation_configurations
WHERE region = '{{ region }}' -- required
;

list_instrumentation_configurations

Returns all active instrumentation configurations for a service and environment. SDKs use this operation to sync configurations and apply client-side filters locally. Include the previous SyncedAt value to perform incremental syncs. When no changes are detected, the response sets Changed to false and omits configuration details.

SELECT
arn,
attribute_filters,
capture_configuration,
created_at,
description,
expires_at,
instrumentation_type,
location,
location_hash,
signal_type
FROM aws.application_signals.instrumentation_configurations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_instrumentation_configuration

Creates a dynamic instrumentation configuration for a specific code or endpoint location within a service and environment. Configurations are immutable after creation. For BREAKPOINT type configurations, they expire after 24 hours unless a shorter expiration is provided. For PROBE type configurations, they persist until explicitly deleted; an expiration cannot be set for PROBE configurations. If a configuration already exists for the same service, environment, signal type, and location, this operation returns a conflict instead of overwriting it. Use attribute filters and capture settings to control where the instrumentation runs and which data is collected.

INSERT INTO aws.application_signals.instrumentation_configurations (
InstrumentationType,
Service,
Environment,
SignalType,
Location,
Description,
ExpiresAt,
AttributeFilters,
CaptureConfiguration,
Tags,
region
)
SELECT 
'{{ InstrumentationType }}' /* required */,
'{{ Service }}',
'{{ Environment }}',
'{{ SignalType }}' /* required */,
'{{ Location }}',
'{{ Description }}',
'{{ ExpiresAt }}',
'{{ AttributeFilters }}',
'{{ CaptureConfiguration }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
arn,
attribute_filters,
capture_configuration,
created_at,
description,
environment,
expires_at,
instrumentation_type,
location,
location_hash,
service,
signal_type
;

Manifest

# Description fields are for documentation purposes
- name: instrumentation_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the instrumentation_configurations resource.
  - name: InstrumentationType
    value: "{{ InstrumentationType }}"
    description: |
      Type of instrumentation configuration
    valid_values: ['BREAKPOINT', 'PROBE']
  - name: Service
    value: "{{ Service }}"
  - name: Environment
    value: "{{ Environment }}"
  - name: SignalType
    value: "{{ SignalType }}"
    description: |
      The telemetry signal type for instrumentation. SNAPSHOT - Captures a snapshot of the instrumentation point.
    valid_values: ['SNAPSHOT']
  - name: Location
    description: |
      A union that identifies the location to instrument. Specify a CodeLocation for code-level instrumentation.
    value:
      CodeLocation:
        Language: "{{ Language }}"
        CodeUnit: "{{ CodeUnit }}"
        ClassName: "{{ ClassName }}"
        MethodName: "{{ MethodName }}"
        FilePath: "{{ FilePath }}"
        LineNumber: {{ LineNumber }}
  - name: Description
    value: "{{ Description }}"
  - name: ExpiresAt
    value: "{{ ExpiresAt }}"
  - name: AttributeFilters
    value: "{{ AttributeFilters }}"
    description: |
      An array of attribute filter groups used to target specific instances. Each filter group must match all of its keys (AND), and multiple groups are OR-matched to decide whether an instance applies the instrumentation. Filters are evaluated client-side by the SDK.
  - name: CaptureConfiguration
    description: |
      A union that defines what data to capture when the instrumentation point is hit. Specify CodeCapture for code-level capture settings.
    value:
      CodeCapture:
        CaptureArguments:
          - "{{ CaptureArguments }}"
        CaptureReturn: {{ CaptureReturn }}
        CaptureStackTrace: {{ CaptureStackTrace }}
        CaptureLocals:
          - "{{ CaptureLocals }}"
        CaptureLimits:
          MaxHits: {{ MaxHits }}
          MaxStringLength: {{ MaxStringLength }}
          MaxCollectionWidth: {{ MaxCollectionWidth }}
          MaxCollectionDepth: {{ MaxCollectionDepth }}
          MaxStackFrames: {{ MaxStackFrames }}
          MaxStackTraceSize: {{ MaxStackTraceSize }}
          MaxObjectDepth: {{ MaxObjectDepth }}
          MaxFieldsPerObject: {{ MaxFieldsPerObject }}
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

DELETE examples

delete_instrumentation_configuration

Deletes the specified instrumentation configuration. SDKs remove the instrumentation during their next sync after the configuration is deleted or expires.

DELETE FROM aws.application_signals.instrumentation_configurations
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

batch_delete_instrumentation_configurations

Deletes multiple instrumentation configurations in a single request. Supports two mutually exclusive selection methods: By scope: Delete all configurations matching a Service + Environment + InstrumentationType By ARN list: Delete specific configurations by providing a list of resource ARNs

EXEC aws.application_signals.instrumentation_configurations.batch_delete_instrumentation_configurations 
@region='{{ region }}' --required 
@@json=
'{
"DeletionTarget": "{{ DeletionTarget }}"
}'
;