CfnSubscriberProps Struct
Properties for defining a CfnSubscriber.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_eventsv2 as eventsv2 } from 'aws-cdk-lib';
const cfnSubscriberProps: eventsv2.CfnSubscriberProps = {
eventBusArn: 'eventBusArn',
name: 'name',
// the properties below are optional
batchConfiguration: {
maxBatchSize: 123,
maxBatchWindowInSeconds: 123,
},
description: 'description',
filterConfiguration: {
filters: [{
pattern: 'pattern',
scope: 'scope',
}],
// the properties below are optional
language: 'language',
},
logConfiguration: {
includePayload: 'includePayload',
level: 'level',
},
onFailureConfiguration: {
arn: 'arn',
},
pointInTimeConfiguration: {
pointType: 'pointType',
// the properties below are optional
endPoint: 123,
startingPoint: 123,
},
resumePosition: 'resumePosition',
retryPolicy: {
maxEventAgeInSeconds: 123,
maxRetryAttempts: 123,
retryStrategy: 'retryStrategy',
},
startingPosition: 'startingPosition',
state: 'state',
tags: [{
key: 'key',
value: 'value',
}],
transformer: {
jsonataConfiguration: {
expression: 'expression',
},
type: 'type',
},
type: 'type',
};
Properties
batchConfigurationIResolvable | CfnSubscriber.BatchConfigurationPropertybatch_configurationtyping.Union[IResolvable, BatchConfigurationProperty]batchConfigurationIResolvableBatchConfigurationIResolvableBatchConfigurationinterface{}#Configuration for batching events into a single delivery.
A description of the subscriber.
Control characters and Unicode line separators are not allowed.
The ARN of the event bus this subscriber belongs to.
filterConfigurationIResolvable | CfnSubscriber.FilterConfigurationPropertyfilter_configurationtyping.Union[IResolvable, FilterConfigurationProperty]filterConfigurationIResolvableFilterConfigurationIResolvableFilterConfigurationinterface{}#Configuration for filtering which events are delivered to the target.
An event must match every filter to be delivered.
logConfigurationIResolvable | CfnSubscriber.LogConfigurationPropertylog_configurationtyping.Union[IResolvable, LogConfigurationProperty]logConfigurationIResolvableLogConfigurationIResolvableLogConfigurationinterface{}#Delivery logging configuration.
The name of the subscriber.
The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.
onFailureConfigurationIResolvable | CfnSubscriber.OnFailureConfigurationPropertyon_failure_configurationtyping.Union[IResolvable, OnFailureConfigurationProperty]onFailureConfigurationIResolvableOnFailureConfigurationIResolvableOnFailureConfigurationinterface{}#The destination for events that could not be delivered.
pointInTimeConfigurationIResolvable | CfnSubscriber.PointInTimeConfigurationPropertypoint_in_time_configurationtyping.Union[IResolvable, PointInTimeConfigurationProperty]pointInTimeConfigurationIResolvablePointInTimeConfigurationIResolvablePointInTimeConfigurationinterface{}#The point in time to start delivering events from, used when StartingPosition is POINT_IN_TIME.
resumePositionstringresume_positionstrresumePositionStringResumePositionstringResumePosition*string#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.
retryPolicyIResolvable | CfnSubscriber.RetryPolicyPropertyretry_policytyping.Union[IResolvable, RetryPolicyProperty]retryPolicyIResolvableRetryPolicyIResolvableRetryPolicyinterface{}#The retry policy for failed deliveries.
startingPositionstringstarting_positionstrstartingPositionStringStartingPositionstringStartingPosition*string#Where the subscriber starts reading events: LATEST starts from the newest events;
POINT_IN_TIME starts from the point specified in PointInTimeConfiguration.
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.
The tags assigned to the subscriber.
transformerIResolvable | CfnSubscriber.TransformerPropertytransformertyping.Union[IResolvable, TransformerProperty]transformerIResolvableTransformerIResolvableTransformerinterface{}#Configuration for transforming events before delivery: the raw payload, the payload with its metadata envelope, or the output of a JSONata expression.
The delivery ordering mode of the subscriber.
FIFO delivers events in order within an event group; UNORDERED delivers without an ordering guarantee.