Class CreateEventBusRequest

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.CreateEventBusRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateEventBusRequest.Builder,CreateEventBusRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateEventBusRequest extends EventBridgeRequest implements ToCopyableBuilder<CreateEventBusRequest.Builder,CreateEventBusRequest>

  • Method Details

    • name

      public final String name()

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

    • eventSourceName

      public final String eventSourceName()

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

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

    • description

      public final String description()

      The event bus description.

      Returns:
      The event bus description.

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

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

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      Tags to associate with the event bus.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      Tags to associate with the event bus.

    • toBuilder

      public CreateEventBusRequest.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<CreateEventBusRequest.Builder,CreateEventBusRequest>
      Specified by:
      toBuilder in class EventBridgeRequest
      Returns:
      a builder for type T

    • builder

      public static CreateEventBusRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateEventBusRequest.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.