Interface CreateEventBusRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateEventBusRequest.Builder,CreateEventBusRequest>, EventBridgeRequest.Builder, SdkBuilder<CreateEventBusRequest.Builder,CreateEventBusRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateEventBusRequest
@Mutable @NotThreadSafe public static interface CreateEventBusRequest.Builder extends EventBridgeRequest.Builder, SdkPojo, CopyableBuilder<CreateEventBusRequest.Builder,CreateEventBusRequest>

  • Method Details

    • name

      CreateEventBusRequest.Builder name(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • eventSourceName

      CreateEventBusRequest.Builder eventSourceName(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • description

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

    • kmsKeyIdentifier

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

      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 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:
      Returns a reference to this object so that method calls can be chained together.

    • deadLetterConfig

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

    • deadLetterConfig

      default CreateEventBusRequest.Builder deadLetterConfig(Consumer<DeadLetterConfig.Builder> deadLetterConfig)
      Sets the value of the DeadLetterConfig property for this object. This is a convenience method that creates an instance of the DeadLetterConfig.Builder avoiding the need to create one manually via DeadLetterConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deadLetterConfig(DeadLetterConfig).

      Parameters:
      deadLetterConfig - a consumer that will call methods on DeadLetterConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • logConfig

      CreateEventBusRequest.Builder logConfig(LogConfig logConfig)

      The logging configuration settings for the event bus.

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

      Parameters:
      logConfig - The logging configuration settings for the event bus.

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

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

    • logConfig

      default CreateEventBusRequest.Builder logConfig(Consumer<LogConfig.Builder> logConfig)

      The logging configuration settings for the event bus.

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

      This is a convenience method that creates an instance of the LogConfig.Builder avoiding the need to create one manually via LogConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to logConfig(LogConfig).

      Parameters:
      logConfig - a consumer that will call methods on LogConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      CreateEventBusRequest.Builder tags(Collection<Tag> tags)

      Tags to associate with the event bus.

      Parameters:
      tags - Tags to associate with the event bus.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateEventBusRequest.Builder tags(Tag... tags)

      Tags to associate with the event bus.

      Parameters:
      tags - Tags to associate with the event bus.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateEventBusRequest.Builder tags(Consumer<Tag.Builder>... tags)

      Tags to associate with the event bus.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateEventBusRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateEventBusRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.