Class: Aws::EventBridge::Types::CreateEventBusRequest

Inherits:

Struct

• Object
• Struct
• Aws::EventBridge::Types::CreateEventBusRequest

Includes:

Structure

Defined in:

lib/aws-sdk-eventbridge/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dead_letter_config ⇒ Types::DeadLetterConfig

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

• #description ⇒ String

  The event bus description.

• #event_source_name ⇒ String

  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 ⇒ 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.

• #name ⇒ String

  The name of the new event bus.

• #tags ⇒ Array<Types::Tag>

  Tags to associate with the event bus.

Instance Attribute Details

#dead_letter_config ⇒ Types::DeadLetterConfig

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*.

[1]: docs.aws.amazon.com/eventbridge/latest/userguide/eb-rule-event-delivery.html#eb-rule-dlq

Returns:

• (Types::DeadLetterConfig)

# File 'lib/aws-sdk-eventbridge/types.rb', line 1219

class CreateEventBusRequest < Struct.new(
  :name,
  :event_source_name,
  :description,
  :kms_key_identifier,
  :dead_letter_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The event bus description.

Returns:

• (String)

# File 'lib/aws-sdk-eventbridge/types.rb', line 1219

class CreateEventBusRequest < Struct.new(
  :name,
  :event_source_name,
  :description,
  :kms_key_identifier,
  :dead_letter_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#event_source_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-eventbridge/types.rb', line 1219

class CreateEventBusRequest < Struct.new(
  :name,
  :event_source_name,
  :description,
  :kms_key_identifier,
  :dead_letter_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_identifier ⇒ 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 [Identify and view keys] in the *Key Management Service Developer Guide*.

<note markdown=“1”> Schema 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.

To enable schema discovery on an event bus, choose to use an Amazon

Web Services owned key. For more information, see [Encrypting events] in the *Amazon EventBridge User Guide*.

</note>

If 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][3] in the *Amazon

EventBridge User Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html [2]: docs.aws.amazon.com/eventbridge/latest/userguide/eb-encryption-event-bus-cmkey.html [3]: docs.aws.amazon.com/eventbridge/latest/userguide/encryption-archives.html

Returns:

• (String)

# File 'lib/aws-sdk-eventbridge/types.rb', line 1219

class CreateEventBusRequest < Struct.new(
  :name,
  :event_source_name,
  :description,
  :kms_key_identifier,
  :dead_letter_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-eventbridge/types.rb', line 1219

class CreateEventBusRequest < Struct.new(
  :name,
  :event_source_name,
  :description,
  :kms_key_identifier,
  :dead_letter_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Tags to associate with the event bus.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-eventbridge/types.rb', line 1219

class CreateEventBusRequest < Struct.new(
  :name,
  :event_source_name,
  :description,
  :kms_key_identifier,
  :dead_letter_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end