@liflig/cdk
    Preparing search index...

    Type Alias ApiGatewayAccessLogsProps

    type ApiGatewayAccessLogsProps = {
        accessLogFormat?: Record<string, unknown>;
        removalPolicy?: cdk.RemovalPolicy;
        retention?: logs.RetentionDays;
    }
    Index

    Properties

    accessLogFormat? removalPolicy? retention?

    Properties

    accessLogFormat?: Record<string, unknown>

    A custom JSON log format, which uses variables from "$context".

    See AWS: CloudWatch log formats for API Gateway for formats and rules. It is possible to use other formats like CLF and XML, but this construct only supports JSON for now.

    For a list of all possible variables to log, see AWS: $context Variables for data models, authorizers, mapping templates, and CloudWatch access logging and AWS: $context Variables for access logging only .

    defaultAccessLogFormat

    removalPolicy?: cdk.RemovalPolicy

    Delete the access logs if this construct is deleted?

    Maybe you want to DESTROY instead. Or for legal reasons, retain for audit.

    RemovalPolicy.RETAIN
    retention?: logs.RetentionDays

    How long to keep the logs. If undefined, uses the same default as new AWS log groups.

    RetentionDays.TWO_YEARS

    Settings

    Member Visibility

    On This Page

    Properties