Package software.amazon.awssdk.services.eventbridge.model

Interface UpdateEventBusRequest.Builder

    • Method Detail

      • name

        UpdateEventBusRequest.Builder name​(String name)

        The name of the event bus.

        Parameters:
        name - The name of the event bus.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kmsKeyIdentifier

        UpdateEventBusRequest.Builder kmsKeyIdentifier​(String 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 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.

        Parameters:
        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 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        UpdateEventBusRequest.Builder description​(String description)

        The event bus description.

        Parameters:
        description - The event bus description.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • deadLetterConfig

        UpdateEventBusRequest.Builder deadLetterConfig​(DeadLetterConfig deadLetterConfig)
        Sets the value of the DeadLetterConfig property for this object.
        Parameters:
        deadLetterConfig - The new value for the DeadLetterConfig property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.