Package software.amazon.awscdk.services.appmesh

Class LoggingFormat

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.appmesh.LoggingFormat

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:34.280Z")
@Stability(Stable)
public abstract class LoggingFormat
extends software.amazon.jsii.JsiiObject

Configuration for Envoy Access Logging Format for mesh endpoints.

Example:

 Mesh mesh;
 Service service;
 VirtualNode node = VirtualNode.Builder.create(this, "node")
         .mesh(mesh)
         .serviceDiscovery(ServiceDiscovery.cloudMap(service))
         .listeners(List.of(VirtualNodeListener.http(HttpVirtualNodeListenerOptions.builder()
                 .port(8080)
                 .healthCheck(HealthCheck.http(HttpHealthCheckOptions.builder()
                         .healthyThreshold(3)
                         .interval(Duration.seconds(5))
                         .path("/ping")
                         .timeout(Duration.seconds(2))
                         .unhealthyThreshold(2)
                         .build()))
                 .timeout(HttpTimeout.builder()
                         .idle(Duration.seconds(5))
                         .build())
                 .build())))
         .backendDefaults(BackendDefaults.builder()
                 .tlsClientPolicy(TlsClientPolicy.builder()
                         .validation(TlsValidation.builder()
                                 .trust(TlsValidationTrust.file("/keys/local_cert_chain.pem"))
                                 .build())
                         .build())
                 .build())
         .accessLog(AccessLog.fromFilePath("/dev/stdout", LoggingFormat.fromJson(Map.of("testKey1", "testValue1", "testKey2", "testValue2"))))
         .build();
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LoggingFormat()
protected	LoggingFormat(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	LoggingFormat(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
abstract LoggingFormatConfig	bind()	Called when the Access Log Format is initialized.
static LoggingFormat	fromJson(Map<String,String> jsonLoggingFormat)	Generate logging format from json key pairs.
static LoggingFormat	fromText(String text)	Generate logging format from text pattern.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

LoggingFormat

protected LoggingFormat(software.amazon.jsii.JsiiObjectRef objRef)

LoggingFormat

protected LoggingFormat(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

LoggingFormat

@Stability(Stable)
protected LoggingFormat()

Method Details

fromJson

@Stability(Stable)
@NotNull
public static LoggingFormat fromJson(@NotNull
 Map<String,String> jsonLoggingFormat)

Generate logging format from json key pairs.

Parameters:

jsonLoggingFormat - This parameter is required.

fromText

@Stability(Stable)
@NotNull
public static LoggingFormat fromText(@NotNull
 String text)

Generate logging format from text pattern.

Parameters:

text - This parameter is required.

bind

@Stability(Stable)
@NotNull
public abstract LoggingFormatConfig bind()

Called when the Access Log Format is initialized.

Can be used to enforce mutual exclusivity with future properties