aws-cdk-lib.aws_stepfunctions.CfnStateMachine.LoggingConfigurationProperty

interface LoggingConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.StepFunctions.CfnStateMachine.LoggingConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#CfnStateMachine_LoggingConfigurationProperty
Javasoftware.amazon.awscdk.services.stepfunctions.CfnStateMachine.LoggingConfigurationProperty
Pythonaws_cdk.aws_stepfunctions.CfnStateMachine.LoggingConfigurationProperty
TypeScript aws-cdk-lib » aws_stepfunctions » CfnStateMachine » LoggingConfigurationProperty

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

Step Functions provides the log levels — OFF , ALL , ERROR , and FATAL . No event types log when set to OFF and all event types do when set to ALL .

By default, the level is set to OFF . For more information see Log Levels in the AWS Step Functions User Guide.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
const loggingConfigurationProperty: stepfunctions.CfnStateMachine.LoggingConfigurationProperty = {
  destinations: [{
    cloudWatchLogsLogGroup: {
      logGroupArn: 'logGroupArn',
    },
  }],
  includeExecutionData: false,
  level: 'level',
};

Properties

NameTypeDescription
destinations?IResolvable | IResolvable | LogDestinationProperty[]An array of objects that describes where your execution history events will be logged.
includeExecutionData?boolean | IResolvableDetermines whether execution data is included in your log.
level?stringDefines which category of execution history events are logged.

destinations?

Type: IResolvable | IResolvable | LogDestinationProperty[] (optional)

An array of objects that describes where your execution history events will be logged.

Limited to size 1. Required, if your log level is not set to OFF .


includeExecutionData?

Type: boolean | IResolvable (optional)

Determines whether execution data is included in your log.

When set to false , data is excluded.


level?

Type: string (optional)

Defines which category of execution history events are logged.