Header menu logo FsCDK

TopicBuilder Type

Constructors

Constructor Description

TopicBuilder(name)

Full Usage: TopicBuilder(name)

Parameters:
    name : string

Returns: TopicBuilder
name : string
Returns: TopicBuilder

Instance members

Instance member Description

this.Combine

Full Usage: this.Combine

Parameters:
Returns: TopicConfig
state1 : TopicConfig
state2 : TopicConfig
Returns: TopicConfig

constructId id

Full Usage: constructId id

Parameters:
    id : string - The construct ID.

Returns: TopicConfig

Sets the construct ID for the topic.

id : string

The construct ID.

Returns: TopicConfig

contentBasedDeduplication enabled

Full Usage: contentBasedDeduplication enabled

Parameters:
    enabled : bool - Whether content-based deduplication is enabled.

Returns: TopicConfig

Enables content-based deduplication for FIFO topics.

enabled : bool

Whether content-based deduplication is enabled.

Returns: TopicConfig

this.Delay

Full Usage: this.Delay

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

displayName displayName

Full Usage: displayName displayName

Parameters:
    displayName : string - The display name shown in email notifications.

Returns: TopicConfig

Sets the display name for the topic.

displayName : string

The display name shown in email notifications.

Returns: TopicConfig

enforceSSL enforce

Full Usage: enforceSSL enforce

Parameters:
    enforce : bool - Whether to enforce SSL.

Returns: TopicConfig

Enforces SSL/TLS for all topic communications.

enforce : bool

Whether to enforce SSL.

Returns: TopicConfig

fifo isFifo

Full Usage: fifo isFifo

Parameters:
    isFifo : bool - Whether the topic is FIFO.

Returns: TopicConfig

Configures the topic as a FIFO topic.

isFifo : bool

Whether the topic is FIFO.

Returns: TopicConfig

fifoThroughputScope scope

Full Usage: fifoThroughputScope scope

Parameters:
Returns: TopicConfig

Sets the throughput scope for FIFO topics.

scope : FifoThroughputScope

The FIFO throughput scope (PerTopic or PerMessageGroupId).

Returns: TopicConfig

this.For

Full Usage: this.For

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

loggingConfigs loggingConfigs

Full Usage: loggingConfigs loggingConfigs

Parameters:
    loggingConfigs : ILoggingConfig list - List of logging configurations.

Returns: TopicConfig

Configures logging for the topic.

loggingConfigs : ILoggingConfig list

List of logging configurations.

Returns: TopicConfig

masterKey key

Full Usage: masterKey key

Parameters:
    key : IKey - The KMS key to use for encryption.

Returns: TopicConfig

Sets the KMS master key for topic encryption.

key : IKey

The KMS key to use for encryption.

Returns: TopicConfig

messageRetentionPeriodInDays days

Full Usage: messageRetentionPeriodInDays days

Parameters:
    days : float - Number of days to retain messages.

Returns: TopicConfig

Sets the message retention period in days.

days : float

Number of days to retain messages.

Returns: TopicConfig

this.Run

Full Usage: this.Run

Parameters:
Returns: TopicSpec
config : TopicConfig
Returns: TopicSpec

signatureVersion version

Full Usage: signatureVersion version

Parameters:
    version : string - The signature version (e.g., "1" or "2").

Returns: TopicConfig

Sets the signature version for message signing.

version : string

The signature version (e.g., "1" or "2").

Returns: TopicConfig

subscription subscription

Full Usage: subscription subscription

Parameters:
Returns: TopicConfig

Adds a subscription to the topic.

subscription : ITopicSubscription

The subscription to add.

Returns: TopicConfig

subscriptions subscriptions

Full Usage: subscriptions subscriptions

Parameters:
Returns: TopicConfig

Adds multiple subscriptions to the topic.

subscriptions : ITopicSubscription list

The subscriptions to add.

Returns: TopicConfig

tracingConfig tracingConfig

Full Usage: tracingConfig tracingConfig

Parameters:
    tracingConfig : TracingConfig - The tracing configuration (Active or PassThrough).

Returns: TopicConfig

Enables tracing configuration for the topic.

tracingConfig : TracingConfig

The tracing configuration (Active or PassThrough).

Returns: TopicConfig

this.Yield

Full Usage: this.Yield

Parameters:
Returns: TopicConfig

Yields a subscription to be added to the topic (implicit yield).

subscription : ITopicSubscription

The subscription to add.

Returns: TopicConfig

this.Yield

Full Usage: this.Yield

Parameters:
    () : unit

Returns: TopicConfig
() : unit
Returns: TopicConfig

this.Zero

Full Usage: this.Zero

Returns: TopicConfig
Returns: TopicConfig

Type something to start searching.