Class CfnQueueProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnQueueProps>
- Enclosing interface:
CfnQueueProps
CfnQueueProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.contentBasedDeduplication
(Boolean contentBasedDeduplication) Sets the value ofCfnQueueProps.getContentBasedDeduplication()
contentBasedDeduplication
(IResolvable contentBasedDeduplication) Sets the value ofCfnQueueProps.getContentBasedDeduplication()
deduplicationScope
(String deduplicationScope) Sets the value ofCfnQueueProps.getDeduplicationScope()
delaySeconds
(Number delaySeconds) Sets the value ofCfnQueueProps.getDelaySeconds()
Sets the value ofCfnQueueProps.getFifoQueue()
fifoQueue
(IResolvable fifoQueue) Sets the value ofCfnQueueProps.getFifoQueue()
fifoThroughputLimit
(String fifoThroughputLimit) Sets the value ofCfnQueueProps.getFifoThroughputLimit()
kmsDataKeyReusePeriodSeconds
(Number kmsDataKeyReusePeriodSeconds) Sets the value ofCfnQueueProps.getKmsDataKeyReusePeriodSeconds()
kmsMasterKeyId
(String kmsMasterKeyId) Sets the value ofCfnQueueProps.getKmsMasterKeyId()
maximumMessageSize
(Number maximumMessageSize) Sets the value ofCfnQueueProps.getMaximumMessageSize()
messageRetentionPeriod
(Number messageRetentionPeriod) Sets the value ofCfnQueueProps.getMessageRetentionPeriod()
Sets the value ofCfnQueueProps.getQueueName()
receiveMessageWaitTimeSeconds
(Number receiveMessageWaitTimeSeconds) Sets the value ofCfnQueueProps.getReceiveMessageWaitTimeSeconds()
redriveAllowPolicy
(Object redriveAllowPolicy) Sets the value ofCfnQueueProps.getRedriveAllowPolicy()
redrivePolicy
(Object redrivePolicy) Sets the value ofCfnQueueProps.getRedrivePolicy()
sqsManagedSseEnabled
(Boolean sqsManagedSseEnabled) Sets the value ofCfnQueueProps.getSqsManagedSseEnabled()
sqsManagedSseEnabled
(IResolvable sqsManagedSseEnabled) Sets the value ofCfnQueueProps.getSqsManagedSseEnabled()
Sets the value ofCfnQueueProps.getTags()
visibilityTimeout
(Number visibilityTimeout) Sets the value ofCfnQueueProps.getVisibilityTimeout()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
contentBasedDeduplication
@Stability(Stable) public CfnQueueProps.Builder contentBasedDeduplication(Boolean contentBasedDeduplication) Sets the value ofCfnQueueProps.getContentBasedDeduplication()
- Parameters:
contentBasedDeduplication
- For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, Amazon SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see theContentBasedDeduplication
attribute for the[CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html)
action in the Amazon SQS API Reference .- Returns:
this
-
contentBasedDeduplication
@Stability(Stable) public CfnQueueProps.Builder contentBasedDeduplication(IResolvable contentBasedDeduplication) Sets the value ofCfnQueueProps.getContentBasedDeduplication()
- Parameters:
contentBasedDeduplication
- For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, Amazon SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see theContentBasedDeduplication
attribute for the[CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html)
action in the Amazon SQS API Reference .- Returns:
this
-
deduplicationScope
Sets the value ofCfnQueueProps.getDeduplicationScope()
- Parameters:
deduplicationScope
- For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. Valid values aremessageGroup
andqueue
.To enable high throughput for a FIFO queue, set this attribute to
messageGroup
and set theFifoThroughputLimit
attribute toperMessageGroupId
. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see High throughput for FIFO queues and Quotas related to messages in the Amazon SQS Developer Guide .- Returns:
this
-
delaySeconds
Sets the value ofCfnQueueProps.getDelaySeconds()
- Parameters:
delaySeconds
- The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of0
to900
(15 minutes). The default value is0
.- Returns:
this
-
fifoQueue
Sets the value ofCfnQueueProps.getFifoQueue()
- Parameters:
fifoQueue
- If set to true, creates a FIFO queue. If you don't specify this property, Amazon SQS creates a standard queue. For more information, see FIFO queues in the Amazon SQS Developer Guide .- Returns:
this
-
fifoQueue
Sets the value ofCfnQueueProps.getFifoQueue()
- Parameters:
fifoQueue
- If set to true, creates a FIFO queue. If you don't specify this property, Amazon SQS creates a standard queue. For more information, see FIFO queues in the Amazon SQS Developer Guide .- Returns:
this
-
fifoThroughputLimit
Sets the value ofCfnQueueProps.getFifoThroughputLimit()
- Parameters:
fifoThroughputLimit
- For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values areperQueue
andperMessageGroupId
.To enable high throughput for a FIFO queue, set this attribute to
perMessageGroupId
and set theDeduplicationScope
attribute tomessageGroup
. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see High throughput for FIFO queues and Quotas related to messages in the Amazon SQS Developer Guide .- Returns:
this
-
kmsDataKeyReusePeriodSeconds
@Stability(Stable) public CfnQueueProps.Builder kmsDataKeyReusePeriodSeconds(Number kmsDataKeyReusePeriodSeconds) Sets the value ofCfnQueueProps.getKmsDataKeyReusePeriodSeconds()
- Parameters:
kmsDataKeyReusePeriodSeconds
- The length of time in seconds for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes).A shorter time period provides better security, but results in more calls to AWS KMS , which might incur charges after Free Tier. For more information, see Encryption at rest in the Amazon SQS Developer Guide .
- Returns:
this
-
kmsMasterKeyId
Sets the value ofCfnQueueProps.getKmsMasterKeyId()
- Parameters:
kmsMasterKeyId
- The ID of an AWS Key Management Service (KMS) for Amazon SQS , or a custom KMS. To use the AWS managed KMS for Amazon SQS , specify a (default) alias ARN, alias name (e.g.alias/aws/sqs
), key ARN, or key ID. For more information, see the following:- Encryption at rest in the Amazon SQS Developer Guide
- CreateQueue in the Amazon SQS API Reference
- Request Parameters in the AWS Key Management Service API Reference
- The Key Management Service (KMS) section of the AWS Key Management Service Best Practices whitepaper
- Returns:
this
-
maximumMessageSize
Sets the value ofCfnQueueProps.getMaximumMessageSize()
- Parameters:
maximumMessageSize
- The limit of how many bytes that a message can contain before Amazon SQS rejects it. You can specify an integer value from1,024
bytes (1 KiB) to262,144
bytes (256 KiB). The default value is262,144
(256 KiB).- Returns:
this
-
messageRetentionPeriod
@Stability(Stable) public CfnQueueProps.Builder messageRetentionPeriod(Number messageRetentionPeriod) Sets the value ofCfnQueueProps.getMessageRetentionPeriod()
- Parameters:
messageRetentionPeriod
- The number of seconds that Amazon SQS retains a message. You can specify an integer value from60
seconds (1 minute) to1,209,600
seconds (14 days). The default value is345,600
seconds (4 days).- Returns:
this
-
queueName
Sets the value ofCfnQueueProps.getQueueName()
- Parameters:
queueName
- A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the.fifo
suffix. For more information, see FIFO queues in the Amazon SQS Developer Guide .If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the queue name. For more information, see Name type in the AWS CloudFormation User Guide .
If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
- Returns:
this
-
receiveMessageWaitTimeSeconds
@Stability(Stable) public CfnQueueProps.Builder receiveMessageWaitTimeSeconds(Number receiveMessageWaitTimeSeconds) Sets the value ofCfnQueueProps.getReceiveMessageWaitTimeSeconds()
- Parameters:
receiveMessageWaitTimeSeconds
- Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see Consuming messages using long polling in the Amazon SQS Developer Guide .- Returns:
this
-
redriveAllowPolicy
Sets the value ofCfnQueueProps.getRedriveAllowPolicy()
- Parameters:
redriveAllowPolicy
- The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:redrivePermission
: The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:allowAll
: (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue.denyAll
: No source queues can specify this queue as the dead-letter queue.byQueue
: Only queues specified by thesourceQueueArns
parameter can specify this queue as the dead-letter queue.sourceQueueArns
: The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when theredrivePermission
parameter is set tobyQueue
. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set theredrivePermission
parameter toallowAll
.
- Returns:
this
-
redrivePolicy
Sets the value ofCfnQueueProps.getRedrivePolicy()
- Parameters:
redrivePolicy
- The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows:deadLetterTargetArn
: The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value ofmaxReceiveCount
is exceeded.maxReceiveCount
: The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When theReceiveCount
for a message exceeds themaxReceiveCount
for a queue, Amazon SQS moves the message to the dead-letter-queue.
The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
JSON
{ "deadLetterTargetArn" : *String* , "maxReceiveCount" : *Integer* }
YAML
deadLetterTargetArn : *String*
maxReceiveCount : *Integer*
- Returns:
this
-
sqsManagedSseEnabled
Sets the value ofCfnQueueProps.getSqsManagedSseEnabled()
-
sqsManagedSseEnabled
@Stability(Stable) public CfnQueueProps.Builder sqsManagedSseEnabled(IResolvable sqsManagedSseEnabled) Sets the value ofCfnQueueProps.getSqsManagedSseEnabled()
-
tags
Sets the value ofCfnQueueProps.getTags()
- Parameters:
tags
- The tags that you attach to this queue. For more information, see Resource tag in the AWS CloudFormation User Guide .- Returns:
this
-
visibilityTimeout
Sets the value ofCfnQueueProps.getVisibilityTimeout()
- Parameters:
visibilityTimeout
- The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue.Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds.
For more information about Amazon SQS queue visibility timeouts, see Visibility timeout in the Amazon SQS Developer Guide .
- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnQueueProps>
- Returns:
- a new instance of
CfnQueueProps
- Throws:
NullPointerException
- if any required attribute was not provided
-