Skip to content
v2.277.0

LogOptions Struct ​

Log Options for the state machine.

Example ​

ts
// 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';
import { custom_resources } from 'aws-cdk-lib';
import { aws_logs as interfaces_logs } from 'aws-cdk-lib/interfaces';

declare const logGroupRef: interfaces_logs.ILogGroupRef;
const logOptions: custom_resources.LogOptions = {
  destination: logGroupRef,
  includeExecutionData: false,
  level: stepfunctions.LogLevel.OFF,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_stepfunctions as stepfunctions
from aws_cdk import custom_resources
from aws_cdk.interfaces import aws_logs as interfaces_logs

# log_group_ref: interfaces_logs.ILogGroupRef

log_options = custom_resources.LogOptions(
    destination=log_group_ref,
    include_execution_data=False,
    level=stepfunctions.LogLevel.OFF
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.stepfunctions.*;
import software.amazon.awscdk.customresources.*;
import software.amazon.awscdk.interfaces.logs.*;

ILogGroupRef logGroupRef;

LogOptions logOptions = LogOptions.builder()
        .destination(logGroupRef)
        .includeExecutionData(false)
        .level(LogLevel.OFF)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.StepFunctions;
using Amazon.CDK.CustomResources;
using Amazon.CDK.Interfaces.Logs;

ILogGroupRef logGroupRef;

var logOptions = new LogOptions {
    Destination = logGroupRef,
    IncludeExecutionData = false,
    Level = LogLevel.OFF
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"

var logGroupRef ILogGroupRef

logOptions := &LogOptions{
	Destination: logGroupRef,
	IncludeExecutionData: jsii.Boolean(false),
	Level: awscdk.Aws_stepfunctions.LogLevel_OFF,
}

Properties ​

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

Default: a new log group will be created

includeExecutionDataoptionalbooleaninclude_execution_dataoptionalboolincludeExecutionDataoptionalBooleanIncludeExecutionDataoptionalboolIncludeExecutionDataoptional*bool = false #
Determines whether execution data is included in your log.
leveloptionalLogLevelleveloptionalLogLevelleveloptionalLogLevelLeveloptionalLogLevelLeveloptionalLogLevel = ERROR #
Defines which category of execution history events are logged.