Package software.amazon.awscdk.services.apprunner

Interface CfnService.ServiceObservabilityConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnService.ServiceObservabilityConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnService

@Stability(Stable)
public static interface CfnService.ServiceObservabilityConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Describes the observability configuration of an AWS App Runner service.

These are additional observability features, like tracing, that you choose to enable. They're configured in a separate resource that you associate with your service.

Example:

 // 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.*;
 ServiceObservabilityConfigurationProperty serviceObservabilityConfigurationProperty = ServiceObservabilityConfigurationProperty.builder()
         .observabilityEnabled(false)
         // the properties below are optional
         .observabilityConfigurationArn("observabilityConfigurationArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-serviceobservabilityconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnService.ServiceObservabilityConfigurationProperty.Builder	A builder for CfnService.ServiceObservabilityConfigurationProperty
static final class	CfnService.ServiceObservabilityConfigurationProperty.Jsii$Proxy	An implementation for CfnService.ServiceObservabilityConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnService.ServiceObservabilityConfigurationProperty.Builder	builder()
default String	getObservabilityConfigurationArn()	The Amazon Resource Name (ARN) of the observability configuration that is associated with the service.
Object	getObservabilityEnabled()	When true , an observability configuration resource is associated with the service, and an ObservabilityConfigurationArn is specified.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getObservabilityEnabled

@Stability(Stable)
@NotNull
Object getObservabilityEnabled()

When true , an observability configuration resource is associated with the service, and an ObservabilityConfigurationArn is specified.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-serviceobservabilityconfiguration.html#cfn-apprunner-service-serviceobservabilityconfiguration-observabilityenabled

getObservabilityConfigurationArn

@Stability(Stable)
@Nullable
default String getObservabilityConfigurationArn()

The Amazon Resource Name (ARN) of the observability configuration that is associated with the service.

Specified only when ObservabilityEnabled is true .

Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3

Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-serviceobservabilityconfiguration.html#cfn-apprunner-service-serviceobservabilityconfiguration-observabilityconfigurationarn

builder

@Stability(Stable)
static CfnService.ServiceObservabilityConfigurationProperty.Builder builder()

Returns:

a CfnService.ServiceObservabilityConfigurationProperty.Builder of CfnService.ServiceObservabilityConfigurationProperty