Package software.amazon.awscdk.services.eventsv2

Interface CfnEventSourceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEventSourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)",
           date="2026-09-30T11:04:52.403Z")
@Stability(Stable)
public interface CfnEventSourceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnEventSource.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.eventsv2.*;
 CfnEventSourceProps cfnEventSourceProps = CfnEventSourceProps.builder()
         .configuration(EventSourceConfigurationProperty.builder()
                 .awsServiceEventsConfiguration(AwsServiceEventsConfigurationProperty.builder()
                         .awsService("awsService")
                         // the properties below are optional
                         .onFailureConfiguration(OnFailureConfigurationProperty.builder()
                                 .arn("arn")
                                 .build())
                         .pattern("pattern")
                         .build())
                 .partnerEventsConfiguration(PartnerEventsConfigurationProperty.builder()
                         .partnerEventSourceArn("partnerEventSourceArn")
                         // the properties below are optional
                         .onFailureConfiguration(OnFailureConfigurationProperty.builder()
                                 .arn("arn")
                                 .build())
                         .partnerBusKmsKeyIdentifier("partnerBusKmsKeyIdentifier")
                         .pattern("pattern")
                         .build())
                 .build())
         .eventBusArn("eventBusArn")
         .name("name")
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-eventsource.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEventSourceProps.Builder	A builder for CfnEventSourceProps
static final class	CfnEventSourceProps.Jsii$Proxy	An implementation for CfnEventSourceProps

Method Summary

Modifier and Type	Method	Description
static CfnEventSourceProps.Builder	builder()
Object	getConfiguration()	Event source configuration.
default String	getDescription()	A description of the event source.
String	getEventBusArn()	The ARN of the custom event bus the event source forwards onto.
String	getName()	The name of the event source.
default List<CfnTag>	getTags()	The tags assigned to the event source.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConfiguration

@Stability(Stable)
@NotNull
Object getConfiguration()

Event source configuration.

Exactly one of the two variants must be set.

Returns union: either IResolvable or CfnEventSource.EventSourceConfigurationProperty

See Also:

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

getEventBusArn

@Stability(Stable)
@NotNull
String getEventBusArn()

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

getName

@Stability(Stable)
@NotNull
String getName()

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

builder

@Stability(Stable)
static CfnEventSourceProps.Builder builder()

Returns:

a CfnEventSourceProps.Builder of CfnEventSourceProps