interface PartnerEventsConfigurationProperty

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

Forward a partner event source's events through a managed partner event bus.

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 partnerEventsConfigurationProperty: eventsv2.CfnEventSource.PartnerEventsConfigurationProperty = {
  partnerEventSourceArn: 'partnerEventSourceArn',

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

Properties

Name	Type	Description
partnerEventSourceArn	`string`	The ARN of the partner event source to forward.
onFailureConfiguration?	`IResolvable` `\|` `OnFailureConfigurationProperty`	The destination for events that could not be forwarded by the managed forwarding target or, for partner event sources, the managed partner event bus.
partnerBusKmsKeyIdentifier?	`string`	The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on the managed partner event bus.
pattern?	`string`	A filter pattern, as a JSON string, that defines which events from the specified partner event source are forwarded to the event bus.

partnerEventSourceArn

Type: string

The ARN of the partner event source to forward.

The partner owns the event source, so the ARN's account segment is empty. Changing this property replaces the event source. Because Name and EventBusArn together identify an event source, and the replacement is created before the old resource is deleted, change Name in the same update.

onFailureConfiguration?

Type: IResolvable | OnFailureConfigurationProperty (optional)

The destination for events that could not be forwarded by the managed forwarding target or, for partner event sources, the managed partner event bus.

Arn is optional. An empty object removes a configured destination on update.

partnerBusKmsKeyIdentifier?

Type: string (optional)

The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on the managed partner event bus.

The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN. If you do not specify a customer managed key identifier, EventBridge uses an AWS owned key to encrypt events on the event bus.

pattern?

Type: string (optional)

A filter pattern, as a JSON string, that defines which events from the specified partner event source are forwarded to the event bus.

If you do not specify a pattern, all events from the partner event source are forwarded.

AWS CDK

2.272.0