Package software.amazon.awscdk.services.events

Class CfnEventBus.Builder

java.lang.Object

software.amazon.awscdk.services.events.CfnEventBus.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEventBus>

Enclosing class:

CfnEventBus

@Stability(Stable)
public static final class CfnEventBus.Builder
extends Object
implements software.amazon.jsii.Builder<CfnEventBus>

A fluent builder for CfnEventBus.

Method Summary

Modifier and Type	Method	Description
CfnEventBus	build()
static CfnEventBus.Builder	create(software.constructs.Construct scope, String id)
CfnEventBus.Builder	deadLetterConfig(IResolvable deadLetterConfig)	Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).
CfnEventBus.Builder	deadLetterConfig(CfnEventBus.DeadLetterConfigProperty deadLetterConfig)	Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).
CfnEventBus.Builder	description(String description)	The event bus description.
CfnEventBus.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.
CfnEventBus.Builder	kmsKeyIdentifier(String 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.
CfnEventBus.Builder	name(String name)	The name of the new event bus.
CfnEventBus.Builder	policy(Object policy)	The permissions policy of the event bus, describing which other AWS accounts can write events to this event bus.
CfnEventBus.Builder	tags(List<? extends CfnTag> tags)	Tags to associate with the event bus.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnEventBus.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnEventBus.Builder.

name

@Stability(Stable)
public CfnEventBus.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. This parameter is required.

Returns:

this

See Also:

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

deadLetterConfig

@Stability(Stable)
public CfnEventBus.Builder deadLetterConfig(IResolvable 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 .

Parameters:

deadLetterConfig - Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ). This parameter is required.

Returns:

this

See Also:

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

deadLetterConfig

@Stability(Stable)
public CfnEventBus.Builder deadLetterConfig(CfnEventBus.DeadLetterConfigProperty 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 .

Parameters:

deadLetterConfig - Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ). This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnEventBus.Builder description(String description)

The event bus description.

Parameters:

description - The event bus description. This parameter is required.

Returns:

this

See Also:

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

eventSourceName

@Stability(Stable)
public CfnEventBus.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. This parameter is required.

Returns:

this

See Also:

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

kmsKeyIdentifier

@Stability(Stable)
public CfnEventBus.Builder kmsKeyIdentifier(String 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 .

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. This parameter is required.

Returns:

this

See Also:

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

policy

@Stability(Stable)
public CfnEventBus.Builder policy(Object policy)

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

Parameters:

policy - The permissions policy of the event bus, describing which other AWS accounts can write events to this event bus. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnEventBus.Builder tags(List<? extends CfnTag> tags)

Tags to associate with the event bus.

Parameters:

tags - Tags to associate with the event bus. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnEventBus build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnEventBus>

Returns:

a newly built instance of CfnEventBus.