Package software.amazon.awscdk.cfnpropertymixins.services.eventsv2

Interface CfnEventSourceMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEventSourceMixinProps.Jsii$Proxy

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

Properties for CfnEventSourcePropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.eventsv2.*;
 CfnEventSourceMixinProps cfnEventSourceMixinProps = CfnEventSourceMixinProps.builder()
         .configuration(EventSourceConfigurationProperty.builder()
                 .awsServiceEventsConfiguration(AwsServiceEventsConfigurationProperty.builder()
                         .awsService("awsService")
                         .onFailureConfiguration(OnFailureConfigurationProperty.builder()
                                 .arn("arn")
                                 .build())
                         .pattern("pattern")
                         .build())
                 .partnerEventsConfiguration(PartnerEventsConfigurationProperty.builder()
                         .onFailureConfiguration(OnFailureConfigurationProperty.builder()
                                 .arn("arn")
                                 .build())
                         .partnerBusKmsKeyIdentifier("partnerBusKmsKeyIdentifier")
                         .partnerEventSourceArn("partnerEventSourceArn")
                         .pattern("pattern")
                         .build())
                 .build())
         .description("description")
         .eventBusArn("eventBusArn")
         .name("name")
         .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	CfnEventSourceMixinProps.Builder	A builder for CfnEventSourceMixinProps
static final class	CfnEventSourceMixinProps.Jsii$Proxy	An implementation for CfnEventSourceMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnEventSourceMixinProps.Builder	builder()
default Object	getConfiguration()	Event source configuration.
default String	getDescription()	A description of the event source.
default String	getEventBusArn()	The ARN of the custom event bus the event source forwards onto.
default 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)
@Nullable
default Object getConfiguration()

Event source configuration.

Exactly one of the two variants must be set.

Returns union: either IResolvable or CfnEventSourcePropsMixin.EventSourceConfigurationProperty

See Also:

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

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

getEventBusArn

@Stability(Stable)
@Nullable
default 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)
@Nullable
default 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

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 CfnEventSourceMixinProps.Builder builder()

Returns:

a CfnEventSourceMixinProps.Builder of CfnEventSourceMixinProps