Package software.amazon.awscdk.services.events

Enum IncludeDetail

java.lang.Object

java.lang.Enum<IncludeDetail>

software.amazon.awscdk.services.events.IncludeDetail

All Implemented Interfaces:

Serializable, Comparable<IncludeDetail>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-22T11:33:06.759Z")
@Stability(Stable)
public enum IncludeDetail
extends Enum<IncludeDetail>

Whether EventBridge include detailed event information in the records it generates.

Detailed data can be useful for troubleshooting and debugging. This information includes details of the event itself, as well as target details.

Example:

 import software.amazon.awscdk.services.events.EventBus;
 import software.amazon.awscdk.services.events.IncludeDetail;
 import software.amazon.awscdk.services.events.Level;
 EventBus bus = EventBus.Builder.create(this, "Bus")
         .logConfig(LogConfig.builder()
                 .includeDetail(IncludeDetail.FULL)
                 .level(Level.TRACE)
                 .build())
         .build();
 

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FULL	FULL: Include all details related to event itself and the request EventBridge sends to the target.
NONE	NONE: Does not include any details.

Method Summary

Modifier and Type	Method	Description
static IncludeDetail	valueOf(String name)	Returns the enum constant of this type with the specified name.
static IncludeDetail[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FULL

@Stability(Stable)
public static final IncludeDetail FULL

FULL: Include all details related to event itself and the request EventBridge sends to the target.

Detailed data can be useful for troubleshooting and debugging.

NONE

@Stability(Stable)
public static final IncludeDetail NONE

NONE: Does not include any details.

Method Details

values

public static IncludeDetail[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IncludeDetail valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null