Skip to content
v2.274.0

CfnEventSourceProps Struct ​

Properties for defining a CfnEventSource.

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 cfnEventSourceProps: eventsv2.CfnEventSourceProps = {
  configuration: {
    awsServiceEventsConfiguration: {
      awsService: 'awsService',

      // the properties below are optional
      onFailureConfiguration: {
        arn: 'arn',
      },
      pattern: 'pattern',
    },
    partnerEventsConfiguration: {
      partnerEventSourceArn: 'partnerEventSourceArn',

      // the properties below are optional
      onFailureConfiguration: {
        arn: 'arn',
      },
      partnerBusKmsKeyIdentifier: 'partnerBusKmsKeyIdentifier',
      pattern: 'pattern',
    },
  },
  eventBusArn: 'eventBusArn',
  name: 'name',

  // the properties below are optional
  description: 'description',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

configurationIResolvable | CfnEventSource.EventSourceConfigurationPropertyconfigurationtyping.Union[IResolvable, EventSourceConfigurationProperty]configurationIResolvableConfigurationIResolvableConfigurationinterface{}required#
Event source configuration.

Exactly one of the two variants must be set.

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A description of the event source.

Control characters and Unicode line separators are not allowed.

eventBusArnstringevent_bus_arnstreventBusArnStringEventBusArnstringEventBusArn*stringrequired#
The ARN of the custom event bus the event source forwards onto.
namestringnamestrnameStringNamestringName*stringrequired#
The name of the event source.

The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'. Names cannot begin with the reserved aws. prefix.

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
The tags assigned to the event source.