observability_configurations

Creates, updates, deletes or gets an observability_configuration resource or lists observability_configurations in a region

Overview

Name	observability_configurations
Type	Resource
Description	The AWS::AppRunner::ObservabilityConfiguration resource is an AWS App Runner resource type that specifies an App Runner observability configuration
Id	aws.apprunner.observability_configurations

Fields

Name	Datatype	Description
observability_configuration_arn	string	The Amazon Resource Name (ARN) of this ObservabilityConfiguration
observability_configuration_name	string	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.
observability_configuration_revision	integer	The revision of this observability configuration. It's unique among all the active configurations ('Status': 'ACTIVE') that share the same ObservabilityConfigurationName.
latest	boolean	It's set to true for the configuration with the highest Revision among all configurations that share the same Name. It's set to false otherwise.
trace_configuration	object	The configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing.
tags	array	A list of metadata items that you can associate with your observability configuration resource. A tag is a key-value pair.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	, region
delete_resource	DELETE	data__Identifier, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all observability_configurations in a region.

SELECT
region,
observability_configuration_arn,
observability_configuration_name,
observability_configuration_revision,
latest,
trace_configuration,
tags
FROM aws.apprunner.observability_configurations
WHERE region = 'us-east-1';

Gets all properties from an individual observability_configuration.

SELECT
region,
observability_configuration_arn,
observability_configuration_name,
observability_configuration_revision,
latest,
trace_configuration,
tags
FROM aws.apprunner.observability_configurations
WHERE region = 'us-east-1' AND data__Identifier = '<ObservabilityConfigurationArn>';

INSERT example

Use the following StackQL query and manifest file to create a new observability_configuration resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.apprunner.observability_configurations (
 ,
 region
)
SELECT 
'{{  }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.apprunner.observability_configurations (
 ObservabilityConfigurationName,
 TraceConfiguration,
 Tags,
 region
)
SELECT 
 '{{ ObservabilityConfigurationName }}',
 '{{ TraceConfiguration }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: observability_configuration
    props:
      - name: ObservabilityConfigurationName
        value: '{{ ObservabilityConfigurationName }}'
      - name: TraceConfiguration
        value:
          Vendor: '{{ Vendor }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.apprunner.observability_configurations
WHERE data__Identifier = '<ObservabilityConfigurationArn>'
AND region = 'us-east-1';

Permissions

To operate on the observability_configurations resource, the following permissions are required:

Create

apprunner:CreateObservabilityConfiguration,
apprunner:DescribeObservabilityConfiguration,
apprunner:TagResource

Read

apprunner:DescribeObservabilityConfiguration

Delete

apprunner:DeleteObservabilityConfiguration

List

apprunner:ListObservabilityConfigurations