class ObservabilityConfiguration (construct) 🔹

Language	Type name
.NET	Amazon.CDK.AWS.AppRunner.Alpha.ObservabilityConfiguration
Go	github.com/aws/aws-cdk-go/awscdkapprunneralpha/v2#ObservabilityConfiguration
Java	software.amazon.awscdk.services.apprunner.alpha.ObservabilityConfiguration
Python	aws_cdk.aws_apprunner_alpha.ObservabilityConfiguration
TypeScript (source)	@aws-cdk/aws-apprunner-alpha » ObservabilityConfiguration

Implements IConstruct, IDependable, IResource, IEnvironmentAware, IObservabilityConfiguration

The App Runner Observability configuration.

Example

const observabilityConfiguration = new apprunner.ObservabilityConfiguration(this, 'ObservabilityConfiguration', {
  observabilityConfigurationName: 'MyObservabilityConfiguration',
  traceConfigurationVendor: apprunner.TraceConfigurationVendor.AWSXRAY,
});

new apprunner.Service(this, 'DemoService', {
  source: apprunner.Source.fromEcrPublic({
    imageConfiguration: { port: 8000 },
    imageIdentifier: 'public.ecr.aws/aws-containers/hello-app-runner:latest',
  }),
  observabilityConfiguration,
});

Initializer

new ObservabilityConfiguration(scope: Construct, id: string, props: ObservabilityConfigurationProps)

Parameters

• scope Construct
• id string
• props ObservabilityConfigurationProps

Construct Props

Name	Type	Description
traceConfigurationVendor🔹	TraceConfigurationVendor	The implementation provider chosen for tracing App Runner services.
observabilityConfigurationName?🔹	string	The name for the ObservabilityConfiguration.

---

traceConfigurationVendor🔹

Type: TraceConfigurationVendor

The implementation provider chosen for tracing App Runner services.

---

observabilityConfigurationName?🔹

Type: string (optional, default: a name generated by CloudFormation)

The name for the ObservabilityConfiguration.

Properties

Name	Type	Description
env🔹	ResourceEnvironment	The environment this resource belongs to.
node🔹	Node	The tree node.
observabilityConfigurationArn🔹	string	The ARN of the Observability configuration.
observabilityConfigurationName🔹	string	The name of the Observability configuration.
observabilityConfigurationRevision🔹	number	The revision of the Observability configuration.
stack🔹	Stack	The stack in which this resource is defined.
static PROPERTY_INJECTION_ID🔹	string	Uniquely identifies this class.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

node🔹

Type: Node

The tree node.

---

observabilityConfigurationArn🔹

Type: string

The ARN of the Observability configuration.

---

observabilityConfigurationName🔹

Type: string

The name of the Observability configuration.

---

observabilityConfigurationRevision🔹

Type: number

The revision of the Observability configuration.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

static PROPERTY_INJECTION_ID🔹

Type: string

Uniquely identifies this class.

Methods

Name	Description
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
toString()🔹	Returns a string representation of this construct.
static fromArn(scope, id, observabilityConfigurationArn)🔹	Imports an App Runner Observability Configuration from its ARN.
static fromObservabilityConfigurationAttributes(scope, id, attrs)🔹	Imports an App Runner Observability Configuration from attributes.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromArn(scope, id, observabilityConfigurationArn)🔹

public static fromArn(scope: Construct, id: string, observabilityConfigurationArn: string): IObservabilityConfiguration

Parameters

• scope Construct
• id string
• observabilityConfigurationArn string

Returns

• IObservabilityConfiguration

Imports an App Runner Observability Configuration from its ARN.

---

static fromObservabilityConfigurationAttributes(scope, id, attrs)🔹

public static fromObservabilityConfigurationAttributes(scope: Construct, id: string, attrs: ObservabilityConfigurationAttributes): IObservabilityConfiguration

Parameters

• scope Construct
• id string
• attrs ObservabilityConfigurationAttributes

Returns

• IObservabilityConfiguration

Imports an App Runner Observability Configuration from attributes.