interface CfnSubscriberProps

Language	Type name
.NET	Amazon.CDK.AWS.EventsV2.CfnSubscriberProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awseventsv2#CfnSubscriberProps
Java	software.amazon.awscdk.services.eventsv2.CfnSubscriberProps
Python	aws_cdk.aws_eventsv2.CfnSubscriberProps
TypeScript	aws-cdk-lib » aws_eventsv2 » CfnSubscriberProps

Properties for defining a CfnSubscriber.

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

Example

// 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

Name	Type	Description
eventBusArn	string	The ARN of the event bus this subscriber belongs to.
name	string	The name of the subscriber.
batchConfiguration?	IResolvable | BatchConfigurationProperty	Configuration for batching events into a single delivery.
description?	string	A description of the subscriber.
filterConfiguration?	IResolvable | FilterConfigurationProperty	Configuration for filtering which events are delivered to the target.
logConfiguration?	IResolvable | LogConfigurationProperty	Delivery logging configuration.
onFailureConfiguration?	IResolvable | OnFailureConfigurationProperty	The destination for events that could not be delivered.
pointInTimeConfiguration?	IResolvable | PointInTimeConfigurationProperty	The point in time to start delivering events from, used when StartingPosition is POINT_IN_TIME.
resumePosition?	string	Resume-time control, never returned by the service.
retryPolicy?	IResolvable | RetryPolicyProperty	The retry policy for failed deliveries.
startingPosition?	string	Where the subscriber starts reading events: LATEST starts from the newest events;
state?	string	The run state of the subscriber.
tags?	CfnTag[]	The tags assigned to the subscriber.
transformer?	IResolvable | TransformerProperty	Configuration for transforming events before delivery: the raw payload, the payload with its metadata envelope, or the output of a JSONata expression.
type?	string	The delivery ordering mode of the subscriber.

---

eventBusArn

Type: string

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

---

name

Type: string

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

---

batchConfiguration?

Type: IResolvable | BatchConfigurationProperty (optional)

Configuration for batching events into a single delivery.

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

---

description?

Type: string (optional)

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

---

filterConfiguration?

Type: IResolvable | FilterConfigurationProperty (optional)

Configuration for filtering which events are delivered to the target.

An event must match every filter to be delivered.

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

---

logConfiguration?

Type: IResolvable | LogConfigurationProperty (optional)

Delivery logging configuration.

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

---

onFailureConfiguration?

Type: IResolvable | OnFailureConfigurationProperty (optional)

The destination for events that could not be delivered.

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

---

pointInTimeConfiguration?

Type: IResolvable | PointInTimeConfigurationProperty (optional)

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

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

---

resumePosition?

Type: string (optional)

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

---

retryPolicy?

Type: IResolvable | RetryPolicyProperty (optional)

The retry policy for failed deliveries.

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

---

startingPosition?

Type: string (optional)

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

---

state?

Type: string (optional)

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

---

tags?

Type: CfnTag[] (optional)

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

---

transformer?

Type: IResolvable | TransformerProperty (optional)

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

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

---

type?

Type: string (optional)

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