software.amazon.awscdk.services.apigateway

Class LogGroupLogDestination

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigateway.LogGroupLogDestination

All Implemented Interfaces:

IAccessLogDestination

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:47.671Z")
public class LogGroupLogDestination
extends software.amazon.jsii.JsiiObject
implements IAccessLogDestination

Use CloudWatch Logs as a custom access log destination for API Gateway.

Example:

 LogGroup logGroup = new LogGroup(this, "ApiGatewayAccessLogs");
 RestApi.Builder.create(this, "books")
         .deployOptions(StageOptions.builder()
                 .accessLogDestination(new LogGroupLogDestination(logGroup))
                 .accessLogFormat(AccessLogFormat.custom(String.format("%s %s %s", AccessLogField.contextRequestId(), AccessLogField.contextErrorMessage(), AccessLogField.contextErrorMessageString())))
                 .build())
         .build();
 

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.IAccessLogDestination

IAccessLogDestination.Jsii$Default, IAccessLogDestination.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
AccessLogDestinationConfig	bind(IStage _stage) Binds this destination to the CloudWatch Logs.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogGroupLogDestination

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

LogGroupLogDestination

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

Method Detail

bind

public AccessLogDestinationConfig bind(IStage _stage)

Binds this destination to the CloudWatch Logs.

Specified by:

bind in interface IAccessLogDestination

Parameters:

_stage - This parameter is required.