observability_configurations

Creates, updates, deletes, gets or lists an observability_configurations resource.

Overview

Name	observability_configurations
Type	Resource
Id	aws.apprunner.observability_configurations

Fields

The following fields are returned by SELECT queries:

describe_observability_configuration

Name	Datatype	Description
created_at	string (date-time)	The time when the observability configuration was created. It's in Unix time stamp format.
deleted_at	string (date-time)	The time when the observability configuration was deleted. It's in Unix time stamp format.
latest	boolean	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.
observability_configuration_arn	string	The Amazon Resource Name (ARN) of this observability configuration. (pattern: <code>arn:aws(-[\w]+)*:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[0-9]{12}:(\w|/|-){1,1011}</code>)
observability_configuration_name	string	The customer-provided observability configuration name. It can be used in multiple revisions of a configuration. (pattern: <code>[A-Za-z0-9][A-Za-z0-9-_]{3,31}</code>)
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.
status	string	The current state of the observability configuration. If the status of a configuration revision is INACTIVE, it was deleted and can't be used. Inactive configuration revisions are permanently removed some time after they are deleted. (ACTIVE, INACTIVE)
trace_configuration	object	The configuration of the tracing feature within this observability configuration. If not specified, tracing isn't enabled.

list_observability_configurations

Name	Datatype	Description
next_token	string	The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request. (pattern: <code>.*</code>)
observability_configuration_summary_list	array	A list of summary information records for observability configurations. In a paginated request, the request returns up to MaxResults records for each call.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_observability_configuration	select	region		Return a full description of an App Runner observability configuration resource.
list_observability_configurations	select	region		Returns a list of active App Runner observability configurations in your Amazon Web Services account. You can query the revisions for a specific configuration name or the revisions for all active configurations in your account. You can optionally query only the latest revision of each requested name. To retrieve a full description of a particular configuration revision, call and provide one of the ARNs returned by ListObservabilityConfigurations.
create_observability_configuration	insert	region, ObservabilityConfigurationName		Create an App Runner observability configuration resource. App Runner requires this resource when you create or update 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 calling this action multiple times using the same ObservabilityConfigurationName. The call returns incremental ObservabilityConfigurationRevision values. When you create 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 action 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.
delete_observability_configuration	delete	region		Delete an App Runner observability configuration resource. You can delete a specific revision or the latest active revision. You can't delete a configuration that's used by one or more App Runner services.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_observability_configuration

Return a full description of an App Runner observability configuration resource.

SELECT
created_at,
deleted_at,
latest,
observability_configuration_arn,
observability_configuration_name,
observability_configuration_revision,
status,
trace_configuration
FROM aws.apprunner.observability_configurations
WHERE region = '{{ region }}' -- required
;

list_observability_configurations

Returns a list of active App Runner observability configurations in your Amazon Web Services account. You can query the revisions for a specific configuration name or the revisions for all active configurations in your account. You can optionally query only the latest revision of each requested name. To retrieve a full description of a particular configuration revision, call and provide one of the ARNs returned by ListObservabilityConfigurations.

SELECT
next_token,
observability_configuration_summary_list
FROM aws.apprunner.observability_configurations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_observability_configuration

Create an App Runner observability configuration resource. App Runner requires this resource when you create or update 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 calling this action multiple times using the same ObservabilityConfigurationName. The call returns incremental ObservabilityConfigurationRevision values. When you create 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 action 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.

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

Manifest

# Description fields are for documentation purposes
- name: observability_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the observability_configurations resource.
  - name: ObservabilityConfigurationName
    value: "{{ ObservabilityConfigurationName }}"
    description: |
      A name for the observability configuration. When you use it for the first time in an Amazon Web Services 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.
  - name: TraceConfiguration
    description: |
      The configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing.
    value:
      Vendor: "{{ Vendor }}"
  - name: Tags
    description: |
      A list of metadata items that you can associate with your observability configuration resource. A tag is a key-value pair.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

DELETE examples

delete_observability_configuration

Delete an App Runner observability configuration resource. You can delete a specific revision or the latest active revision. You can't delete a configuration that's used by one or more App Runner services.

DELETE FROM aws.apprunner.observability_configurations
WHERE region = '{{ region }}' --required
;