EventBridge / Client / create_event_bus

create_event_bus#

EventBridge.Client.create_event_bus(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.create_event_bus(
    Name='string',
    EventSourceName='string',
    Description='string',
    KmsKeyIdentifier='string',
    DeadLetterConfig={
        'Arn': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • Name (string) –

    [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 (string) – If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.

  • Description (string) – The event bus description.

  • KmsKeyIdentifier (string) –

    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.

    Note

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

    • You call CreateArchive 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 (dict) –

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

    For more information, see Event retry policy and using dead-letter queues in the EventBridge User Guide.

    • Arn (string) –

      The ARN of the SQS queue specified as the target for the dead-letter queue.

  • Tags (list) –

    Tags to associate with the event bus.

    • (dict) –

      A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses support tagging.

      • Key (string) – [REQUIRED]

        A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.

      • Value (string) – [REQUIRED]

        The value for the specified tag key.

Return type:

dict

Returns:

Response Syntax

{
    'EventBusArn': 'string',
    'Description': 'string',
    'KmsKeyIdentifier': 'string',
    'DeadLetterConfig': {
        'Arn': 'string'
    }
}

Response Structure

  • (dict) –

    • EventBusArn (string) –

      The ARN of the new event bus.

    • Description (string) –

      The event bus description.

    • KmsKeyIdentifier (string) –

      The identifier of the KMS customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified.

      For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

    • DeadLetterConfig (dict) –

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

      For more information, see Event retry policy and using dead-letter queues in the EventBridge User Guide.

      • Arn (string) –

        The ARN of the SQS queue specified as the target for the dead-letter queue.

Exceptions