Package software.amazon.awscdk.services.eventsv2

Interface CfnEventBusProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEventBusProps.Jsii$Proxy

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

Properties for defining a CfnEventBus.

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.*;
 CfnEventBusProps cfnEventBusProps = CfnEventBusProps.builder()
         .name("name")
         // the properties below are optional
         .description("description")
         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                 .kmsKeyIdentifier("kmsKeyIdentifier")
                 .build())
         .storageConfiguration(StorageConfigurationProperty.builder()
                 .retentionPeriodInDays(123)
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnEventBusProps.Builder	builder()
default String	getDescription()	A description of the event bus.
default Object	getEncryptionConfiguration()	Encryption configuration for an event bus.
String	getName()	The name of the event bus.
default Object	getStorageConfiguration()	Storage (retention) configuration for the event bus.
default List<CfnTag>	getTags()	The tags assigned to the event bus.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the event bus.

The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.

See Also:

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

getDescription

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

A description of the event bus.

Control characters and Unicode line separators are not allowed.

See Also:

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

getEncryptionConfiguration

@Stability(Stable)
@Nullable
default Object getEncryptionConfiguration()

Encryption configuration for an event bus.

Returns union: either IResolvable or CfnEventBus.EncryptionConfigurationProperty

See Also:

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

getStorageConfiguration

@Stability(Stable)
@Nullable
default Object getStorageConfiguration()

Storage (retention) configuration for the event bus.

Returns union: either IResolvable or CfnEventBus.StorageConfigurationProperty

See Also:

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

getTags

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

The tags assigned to the event bus.

See Also:

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

builder

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

Returns:

a CfnEventBusProps.Builder of CfnEventBusProps