Class: Aws::EventBridge::Types::UpdateEventBusRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-eventbridge/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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:



5690
5691
5692
5693
5694
5695
5696
5697
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 5690

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

#description ⇒ String

The event bus description.

Returns:

  • (String) 


5690
5691
5692
5693
5694
5695
5696
5697
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 5690

class UpdateEventBusRequest < Struct.new(
  :name,
  :kms_key_identifier,
  :description,
  :dead_letter_config)
  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 [Managing keys] in the *Key Management Service Developer Guide*.

<note markdown=“1”> 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][2

in the *Amazon EventBridge User

Guide*.

</note>

[1]: docs.aws.amazon.com/kms/latest/developerguide/getting-started.html [2]: docs.aws.amazon.com/eventbridge/latest/userguide/eb-encryption.html

Returns:

  • (String) 


5690
5691
5692
5693
5694
5695
5696
5697
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 5690

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

#name ⇒ String

The name of the event bus.

Returns:

  • (String) 


5690
5691
5692
5693
5694
5695
5696
5697
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 5690

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