Package com.commercetools.api.models.subscription

Interface EventBridgeDestination

All Superinterfaces:

Destination

All Known Implementing Classes:

EventBridgeDestinationImpl

public interface EventBridgeDestination
extends Destination

AWS EventBridge can be used to push events and messages to a serverless event bus that can forward them to AWS SQS, SNS, Lambda, and other AWS services based on forwarding rules. Once the Subscription is created, an equivalent "partner event source" is created in AWS EventBridge. This event source must be associated with an event bus for the Subscription setup to be complete.

Example to create an instance using the builder pattern

     EventBridgeDestination eventBridgeDestination = EventBridgeDestination.builder()
             .region("{region}")
             .accountId("{accountId}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EVENT_BRIDGE	discriminator value for EventBridgeDestination

Method Summary

Modifier and Type	Method	Description
static EventBridgeDestinationBuilder	builder()	builder factory method for EventBridgeDestination
static EventBridgeDestinationBuilder	builder(EventBridgeDestination template)	create builder for EventBridgeDestination instance
static EventBridgeDestination	deepCopy(EventBridgeDestination template)	factory method to create a deep copy of EventBridgeDestination
@NotNull String	getAccountId()	ID of the AWS account that receives the events.
@NotNull String	getRegion()	AWS region that receives the events.
static EventBridgeDestination	of()	factory method
static EventBridgeDestination	of(EventBridgeDestination template)	factory method to create a shallow copy EventBridgeDestination
void	setAccountId(String accountId)	ID of the AWS account that receives the events.
void	setRegion(String region)	AWS region that receives the events.
static com.fasterxml.jackson.core.type.TypeReference<EventBridgeDestination>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withEventBridgeDestination(Function<EventBridgeDestination,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.subscription.Destination

getType, withDestination

Field Details

EVENT_BRIDGE

static final String EVENT_BRIDGE

discriminator value for EventBridgeDestination

See Also:

• Constant Field Values

Method Details

getRegion

@NotNull
@NotNull String getRegion()

AWS region that receives the events.

Returns:

region

getAccountId

@NotNull
@NotNull String getAccountId()

ID of the AWS account that receives the events.

Returns:

accountId

setRegion

void setRegion(String region)

AWS region that receives the events.

Parameters:

region - value to be set

setAccountId

void setAccountId(String accountId)

ID of the AWS account that receives the events.

Parameters:

accountId - value to be set

of

static EventBridgeDestination of()

factory method

Returns:

instance of EventBridgeDestination

of

static EventBridgeDestination of(EventBridgeDestination template)

factory method to create a shallow copy EventBridgeDestination

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static EventBridgeDestination deepCopy(@Nullable
 EventBridgeDestination template)

factory method to create a deep copy of EventBridgeDestination

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static EventBridgeDestinationBuilder builder()

builder factory method for EventBridgeDestination

Returns:

builder

builder

static EventBridgeDestinationBuilder builder(EventBridgeDestination template)

create builder for EventBridgeDestination instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withEventBridgeDestination

default <T> T withEventBridgeDestination(Function<EventBridgeDestination,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<EventBridgeDestination> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference