Skip to content
v2.277.0

CfnObservabilityConfigurationProps Struct ​

Properties for defining a CfnObservabilityConfiguration.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apprunner as apprunner } from 'aws-cdk-lib';
const cfnObservabilityConfigurationProps: apprunner.CfnObservabilityConfigurationProps = {
  observabilityConfigurationName: 'observabilityConfigurationName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  traceConfiguration: {
    vendor: 'vendor',
  },
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_apprunner as apprunner

cfn_observability_configuration_props = apprunner.CfnObservabilityConfigurationProps(
    observability_configuration_name="observabilityConfigurationName",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    trace_configuration=apprunner.CfnObservabilityConfiguration.TraceConfigurationProperty(
        vendor="vendor"
    )
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.apprunner.*;

CfnObservabilityConfigurationProps cfnObservabilityConfigurationProps = CfnObservabilityConfigurationProps.builder()
        .observabilityConfigurationName("observabilityConfigurationName")
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .traceConfiguration(TraceConfigurationProperty.builder()
                .vendor("vendor")
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppRunner;

var cfnObservabilityConfigurationProps = new CfnObservabilityConfigurationProps {
    ObservabilityConfigurationName = "observabilityConfigurationName",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    TraceConfiguration = new TraceConfigurationProperty {
        Vendor = "vendor"
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnObservabilityConfigurationProps := &CfnObservabilityConfigurationProps{
	ObservabilityConfigurationName: jsii.String("observabilityConfigurationName"),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	TraceConfiguration: &TraceConfigurationProperty{
		Vendor: jsii.String("vendor"),
	},
}

Properties ​

observabilityConfigurationNameoptionalstringobservability_configuration_nameoptionalstrobservabilityConfigurationNameoptionalStringObservabilityConfigurationNameoptionalstringObservabilityConfigurationNameoptional*string#
A name for the observability configuration.
notes

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.

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
A list of metadata items that you can associate with your observability configuration resource.

A tag is a key-value pair.

traceConfigurationoptionalIResolvable | CfnObservabilityConfiguration.TraceConfigurationPropertytrace_configurationoptionaltyping.Union[IResolvable, TraceConfigurationProperty]traceConfigurationoptionalIResolvableTraceConfigurationoptionalIResolvableTraceConfigurationoptionalinterface{}#
The configuration of the tracing feature within this observability configuration.

If you don't specify it, App Runner doesn't enable tracing.