aws-cdk-lib.aws_stepfunctions.LogOptions

interface LogOptions

LanguageType name
.NETAmazon.CDK.AWS.StepFunctions.LogOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#LogOptions
Javasoftware.amazon.awscdk.services.stepfunctions.LogOptions
Pythonaws_cdk.aws_stepfunctions.LogOptions
TypeScript (source)aws-cdk-lib » aws_stepfunctions » LogOptions

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

Example

import * as logs from 'aws-cdk-lib/aws-logs';

const logGroup = new logs.LogGroup(this, 'MyLogGroup');

new sfn.StateMachine(this, 'MyStateMachine', {
  definition: sfn.Chain.start(new sfn.Pass(this, 'Pass')),
  logs: {
    destination: logGroup,
    level: sfn.LogLevel.ALL,
  },
});

Properties

NameTypeDescription
destinationILogGroupThe log group where the execution history events will be logged.
includeExecutionData?booleanDetermines whether execution data is included in your log.
level?LogLevelDefines which category of execution history events are logged.

destination

Type: ILogGroup

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


includeExecutionData?

Type: boolean (optional, default: false)

Determines whether execution data is included in your log.


level?

Type: LogLevel (optional, default: ERROR)

Defines which category of execution history events are logged.