Class LogOptions

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

Inheritance

object

LogOptions

Implements

ILogOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.StepFunctions

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class LogOptions : ILogOptions

Syntax (vb)

Public Class LogOptions Implements ILogOptions

Remarks

ExampleMetadata: infused

Examples

using Amazon.CDK.AWS.Logs;


            var logGroup = new LogGroup(this, "MyLogGroup");

            var definition = Chain.Start(new Pass(this, "Pass"));

            new StateMachine(this, "MyStateMachine", new StateMachineProps {
                DefinitionBody = DefinitionBody.FromChainable(definition),
                Logs = new LogOptions {
                    Destination = logGroup,
                    Level = LogLevel.ALL
                }
            });

Synopsis

Constructors

LogOptions()

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

Properties

Destination	The log group where the 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

LogOptions()

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

public LogOptions()

Remarks

ExampleMetadata: infused

Examples

using Amazon.CDK.AWS.Logs;


            var logGroup = new LogGroup(this, "MyLogGroup");

            var definition = Chain.Start(new Pass(this, "Pass"));

            new StateMachine(this, "MyStateMachine", new StateMachineProps {
                DefinitionBody = DefinitionBody.FromChainable(definition),
                Logs = new LogOptions {
                    Destination = logGroup,
                    Level = LogLevel.ALL
                }
            });

Properties

Destination

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

public ILogGroupRef? Destination { get; set; }

Property Value

ILogGroupRef

Remarks

Default: No log group. Required if your log level is not set to OFF.

IncludeExecutionData

Determines whether execution data is included in your log.

public bool? IncludeExecutionData { get; set; }

Property Value

bool?

Remarks

Default: false

Level

Defines which category of execution history events are logged.

public LogLevel? Level { get; set; }

Property Value

LogLevel?

Remarks

Default: ERROR

Implements

ILogOptions