AWS::AppRunner::ObservabilityConfiguration - AWS CloudFormation
SyntaxPropertiesReturn valuesExamplesSee also

AWS::AppRunner::ObservabilityConfiguration

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.

Syntax

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

JSON

{
  "Type" : "AWS::AppRunner::ObservabilityConfiguration",
  "Properties" : {
      "ObservabilityConfigurationName" : String,
      "Tags" : [ Tag, ... ],
      "TraceConfiguration" : TraceConfiguration
    }
}

YAML

Type: AWS::AppRunner::ObservabilityConfiguration
Properties:
  ObservabilityConfigurationName: String
  Tags: 
    - Tag
  TraceConfiguration: 
    TraceConfiguration

Properties

ObservabilityConfigurationName

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.

Note

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, AWS CloudFormation generates a name for your observability configuration.

Required: No

Type: String

Pattern: [A-Za-z0-9][A-Za-z0-9\-_]{3,31}

Minimum: 4

Maximum: 32

Update requires: Replacement

Tags

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

Required: No

Type: Array of Tag

Update requires: Replacement

TraceConfiguration

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

Required: No

Type: TraceConfiguration

Update requires: Replacement

Return values

Ref

When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the resource name.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Latest

It's set to true for the configuration with the highest Revision among all configurations that share the same ObservabilityConfigurationName. It's set to false otherwise.

ObservabilityConfigurationArn

The Amazon Resource Name (ARN) of this observability configuration.

ObservabilityConfigurationRevision

The revision of this observability configuration. It's unique among all the active configurations ("Status": "ACTIVE") that share the same ObservabilityConfigurationName.

Examples

Observability configuration to enable tracing

This example illustrates creating an observability configuration that enables tracing using AWS X-Ray.

JSON

{
  "Type": "AWS::AppRunner::ObservabilityConfiguration",
  "Properties": {
    "ObservabilityConfigurationName": "xray-tracing",
    "TraceConfiguration": {
      "Vendor": "AWSXRAY"
    }
  }
}

YAML

Type: AWS::AppRunner::ObservabilityConfiguration
Properties:
  ObservabilityConfigurationName: xray-tracing
  TraceConfiguration:
    Vendor: AWSXRAY

See also