Header menu logo FsCDK

SqsSubscriptionBuilder Type

Constructors

Constructor Description

SqsSubscriptionBuilder()

Full Usage: SqsSubscriptionBuilder()

Returns: SqsSubscriptionBuilder
Returns: SqsSubscriptionBuilder

Instance members

Instance member Description

this.Combine

Full Usage: this.Combine

Parameters:
Returns: SqsSubscriptionConfig
state1 : SqsSubscriptionConfig
state2 : SqsSubscriptionConfig
Returns: SqsSubscriptionConfig

deadLetterQueue q

Full Usage: deadLetterQueue q

Parameters:
    q : IQueue - The SQS queue to use as DLQ.

Returns: SqsSubscriptionConfig

Sets a dead-letter queue for failed messages.

q : IQueue

The SQS queue to use as DLQ.

Returns: SqsSubscriptionConfig

this.Delay

Full Usage: this.Delay

Parameters:
Returns: SqsSubscriptionConfig
Modifiers: inline
f : unit -> SqsSubscriptionConfig
Returns: SqsSubscriptionConfig

filterPolicy policy

Full Usage: filterPolicy policy

Parameters:
Returns: SqsSubscriptionConfig

Sets a filter policy for the subscription.

policy : IDictionary<string, SubscriptionFilter>

The filter policy dictionary.

Returns: SqsSubscriptionConfig

filterPolicyWithMessageBody policy

Full Usage: filterPolicyWithMessageBody policy

Parameters:
Returns: SqsSubscriptionConfig

Sets a filter policy with message body for the subscription.

policy : IDictionary<string, FilterOrPolicy>

The filter policy with message body dictionary.

Returns: SqsSubscriptionConfig

this.For

Full Usage: this.For

Parameters:
Returns: SqsSubscriptionConfig
Modifiers: inline
config : SqsSubscriptionConfig
f : unit -> SqsSubscriptionConfig
Returns: SqsSubscriptionConfig

queue q

Full Usage: queue q

Parameters:
    q : IQueue - The SQS queue to subscribe.

Returns: SqsSubscriptionConfig

Sets the SQS queue for the subscription.

q : IQueue

The SQS queue to subscribe.

Returns: SqsSubscriptionConfig

rawMessageDelivery enabled

Full Usage: rawMessageDelivery enabled

Parameters:
    enabled : bool - Whether to enable raw message delivery.

Returns: SqsSubscriptionConfig

Enables raw message delivery (without SNS metadata).

enabled : bool

Whether to enable raw message delivery.

Returns: SqsSubscriptionConfig

this.Run

Full Usage: this.Run

Parameters:
Returns: ITopicSubscription
config : SqsSubscriptionConfig
Returns: ITopicSubscription

this.Yield

Full Usage: this.Yield

Parameters:
    () : unit

Returns: SqsSubscriptionConfig
() : unit
Returns: SqsSubscriptionConfig

this.Zero

Full Usage: this.Zero

Returns: SqsSubscriptionConfig
Returns: SqsSubscriptionConfig

Type something to start searching.