interface CfnEventSourceProps

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

Properties for defining a CfnEventSource.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-eventsource.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 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

Name	Type	Description
configuration	IResolvable | EventSourceConfigurationProperty	Event source configuration.
eventBusArn	string	The ARN of the custom event bus the event source forwards onto.
name	string	The name of the event source.
description?	string	A description of the event source.
tags?	CfnTag[]	The tags assigned to the event source.

---

configuration

Type: IResolvable | EventSourceConfigurationProperty

Event source configuration.

Exactly one of the two variants must be set.

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

---

eventBusArn

Type: string

The ARN of the custom event bus the event source forwards onto.

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

---

name

Type: string

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.

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

---

description?

Type: string (optional)

A description of the event source.

Control characters and Unicode line separators are not allowed.

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

---

tags?

Type: CfnTag[] (optional)

The tags assigned to the event source.

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