CfnObservabilityConfigurationProps

class aws_cdk.aws_apprunner.CfnObservabilityConfigurationProps(*, observability_configuration_name=None, tags=None, trace_configuration=None)

Bases: object

Properties for defining a CfnObservabilityConfiguration.

Parameters
  • observability_configuration_name (Optional[str]) – 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. .. epigraph:: 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.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A list of metadata items that you can associate with your observability configuration resource. A tag is a key-value pair.

  • trace_configuration (Union[TraceConfigurationProperty, Dict[str, Any], IResolvable, None]) – The configuration of the tracing feature within this observability configuration. If you don’t specify it, App Runner doesn’t enable tracing.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.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"
    )
)

Attributes

observability_configuration_name

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. .. epigraph:

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.

Link

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

Return type

Optional[str]

tags

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

A tag is a key-value pair.

Link

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

Return type

Optional[List[CfnTag]]

trace_configuration

The configuration of the tracing feature within this observability configuration.

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

Link

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

Return type

Union[TraceConfigurationProperty, IResolvable, None]