Package software.amazon.awscdk.cfnpropertymixins.services.eventsv2

Class CfnSubscriberPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.eventsv2.CfnSubscriberPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)",
           date="2026-09-30T11:05:09.966Z")
@Stability(Stable)
public class CfnSubscriberPropsMixin
extends Mixin
implements software.constructs.IMixin

Resource type definition for AWS::EventsV2::Subscriber, an Amazon EventBridge subscription that delivers events from an event bus to a target.

Canonical identity is the combination of bus, name, and target. Replacement uses delete_then_create.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.eventsv2.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnSubscriberPropsMixin cfnSubscriberPropsMixin = CfnSubscriberPropsMixin.Builder.create(CfnSubscriberMixinProps.builder()
         .batchConfiguration(BatchConfigurationProperty.builder()
                 .maxBatchSize(123)
                 .maxBatchWindowInSeconds(123)
                 .build())
         .description("description")
         .eventBusArn("eventBusArn")
         .filterConfiguration(FilterConfigurationProperty.builder()
                 .filters(List.of(FilterProperty.builder()
                         .pattern("pattern")
                         .scope("scope")
                         .build()))
                 .language("language")
                 .build())
         .logConfiguration(LogConfigurationProperty.builder()
                 .includePayload("includePayload")
                 .level("level")
                 .build())
         .name("name")
         .onFailureConfiguration(OnFailureConfigurationProperty.builder()
                 .arn("arn")
                 .build())
         .pointInTimeConfiguration(PointInTimeConfigurationProperty.builder()
                 .endPoint(123)
                 .pointType("pointType")
                 .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())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnSubscriberPropsMixin.BatchConfigurationProperty	Configuration for batching events into a single delivery.
static final class	CfnSubscriberPropsMixin.Builder	A fluent builder for CfnSubscriberPropsMixin.
static interface	CfnSubscriberPropsMixin.FilterConfigurationProperty	Configuration for filtering which events are delivered to the target.
static interface	CfnSubscriberPropsMixin.FilterProperty	A single filter entry: an event pattern and the scope of the event it is evaluated against.
static interface	CfnSubscriberPropsMixin.JsonataConfigurationProperty	JSONata transform settings.
static interface	CfnSubscriberPropsMixin.LogConfigurationProperty	Delivery logging configuration.
static interface	CfnSubscriberPropsMixin.OnFailureConfigurationProperty	The destination for events that could not be delivered.
static interface	CfnSubscriberPropsMixin.PointInTimeConfigurationProperty	The point in time to start delivering events from, used when StartingPosition is POINT_IN_TIME.
static interface	CfnSubscriberPropsMixin.RetryPolicyProperty	The retry policy for failed deliveries.
static interface	CfnSubscriberPropsMixin.TransformerProperty	Configuration for transforming events before delivery: the raw payload, the payload with its metadata envelope, or the output of a JSONata expression.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnSubscriberPropsMixin(CfnSubscriberMixinProps props)	Create a mixin to apply properties to AWS::EventsV2::Subscriber.
	CfnSubscriberPropsMixin(CfnSubscriberMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::EventsV2::Subscriber.
protected	CfnSubscriberPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSubscriberPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnSubscriberMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnSubscriberPropsMixin

protected CfnSubscriberPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnSubscriberPropsMixin

protected CfnSubscriberPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnSubscriberPropsMixin

@Stability(Stable)
public CfnSubscriberPropsMixin(@NotNull
 CfnSubscriberMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::EventsV2::Subscriber.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnSubscriberPropsMixin

@Stability(Stable)
public CfnSubscriberPropsMixin(@NotNull
 CfnSubscriberMixinProps props)

Create a mixin to apply properties to AWS::EventsV2::Subscriber.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnSubscriberMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()