Class CfnStateMachinePropsMixin.LoggingConfigurationProperty

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

Inheritance

object

CfnStateMachinePropsMixin.LoggingConfigurationProperty

Implements

CfnStateMachinePropsMixin.ILoggingConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.StepFunctions

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnStateMachinePropsMixin.LoggingConfigurationProperty : CfnStateMachinePropsMixin.ILoggingConfigurationProperty

Syntax (vb)

Public Class CfnStateMachinePropsMixin.LoggingConfigurationProperty Implements CfnStateMachinePropsMixin.ILoggingConfigurationProperty

Remarks

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 <code>level</code> is set to <code>OFF</code> . For more information see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html">Log Levels</a> in the AWS Step Functions User Guide.

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.StepFunctions;

             var loggingConfigurationProperty = new LoggingConfigurationProperty {
                 Destinations = new [] { new LogDestinationProperty {
                     CloudWatchLogsLogGroup = new CloudWatchLogsLogGroupProperty {
                         LogGroupArn = "logGroupArn"
                     }
                 } },
                 IncludeExecutionData = false,
                 Level = "level"
             };

Synopsis

Constructors

LoggingConfigurationProperty()

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

Properties

Destinations	An array of objects that describes where your execution history events will be logged.
IncludeExecutionData	Determines whether execution data is included in your log.
Level	Defines which category of execution history events are logged.

Constructors

LoggingConfigurationProperty()

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

public LoggingConfigurationProperty()

Remarks

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 <code>level</code> is set to <code>OFF</code> . For more information see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html">Log Levels</a> in the AWS Step Functions User Guide.

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.StepFunctions;

             var loggingConfigurationProperty = new LoggingConfigurationProperty {
                 Destinations = new [] { new LogDestinationProperty {
                     CloudWatchLogsLogGroup = new CloudWatchLogsLogGroupProperty {
                         LogGroupArn = "logGroupArn"
                     }
                 } },
                 IncludeExecutionData = false,
                 Level = "level"
             };

Properties

Destinations

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

public object? Destinations { get; set; }

Property Value

object

Remarks

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

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

Type union: either IResolvable or (either IResolvable or CfnStateMachinePropsMixin.ILogDestinationProperty)[]

IncludeExecutionData

Determines whether execution data is included in your log.

public object? IncludeExecutionData { get; set; }

Property Value

object

Remarks

When set to false , data is excluded.

Type union: either bool or IResolvable

Level

Defines which category of execution history events are logged.

public string? Level { get; set; }