Class CfnSubscriberProps.Builder
java.lang.Object
software.amazon.awscdk.services.eventsv2.CfnSubscriberProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnSubscriberProps>
- Enclosing interface:
CfnSubscriberProps
@Stability(Stable)
public static final class CfnSubscriberProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnSubscriberProps>
A builder for
CfnSubscriberProps-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbatchConfiguration(IResolvable batchConfiguration) Sets the value ofCfnSubscriberProps.getBatchConfiguration()batchConfiguration(CfnSubscriber.BatchConfigurationProperty batchConfiguration) Sets the value ofCfnSubscriberProps.getBatchConfiguration()build()Builds the configured instance.description(String description) Sets the value ofCfnSubscriberProps.getDescription()eventBusArn(String eventBusArn) Sets the value ofCfnSubscriberProps.getEventBusArn()filterConfiguration(IResolvable filterConfiguration) Sets the value ofCfnSubscriberProps.getFilterConfiguration()filterConfiguration(CfnSubscriber.FilterConfigurationProperty filterConfiguration) Sets the value ofCfnSubscriberProps.getFilterConfiguration()logConfiguration(IResolvable logConfiguration) Sets the value ofCfnSubscriberProps.getLogConfiguration()logConfiguration(CfnSubscriber.LogConfigurationProperty logConfiguration) Sets the value ofCfnSubscriberProps.getLogConfiguration()Sets the value ofCfnSubscriberProps.getName()onFailureConfiguration(IResolvable onFailureConfiguration) Sets the value ofCfnSubscriberProps.getOnFailureConfiguration()onFailureConfiguration(CfnSubscriber.OnFailureConfigurationProperty onFailureConfiguration) Sets the value ofCfnSubscriberProps.getOnFailureConfiguration()pointInTimeConfiguration(IResolvable pointInTimeConfiguration) Sets the value ofCfnSubscriberProps.getPointInTimeConfiguration()pointInTimeConfiguration(CfnSubscriber.PointInTimeConfigurationProperty pointInTimeConfiguration) Sets the value ofCfnSubscriberProps.getPointInTimeConfiguration()resumePosition(String resumePosition) Sets the value ofCfnSubscriberProps.getResumePosition()retryPolicy(IResolvable retryPolicy) Sets the value ofCfnSubscriberProps.getRetryPolicy()retryPolicy(CfnSubscriber.RetryPolicyProperty retryPolicy) Sets the value ofCfnSubscriberProps.getRetryPolicy()startingPosition(String startingPosition) Sets the value ofCfnSubscriberProps.getStartingPosition()Sets the value ofCfnSubscriberProps.getState()Sets the value ofCfnSubscriberProps.getTags()transformer(IResolvable transformer) Sets the value ofCfnSubscriberProps.getTransformer()transformer(CfnSubscriber.TransformerProperty transformer) Sets the value ofCfnSubscriberProps.getTransformer()Sets the value ofCfnSubscriberProps.getType()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
eventBusArn
Sets the value ofCfnSubscriberProps.getEventBusArn()- Parameters:
eventBusArn- The ARN of the event bus this subscriber belongs to. This parameter is required.- Returns:
this
-
name
Sets the value ofCfnSubscriberProps.getName()- Parameters:
name- The name of the subscriber. This parameter is required. The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.- Returns:
this
-
batchConfiguration
@Stability(Stable) public CfnSubscriberProps.Builder batchConfiguration(IResolvable batchConfiguration) Sets the value ofCfnSubscriberProps.getBatchConfiguration()- Parameters:
batchConfiguration- Configuration for batching events into a single delivery.- Returns:
this
-
batchConfiguration
@Stability(Stable) public CfnSubscriberProps.Builder batchConfiguration(CfnSubscriber.BatchConfigurationProperty batchConfiguration) Sets the value ofCfnSubscriberProps.getBatchConfiguration()- Parameters:
batchConfiguration- Configuration for batching events into a single delivery.- Returns:
this
-
description
Sets the value ofCfnSubscriberProps.getDescription()- Parameters:
description- A description of the subscriber. Control characters and Unicode line separators are not allowed.- Returns:
this
-
filterConfiguration
@Stability(Stable) public CfnSubscriberProps.Builder filterConfiguration(IResolvable filterConfiguration) Sets the value ofCfnSubscriberProps.getFilterConfiguration()- Parameters:
filterConfiguration- Configuration for filtering which events are delivered to the target. An event must match every filter to be delivered.- Returns:
this
-
filterConfiguration
@Stability(Stable) public CfnSubscriberProps.Builder filterConfiguration(CfnSubscriber.FilterConfigurationProperty filterConfiguration) Sets the value ofCfnSubscriberProps.getFilterConfiguration()- Parameters:
filterConfiguration- Configuration for filtering which events are delivered to the target. An event must match every filter to be delivered.- Returns:
this
-
logConfiguration
Sets the value ofCfnSubscriberProps.getLogConfiguration()- Parameters:
logConfiguration- Delivery logging configuration.- Returns:
this
-
logConfiguration
@Stability(Stable) public CfnSubscriberProps.Builder logConfiguration(CfnSubscriber.LogConfigurationProperty logConfiguration) Sets the value ofCfnSubscriberProps.getLogConfiguration()- Parameters:
logConfiguration- Delivery logging configuration.- Returns:
this
-
onFailureConfiguration
@Stability(Stable) public CfnSubscriberProps.Builder onFailureConfiguration(IResolvable onFailureConfiguration) Sets the value ofCfnSubscriberProps.getOnFailureConfiguration()- Parameters:
onFailureConfiguration- The destination for events that could not be delivered.- Returns:
this
-
onFailureConfiguration
@Stability(Stable) public CfnSubscriberProps.Builder onFailureConfiguration(CfnSubscriber.OnFailureConfigurationProperty onFailureConfiguration) Sets the value ofCfnSubscriberProps.getOnFailureConfiguration()- Parameters:
onFailureConfiguration- The destination for events that could not be delivered.- Returns:
this
-
pointInTimeConfiguration
@Stability(Stable) public CfnSubscriberProps.Builder pointInTimeConfiguration(IResolvable pointInTimeConfiguration) Sets the value ofCfnSubscriberProps.getPointInTimeConfiguration()- Parameters:
pointInTimeConfiguration- The point in time to start delivering events from, used when StartingPosition is POINT_IN_TIME.- Returns:
this
-
pointInTimeConfiguration
@Stability(Stable) public CfnSubscriberProps.Builder pointInTimeConfiguration(CfnSubscriber.PointInTimeConfigurationProperty pointInTimeConfiguration) Sets the value ofCfnSubscriberProps.getPointInTimeConfiguration()- Parameters:
pointInTimeConfiguration- The point in time to start delivering events from, used when StartingPosition is POINT_IN_TIME.- Returns:
this
-
resumePosition
Sets the value ofCfnSubscriberProps.getResumePosition()- Parameters:
resumePosition- Resume-time control, never returned by the service. Applied only when an update transitions State from STOPPED to RUNNING: LAST_PROCESSED (default) resumes from the last processed event, LATEST skips to the newest. Ignored on create and on any update that does not perform that transition.- Returns:
this
-
retryPolicy
Sets the value ofCfnSubscriberProps.getRetryPolicy()- Parameters:
retryPolicy- The retry policy for failed deliveries.- Returns:
this
-
retryPolicy
@Stability(Stable) public CfnSubscriberProps.Builder retryPolicy(CfnSubscriber.RetryPolicyProperty retryPolicy) Sets the value ofCfnSubscriberProps.getRetryPolicy()- Parameters:
retryPolicy- The retry policy for failed deliveries.- Returns:
this
-
startingPosition
Sets the value ofCfnSubscriberProps.getStartingPosition()- Parameters:
startingPosition- Where the subscriber starts reading events: LATEST starts from the newest events;. POINT_IN_TIME starts from the point specified in PointInTimeConfiguration.- Returns:
this
-
state
Sets the value ofCfnSubscriberProps.getState()- Parameters:
state- The run state of the subscriber. Events are delivered only while the state is RUNNING. Setting the state to STOPPED pauses delivery. When an update sets a stopped subscriber back to RUNNING, ResumePosition controls where delivery resumes.- Returns:
this
-
tags
Sets the value ofCfnSubscriberProps.getTags()- Parameters:
tags- The tags assigned to the subscriber.- Returns:
this
-
transformer
Sets the value ofCfnSubscriberProps.getTransformer()- Parameters:
transformer- Configuration for transforming events before delivery: the raw payload, the payload with its metadata envelope, or the output of a JSONata expression.- Returns:
this
-
transformer
@Stability(Stable) public CfnSubscriberProps.Builder transformer(CfnSubscriber.TransformerProperty transformer) Sets the value ofCfnSubscriberProps.getTransformer()- Parameters:
transformer- Configuration for transforming events before delivery: the raw payload, the payload with its metadata envelope, or the output of a JSONata expression.- Returns:
this
-
type
Sets the value ofCfnSubscriberProps.getType()- Parameters:
type- The delivery ordering mode of the subscriber. FIFO delivers events in order within an event group; UNORDERED delivers without an ordering guarantee.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnSubscriberProps>- Returns:
- a new instance of
CfnSubscriberProps - Throws:
NullPointerException- if any required attribute was not provided
-