CfnEventBusProps¶

class aws_cdk.aws_events.CfnEventBusProps(*, name, event_source_name=None, tags=None)¶

Bases: object

Properties for defining a CfnEventBus.

Parameters

name (str) – The name of the new event bus. Event bus names cannot contain the / character. 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. If this is a partner event bus, the name must exactly match the name of the partner event source that this event bus is matched to.
event_source_name (Optional[str]) – If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
tags (Optional[Sequence[Union[TagEntryProperty, Dict[str, Any]]]]) – Tags to associate with the event bus.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_events as events

cfn_event_bus_props = events.CfnEventBusProps(
    name="name",

    # the properties below are optional
    event_source_name="eventSourceName",
    tags=[events.CfnEventBus.TagEntryProperty(
        key="key",
        value="value"
    )]
)

Attributes

event_source_name¶

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-eventsourcename
Return type: Optional[str]

name¶

The name of the new event bus.

Event bus names cannot contain the / character. 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.

If this is a partner event bus, the name must exactly match the name of the partner event source that this event bus is matched to.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-name
Return type: str

tags¶

Tags to associate with the event bus.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-tags
Return type: Optional[List[TagEntryProperty]]