Package software.amazon.awscdk.services.eventsv2

Interface CfnSubscriberProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSubscriberProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)",
           date="2026-09-30T11:04:52.426Z")
@Stability(Stable)
public interface CfnSubscriberProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnSubscriber.

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.eventsv2.*;
 CfnSubscriberProps cfnSubscriberProps = CfnSubscriberProps.builder()
         .eventBusArn("eventBusArn")
         .name("name")
         // the properties below are optional
         .batchConfiguration(BatchConfigurationProperty.builder()
                 .maxBatchSize(123)
                 .maxBatchWindowInSeconds(123)
                 .build())
         .description("description")
         .filterConfiguration(FilterConfigurationProperty.builder()
                 .filters(List.of(FilterProperty.builder()
                         .pattern("pattern")
                         .scope("scope")
                         .build()))
                 // the properties below are optional
                 .language("language")
                 .build())
         .logConfiguration(LogConfigurationProperty.builder()
                 .includePayload("includePayload")
                 .level("level")
                 .build())
         .onFailureConfiguration(OnFailureConfigurationProperty.builder()
                 .arn("arn")
                 .build())
         .pointInTimeConfiguration(PointInTimeConfigurationProperty.builder()
                 .pointType("pointType")
                 // the properties below are optional
                 .endPoint(123)
                 .startingPoint(123)
                 .build())
         .resumePosition("resumePosition")
         .retryPolicy(RetryPolicyProperty.builder()
                 .maxEventAgeInSeconds(123)
                 .maxRetryAttempts(123)
                 .retryStrategy("retryStrategy")
                 .build())
         .startingPosition("startingPosition")
         .state("state")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .transformer(TransformerProperty.builder()
                 .jsonataConfiguration(JsonataConfigurationProperty.builder()
                         .expression("expression")
                         .build())
                 .type("type")
                 .build())
         .type("type")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnSubscriberProps.Builder	builder()
default Object	getBatchConfiguration()	Configuration for batching events into a single delivery.
default String	getDescription()	A description of the subscriber.
String	getEventBusArn()	The ARN of the event bus this subscriber belongs to.
default Object	getFilterConfiguration()	Configuration for filtering which events are delivered to the target.
default Object	getLogConfiguration()	Delivery logging configuration.
String	getName()	The name of the subscriber.
default Object	getOnFailureConfiguration()	The destination for events that could not be delivered.
default Object	getPointInTimeConfiguration()	The point in time to start delivering events from, used when StartingPosition is POINT_IN_TIME.
default String	getResumePosition()	Resume-time control, never returned by the service.
default Object	getRetryPolicy()	The retry policy for failed deliveries.
default String	getStartingPosition()	Where the subscriber starts reading events: LATEST starts from the newest events;
default String	getState()	The run state of the subscriber.
default List<CfnTag>	getTags()	The tags assigned to the subscriber.
default Object	getTransformer()	Configuration for transforming events before delivery: the raw payload, the payload with its metadata envelope, or the output of a JSONata expression.
default String	getType()	The delivery ordering mode of the subscriber.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEventBusArn

@Stability(Stable)
@NotNull
String getEventBusArn()

The ARN of the event bus this subscriber belongs to.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-eventbusarn

getName

@Stability(Stable)
@NotNull
String getName()

The name of the subscriber.

The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-name

getBatchConfiguration

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

Configuration for batching events into a single delivery.

Returns union: either IResolvable or CfnSubscriber.BatchConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-batchconfiguration

getDescription

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

A description of the subscriber.

Control characters and Unicode line separators are not allowed.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-description

getFilterConfiguration

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

Configuration for filtering which events are delivered to the target.

An event must match every filter to be delivered.

Returns union: either IResolvable or CfnSubscriber.FilterConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-filterconfiguration

getLogConfiguration

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

Delivery logging configuration.

Returns union: either IResolvable or CfnSubscriber.LogConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-logconfiguration

getOnFailureConfiguration

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

The destination for events that could not be delivered.

Returns union: either IResolvable or CfnSubscriber.OnFailureConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-onfailureconfiguration

getPointInTimeConfiguration

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

The point in time to start delivering events from, used when StartingPosition is POINT_IN_TIME.

Returns union: either IResolvable or CfnSubscriber.PointInTimeConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-pointintimeconfiguration

getResumePosition

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

Resume-time control, never returned by the service.

Applied only when an update transitions State from STOPPED to RUNNING: LAST_PROCESSED (default) resumes from the last processed event, LATEST skips to the newest. Ignored on create and on any update that does not perform that transition.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-resumeposition

getRetryPolicy

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

The retry policy for failed deliveries.

Returns union: either IResolvable or CfnSubscriber.RetryPolicyProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-retrypolicy

getStartingPosition

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

Where the subscriber starts reading events: LATEST starts from the newest events;

POINT_IN_TIME starts from the point specified in PointInTimeConfiguration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-startingposition

getState

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

The run state of the subscriber.

Events are delivered only while the state is RUNNING. Setting the state to STOPPED pauses delivery. When an update sets a stopped subscriber back to RUNNING, ResumePosition controls where delivery resumes.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-state

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags assigned to the subscriber.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-tags

getTransformer

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

Configuration for transforming events before delivery: the raw payload, the payload with its metadata envelope, or the output of a JSONata expression.

Returns union: either IResolvable or CfnSubscriber.TransformerProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-transformer

getType

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

The delivery ordering mode of the subscriber.

FIFO delivers events in order within an event group; UNORDERED delivers without an ordering guarantee.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-type

builder

@Stability(Stable)
static CfnSubscriberProps.Builder builder()

Returns:

a CfnSubscriberProps.Builder of CfnSubscriberProps