amazonka-apprunner-2.0: Amazon App Runner SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.AppRunner.CreateObservabilityConfiguration

Description

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.

Synopsis

Creating a Request

data CreateObservabilityConfiguration Source #

See: newCreateObservabilityConfiguration smart constructor.

Constructors

CreateObservabilityConfiguration' 

Fields

  • tags :: Maybe [Tag]

    A list of metadata items that you can associate with your observability configuration resource. A tag is a key-value pair.

  • traceConfiguration :: Maybe TraceConfiguration

    The configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing.

  • observabilityConfigurationName :: Text

    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.

Instances

Instances details
ToJSON CreateObservabilityConfiguration Source # 
Instance details

Defined in Amazonka.AppRunner.CreateObservabilityConfiguration

ToHeaders CreateObservabilityConfiguration Source # 
Instance details

Defined in Amazonka.AppRunner.CreateObservabilityConfiguration

ToPath CreateObservabilityConfiguration Source # 
Instance details

Defined in Amazonka.AppRunner.CreateObservabilityConfiguration

ToQuery CreateObservabilityConfiguration Source # 
Instance details

Defined in Amazonka.AppRunner.CreateObservabilityConfiguration

AWSRequest CreateObservabilityConfiguration Source # 
Instance details

Defined in Amazonka.AppRunner.CreateObservabilityConfiguration

Generic CreateObservabilityConfiguration Source # 
Instance details

Defined in Amazonka.AppRunner.CreateObservabilityConfiguration

Associated Types

type Rep CreateObservabilityConfiguration :: Type -> Type #

Read CreateObservabilityConfiguration Source # 
Instance details

Defined in Amazonka.AppRunner.CreateObservabilityConfiguration

Show CreateObservabilityConfiguration Source # 
Instance details

Defined in Amazonka.AppRunner.CreateObservabilityConfiguration

NFData CreateObservabilityConfiguration Source # 
Instance details

Defined in Amazonka.AppRunner.CreateObservabilityConfiguration

Eq CreateObservabilityConfiguration Source # 
Instance details

Defined in Amazonka.AppRunner.CreateObservabilityConfiguration

Hashable CreateObservabilityConfiguration Source # 
Instance details

Defined in Amazonka.AppRunner.CreateObservabilityConfiguration

type AWSResponse CreateObservabilityConfiguration Source # 
Instance details

Defined in Amazonka.AppRunner.CreateObservabilityConfiguration

type Rep CreateObservabilityConfiguration Source # 
Instance details

Defined in Amazonka.AppRunner.CreateObservabilityConfiguration

type Rep CreateObservabilityConfiguration = D1 ('MetaData "CreateObservabilityConfiguration" "Amazonka.AppRunner.CreateObservabilityConfiguration" "amazonka-apprunner-2.0-EwwUWnxXZrM2Mgbv25gcO5" 'False) (C1 ('MetaCons "CreateObservabilityConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: (S1 ('MetaSel ('Just "traceConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TraceConfiguration)) :*: S1 ('MetaSel ('Just "observabilityConfigurationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateObservabilityConfiguration Source #

Create a value of CreateObservabilityConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:tags:CreateObservabilityConfiguration', createObservabilityConfiguration_tags - A list of metadata items that you can associate with your observability configuration resource. A tag is a key-value pair.

CreateObservabilityConfiguration, createObservabilityConfiguration_traceConfiguration - The configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing.

CreateObservabilityConfiguration, createObservabilityConfiguration_observabilityConfigurationName - 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.

Request Lenses

createObservabilityConfiguration_tags :: Lens' CreateObservabilityConfiguration (Maybe [Tag]) Source #

A list of metadata items that you can associate with your observability configuration resource. A tag is a key-value pair.

createObservabilityConfiguration_traceConfiguration :: Lens' CreateObservabilityConfiguration (Maybe TraceConfiguration) Source #

The configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing.

createObservabilityConfiguration_observabilityConfigurationName :: Lens' CreateObservabilityConfiguration Text Source #

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.

Destructuring the Response

data CreateObservabilityConfigurationResponse Source #

Constructors

CreateObservabilityConfigurationResponse' 

Fields

Instances

Instances details
Generic CreateObservabilityConfigurationResponse Source # 
Instance details

Defined in Amazonka.AppRunner.CreateObservabilityConfiguration

Read CreateObservabilityConfigurationResponse Source # 
Instance details

Defined in Amazonka.AppRunner.CreateObservabilityConfiguration

Show CreateObservabilityConfigurationResponse Source # 
Instance details

Defined in Amazonka.AppRunner.CreateObservabilityConfiguration

NFData CreateObservabilityConfigurationResponse Source # 
Instance details

Defined in Amazonka.AppRunner.CreateObservabilityConfiguration

Eq CreateObservabilityConfigurationResponse Source # 
Instance details

Defined in Amazonka.AppRunner.CreateObservabilityConfiguration

type Rep CreateObservabilityConfigurationResponse Source # 
Instance details

Defined in Amazonka.AppRunner.CreateObservabilityConfiguration

type Rep CreateObservabilityConfigurationResponse = D1 ('MetaData "CreateObservabilityConfigurationResponse" "Amazonka.AppRunner.CreateObservabilityConfiguration" "amazonka-apprunner-2.0-EwwUWnxXZrM2Mgbv25gcO5" 'False) (C1 ('MetaCons "CreateObservabilityConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "observabilityConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ObservabilityConfiguration)))

newCreateObservabilityConfigurationResponse Source #

Create a value of CreateObservabilityConfigurationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateObservabilityConfigurationResponse', createObservabilityConfigurationResponse_httpStatus - The response's http status code.

CreateObservabilityConfigurationResponse, createObservabilityConfigurationResponse_observabilityConfiguration - A description of the App Runner observability configuration that's created by this request.

Response Lenses

createObservabilityConfigurationResponse_observabilityConfiguration :: Lens' CreateObservabilityConfigurationResponse ObservabilityConfiguration Source #

A description of the App Runner observability configuration that's created by this request.