CfnSubscriberProps
- class aws_cdk.aws_eventsv2.CfnSubscriberProps(*, event_bus_arn, name, batch_configuration=None, description=None, filter_configuration=None, log_configuration=None, on_failure_configuration=None, point_in_time_configuration=None, resume_position=None, retry_policy=None, starting_position=None, state=None, tags=None, transformer=None, type=None)
Bases:
objectProperties for defining a
CfnSubscriber.- Parameters:
event_bus_arn (
str) – The ARN of the event bus this subscriber belongs to.name (
str) – The name of the subscriber. The first character must be alphanumeric; the remaining characters may also include ‘.’, ‘-’, and ‘_’.batch_configuration (
Union[IResolvable,BatchConfigurationProperty,Dict[str,Any],None]) – Configuration for batching events into a single delivery.description (
Optional[str]) – A description of the subscriber. Control characters and Unicode line separators are not allowed.filter_configuration (
Union[IResolvable,FilterConfigurationProperty,Dict[str,Any],None]) – Configuration for filtering which events are delivered to the target. An event must match every filter to be delivered.log_configuration (
Union[IResolvable,LogConfigurationProperty,Dict[str,Any],None]) – Delivery logging configuration.on_failure_configuration (
Union[IResolvable,OnFailureConfigurationProperty,Dict[str,Any],None]) – The destination for events that could not be delivered.point_in_time_configuration (
Union[IResolvable,PointInTimeConfigurationProperty,Dict[str,Any],None]) – The point in time to start delivering events from, used when StartingPosition is POINT_IN_TIME.resume_position (
Optional[str]) – 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.retry_policy (
Union[IResolvable,RetryPolicyProperty,Dict[str,Any],None]) – The retry policy for failed deliveries.starting_position (
Optional[str]) – Where the subscriber starts reading events: LATEST starts from the newest events; POINT_IN_TIME starts from the point specified in PointInTimeConfiguration.state (
Optional[str]) – 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.tags (
Optional[Sequence[Union[CfnTag,Dict[str,Any]]]]) – The tags assigned to the subscriber.transformer (
Union[IResolvable,TransformerProperty,Dict[str,Any],None]) – Configuration for transforming events before delivery: the raw payload, the payload with its metadata envelope, or the output of a JSONata expression.type (
Optional[str]) – The delivery ordering mode of the subscriber. FIFO delivers events in order within an event group; UNORDERED delivers without an ordering guarantee.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html
- ExampleMetadata:
fixture=_generated
Example:
from aws_cdk import CfnTag # The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_eventsv2 as eventsv2 cfn_subscriber_props = eventsv2.CfnSubscriberProps( event_bus_arn="eventBusArn", name="name", # the properties below are optional batch_configuration=eventsv2.CfnSubscriber.BatchConfigurationProperty( max_batch_size=123, max_batch_window_in_seconds=123 ), description="description", filter_configuration=eventsv2.CfnSubscriber.FilterConfigurationProperty( filters=[eventsv2.CfnSubscriber.FilterProperty( pattern="pattern", scope="scope" )], # the properties below are optional language="language" ), log_configuration=eventsv2.CfnSubscriber.LogConfigurationProperty( include_payload="includePayload", level="level" ), on_failure_configuration=eventsv2.CfnSubscriber.OnFailureConfigurationProperty( arn="arn" ), point_in_time_configuration=eventsv2.CfnSubscriber.PointInTimeConfigurationProperty( point_type="pointType", # the properties below are optional end_point=123, starting_point=123 ), resume_position="resumePosition", retry_policy=eventsv2.CfnSubscriber.RetryPolicyProperty( max_event_age_in_seconds=123, max_retry_attempts=123, retry_strategy="retryStrategy" ), starting_position="startingPosition", state="state", tags=[CfnTag( key="key", value="value" )], transformer=eventsv2.CfnSubscriber.TransformerProperty( jsonata_configuration=eventsv2.CfnSubscriber.JsonataConfigurationProperty( expression="expression" ), type="type" ), type="type" )
Attributes
- batch_configuration
Configuration for batching events into a single delivery.
- description
A description of the subscriber.
Control characters and Unicode line separators are not allowed.
- event_bus_arn
The ARN of the event bus this subscriber belongs to.
- filter_configuration
Configuration for filtering which events are delivered to the target.
An event must match every filter to be delivered.
- log_configuration
Delivery logging configuration.
- name
The name of the subscriber.
The first character must be alphanumeric; the remaining characters may also include ‘.’, ‘-’, and ‘_’.
- on_failure_configuration
The destination for events that could not be delivered.
- point_in_time_configuration
The point in time to start delivering events from, used when StartingPosition is POINT_IN_TIME.
- resume_position
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.
- retry_policy
The retry policy for failed deliveries.
- starting_position
LATEST starts from the newest events;
POINT_IN_TIME starts from the point specified in PointInTimeConfiguration.
- See:
- Type:
Where the subscriber starts reading events
- state
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.
- tags
The tags assigned to the subscriber.
- transformer
the raw payload, the payload with its metadata envelope, or the output of a JSONata expression.
- See:
- Type:
Configuration for transforming events before delivery
- type
The delivery ordering mode of the subscriber.
FIFO delivers events in order within an event group; UNORDERED delivers without an ordering guarantee.