software.amazon.awscdk.services.stepfunctions

Interface LogOptions

All Known Implementing Classes:

LogOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-06-22T23:27:55.795Z")
public interface LogOptions

Defines what execution history events are logged and where they are logged.

Example:

 import software.amazon.awscdk.services.logs.*;
 LogGroup logGroup = new LogGroup(this, "MyLogGroup");
 StateMachine.Builder.create(this, "MyStateMachine")
         .definition(Chain.start(new Pass(this, "Pass")))
         .logs(LogOptions.builder()
                 .destination(logGroup)
                 .level(LogLevel.ALL)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LogOptions.Builder A builder for LogOptions
static class	LogOptions.Jsii$Proxy An implementation for LogOptions

Method Summary

Modifier and Type	Method and Description
static LogOptions.Builder	builder()
ILogGroup	getDestination() The log group where the execution history events will be logged.
default java.lang.Boolean	getIncludeExecutionData() Determines whether execution data is included in your log.
default LogLevel	getLevel() Defines which category of execution history events are logged.

Method Detail

getDestination

ILogGroup getDestination()

The log group where the execution history events will be logged.

getIncludeExecutionData

default java.lang.Boolean getIncludeExecutionData()

Determines whether execution data is included in your log.

Default: false

getLevel

default LogLevel getLevel()

Defines which category of execution history events are logged.

Default: ERROR

builder

static LogOptions.Builder builder()

Returns:

a LogOptions.Builder of LogOptions