Header menu logo FsCDK

EmailSubscriptionBuilder Type

Constructors

Constructor Description

EmailSubscriptionBuilder()

Full Usage: EmailSubscriptionBuilder()

Returns: EmailSubscriptionBuilder
Returns: EmailSubscriptionBuilder

Instance members

Instance member Description

this.Combine

Full Usage: this.Combine

Parameters:
Returns: EmailSubscriptionConfig
state1 : EmailSubscriptionConfig
state2 : EmailSubscriptionConfig
Returns: EmailSubscriptionConfig

deadLetterQueue queue

Full Usage: deadLetterQueue queue

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

Returns: EmailSubscriptionConfig

Sets a dead-letter queue for failed messages.

queue : IQueue

The SQS queue to use as DLQ.

Returns: EmailSubscriptionConfig

this.Delay

Full Usage: this.Delay

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

email address

Full Usage: email address

Parameters:
    address : string - The email address to subscribe.

Returns: EmailSubscriptionConfig

Sets the email address for the subscription.

address : string

The email address to subscribe.

Returns: EmailSubscriptionConfig

filterPolicy policy

Full Usage: filterPolicy policy

Parameters:
Returns: EmailSubscriptionConfig

Sets a filter policy for the subscription.

policy : IDictionary<string, SubscriptionFilter>

The filter policy dictionary.

Returns: EmailSubscriptionConfig

filterPolicyWithMessageBody policy

Full Usage: filterPolicyWithMessageBody policy

Parameters:
Returns: EmailSubscriptionConfig

Sets a filter policy with message body for the subscription.

policy : IDictionary<string, FilterOrPolicy>

The filter policy with message body dictionary.

Returns: EmailSubscriptionConfig

this.For

Full Usage: this.For

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

json enabled

Full Usage: json enabled

Parameters:
    enabled : bool - Whether to send JSON format.

Returns: EmailSubscriptionConfig

Sends the full notification JSON to the email address.

enabled : bool

Whether to send JSON format.

Returns: EmailSubscriptionConfig

this.Run

Full Usage: this.Run

Parameters:
Returns: ITopicSubscription
config : EmailSubscriptionConfig
Returns: ITopicSubscription

this.Yield

Full Usage: this.Yield

Parameters:
    () : unit

Returns: EmailSubscriptionConfig
() : unit
Returns: EmailSubscriptionConfig

this.Zero

Full Usage: this.Zero

Returns: EmailSubscriptionConfig
Returns: EmailSubscriptionConfig

Type something to start searching.