Update Event Bus
eventbridge_update_event_bus | R Documentation |
Updates the specified event bus¶
Description¶
Updates the specified event bus.
Usage¶
Arguments¶
Name
The name of the event bus.
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.
Description
The event bus description.
DeadLetterConfig
Value¶
A list with the following syntax:
list(
Arn = "string",
Name = "string",
KmsKeyIdentifier = "string",
Description = "string",
DeadLetterConfig = list(
Arn = "string"
)
)
Request syntax¶
svc$update_event_bus(
Name = "string",
KmsKeyIdentifier = "string",
Description = "string",
DeadLetterConfig = list(
Arn = "string"
)
)