CfnEventBusProps

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

Bases: object

Properties for defining a CfnEventBus.

Parameters:
  • name (str) – 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.

  • 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.

  • policy (Optional[Any]) – The permissions policy of the event bus, describing which other AWS accounts can write events to this event bus.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Tags to associate with the event bus.

See:

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.
from aws_cdk import aws_events as events

# policy: Any

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

    # the properties below are optional
    event_source_name="eventSourceName",
    policy=policy,
    tags=[CfnTag(
        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.

See:

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

name

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:

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

policy

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

See:

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

tags

Tags to associate with the event bus.

See:

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