Package software.amazon.awscdk.services.events

Interface CfnEventBusProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEventBusProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:17.016Z")
@Stability(Stable)
public interface CfnEventBusProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnEventBus.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.events.*;
 Object policy;
 CfnEventBusProps cfnEventBusProps = CfnEventBusProps.builder()
         .name("name")
         // the properties below are optional
         .deadLetterConfig(DeadLetterConfigProperty.builder()
                 .arn("arn")
                 .build())
         .description("description")
         .eventSourceName("eventSourceName")
         .kmsKeyIdentifier("kmsKeyIdentifier")
         .policy(policy)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEventBusProps.Builder	A builder for CfnEventBusProps
static final class	CfnEventBusProps.Jsii$Proxy	An implementation for CfnEventBusProps

Method Summary

Modifier and Type	Method	Description
static CfnEventBusProps.Builder	builder()
default Object	getDeadLetterConfig()	Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).
default String	getDescription()	The event bus description.
default String	getEventSourceName()	If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
default String	getKmsKeyIdentifier()	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.
String	getName()	The name of the new event bus.
default Object	getPolicy()	The permissions policy of the event bus, describing which other AWS accounts can write events to this event bus.
default List<CfnTag>	getTags()	Tags to associate with the event bus.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-name

getDeadLetterConfig

@Stability(Stable)
@Nullable
default Object getDeadLetterConfig()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-deadletterconfig

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The event bus description.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-description

getEventSourceName

@Stability(Stable)
@Nullable
default String getEventSourceName()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-eventsourcename

getKmsKeyIdentifier

@Stability(Stable)
@Nullable
default String getKmsKeyIdentifier()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-kmskeyidentifier

getPolicy

@Stability(Stable)
@Nullable
default Object getPolicy()

The permissions policy of the event bus, describing which other AWS accounts can write events to this event bus.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-policy

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Tags to associate with the event bus.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-tags

builder

@Stability(Stable)
static CfnEventBusProps.Builder builder()

Returns:

a CfnEventBusProps.Builder of CfnEventBusProps