Class CfnObservabilityConfiguration

Specify an AWS App Runner observability configuration by using the AWS::AppRunner::ObservabilityConfiguration resource in an AWS CloudFormation template.

Inheritance

System.Object

CfnElement

CfnRefElement

CfnResource

CfnObservabilityConfiguration

Implements

IInspectable

ITaggable

Inherited Members

CfnResource.IsCfnResource(Object)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String, Nullable<ResolutionTypeHint>)

CfnResource.GetMetadata(String)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.AppRunner

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnObservabilityConfiguration : CfnResource, IInspectable, ITaggable

Syntax (vb)

Public Class CfnObservabilityConfiguration
    Inherits CfnResource
    Implements IInspectable, ITaggable

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-observabilityconfiguration.html

CloudformationResource: AWS::AppRunner::ObservabilityConfiguration

ExampleMetadata: fixture=_generated

Examples

// 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 cfnObservabilityConfiguration = new CfnObservabilityConfiguration(this, "MyCfnObservabilityConfiguration", new CfnObservabilityConfigurationProps {
    ObservabilityConfigurationName = "observabilityConfigurationName",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    TraceConfiguration = new TraceConfigurationProperty {
        Vendor = "vendor"
    }
});

Synopsis

Constructors

CfnObservabilityConfiguration(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnObservabilityConfiguration(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps
CfnObservabilityConfiguration(Construct, String, ICfnObservabilityConfigurationProps)

Properties

AttrLatest	It's set to `true` for the configuration with the highest `Revision` among all configurations that share the same `ObservabilityConfigurationName` .
AttrObservabilityConfigurationArn	The Amazon Resource Name (ARN) of this observability configuration.
AttrObservabilityConfigurationRevision	The revision of this observability configuration.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties
ObservabilityConfigurationName	A name for the observability configuration.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	A list of metadata items that you can associate with your observability configuration resource.
TraceConfiguration	The configuration of the tracing feature within this observability configuration.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnObservabilityConfiguration(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnObservabilityConfiguration(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

CfnObservabilityConfiguration(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnObservabilityConfiguration(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

CfnObservabilityConfiguration(Construct, String, ICfnObservabilityConfigurationProps)

public CfnObservabilityConfiguration(Construct scope, string id, ICfnObservabilityConfigurationProps props = null)

Parameters

scope Constructs.Construct: Scope in which this resource is defined.
id System.String: Construct identifier for this resource (unique in its scope).
props ICfnObservabilityConfigurationProps: Resource properties.

Properties

AttrLatest

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

public virtual IResolvable AttrLatest { get; }

Property Value

IResolvable

Remarks

It's set to false otherwise.

CloudformationAttribute: Latest

AttrObservabilityConfigurationArn

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

public virtual string AttrObservabilityConfigurationArn { get; }

Property Value

System.String

Remarks

CloudformationAttribute: ObservabilityConfigurationArn

AttrObservabilityConfigurationRevision

The revision of this observability configuration.

public virtual double AttrObservabilityConfigurationRevision { get; }

Property Value

System.Double

Remarks

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

CloudformationAttribute: ObservabilityConfigurationRevision

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.CfnProperties

ObservabilityConfigurationName

A name for the observability configuration.

public virtual string ObservabilityConfigurationName { get; set; }

Property Value

System.String

TagsRaw

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

public virtual ICfnTag[] TagsRaw { get; set; }

Property Value

ICfnTag[]

TraceConfiguration

The configuration of the tracing feature within this observability configuration.

public virtual object TraceConfiguration { get; set; }

Property Value

System.Object

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector: tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props System.Collections.Generic.IDictionary<System.String, System.Object>

Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IInspectable

ITaggable