Create Event Bus

eventbridge_create_event_bus

R Documentation

Creates a new event bus within your account

Description

Creates a new event bus within your account. This can be a custom event bus which you can use to receive events from your custom applications and services, or it can be a partner event bus which can be matched to a partner event source.

Usage

eventbridge_create_event_bus(Name, EventSourceName, Description,
  KmsKeyIdentifier, DeadLetterConfig, Tags)

Arguments

Name

[required] 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.

EventSourceName

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

Description

The event bus description.

KmsKeyIdentifier

The identifier of the 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 Amazon Web Services owned key to encrypt events on the event bus.

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

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

• You call create_archive on an event bus set to use a customer managed key for encryption.

• You call CreateDiscoverer on an event bus set to use a customer managed key for encryption.

• You call UpdatedEventBus 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 Amazon Web Services owned key. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

DeadLetterConfig

Tags

Tags to associate with the event bus.

Value

A list with the following syntax:

list(
  EventBusArn = "string",
  Description = "string",
  KmsKeyIdentifier = "string",
  DeadLetterConfig = list(
    Arn = "string"
  )
)

Request syntax

svc$create_event_bus(
  Name = "string",
  EventSourceName = "string",
  Description = "string",
  KmsKeyIdentifier = "string",
  DeadLetterConfig = list(
    Arn = "string"
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)