software.amazon.awscdk.services.apprunner

Class CfnObservabilityConfiguration

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.apprunner.CfnObservabilityConfiguration

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.594Z")
 @Stability(value=Stable)
public class CfnObservabilityConfiguration
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppRunner::ObservabilityConfiguration`.

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.

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.*;
 CfnObservabilityConfiguration cfnObservabilityConfiguration = CfnObservabilityConfiguration.Builder.create(this, "MyCfnObservabilityConfiguration")
         .observabilityConfigurationName("observabilityConfigurationName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .traceConfiguration(TraceConfigurationProperty.builder()
                 .vendor("vendor")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnObservabilityConfiguration.Builder A fluent builder for CfnObservabilityConfiguration.
static interface	CfnObservabilityConfiguration.TraceConfigurationProperty Describes the configuration of the tracing feature within an AWS App Runner observability configuration.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnObservabilityConfiguration(software.constructs.Construct scope, String id) Create a new `AWS::AppRunner::ObservabilityConfiguration`.
	CfnObservabilityConfiguration(software.constructs.Construct scope, String id, CfnObservabilityConfigurationProps props) Create a new `AWS::AppRunner::ObservabilityConfiguration`.
protected	CfnObservabilityConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnObservabilityConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
IResolvable	getAttrLatest() It's set to `true` for the configuration with the highest `Revision` among all configurations that share the same `ObservabilityConfigurationName` .
String	getAttrObservabilityConfigurationArn() The Amazon Resource Name (ARN) of this observability configuration.
Number	getAttrObservabilityConfigurationRevision() The revision of this observability configuration.
protected Map<String,Object>	getCfnProperties()
String	getObservabilityConfigurationName() A name for the observability configuration.
TagManager	getTags() A list of metadata items that you can associate with your observability configuration resource.
Object	getTraceConfiguration() The configuration of the tracing feature within this observability configuration.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setObservabilityConfigurationName(String value) A name for the observability configuration.
void	setTraceConfiguration(CfnObservabilityConfiguration.TraceConfigurationProperty value) The configuration of the tracing feature within this observability configuration.
void	setTraceConfiguration(IResolvable value) The configuration of the tracing feature within this observability configuration.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnObservabilityConfiguration

protected CfnObservabilityConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

CfnObservabilityConfiguration

protected CfnObservabilityConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnObservabilityConfiguration

@Stability(value=Stable)
public CfnObservabilityConfiguration(@NotNull
                                                              software.constructs.Construct scope,
                                                              @NotNull
                                                              String id,
                                                              @Nullable
                                                              CfnObservabilityConfigurationProps props)

Create a new `AWS::AppRunner::ObservabilityConfiguration`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnObservabilityConfiguration

@Stability(value=Stable)
public CfnObservabilityConfiguration(@NotNull
                                                              software.constructs.Construct scope,
                                                              @NotNull
                                                              String id)

Create a new `AWS::AppRunner::ObservabilityConfiguration`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrLatest

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrLatest()

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.

getAttrObservabilityConfigurationArn

@Stability(value=Stable)
 @NotNull
public String getAttrObservabilityConfigurationArn()

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

getAttrObservabilityConfigurationRevision

@Stability(value=Stable)
 @NotNull
public Number getAttrObservabilityConfigurationRevision()

The revision of this observability configuration.

It's unique among all the active configurations ( "Status": "ACTIVE" ) that share the same ObservabilityConfigurationName .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

A list of metadata items that you can associate with your observability configuration resource.

A tag is a key-value pair.

getObservabilityConfigurationName

@Stability(value=Stable)
 @Nullable
public String getObservabilityConfigurationName()

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

setObservabilityConfigurationName

@Stability(value=Stable)
public void setObservabilityConfigurationName(@Nullable
                                                                       String value)

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

getTraceConfiguration

@Stability(value=Stable)
 @Nullable
public Object getTraceConfiguration()

The configuration of the tracing feature within this observability configuration.

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

setTraceConfiguration

@Stability(value=Stable)
public void setTraceConfiguration(@Nullable
                                                           CfnObservabilityConfiguration.TraceConfigurationProperty value)

The configuration of the tracing feature within this observability configuration.

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

setTraceConfiguration

@Stability(value=Stable)
public void setTraceConfiguration(@Nullable
                                                           IResolvable value)

The configuration of the tracing feature within this observability configuration.

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