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

Class UpdateEventBusRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.eventbridge.model.EventBridgeRequest
software.amazon.awssdk.services.eventbridge.model.UpdateEventBusRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateEventBusRequest.Builder,UpdateEventBusRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateEventBusRequest extends EventBridgeRequest implements ToCopyableBuilder<UpdateEventBusRequest.Builder,UpdateEventBusRequest>

  • Method Details

    • name

      public final String name()

      The name of the event bus.

      Returns:
      The name of the event bus.

    • kmsKeyIdentifier

      public final 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 Identify and view keys in the Key Management Service Developer Guide.

      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.

      • 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 Amazon Web Services owned key. For more information, see Encrypting events in the Amazon EventBridge User Guide.

      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 in the Amazon EventBridge User Guide.

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

      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.

      • 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 Amazon Web Services owned key. For more information, see Encrypting events in the Amazon EventBridge User Guide.

      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 in the Amazon EventBridge User Guide.

    • description

      public final String description()

      The event bus description.

      Returns:
      The event bus description.

    • deadLetterConfig

      public final DeadLetterConfig deadLetterConfig()
      Returns the value of the DeadLetterConfig property for this object.
      Returns:
      The value of the DeadLetterConfig property for this object.

    • logConfig

      public final LogConfig logConfig()

      The logging configuration settings for the event bus.

      For more information, see Configuring logs for event buses in the EventBridge User Guide.

      Returns:
      The logging configuration settings for the event bus.

      For more information, see Configuring logs for event buses in the EventBridge User Guide.

    • toBuilder

      public UpdateEventBusRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateEventBusRequest.Builder,UpdateEventBusRequest>
      Specified by:
      toBuilder in class EventBridgeRequest

    • builder

      public static UpdateEventBusRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateEventBusRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo