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

Interface CreateEventBusRequest.Builder

    • Method Detail

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

        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.

        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.

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

        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:
        #tags(java.util.Collection)