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

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

    • toBuilder

      public UpdateEventBusRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateEventBusRequest.Builder,UpdateEventBusRequest>
      Specified by:
      toBuilder in class EventBridgeRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.