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	awscc.apprunner.observability_configurations

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
observability_configuration_arn	string	The Amazon Resource Name (ARN) of this ObservabilityConfiguration
region	string	AWS region.

For more information, see AWS::AppRunner::ObservabilityConfiguration.

Methods

Name	Resource	Accessible by	Required Params
create_resource	observability_configurations	INSERT	, region
delete_resource	observability_configurations	DELETE	Identifier, region
list_resources	observability_configurations_list_only	SELECT	region
get_resource	observability_configurations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual observability_configuration.

SELECT
  region,
  observability_configuration_arn,
  observability_configuration_name,
  observability_configuration_revision,
  latest,
  trace_configuration,
  tags
FROM awscc.apprunner.observability_configurations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ observability_configuration_arn }}';

list (identifiers only)

Lists all observability_configurations in a region.

SELECT
  region,
  observability_configuration_arn
FROM awscc.apprunner.observability_configurations_list_only
WHERE
  region = '{{ region }}';

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 awscc.apprunner.observability_configurations (
  ,
  region
)
SELECT
  '{{  }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.apprunner.observability_configurations (
  ObservabilityConfigurationName,
  TraceConfiguration,
  Tags,
  region
)
SELECT
  '{{ observability_configuration_name }}',
  '{{ trace_configuration }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: observability_configuration
  props:
    - name: observability_configuration_name
      value: '{{ observability_configuration_name }}'
    - name: trace_configuration
      value:
        vendor: '{{ vendor }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

DELETE example

/*+ delete */
DELETE FROM awscc.apprunner.observability_configurations
WHERE
  Identifier = '{{ observability_configuration_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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