Package software.amazon.awscdk.services.events

Interface CfnEventBusProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEventBusProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.93.0 (build 1706ca5)",
           date="2024-01-03T18:29:26.749Z")
@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.events.*;
 Object policy;
 CfnEventBusProps cfnEventBusProps = CfnEventBusProps.builder()
         .name("name")
         // the properties below are optional
         .eventSourceName("eventSourceName")
         .policy(policy)
         .tags(List.of(TagEntryProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-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	getEventSourceName()	If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
String	getName()	The name of the new event bus.
default Object	getPolicy()	The permissions policy of the event bus, describing which other AWS accounts can write events to this event bus.
default List<CfnEventBus.TagEntryProperty>	getTags()	Tags to associate with 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 new event bus.

Custom event bus names can't contain the / character, but you can use the / character in partner event bus names. In addition, for partner event buses, the name must exactly match the name of the partner event source that this event bus is matched to.

You can't use the name default for a custom event bus, as this name is already used for your account's default event bus.

See Also:

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

getEventSourceName

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

If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.

See Also:

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

getPolicy

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

The permissions policy of the event bus, describing which other AWS accounts can write events to this event bus.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnEventBus.TagEntryProperty> getTags()

Tags to associate with the event bus.

See Also:

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

builder

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

Returns:

a CfnEventBusProps.Builder of CfnEventBusProps