LoggingConfigurationProperty Struct
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
levelis set toOFF. For more information see Log Levels in the AWS Step Functions User Guide.
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';
const loggingConfigurationProperty: stepfunctions.CfnStateMachine.LoggingConfigurationProperty = {
destinations: [{
cloudWatchLogsLogGroup: {
logGroupArn: 'logGroupArn',
},
}],
includeExecutionData: false,
level: 'level',
};
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
logging_configuration_property = stepfunctions.CfnStateMachine.LoggingConfigurationProperty(
destinations=[stepfunctions.CfnStateMachine.LogDestinationProperty(
cloud_watch_logs_log_group=stepfunctions.CfnStateMachine.CloudWatchLogsLogGroupProperty(
log_group_arn="logGroupArn"
)
)],
include_execution_data=False,
level="level"
)
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.*;
LoggingConfigurationProperty loggingConfigurationProperty = LoggingConfigurationProperty.builder()
.destinations(List.of(LogDestinationProperty.builder()
.cloudWatchLogsLogGroup(CloudWatchLogsLogGroupProperty.builder()
.logGroupArn("logGroupArn")
.build())
.build()))
.includeExecutionData(false)
.level("level")
.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;
var loggingConfigurationProperty = new LoggingConfigurationProperty {
Destinations = new [] { new LogDestinationProperty {
CloudWatchLogsLogGroup = new CloudWatchLogsLogGroupProperty {
LogGroupArn = "logGroupArn"
}
} },
IncludeExecutionData = false,
Level = "level"
};
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"
loggingConfigurationProperty := &LoggingConfigurationProperty{
Destinations: []interface{}{
&LogDestinationProperty{
CloudWatchLogsLogGroup: &CloudWatchLogsLogGroupProperty{
LogGroupArn: jsii.String("logGroupArn"),
},
},
},
IncludeExecutionData: jsii.Boolean(false),
Level: jsii.String("level"),
}
Properties
destinationsoptionalIResolvable | IResolvable | CfnStateMachine.LogDestinationProperty[]destinationsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, LogDestinationProperty]]]destinationsoptionalIResolvableDestinationsoptionalIResolvableDestinationsoptionalinterface{}#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 .
includeExecutionDataoptionalboolean | IResolvableinclude_execution_dataoptionaltyping.Union[bool, IResolvable]includeExecutionDataoptionalBooleanIncludeExecutionDataoptionalboolIncludeExecutionDataoptionalinterface{}#Determines whether execution data is included in your log.
When set to false , data is excluded.
Defines which category of execution history events are logged.