CfnEventBusProps

class aws_cdk.aws_events.CfnEventBusProps(*, name, dead_letter_config=None, description=None, event_source_name=None, kms_key_identifier=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.
dead_letter_config (Union[IResolvable, DeadLetterConfigProperty, Dict[str, Any], None]) – Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ). For more information, see Using dead-letter queues to process undelivered events in the EventBridge User Guide .
description (Optional[str]) – The event bus description.
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.
kms_key_identifier (Optional[str]) – The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN. If you do not specify a customer managed key identifier, EventBridge uses an AWS owned key to encrypt events on the event bus. For more information, see Managing keys in the AWS Key Management Service Developer Guide . .. epigraph:: Archives and schema discovery are not supported for event buses encrypted using a customer managed key. EventBridge returns an error if: - You call [CreateArchive](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateArchive.html) on an event bus set to use a customer managed key for encryption. - You call [CreateDiscoverer](https://docs.aws.amazon.com/eventbridge/latest/schema-reference/v1-discoverers.html#CreateDiscoverer) on an event bus set to use a customer managed key for encryption. - You call [UpdatedEventBus](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UpdatedEventBus.html) to set a customer managed key on an event bus with an archives or schema discovery enabled. To enable archives or schema discovery on an event bus, choose to use an AWS owned key . For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide .
policy (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
    dead_letter_config=events.CfnEventBus.DeadLetterConfigProperty(
        arn="arn"
    ),
    description="description",
    event_source_name="eventSourceName",
    kms_key_identifier="kmsKeyIdentifier",
    policy=policy,
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

dead_letter_config

Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).

For more information, see Using dead-letter queues to process undelivered events in the EventBridge User Guide .

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

description

The event bus description.

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

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

kms_key_identifier

The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus.

The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

If you do not specify a customer managed key identifier, EventBridge uses an AWS owned key to encrypt events on the event bus.

For more information, see Managing keys in the AWS Key Management Service Developer Guide . .. epigraph:

Archives and schema discovery are not supported for event buses encrypted using a customer managed key. EventBridge returns an error if:

- You call ``[CreateArchive](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateArchive.html)`` on an event bus set to use a customer managed key for encryption.
- You call ``[CreateDiscoverer](https://docs.aws.amazon.com/eventbridge/latest/schema-reference/v1-discoverers.html#CreateDiscoverer)`` on an event bus set to use a customer managed key for encryption.
- You call ``[UpdatedEventBus](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UpdatedEventBus.html)`` to set a customer managed key on an event bus with an archives or schema discovery enabled.

To enable archives or schema discovery on an event bus, choose to use an AWS owned key . For more information, see `Data encryption in EventBridge <https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-encryption.html>`_ in the *Amazon EventBridge User Guide* .

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

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