QueueBuilder (FsCDK)

QueueBuilder Type

Namespace: FsCDK
Assembly: FsCDK.dll
Base Type: obj

Constructors

Constructor Description

Constructor	Description
`QueueBuilder(name)` Full Usage: `QueueBuilder(name)` Parameters: name : `string` Returns: `QueueBuilder`	name : `string` Returns: `QueueBuilder`


                
                  
                    
                      QueueBuilder(name)

Full Usage: QueueBuilder(name)

Parameters:

name : string

Returns: QueueBuilder

name : string

Returns: QueueBuilder

Instance members

Instance member	Description
`this.Combine` Full Usage: `this.Combine` Parameters: state1 : `QueueConfig` state2 : `QueueConfig` Returns: `QueueConfig`	state1 : `QueueConfig` state2 : `QueueConfig` Returns: `QueueConfig`
`constructId id` Full Usage: `constructId id` Parameters: id : `string` - The construct ID. Returns: `QueueConfig`	Sets the construct ID for the queue. id : `string` The construct ID. Returns: `QueueConfig`
`contentBasedDeduplication enabled` Full Usage: `contentBasedDeduplication enabled` Parameters: enabled : `bool` - Whether content-based deduplication is enabled. Returns: `QueueConfig`	Enables content-based deduplication for FIFO queues. enabled : `bool` Whether content-based deduplication is enabled. Returns: `QueueConfig`
`dataKeyReuse duration` Full Usage: `dataKeyReuse duration` Parameters: duration : `Duration` - The data key reuse duration. Returns: `QueueConfig`	Sets the data key reuse period for SSE. duration : `Duration` The data key reuse duration. Returns: `QueueConfig`
`deadLetterQueue deadLetterQueue` Full Usage: `deadLetterQueue deadLetterQueue` Parameters: deadLetterQueue : `IDeadLetterQueue` - The dead-letter queue configuration. Returns: `QueueConfig`	Configures a dead-letter queue for the queue. deadLetterQueue : `IDeadLetterQueue` The dead-letter queue configuration. Returns: `QueueConfig`
`deduplicationScope scope` Full Usage: `deduplicationScope scope` Parameters: scope : `DeduplicationScope` - The deduplication scope (Queue or MessageGroup). Returns: `QueueConfig`	Sets the deduplication scope for FIFO queues. scope : `DeduplicationScope` The deduplication scope (Queue or MessageGroup). Returns: `QueueConfig`
`this.Delay` Full Usage: `this.Delay` Parameters: f : `unit -> QueueConfig` Returns: `QueueConfig` Modifiers: inline	f : `unit -> QueueConfig` Returns: `QueueConfig`
`deliveryDelay delay` Full Usage: `deliveryDelay delay` Parameters: delay : `Duration` - The delay duration. Returns: `QueueConfig`	Sets the delay for all messages in the queue. delay : `Duration` The delay duration. Returns: `QueueConfig`
`encryption encryption` Full Usage: `encryption encryption` Parameters: encryption : `QueueEncryption` - The encryption type (KMS, KMS_MANAGED, SQS_MANAGED, or UNENCRYPTED). Returns: `QueueConfig`	Sets the encryption type for the queue. encryption : `QueueEncryption` The encryption type (KMS, KMS_MANAGED, SQS_MANAGED, or UNENCRYPTED). Returns: `QueueConfig`
`encryptionMasterKey key` Full Usage: `encryptionMasterKey key` Parameters: key : `IKey` - The KMS key. Returns: `QueueConfig`	Sets the KMS master key for encryption. key : `IKey` The KMS key. Returns: `QueueConfig`
`enforceSSL enforce` Full Usage: `enforceSSL enforce` Parameters: enforce : `bool` - Whether to enforce SSL. Returns: `QueueConfig`	Enforces SSL/TLS for all queue communications. enforce : `bool` Whether to enforce SSL. Returns: `QueueConfig`
`fifo isFifo` Full Usage: `fifo isFifo` Parameters: isFifo : `bool` - Whether the queue is FIFO. Returns: `QueueConfig`	Configures the queue as a FIFO queue. isFifo : `bool` Whether the queue is FIFO. Returns: `QueueConfig`
`fifoThroughputLimit limit` Full Usage: `fifoThroughputLimit limit` Parameters: limit : `FifoThroughputLimit` - The throughput limit (PerQueue or PerMessageGroupId). Returns: `QueueConfig`	Sets the throughput limit for FIFO queues. limit : `FifoThroughputLimit` The throughput limit (PerQueue or PerMessageGroupId). Returns: `QueueConfig`
`this.For` Full Usage: `this.For` Parameters: config : `QueueConfig` f : `unit -> QueueConfig` Returns: `QueueConfig` Modifiers: inline	config : `QueueConfig` f : `unit -> QueueConfig` Returns: `QueueConfig`
`maxMessageSizeBytes bytes` Full Usage: `maxMessageSizeBytes bytes` Parameters: bytes : `float` - The maximum message size in bytes. Returns: `QueueConfig`	Sets the maximum message size in bytes (1,024 to 262,144 bytes). bytes : `float` The maximum message size in bytes. Returns: `QueueConfig`
`receiveMessageWaitTime duration` Full Usage: `receiveMessageWaitTime duration` Parameters: duration : `Duration` - The wait time duration. Returns: `QueueConfig`	Sets the receive message wait time for long polling. duration : `Duration` The wait time duration. Returns: `QueueConfig`
`redriveAllowPolicy policy` Full Usage: `redriveAllowPolicy policy` Parameters: policy : `IRedriveAllowPolicy` - The redrive allow policy. Returns: `QueueConfig`	Sets the redrive allow policy for this queue. policy : `IRedriveAllowPolicy` The redrive allow policy. Returns: `QueueConfig`
`removalPolicy policy` Full Usage: `removalPolicy policy` Parameters: policy : `RemovalPolicy` - The removal policy (DESTROY, RETAIN, SNAPSHOT, or RETAIN_ON_UPDATE_OR_DELETE). Returns: `QueueConfig`	Sets the removal policy for the queue. policy : `RemovalPolicy` The removal policy (DESTROY, RETAIN, SNAPSHOT, or RETAIN_ON_UPDATE_OR_DELETE). Returns: `QueueConfig`
`retentionPeriod seconds` Full Usage: `retentionPeriod seconds` Parameters: seconds : `float` - The retention period in seconds. Returns: `QueueConfig`	Sets the message retention period for the queue. seconds : `float` The retention period in seconds. Returns: `QueueConfig`
`this.Run` Full Usage: `this.Run` Parameters: config : `QueueConfig` Returns: `QueueSpec`	config : `QueueConfig` Returns: `QueueSpec`
`visibilityTimeout seconds` Full Usage: `visibilityTimeout seconds` Parameters: seconds : `float` - The visibility timeout in seconds. Returns: `QueueConfig`	Sets the visibility timeout for messages in the queue. seconds : `float` The visibility timeout in seconds. Returns: `QueueConfig`
`this.Yield` Full Usage: `this.Yield` Parameters: () : `unit` Returns: `QueueConfig`	() : `unit` Returns: `QueueConfig`
`this.Zero` Full Usage: `this.Zero` Returns: `QueueConfig`	Returns: `QueueConfig`