Package software.amazon.awscdk.services.eventsv2

Class CfnSubscriber.Builder

java.lang.Object

software.amazon.awscdk.services.eventsv2.CfnSubscriber.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSubscriber>

Enclosing class:

CfnSubscriber

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

A fluent builder for CfnSubscriber.

Method Summary

Modifier and Type	Method	Description
CfnSubscriber.Builder	batchConfiguration(IResolvable batchConfiguration)	Configuration for batching events into a single delivery.
CfnSubscriber.Builder	batchConfiguration(CfnSubscriber.BatchConfigurationProperty batchConfiguration)	Configuration for batching events into a single delivery.
CfnSubscriber	build()
static CfnSubscriber.Builder	create(software.constructs.Construct scope, String id)
CfnSubscriber.Builder	description(String description)	A description of the subscriber.
CfnSubscriber.Builder	eventBusArn(String eventBusArn)	The ARN of the event bus this subscriber belongs to.
CfnSubscriber.Builder	filterConfiguration(IResolvable filterConfiguration)	Configuration for filtering which events are delivered to the target.
CfnSubscriber.Builder	filterConfiguration(CfnSubscriber.FilterConfigurationProperty filterConfiguration)	Configuration for filtering which events are delivered to the target.
CfnSubscriber.Builder	logConfiguration(IResolvable logConfiguration)	Delivery logging configuration.
CfnSubscriber.Builder	logConfiguration(CfnSubscriber.LogConfigurationProperty logConfiguration)	Delivery logging configuration.
CfnSubscriber.Builder	name(String name)	The name of the subscriber.
CfnSubscriber.Builder	onFailureConfiguration(IResolvable onFailureConfiguration)	The destination for events that could not be delivered.
CfnSubscriber.Builder	onFailureConfiguration(CfnSubscriber.OnFailureConfigurationProperty onFailureConfiguration)	The destination for events that could not be delivered.
CfnSubscriber.Builder	pointInTimeConfiguration(IResolvable pointInTimeConfiguration)	The point in time to start delivering events from, used when StartingPosition is POINT_IN_TIME.
CfnSubscriber.Builder	pointInTimeConfiguration(CfnSubscriber.PointInTimeConfigurationProperty pointInTimeConfiguration)	The point in time to start delivering events from, used when StartingPosition is POINT_IN_TIME.
CfnSubscriber.Builder	resumePosition(String resumePosition)	Resume-time control, never returned by the service.
CfnSubscriber.Builder	retryPolicy(IResolvable retryPolicy)	The retry policy for failed deliveries.
CfnSubscriber.Builder	retryPolicy(CfnSubscriber.RetryPolicyProperty retryPolicy)	The retry policy for failed deliveries.
CfnSubscriber.Builder	startingPosition(String startingPosition)	Where the subscriber starts reading events: LATEST starts from the newest events;
CfnSubscriber.Builder	state(String state)	The run state of the subscriber.
CfnSubscriber.Builder	tags(List<? extends CfnTag> tags)	The tags assigned to the subscriber.
CfnSubscriber.Builder	transformer(IResolvable transformer)	Configuration for transforming events before delivery: the raw payload, the payload with its metadata envelope, or the output of a JSONata expression.
CfnSubscriber.Builder	transformer(CfnSubscriber.TransformerProperty transformer)	Configuration for transforming events before delivery: the raw payload, the payload with its metadata envelope, or the output of a JSONata expression.
CfnSubscriber.Builder	type(String type)	The delivery ordering mode of the subscriber.

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 CfnSubscriber.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 CfnSubscriber.Builder.

eventBusArn

@Stability(Stable)
public CfnSubscriber.Builder eventBusArn(String eventBusArn)

The ARN of the event bus this subscriber belongs to.

Parameters:

eventBusArn - The ARN of the event bus this subscriber belongs to. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-eventbusarn

name

@Stability(Stable)
public CfnSubscriber.Builder name(String name)

The name of the subscriber.

The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.

Parameters:

name - The name of the subscriber. This parameter is required.

Returns:

this

See Also:

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

batchConfiguration

@Stability(Stable)
public CfnSubscriber.Builder batchConfiguration(IResolvable batchConfiguration)

Configuration for batching events into a single delivery.

Parameters:

batchConfiguration - Configuration for batching events into a single delivery. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-batchconfiguration

batchConfiguration

@Stability(Stable)
public CfnSubscriber.Builder batchConfiguration(CfnSubscriber.BatchConfigurationProperty batchConfiguration)

Configuration for batching events into a single delivery.

Parameters:

batchConfiguration - Configuration for batching events into a single delivery. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-batchconfiguration

description

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

A description of the subscriber.

Control characters and Unicode line separators are not allowed.

Parameters:

description - A description of the subscriber. This parameter is required.

Returns:

this

See Also:

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

filterConfiguration

@Stability(Stable)
public CfnSubscriber.Builder filterConfiguration(IResolvable filterConfiguration)

Configuration for filtering which events are delivered to the target.

An event must match every filter to be delivered.

Parameters:

filterConfiguration - Configuration for filtering which events are delivered to the target. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-filterconfiguration

filterConfiguration

@Stability(Stable)
public CfnSubscriber.Builder filterConfiguration(CfnSubscriber.FilterConfigurationProperty filterConfiguration)

Configuration for filtering which events are delivered to the target.

An event must match every filter to be delivered.

Parameters:

filterConfiguration - Configuration for filtering which events are delivered to the target. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-filterconfiguration

logConfiguration

@Stability(Stable)
public CfnSubscriber.Builder logConfiguration(IResolvable logConfiguration)

Delivery logging configuration.

Parameters:

logConfiguration - Delivery logging configuration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-logconfiguration

logConfiguration

@Stability(Stable)
public CfnSubscriber.Builder logConfiguration(CfnSubscriber.LogConfigurationProperty logConfiguration)

Delivery logging configuration.

Parameters:

logConfiguration - Delivery logging configuration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-logconfiguration

onFailureConfiguration

@Stability(Stable)
public CfnSubscriber.Builder onFailureConfiguration(IResolvable onFailureConfiguration)

The destination for events that could not be delivered.

Parameters:

onFailureConfiguration - The destination for events that could not be delivered. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-onfailureconfiguration

onFailureConfiguration

@Stability(Stable)
public CfnSubscriber.Builder onFailureConfiguration(CfnSubscriber.OnFailureConfigurationProperty onFailureConfiguration)

The destination for events that could not be delivered.

Parameters:

onFailureConfiguration - The destination for events that could not be delivered. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-onfailureconfiguration

pointInTimeConfiguration

@Stability(Stable)
public CfnSubscriber.Builder pointInTimeConfiguration(IResolvable pointInTimeConfiguration)

The point in time to start delivering events from, used when StartingPosition is POINT_IN_TIME.

Parameters:

pointInTimeConfiguration - The point in time to start delivering events from, used when StartingPosition is POINT_IN_TIME. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-pointintimeconfiguration

pointInTimeConfiguration

@Stability(Stable)
public CfnSubscriber.Builder pointInTimeConfiguration(CfnSubscriber.PointInTimeConfigurationProperty pointInTimeConfiguration)

The point in time to start delivering events from, used when StartingPosition is POINT_IN_TIME.

Parameters:

pointInTimeConfiguration - The point in time to start delivering events from, used when StartingPosition is POINT_IN_TIME. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-pointintimeconfiguration

resumePosition

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

Parameters:

resumePosition - Resume-time control, never returned by the service. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-resumeposition

retryPolicy

@Stability(Stable)
public CfnSubscriber.Builder retryPolicy(IResolvable retryPolicy)

The retry policy for failed deliveries.

Parameters:

retryPolicy - The retry policy for failed deliveries. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-retrypolicy

retryPolicy

@Stability(Stable)
public CfnSubscriber.Builder retryPolicy(CfnSubscriber.RetryPolicyProperty retryPolicy)

The retry policy for failed deliveries.

Parameters:

retryPolicy - The retry policy for failed deliveries. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-retrypolicy

startingPosition

@Stability(Stable)
public CfnSubscriber.Builder startingPosition(String startingPosition)

Where the subscriber starts reading events: LATEST starts from the newest events;

POINT_IN_TIME starts from the point specified in PointInTimeConfiguration.

Parameters:

startingPosition - Where the subscriber starts reading events: LATEST starts from the newest events;. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-startingposition

state

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

Parameters:

state - The run state of the subscriber. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-state

tags

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

The tags assigned to the subscriber.

Parameters:

tags - The tags assigned to the subscriber. This parameter is required.

Returns:

this

See Also:

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

transformer

@Stability(Stable)
public CfnSubscriber.Builder transformer(IResolvable transformer)

Configuration for transforming events before delivery: the raw payload, the payload with its metadata envelope, or the output of a JSONata expression.

Parameters:

transformer - Configuration for transforming events before delivery: the raw payload, the payload with its metadata envelope, or the output of a JSONata expression. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-transformer

transformer

@Stability(Stable)
public CfnSubscriber.Builder transformer(CfnSubscriber.TransformerProperty transformer)

Configuration for transforming events before delivery: the raw payload, the payload with its metadata envelope, or the output of a JSONata expression.

Parameters:

transformer - Configuration for transforming events before delivery: the raw payload, the payload with its metadata envelope, or the output of a JSONata expression. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-transformer

type

@Stability(Stable)
public CfnSubscriber.Builder type(String type)

The delivery ordering mode of the subscriber.

FIFO delivers events in order within an event group; UNORDERED delivers without an ordering guarantee.

Parameters:

type - The delivery ordering mode of the subscriber. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html#cfn-eventsv2-subscriber-type

build

@Stability(Stable)
public CfnSubscriber build()

Specified by:

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

Returns:

a newly built instance of CfnSubscriber.