View a markdown version of this page

AWS::ApplicationSignals::InstrumentationConfig - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::ApplicationSignals::InstrumentationConfig

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.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::ApplicationSignals::InstrumentationConfig",
  "Properties" : {
      "AttributeFilters" : [ {Key: Value, ...}, ... ],
      "CaptureConfiguration" : CaptureConfiguration,
      "Description" : String,
      "Environment" : String,
      "ExpiresAt" : String,
      "InstrumentationType" : String,
      "Location" : Location,
      "Service" : String,
      "SignalType" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::ApplicationSignals::InstrumentationConfig
Properties:
  AttributeFilters: 
    - 
    Key: Value
  CaptureConfiguration: 
    CaptureConfiguration
  Description: String
  Environment: String
  ExpiresAt: String
  InstrumentationType: String
  Location: 
    Location
  Service: String
  SignalType: String
  Tags: 
    - Tag

Properties

AttributeFilters

Client-side filters that determine which instances apply this instrumentation.

Required: No

Type: Array of Object

Minimum: 1

Maximum: 10

Update requires: Replacement

CaptureConfiguration

The capture settings for this instrumentation configuration.

Required: Yes

Type: CaptureConfiguration

Update requires: Replacement

Description

An optional short description of the instrumentation configuration.

Required: No

Type: String

Minimum: 1

Maximum: 50

Update requires: Replacement

Environment

The environment where the service is running.

Required: Yes

Type: String

Pattern: ^[A-Za-z0-9:/+=,.@_-]+$

Minimum: 1

Maximum: 255

Update requires: Replacement

ExpiresAt

The timestamp when this configuration expires.

Required: No

Type: String

Update requires: Replacement

InstrumentationType

The type of instrumentation for this configuration.

Required: Yes

Type: String

Allowed values: BREAKPOINT | PROBE

Update requires: Replacement

Location

The location where this instrumentation is applied.

Required: Yes

Type: Location

Update requires: Replacement

Service

The service that this instrumentation configuration targets.

Required: Yes

Type: String

Pattern: ^[A-Za-z0-9:/+=,.@_-]+$

Minimum: 1

Maximum: 255

Update requires: Replacement

SignalType

The telemetry signal type for this instrumentation configuration.

Required: Yes

Type: String

Allowed values: SNAPSHOT

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: Array of Tag

Maximum: 200

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

The ARN for the instrumentation configuration.

CreatedAt

The timestamp when this instrumentation configuration was created.

LocationHash

The stable hash derived from the location that uniquely identifies this instrumentation point within the service and environment.