Package software.amazon.awscdk.services.events

Class CfnEventBusProps.Builder

java.lang.Object
software.amazon.awscdk.services.events.CfnEventBusProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnEventBusProps>
Enclosing interface:
CfnEventBusProps
@Stability(Stable) public static final class CfnEventBusProps.Builder extends Object implements software.amazon.jsii.Builder<CfnEventBusProps>
A builder for CfnEventBusProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • name

      @Stability(Stable) public CfnEventBusProps.Builder name(String name)
      Sets the value of CfnEventBusProps.getName()
      Parameters:
      name - The name of the new event bus. This parameter is required. 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:
      this

    • deadLetterConfig

      @Stability(Stable) public CfnEventBusProps.Builder deadLetterConfig(IResolvable deadLetterConfig)
      Sets the value of CfnEventBusProps.getDeadLetterConfig()
      Parameters:
      deadLetterConfig - Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ). For more information, see Using dead-letter queues to process undelivered events in the EventBridge User Guide .
      Returns:
      this

    • deadLetterConfig

      @Stability(Stable) public CfnEventBusProps.Builder deadLetterConfig(CfnEventBus.DeadLetterConfigProperty deadLetterConfig)
      Sets the value of CfnEventBusProps.getDeadLetterConfig()
      Parameters:
      deadLetterConfig - Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ). For more information, see Using dead-letter queues to process undelivered events in the EventBridge User Guide .
      Returns:
      this

    • description

      @Stability(Stable) public CfnEventBusProps.Builder description(String description)
      Sets the value of CfnEventBusProps.getDescription()
      Parameters:
      description - The event bus description.
      Returns:
      this

    • eventSourceName

      @Stability(Stable) public CfnEventBusProps.Builder eventSourceName(String eventSourceName)
      Sets the value of CfnEventBusProps.getEventSourceName()
      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:
      this

    • kmsKeyIdentifier

      @Stability(Stable) public CfnEventBusProps.Builder kmsKeyIdentifier(String kmsKeyIdentifier)
      Sets the value of CfnEventBusProps.getKmsKeyIdentifier()
      Parameters:
      kmsKeyIdentifier - The identifier of the AWS 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 AWS owned key to encrypt events on the event bus.

      For more information, see Managing keys in the AWS 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](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateArchive.html) on an event bus set to use a customer managed key for encryption.
      • You call [CreateDiscoverer](https://docs.aws.amazon.com/eventbridge/latest/schema-reference/v1-discoverers.html#CreateDiscoverer) on an event bus set to use a customer managed key for encryption.
      • You call [UpdatedEventBus](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UpdatedEventBus.html) 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 AWS owned key . For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide .

      Returns:
      this

    • policy

      @Stability(Stable) public CfnEventBusProps.Builder policy(Object policy)
      Sets the value of CfnEventBusProps.getPolicy()
      Parameters:
      policy - The permissions policy of the event bus, describing which other AWS accounts can write events to this event bus.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnEventBusProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnEventBusProps.getTags()
      Parameters:
      tags - Tags to associate with the event bus.
      Returns:
      this

    • build

      @Stability(Stable) public CfnEventBusProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnEventBusProps>
      Returns:
      a new instance of CfnEventBusProps
      Throws:
      NullPointerException - if any required attribute was not provided