Package software.amazon.awscdk.services.stepfunctions

Interface CfnStateMachine.LoggingConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStateMachine.LoggingConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnStateMachine

@Stability(Stable)
public static interface CfnStateMachine.LoggingConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-loggingconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnStateMachine.LoggingConfigurationProperty.Builder	builder()
default Object	getDestinations()	An array of objects that describes where your execution history events will be logged.
default Object	getIncludeExecutionData()	Determines whether execution data is included in your log.
default String	getLevel()	Defines which category of execution history events are logged.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDestinations

@Stability(Stable)
@Nullable
default Object getDestinations()

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 .

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnStateMachine.LogDestinationProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-loggingconfiguration.html#cfn-stepfunctions-statemachine-loggingconfiguration-destinations

getIncludeExecutionData

@Stability(Stable)
@Nullable
default Object getIncludeExecutionData()

Determines whether execution data is included in your log.

When set to false , data is excluded.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-loggingconfiguration.html#cfn-stepfunctions-statemachine-loggingconfiguration-includeexecutiondata

getLevel

@Stability(Stable)
@Nullable
default String getLevel()

Defines which category of execution history events are logged.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-loggingconfiguration.html#cfn-stepfunctions-statemachine-loggingconfiguration-level

builder

@Stability(Stable)
static CfnStateMachine.LoggingConfigurationProperty.Builder builder()

Returns:

a CfnStateMachine.LoggingConfigurationProperty.Builder of CfnStateMachine.LoggingConfigurationProperty