We recommend new projects start with resources from the AWS provider.
published on Monday, Nov 2, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Monday, Nov 2, 2026 by Pulumi
Creates a dynamic instrumentation configuration for a specific code or endpoint location within a service and environment.
Create InstrumentationConfig Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new InstrumentationConfig(name: string, args: InstrumentationConfigArgs, opts?: CustomResourceOptions);@overload
def InstrumentationConfig(resource_name: str,
args: InstrumentationConfigArgs,
opts: Optional[ResourceOptions] = None)
@overload
def InstrumentationConfig(resource_name: str,
opts: Optional[ResourceOptions] = None,
capture_configuration: Optional[CaptureConfigurationPropertiesArgs] = None,
environment: Optional[str] = None,
instrumentation_type: Optional[InstrumentationConfigInstrumentationType] = None,
location: Optional[LocationPropertiesArgs] = None,
service: Optional[str] = None,
signal_type: Optional[InstrumentationConfigSignalType] = None,
attribute_filters: Optional[Sequence[Mapping[str, str]]] = None,
description: Optional[str] = None,
expires_at: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)func NewInstrumentationConfig(ctx *Context, name string, args InstrumentationConfigArgs, opts ...ResourceOption) (*InstrumentationConfig, error)public InstrumentationConfig(string name, InstrumentationConfigArgs args, CustomResourceOptions? opts = null)
public InstrumentationConfig(String name, InstrumentationConfigArgs args)
public InstrumentationConfig(String name, InstrumentationConfigArgs args, CustomResourceOptions options)
type: aws-native:applicationsignals:InstrumentationConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_applicationsignals_instrumentation_config" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args InstrumentationConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args InstrumentationConfigArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args InstrumentationConfigArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args InstrumentationConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args InstrumentationConfigArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
InstrumentationConfig Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The InstrumentationConfig resource accepts the following input properties:
- Capture
Configuration Pulumi.Aws Native. Application Signals. Inputs. Capture Configuration Properties - Specifies what to capture when the instrumentation point is hit.
- Environment string
- The environment that the service is running in.
- Instrumentation
Type Pulumi.Aws Native. Application Signals. Instrumentation Config Instrumentation Type - Type of instrumentation: BREAKPOINT (temporary, expires after 24 hours) or PROBE (permanent, persists until deleted).
- Location
Pulumi.
Aws Native. Application Signals. Inputs. Location Properties - The location where instrumentation should be applied.
- Service string
- The name of the service to instrument. This should match the service.name resource attribute reported by the application.
- Signal
Type Pulumi.Aws Native. Application Signals. Instrumentation Config Signal Type - The telemetry signal type to emit for this instrumentation. The supported value is SNAPSHOT.
- Attribute
Filters List<ImmutableDictionary<string, string>> - Client-side filters that target specific instances. Each object is AND-matched on keys, multiple objects are OR-matched.
- Description string
- An optional short description that explains the purpose of this instrumentation.
- Expires
At string - The timestamp after which this configuration is no longer served. For BREAKPOINT only; defaults to 24 hours.
-
List<Pulumi.
Aws Native. Inputs. Tag> - An optional list of key-value pairs to associate with the instrumentation configuration.
- Capture
Configuration CaptureConfiguration Properties Args - Specifies what to capture when the instrumentation point is hit.
- Environment string
- The environment that the service is running in.
- Instrumentation
Type InstrumentationConfig Instrumentation Type - Type of instrumentation: BREAKPOINT (temporary, expires after 24 hours) or PROBE (permanent, persists until deleted).
- Location
Location
Properties Args - The location where instrumentation should be applied.
- Service string
- The name of the service to instrument. This should match the service.name resource attribute reported by the application.
- Signal
Type InstrumentationConfig Signal Type - The telemetry signal type to emit for this instrumentation. The supported value is SNAPSHOT.
- Attribute
Filters []map[string]string - Client-side filters that target specific instances. Each object is AND-matched on keys, multiple objects are OR-matched.
- Description string
- An optional short description that explains the purpose of this instrumentation.
- Expires
At string - The timestamp after which this configuration is no longer served. For BREAKPOINT only; defaults to 24 hours.
-
Tag
Args - An optional list of key-value pairs to associate with the instrumentation configuration.
- capture_
configuration object - Specifies what to capture when the instrumentation point is hit.
- environment string
- The environment that the service is running in.
- instrumentation_
type "BREAKPOINT" | "PROBE" - Type of instrumentation: BREAKPOINT (temporary, expires after 24 hours) or PROBE (permanent, persists until deleted).
- location object
- The location where instrumentation should be applied.
- service string
- The name of the service to instrument. This should match the service.name resource attribute reported by the application.
- signal_
type "SNAPSHOT" - The telemetry signal type to emit for this instrumentation. The supported value is SNAPSHOT.
- attribute_
filters list(map(string)) - Client-side filters that target specific instances. Each object is AND-matched on keys, multiple objects are OR-matched.
- description string
- An optional short description that explains the purpose of this instrumentation.
- expires_
at string - The timestamp after which this configuration is no longer served. For BREAKPOINT only; defaults to 24 hours.
- list(object)
- An optional list of key-value pairs to associate with the instrumentation configuration.
- capture
Configuration CaptureConfiguration Properties - Specifies what to capture when the instrumentation point is hit.
- environment String
- The environment that the service is running in.
- instrumentation
Type InstrumentationConfig Instrumentation Type - Type of instrumentation: BREAKPOINT (temporary, expires after 24 hours) or PROBE (permanent, persists until deleted).
- location
Location
Properties - The location where instrumentation should be applied.
- service String
- The name of the service to instrument. This should match the service.name resource attribute reported by the application.
- signal
Type InstrumentationConfig Signal Type - The telemetry signal type to emit for this instrumentation. The supported value is SNAPSHOT.
- attribute
Filters List<Map<String,String>> - Client-side filters that target specific instances. Each object is AND-matched on keys, multiple objects are OR-matched.
- description String
- An optional short description that explains the purpose of this instrumentation.
- expires
At String - The timestamp after which this configuration is no longer served. For BREAKPOINT only; defaults to 24 hours.
- List<Tag>
- An optional list of key-value pairs to associate with the instrumentation configuration.
- capture
Configuration CaptureConfiguration Properties - Specifies what to capture when the instrumentation point is hit.
- environment string
- The environment that the service is running in.
- instrumentation
Type InstrumentationConfig Instrumentation Type - Type of instrumentation: BREAKPOINT (temporary, expires after 24 hours) or PROBE (permanent, persists until deleted).
- location
Location
Properties - The location where instrumentation should be applied.
- service string
- The name of the service to instrument. This should match the service.name resource attribute reported by the application.
- signal
Type InstrumentationConfig Signal Type - The telemetry signal type to emit for this instrumentation. The supported value is SNAPSHOT.
- attribute
Filters {[key: string]: string}[] - Client-side filters that target specific instances. Each object is AND-matched on keys, multiple objects are OR-matched.
- description string
- An optional short description that explains the purpose of this instrumentation.
- expires
At string - The timestamp after which this configuration is no longer served. For BREAKPOINT only; defaults to 24 hours.
- Tag[]
- An optional list of key-value pairs to associate with the instrumentation configuration.
- capture_
configuration CaptureConfiguration Properties Args - Specifies what to capture when the instrumentation point is hit.
- environment str
- The environment that the service is running in.
- instrumentation_
type InstrumentationConfig Instrumentation Type - Type of instrumentation: BREAKPOINT (temporary, expires after 24 hours) or PROBE (permanent, persists until deleted).
- location
Location
Properties Args - The location where instrumentation should be applied.
- service str
- The name of the service to instrument. This should match the service.name resource attribute reported by the application.
- signal_
type InstrumentationConfig Signal Type - The telemetry signal type to emit for this instrumentation. The supported value is SNAPSHOT.
- attribute_
filters Sequence[Mapping[str, str]] - Client-side filters that target specific instances. Each object is AND-matched on keys, multiple objects are OR-matched.
- description str
- An optional short description that explains the purpose of this instrumentation.
- expires_
at str - The timestamp after which this configuration is no longer served. For BREAKPOINT only; defaults to 24 hours.
-
Sequence[Tag
Args] - An optional list of key-value pairs to associate with the instrumentation configuration.
- capture
Configuration Property Map - Specifies what to capture when the instrumentation point is hit.
- environment String
- The environment that the service is running in.
- instrumentation
Type "BREAKPOINT" | "PROBE" - Type of instrumentation: BREAKPOINT (temporary, expires after 24 hours) or PROBE (permanent, persists until deleted).
- location Property Map
- The location where instrumentation should be applied.
- service String
- The name of the service to instrument. This should match the service.name resource attribute reported by the application.
- signal
Type "SNAPSHOT" - The telemetry signal type to emit for this instrumentation. The supported value is SNAPSHOT.
- attribute
Filters List<Map<String>> - Client-side filters that target specific instances. Each object is AND-matched on keys, multiple objects are OR-matched.
- description String
- An optional short description that explains the purpose of this instrumentation.
- expires
At String - The timestamp after which this configuration is no longer served. For BREAKPOINT only; defaults to 24 hours.
- List<Property Map>
- An optional list of key-value pairs to associate with the instrumentation configuration.
Outputs
All input properties are implicitly available as output properties. Additionally, the InstrumentationConfig resource produces the following output properties:
- Arn string
- The Amazon Resource Name (ARN) of the instrumentation configuration.
- Created
At string - The server-generated creation timestamp for this instrumentation configuration.
- Id string
- The provider-assigned unique ID for this managed resource.
- Location
Hash string - A stable hash computed from the location that uniquely identifies this instrumentation point.
- Arn string
- The Amazon Resource Name (ARN) of the instrumentation configuration.
- Created
At string - The server-generated creation timestamp for this instrumentation configuration.
- Id string
- The provider-assigned unique ID for this managed resource.
- Location
Hash string - A stable hash computed from the location that uniquely identifies this instrumentation point.
- arn string
- The Amazon Resource Name (ARN) of the instrumentation configuration.
- created_
at string - The server-generated creation timestamp for this instrumentation configuration.
- id string
- The provider-assigned unique ID for this managed resource.
- location_
hash string - A stable hash computed from the location that uniquely identifies this instrumentation point.
- arn String
- The Amazon Resource Name (ARN) of the instrumentation configuration.
- created
At String - The server-generated creation timestamp for this instrumentation configuration.
- id String
- The provider-assigned unique ID for this managed resource.
- location
Hash String - A stable hash computed from the location that uniquely identifies this instrumentation point.
- arn string
- The Amazon Resource Name (ARN) of the instrumentation configuration.
- created
At string - The server-generated creation timestamp for this instrumentation configuration.
- id string
- The provider-assigned unique ID for this managed resource.
- location
Hash string - A stable hash computed from the location that uniquely identifies this instrumentation point.
- arn str
- The Amazon Resource Name (ARN) of the instrumentation configuration.
- created_
at str - The server-generated creation timestamp for this instrumentation configuration.
- id str
- The provider-assigned unique ID for this managed resource.
- location_
hash str - A stable hash computed from the location that uniquely identifies this instrumentation point.
- arn String
- The Amazon Resource Name (ARN) of the instrumentation configuration.
- created
At String - The server-generated creation timestamp for this instrumentation configuration.
- id String
- The provider-assigned unique ID for this managed resource.
- location
Hash String - A stable hash computed from the location that uniquely identifies this instrumentation point.
Supporting Types
CaptureConfigurationProperties, CaptureConfigurationPropertiesArgs
Specifies what to capture when the instrumentation point is hit.InstrumentationConfigCaptureLimitsConfig, InstrumentationConfigCaptureLimitsConfigArgs
Safety limits that bound what is captured.- Max
Collection intDepth - Maximum nesting depth to traverse inside collections.
- Max
Collection intWidth - Maximum number of items to capture from any collection.
- Max
Fields intPer Object - Maximum number of fields to capture for any object.
- Max
Hits int - Maximum number of times the instrumentation point can be hit before disabled.
- Max
Object intDepth - Maximum depth for nested object traversal.
- Max
Stack intFrames - Maximum number of stack frames to capture.
- Max
Stack intTrace Size - Maximum total size in bytes of a captured stack trace.
- Max
String intLength - Maximum length of captured string values in characters.
- Max
Collection intDepth - Maximum nesting depth to traverse inside collections.
- Max
Collection intWidth - Maximum number of items to capture from any collection.
- Max
Fields intPer Object - Maximum number of fields to capture for any object.
- Max
Hits int - Maximum number of times the instrumentation point can be hit before disabled.
- Max
Object intDepth - Maximum depth for nested object traversal.
- Max
Stack intFrames - Maximum number of stack frames to capture.
- Max
Stack intTrace Size - Maximum total size in bytes of a captured stack trace.
- Max
String intLength - Maximum length of captured string values in characters.
- max_
collection_ numberdepth - Maximum nesting depth to traverse inside collections.
- max_
collection_ numberwidth - Maximum number of items to capture from any collection.
- max_
fields_ numberper_ object - Maximum number of fields to capture for any object.
- max_
hits number - Maximum number of times the instrumentation point can be hit before disabled.
- max_
object_ numberdepth - Maximum depth for nested object traversal.
- max_
stack_ numberframes - Maximum number of stack frames to capture.
- max_
stack_ numbertrace_ size - Maximum total size in bytes of a captured stack trace.
- max_
string_ numberlength - Maximum length of captured string values in characters.
- max
Collection IntegerDepth - Maximum nesting depth to traverse inside collections.
- max
Collection IntegerWidth - Maximum number of items to capture from any collection.
- max
Fields IntegerPer Object - Maximum number of fields to capture for any object.
- max
Hits Integer - Maximum number of times the instrumentation point can be hit before disabled.
- max
Object IntegerDepth - Maximum depth for nested object traversal.
- max
Stack IntegerFrames - Maximum number of stack frames to capture.
- max
Stack IntegerTrace Size - Maximum total size in bytes of a captured stack trace.
- max
String IntegerLength - Maximum length of captured string values in characters.
- max
Collection numberDepth - Maximum nesting depth to traverse inside collections.
- max
Collection numberWidth - Maximum number of items to capture from any collection.
- max
Fields numberPer Object - Maximum number of fields to capture for any object.
- max
Hits number - Maximum number of times the instrumentation point can be hit before disabled.
- max
Object numberDepth - Maximum depth for nested object traversal.
- max
Stack numberFrames - Maximum number of stack frames to capture.
- max
Stack numberTrace Size - Maximum total size in bytes of a captured stack trace.
- max
String numberLength - Maximum length of captured string values in characters.
- max_
collection_ intdepth - Maximum nesting depth to traverse inside collections.
- max_
collection_ intwidth - Maximum number of items to capture from any collection.
- max_
fields_ intper_ object - Maximum number of fields to capture for any object.
- max_
hits int - Maximum number of times the instrumentation point can be hit before disabled.
- max_
object_ intdepth - Maximum depth for nested object traversal.
- max_
stack_ intframes - Maximum number of stack frames to capture.
- max_
stack_ inttrace_ size - Maximum total size in bytes of a captured stack trace.
- max_
string_ intlength - Maximum length of captured string values in characters.
- max
Collection NumberDepth - Maximum nesting depth to traverse inside collections.
- max
Collection NumberWidth - Maximum number of items to capture from any collection.
- max
Fields NumberPer Object - Maximum number of fields to capture for any object.
- max
Hits Number - Maximum number of times the instrumentation point can be hit before disabled.
- max
Object NumberDepth - Maximum depth for nested object traversal.
- max
Stack NumberFrames - Maximum number of stack frames to capture.
- max
Stack NumberTrace Size - Maximum total size in bytes of a captured stack trace.
- max
String NumberLength - Maximum length of captured string values in characters.
InstrumentationConfigCodeCaptureConfiguration, InstrumentationConfigCodeCaptureConfigurationArgs
Defines what data to capture for code-level instrumentation.- Capture
Limits Pulumi.Aws Native. Application Signals. Inputs. Instrumentation Config Capture Limits Config - Capture
Arguments List<string> - The function arguments to capture.
- Capture
Locals List<string> - The local variables to capture by name.
- Capture
Return bool - Whether to capture the return value. Defaults to false.
- Capture
Stack boolTrace - Whether to capture a stack trace. Defaults to true.
- Capture
Limits InstrumentationConfig Capture Limits Config - Capture
Arguments []string - The function arguments to capture.
- Capture
Locals []string - The local variables to capture by name.
- Capture
Return bool - Whether to capture the return value. Defaults to false.
- Capture
Stack boolTrace - Whether to capture a stack trace. Defaults to true.
- capture_
limits object - capture_
arguments list(string) - The function arguments to capture.
- capture_
locals list(string) - The local variables to capture by name.
- capture_
return bool - Whether to capture the return value. Defaults to false.
- capture_
stack_ booltrace - Whether to capture a stack trace. Defaults to true.
- capture
Limits InstrumentationConfig Capture Limits Config - capture
Arguments List<String> - The function arguments to capture.
- capture
Locals List<String> - The local variables to capture by name.
- capture
Return Boolean - Whether to capture the return value. Defaults to false.
- capture
Stack BooleanTrace - Whether to capture a stack trace. Defaults to true.
- capture
Limits InstrumentationConfig Capture Limits Config - capture
Arguments string[] - The function arguments to capture.
- capture
Locals string[] - The local variables to capture by name.
- capture
Return boolean - Whether to capture the return value. Defaults to false.
- capture
Stack booleanTrace - Whether to capture a stack trace. Defaults to true.
- capture_
limits InstrumentationConfig Capture Limits Config - capture_
arguments Sequence[str] - The function arguments to capture.
- capture_
locals Sequence[str] - The local variables to capture by name.
- capture_
return bool - Whether to capture the return value. Defaults to false.
- capture_
stack_ booltrace - Whether to capture a stack trace. Defaults to true.
- capture
Limits Property Map - capture
Arguments List<String> - The function arguments to capture.
- capture
Locals List<String> - The local variables to capture by name.
- capture
Return Boolean - Whether to capture the return value. Defaults to false.
- capture
Stack BooleanTrace - Whether to capture a stack trace. Defaults to true.
InstrumentationConfigCodeLocation, InstrumentationConfigCodeLocationArgs
Identifies a code location to instrument.- File
Path string - The source file path relative to the project or source root.
- Language
Pulumi.
Aws Native. Application Signals. Instrumentation Config Code Location Language - The programming language for this instrumentation point.
- Class
Name string - The class or type name that contains the method.
- Code
Unit string - The package, module, or namespace that contains the target code.
- Line
Number int - The line number to instrument.
- Method
Name string - The method or function name to instrument.
- File
Path string - The source file path relative to the project or source root.
- Language
Instrumentation
Config Code Location Language - The programming language for this instrumentation point.
- Class
Name string - The class or type name that contains the method.
- Code
Unit string - The package, module, or namespace that contains the target code.
- Line
Number int - The line number to instrument.
- Method
Name string - The method or function name to instrument.
- file_
path string - The source file path relative to the project or source root.
- language "Java" | "Python" | "Javascript"
- The programming language for this instrumentation point.
- class_
name string - The class or type name that contains the method.
- code_
unit string - The package, module, or namespace that contains the target code.
- line_
number number - The line number to instrument.
- method_
name string - The method or function name to instrument.
- file
Path String - The source file path relative to the project or source root.
- language
Instrumentation
Config Code Location Language - The programming language for this instrumentation point.
- class
Name String - The class or type name that contains the method.
- code
Unit String - The package, module, or namespace that contains the target code.
- line
Number Integer - The line number to instrument.
- method
Name String - The method or function name to instrument.
- file
Path string - The source file path relative to the project or source root.
- language
Instrumentation
Config Code Location Language - The programming language for this instrumentation point.
- class
Name string - The class or type name that contains the method.
- code
Unit string - The package, module, or namespace that contains the target code.
- line
Number number - The line number to instrument.
- method
Name string - The method or function name to instrument.
- file_
path str - The source file path relative to the project or source root.
- language
Instrumentation
Config Code Location Language - The programming language for this instrumentation point.
- class_
name str - The class or type name that contains the method.
- code_
unit str - The package, module, or namespace that contains the target code.
- line_
number int - The line number to instrument.
- method_
name str - The method or function name to instrument.
- file
Path String - The source file path relative to the project or source root.
- language "Java" | "Python" | "Javascript"
- The programming language for this instrumentation point.
- class
Name String - The class or type name that contains the method.
- code
Unit String - The package, module, or namespace that contains the target code.
- line
Number Number - The line number to instrument.
- method
Name String - The method or function name to instrument.
InstrumentationConfigCodeLocationLanguage, InstrumentationConfigCodeLocationLanguageArgs
- Java
Java- Python
Python- Javascript
Javascript
- Instrumentation
Config Code Location Language Java Java- Instrumentation
Config Code Location Language Python Python- Instrumentation
Config Code Location Language Javascript Javascript
- "Java"
Java- "Python"
Python- "Javascript"
Javascript
- Java
Java- Python
Python- Javascript
Javascript
- Java
Java- Python
Python- Javascript
Javascript
- JAVA
Java- PYTHON
Python- JAVASCRIPT
Javascript
- "Java"
Java- "Python"
Python- "Javascript"
Javascript
InstrumentationConfigInstrumentationType, InstrumentationConfigInstrumentationTypeArgs
- Breakpoint
BREAKPOINT- Probe
PROBE
- Instrumentation
Config Instrumentation Type Breakpoint BREAKPOINT- Instrumentation
Config Instrumentation Type Probe PROBE
- "BREAKPOINT"
BREAKPOINT- "PROBE"
PROBE
- Breakpoint
BREAKPOINT- Probe
PROBE
- Breakpoint
BREAKPOINT- Probe
PROBE
- BREAKPOINT
BREAKPOINT- PROBE
PROBE
- "BREAKPOINT"
BREAKPOINT- "PROBE"
PROBE
InstrumentationConfigSignalType, InstrumentationConfigSignalTypeArgs
- Snapshot
SNAPSHOT
- Instrumentation
Config Signal Type Snapshot SNAPSHOT
- "SNAPSHOT"
SNAPSHOT
- Snapshot
SNAPSHOT
- Snapshot
SNAPSHOT
- SNAPSHOT
SNAPSHOT
- "SNAPSHOT"
SNAPSHOT
LocationProperties, LocationPropertiesArgs
The location where instrumentation should be applied.Tag, TagArgs
A set of tags to apply to the resource.Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Monday, Nov 2, 2026 by Pulumi