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.
Request Syntax{
"DeadLetterConfig": {
"Arn": "string
"
},
"Description": "string
",
"EventSourceName": "string
",
"KmsKeyIdentifier": "string
",
"LogConfig": {
"IncludeDetail": "string
",
"Level": "string
"
},
"Name": "string
",
"Tags": [
{
"Key": "string
",
"Value": "string
"
}
]
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
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.
Type: DeadLetterConfig object
Required: No
The event bus description.
Type: String
Length Constraints: Maximum length of 512.
Required: No
If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: aws\.partner(/[\.\-_A-Za-z0-9]+){2,}
Required: No
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 Identify and view keys in the AWS Key Management Service Developer Guide.
NoteSchema discovery is not supported for event buses encrypted using a customer managed key. EventBridge returns an error if:
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 schema discovery enabled.
To enable schema discovery on an event bus, choose to use an AWS owned key. For more information, see Encrypting events in the Amazon EventBridge User Guide.
ImportantIf you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.
For more information, see Encrypting archives in the Amazon EventBridge User Guide.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: ^[a-zA-Z0-9_\-/:]*$
Required: No
The logging configuration settings for the event bus.
For more information, see Configuring logs for event buses in the EventBridge User Guide.
Type: LogConfig object
Required: No
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [/\.\-_A-Za-z0-9]+
Required: Yes
Tags to associate with the event bus.
Type: Array of Tag objects
Required: No
{
"DeadLetterConfig": {
"Arn": "string"
},
"Description": "string",
"EventBusArn": "string",
"KmsKeyIdentifier": "string",
"LogConfig": {
"IncludeDetail": "string",
"Level": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
ErrorsFor information about the errors that are common to all actions, see Common Errors.
There is concurrent modification on a rule, target, archive, or replay.
HTTP Status Code: 400
This exception occurs due to unexpected causes.
HTTP Status Code: 500
The specified state is not a valid state for an event source.
HTTP Status Code: 400
The request failed because it attempted to create resource beyond the allowed service quota.
HTTP Status Code: 400
The operation you are attempting is not available in this region.
HTTP Status Code: 400
The resource you are trying to create already exists.
HTTP Status Code: 400
An entity that you specified does not exist.
HTTP Status Code: 400
For more information about using this API in one of the language-specific AWS SDKs, see the following:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4