AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::AppRunner::ObservabilityConfiguration

CfnObservabilityConfiguration

Specify an AWS App Runner observability configuration by using the `AWS::AppRunner::ObservabilityConfiguration` resource in an AWS CloudFormation template. The `AWS::AppRunner::ObservabilityConfiguration` resource is an AWS App Runner resource type that specifies an App Runner observability configuration. App Runner requires this resource when you specify App Runner services and you want to enable non-default observability features. You can share an observability configuration across multiple services. Create multiple revisions of a configuration by specifying this resource multiple times using the same `ObservabilityConfigurationName` . App Runner creates multiple resources with incremental `ObservabilityConfigurationRevision` values. When you specify a service and configure an observability configuration resource, the service uses the latest active revision of the observability configuration by default. You can optionally configure the service to use a specific revision. The observability configuration resource is designed to configure multiple features (currently one feature, tracing). This resource takes optional parameters that describe the configuration of these features (currently one parameter, `TraceConfiguration` ). If you don't specify a feature parameter, App Runner doesn't enable the feature.

Import

import { CfnObservabilityConfiguration } from 'aws-cdk-lib/aws-apprunner';

Or use the module namespace:

import * as apprunner from 'aws-cdk-lib/aws-apprunner';
// apprunner.CfnObservabilityConfiguration

Properties

Configuration passed to the constructor as CfnObservabilityConfigurationProps.

observabilityConfigurationNameOptional
string

A name for the observability configuration. When you use it for the first time in an AWS Region , App Runner creates revision number `1` of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration. > The name `DefaultConfiguration` is reserved. You can't use it to create a new observability configuration, and you can't create a revision of it. > > When you want to use your own observability configuration for your App Runner service, *create a configuration with a different name* , and then provide it when you create or update your service. If you don't specify a name, CloudFormation generates a name for your observability configuration.

tagsOptional
CfnTag[]

A list of metadata items that you can associate with your observability configuration resource. A tag is a key-value pair.

traceConfigurationOptional
IResolvable | TraceConfigurationProperty

The configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-apprunner
CFN TypeAWS::AppRunner::ObservabilityConfiguration
Properties3

External Links