1173 lines
90 KiB
C
1173 lines
90 KiB
C
|
/**
|
|||
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|||
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|||
|
|
*/
|
|||
|
|
|
|||
|
|
#pragma once
|
|||
|
|
#include <aws/sqs/SQS_EXPORTS.h>
|
|||
|
|
#include <aws/sqs/SQSRequest.h>
|
|||
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|||
|
|
#include <aws/core/utils/memory/stl/AWSMap.h>
|
|||
|
|
#include <aws/sqs/model/QueueAttributeName.h>
|
|||
|
|
#include <utility>
|
|||
|
|
|
|||
|
|
namespace Aws
|
|||
|
|
{
|
|||
|
|
namespace SQS
|
|||
|
|
{
|
|||
|
|
namespace Model
|
|||
|
|
{
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p/><p><h3>See Also:</h3> <a
|
|||
|
|
* href="http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SetQueueAttributesRequest">AWS
|
|||
|
|
* API Reference</a></p>
|
|||
|
|
*/
|
|||
|
|
class AWS_SQS_API SetQueueAttributesRequest : public SQSRequest
|
|||
|
|
{
|
|||
|
|
public:
|
|||
|
|
SetQueueAttributesRequest();
|
|||
|
|
|
|||
|
|
// Service request name is the Operation name which will send this request out,
|
|||
|
|
// each operation should has unique request name, so that we can get operation's name from this request.
|
|||
|
|
// Note: this is not true for response, multiple operations may have the same response name,
|
|||
|
|
// so we can not get operation's name from response.
|
|||
|
|
inline virtual const char* GetServiceRequestName() const override { return "SetQueueAttributes"; }
|
|||
|
|
|
|||
|
|
Aws::String SerializePayload() const override;
|
|||
|
|
|
|||
|
|
protected:
|
|||
|
|
void DumpBodyToUrl(Aws::Http::URI& uri ) const override;
|
|||
|
|
|
|||
|
|
public:
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The URL of the Amazon SQS queue whose attributes are set.</p> <p>Queue URLs
|
|||
|
|
* and names are case-sensitive.</p>
|
|||
|
|
*/
|
|||
|
|
inline const Aws::String& GetQueueUrl() const{ return m_queueUrl; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The URL of the Amazon SQS queue whose attributes are set.</p> <p>Queue URLs
|
|||
|
|
* and names are case-sensitive.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool QueueUrlHasBeenSet() const { return m_queueUrlHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The URL of the Amazon SQS queue whose attributes are set.</p> <p>Queue URLs
|
|||
|
|
* and names are case-sensitive.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetQueueUrl(const Aws::String& value) { m_queueUrlHasBeenSet = true; m_queueUrl = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The URL of the Amazon SQS queue whose attributes are set.</p> <p>Queue URLs
|
|||
|
|
* and names are case-sensitive.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetQueueUrl(Aws::String&& value) { m_queueUrlHasBeenSet = true; m_queueUrl = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The URL of the Amazon SQS queue whose attributes are set.</p> <p>Queue URLs
|
|||
|
|
* and names are case-sensitive.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetQueueUrl(const char* value) { m_queueUrlHasBeenSet = true; m_queueUrl.assign(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The URL of the Amazon SQS queue whose attributes are set.</p> <p>Queue URLs
|
|||
|
|
* and names are case-sensitive.</p>
|
|||
|
|
*/
|
|||
|
|
inline SetQueueAttributesRequest& WithQueueUrl(const Aws::String& value) { SetQueueUrl(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The URL of the Amazon SQS queue whose attributes are set.</p> <p>Queue URLs
|
|||
|
|
* and names are case-sensitive.</p>
|
|||
|
|
*/
|
|||
|
|
inline SetQueueAttributesRequest& WithQueueUrl(Aws::String&& value) { SetQueueUrl(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The URL of the Amazon SQS queue whose attributes are set.</p> <p>Queue URLs
|
|||
|
|
* and names are case-sensitive.</p>
|
|||
|
|
*/
|
|||
|
|
inline SetQueueAttributesRequest& WithQueueUrl(const char* value) { SetQueueUrl(value); return *this;}
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map of attributes to set.</p> <p>The following lists the names,
|
|||
|
|
* descriptions, and values of the special request parameters that the
|
|||
|
|
* <code>SetQueueAttributes</code> action uses:</p> <ul> <li> <p>
|
|||
|
|
* <code>DelaySeconds</code> – The length of time, in seconds, for which the
|
|||
|
|
* delivery of all messages in the queue is delayed. Valid values: An integer from
|
|||
|
|
* 0 to 900 (15 minutes). Default: 0. </p> </li> <li> <p>
|
|||
|
|
* <code>MaximumMessageSize</code> – The limit of how many bytes a message can
|
|||
|
|
* contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
|
|||
|
|
* (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). </p> </li>
|
|||
|
|
* <li> <p> <code>MessageRetentionPeriod</code> – The length of time, in seconds,
|
|||
|
|
* for which Amazon SQS retains a message. Valid values: An integer representing
|
|||
|
|
* seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).
|
|||
|
|
* </p> </li> <li> <p> <code>Policy</code> – The queue's policy. A valid AWS
|
|||
|
|
* policy. For more information about policy structure, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview
|
|||
|
|
* of AWS IAM Policies</a> in the <i>Amazon IAM User Guide</i>. </p> </li> <li> <p>
|
|||
|
|
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in seconds, for
|
|||
|
|
* which a <code> <a>ReceiveMessage</a> </code> action waits for a message to
|
|||
|
|
* arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0. </p> </li>
|
|||
|
|
* <li> <p> <code>RedrivePolicy</code> – The string that includes the parameters
|
|||
|
|
* for the dead-letter queue functionality of the source queue as a JSON object.
|
|||
|
|
* For more information about the redrive policy and dead-letter queues, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">Using
|
|||
|
|
* Amazon SQS Dead-Letter Queues</a> in the <i>Amazon Simple Queue Service
|
|||
|
|
* Developer Guide</i>.</p> <ul> <li> <p> <code>deadLetterTargetArn</code> – The
|
|||
|
|
* Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves
|
|||
|
|
* messages after the value of <code>maxReceiveCount</code> is exceeded.</p> </li>
|
|||
|
|
* <li> <p> <code>maxReceiveCount</code> – The number of times a message is
|
|||
|
|
* delivered to the source queue before being moved to the dead-letter queue. When
|
|||
|
|
* the <code>ReceiveCount</code> for a message exceeds the
|
|||
|
|
* <code>maxReceiveCount</code> for a queue, Amazon SQS moves the message to the
|
|||
|
|
* dead-letter-queue.</p> </li> </ul> <p>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.</p> </li> <li> <p>
|
|||
|
|
* <code>VisibilityTimeout</code> – The visibility timeout for the queue, in
|
|||
|
|
* seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For
|
|||
|
|
* more information about the visibility timeout, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility
|
|||
|
|
* Timeout</a> in the <i>Amazon Simple Queue Service Developer Guide</i>.</p> </li>
|
|||
|
|
* </ul> <p>The following attributes apply only to <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html">server-side-encryption</a>:</p>
|
|||
|
|
* <ul> <li> <p> <code>KmsMasterKeyId</code> – The ID of an AWS-managed customer
|
|||
|
|
* master key (CMK) for Amazon SQS or a custom CMK. For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key
|
|||
|
|
* Terms</a>. While the alias of the AWS-managed CMK for Amazon SQS is always
|
|||
|
|
* <code>alias/aws/sqs</code>, the alias of a custom CMK can, for example, be
|
|||
|
|
* <code>alias/<i>MyAlias</i> </code>. For more examples, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a>
|
|||
|
|
* in the <i>AWS Key Management Service API Reference</i>. </p> </li> <li> <p>
|
|||
|
|
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in seconds, for
|
|||
|
|
* which Amazon SQS can reuse a <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data
|
|||
|
|
* key</a> to encrypt or decrypt messages before calling AWS KMS again. An integer
|
|||
|
|
* representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
|||
|
|
* hours). Default: 300 (5 minutes). A shorter time period provides better security
|
|||
|
|
* but results in more calls to KMS which might incur charges after Free Tier. For
|
|||
|
|
* more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work">How
|
|||
|
|
* Does the Data Key Reuse Period Work?</a>. </p> </li> </ul> <p>The following
|
|||
|
|
* attribute applies only to <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO
|
|||
|
|
* (first-in-first-out) queues</a>:</p> <ul> <li> <p>
|
|||
|
|
* <code>ContentBasedDeduplication</code> – Enables content-based deduplication.
|
|||
|
|
* For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing">Exactly-Once
|
|||
|
|
* Processing</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. </p>
|
|||
|
|
* <ul> <li> <p>Every message must have a unique
|
|||
|
|
* <code>MessageDeduplicationId</code>,</p> <ul> <li> <p>You may provide a
|
|||
|
|
* <code>MessageDeduplicationId</code> explicitly.</p> </li> <li> <p>If you aren't
|
|||
|
|
* able to provide a <code>MessageDeduplicationId</code> and you enable
|
|||
|
|
* <code>ContentBasedDeduplication</code> for your queue, Amazon SQS uses a SHA-256
|
|||
|
|
* hash to generate the <code>MessageDeduplicationId</code> using the body of the
|
|||
|
|
* message (but not the attributes of the message). </p> </li> <li> <p>If you don't
|
|||
|
|
* provide a <code>MessageDeduplicationId</code> and the queue doesn't have
|
|||
|
|
* <code>ContentBasedDeduplication</code> set, the action fails with an error.</p>
|
|||
|
|
* </li> <li> <p>If the queue has <code>ContentBasedDeduplication</code> set, your
|
|||
|
|
* <code>MessageDeduplicationId</code> overrides the generated one.</p> </li> </ul>
|
|||
|
|
* </li> <li> <p>When <code>ContentBasedDeduplication</code> is in effect, messages
|
|||
|
|
* with identical content sent within the deduplication interval are treated as
|
|||
|
|
* duplicates and only one copy of the message is delivered.</p> </li> <li> <p>If
|
|||
|
|
* you send one message with <code>ContentBasedDeduplication</code> enabled and
|
|||
|
|
* then another message with a <code>MessageDeduplicationId</code> that is the same
|
|||
|
|
* as the one generated for the first <code>MessageDeduplicationId</code>, the two
|
|||
|
|
* messages are treated as duplicates and only one copy of the message is
|
|||
|
|
* delivered. </p> </li> </ul> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline const Aws::Map<QueueAttributeName, Aws::String>& GetAttributes() const{ return m_attributes; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map of attributes to set.</p> <p>The following lists the names,
|
|||
|
|
* descriptions, and values of the special request parameters that the
|
|||
|
|
* <code>SetQueueAttributes</code> action uses:</p> <ul> <li> <p>
|
|||
|
|
* <code>DelaySeconds</code> – The length of time, in seconds, for which the
|
|||
|
|
* delivery of all messages in the queue is delayed. Valid values: An integer from
|
|||
|
|
* 0 to 900 (15 minutes). Default: 0. </p> </li> <li> <p>
|
|||
|
|
* <code>MaximumMessageSize</code> – The limit of how many bytes a message can
|
|||
|
|
* contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
|
|||
|
|
* (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). </p> </li>
|
|||
|
|
* <li> <p> <code>MessageRetentionPeriod</code> – The length of time, in seconds,
|
|||
|
|
* for which Amazon SQS retains a message. Valid values: An integer representing
|
|||
|
|
* seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).
|
|||
|
|
* </p> </li> <li> <p> <code>Policy</code> – The queue's policy. A valid AWS
|
|||
|
|
* policy. For more information about policy structure, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview
|
|||
|
|
* of AWS IAM Policies</a> in the <i>Amazon IAM User Guide</i>. </p> </li> <li> <p>
|
|||
|
|
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in seconds, for
|
|||
|
|
* which a <code> <a>ReceiveMessage</a> </code> action waits for a message to
|
|||
|
|
* arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0. </p> </li>
|
|||
|
|
* <li> <p> <code>RedrivePolicy</code> – The string that includes the parameters
|
|||
|
|
* for the dead-letter queue functionality of the source queue as a JSON object.
|
|||
|
|
* For more information about the redrive policy and dead-letter queues, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">Using
|
|||
|
|
* Amazon SQS Dead-Letter Queues</a> in the <i>Amazon Simple Queue Service
|
|||
|
|
* Developer Guide</i>.</p> <ul> <li> <p> <code>deadLetterTargetArn</code> – The
|
|||
|
|
* Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves
|
|||
|
|
* messages after the value of <code>maxReceiveCount</code> is exceeded.</p> </li>
|
|||
|
|
* <li> <p> <code>maxReceiveCount</code> – The number of times a message is
|
|||
|
|
* delivered to the source queue before being moved to the dead-letter queue. When
|
|||
|
|
* the <code>ReceiveCount</code> for a message exceeds the
|
|||
|
|
* <code>maxReceiveCount</code> for a queue, Amazon SQS moves the message to the
|
|||
|
|
* dead-letter-queue.</p> </li> </ul> <p>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.</p> </li> <li> <p>
|
|||
|
|
* <code>VisibilityTimeout</code> – The visibility timeout for the queue, in
|
|||
|
|
* seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For
|
|||
|
|
* more information about the visibility timeout, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility
|
|||
|
|
* Timeout</a> in the <i>Amazon Simple Queue Service Developer Guide</i>.</p> </li>
|
|||
|
|
* </ul> <p>The following attributes apply only to <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html">server-side-encryption</a>:</p>
|
|||
|
|
* <ul> <li> <p> <code>KmsMasterKeyId</code> – The ID of an AWS-managed customer
|
|||
|
|
* master key (CMK) for Amazon SQS or a custom CMK. For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key
|
|||
|
|
* Terms</a>. While the alias of the AWS-managed CMK for Amazon SQS is always
|
|||
|
|
* <code>alias/aws/sqs</code>, the alias of a custom CMK can, for example, be
|
|||
|
|
* <code>alias/<i>MyAlias</i> </code>. For more examples, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a>
|
|||
|
|
* in the <i>AWS Key Management Service API Reference</i>. </p> </li> <li> <p>
|
|||
|
|
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in seconds, for
|
|||
|
|
* which Amazon SQS can reuse a <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data
|
|||
|
|
* key</a> to encrypt or decrypt messages before calling AWS KMS again. An integer
|
|||
|
|
* representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
|||
|
|
* hours). Default: 300 (5 minutes). A shorter time period provides better security
|
|||
|
|
* but results in more calls to KMS which might incur charges after Free Tier. For
|
|||
|
|
* more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work">How
|
|||
|
|
* Does the Data Key Reuse Period Work?</a>. </p> </li> </ul> <p>The following
|
|||
|
|
* attribute applies only to <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO
|
|||
|
|
* (first-in-first-out) queues</a>:</p> <ul> <li> <p>
|
|||
|
|
* <code>ContentBasedDeduplication</code> – Enables content-based deduplication.
|
|||
|
|
* For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing">Exactly-Once
|
|||
|
|
* Processing</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. </p>
|
|||
|
|
* <ul> <li> <p>Every message must have a unique
|
|||
|
|
* <code>MessageDeduplicationId</code>,</p> <ul> <li> <p>You may provide a
|
|||
|
|
* <code>MessageDeduplicationId</code> explicitly.</p> </li> <li> <p>If you aren't
|
|||
|
|
* able to provide a <code>MessageDeduplicationId</code> and you enable
|
|||
|
|
* <code>ContentBasedDeduplication</code> for your queue, Amazon SQS uses a SHA-256
|
|||
|
|
* hash to generate the <code>MessageDeduplicationId</code> using the body of the
|
|||
|
|
* message (but not the attributes of the message). </p> </li> <li> <p>If you don't
|
|||
|
|
* provide a <code>MessageDeduplicationId</code> and the queue doesn't have
|
|||
|
|
* <code>ContentBasedDeduplication</code> set, the action fails with an error.</p>
|
|||
|
|
* </li> <li> <p>If the queue has <code>ContentBasedDeduplication</code> set, your
|
|||
|
|
* <code>MessageDeduplicationId</code> overrides the generated one.</p> </li> </ul>
|
|||
|
|
* </li> <li> <p>When <code>ContentBasedDeduplication</code> is in effect, messages
|
|||
|
|
* with identical content sent within the deduplication interval are treated as
|
|||
|
|
* duplicates and only one copy of the message is delivered.</p> </li> <li> <p>If
|
|||
|
|
* you send one message with <code>ContentBasedDeduplication</code> enabled and
|
|||
|
|
* then another message with a <code>MessageDeduplicationId</code> that is the same
|
|||
|
|
* as the one generated for the first <code>MessageDeduplicationId</code>, the two
|
|||
|
|
* messages are treated as duplicates and only one copy of the message is
|
|||
|
|
* delivered. </p> </li> </ul> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline bool AttributesHasBeenSet() const { return m_attributesHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map of attributes to set.</p> <p>The following lists the names,
|
|||
|
|
* descriptions, and values of the special request parameters that the
|
|||
|
|
* <code>SetQueueAttributes</code> action uses:</p> <ul> <li> <p>
|
|||
|
|
* <code>DelaySeconds</code> – The length of time, in seconds, for which the
|
|||
|
|
* delivery of all messages in the queue is delayed. Valid values: An integer from
|
|||
|
|
* 0 to 900 (15 minutes). Default: 0. </p> </li> <li> <p>
|
|||
|
|
* <code>MaximumMessageSize</code> – The limit of how many bytes a message can
|
|||
|
|
* contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
|
|||
|
|
* (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). </p> </li>
|
|||
|
|
* <li> <p> <code>MessageRetentionPeriod</code> – The length of time, in seconds,
|
|||
|
|
* for which Amazon SQS retains a message. Valid values: An integer representing
|
|||
|
|
* seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).
|
|||
|
|
* </p> </li> <li> <p> <code>Policy</code> – The queue's policy. A valid AWS
|
|||
|
|
* policy. For more information about policy structure, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview
|
|||
|
|
* of AWS IAM Policies</a> in the <i>Amazon IAM User Guide</i>. </p> </li> <li> <p>
|
|||
|
|
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in seconds, for
|
|||
|
|
* which a <code> <a>ReceiveMessage</a> </code> action waits for a message to
|
|||
|
|
* arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0. </p> </li>
|
|||
|
|
* <li> <p> <code>RedrivePolicy</code> – The string that includes the parameters
|
|||
|
|
* for the dead-letter queue functionality of the source queue as a JSON object.
|
|||
|
|
* For more information about the redrive policy and dead-letter queues, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">Using
|
|||
|
|
* Amazon SQS Dead-Letter Queues</a> in the <i>Amazon Simple Queue Service
|
|||
|
|
* Developer Guide</i>.</p> <ul> <li> <p> <code>deadLetterTargetArn</code> – The
|
|||
|
|
* Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves
|
|||
|
|
* messages after the value of <code>maxReceiveCount</code> is exceeded.</p> </li>
|
|||
|
|
* <li> <p> <code>maxReceiveCount</code> – The number of times a message is
|
|||
|
|
* delivered to the source queue before being moved to the dead-letter queue. When
|
|||
|
|
* the <code>ReceiveCount</code> for a message exceeds the
|
|||
|
|
* <code>maxReceiveCount</code> for a queue, Amazon SQS moves the message to the
|
|||
|
|
* dead-letter-queue.</p> </li> </ul> <p>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.</p> </li> <li> <p>
|
|||
|
|
* <code>VisibilityTimeout</code> – The visibility timeout for the queue, in
|
|||
|
|
* seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For
|
|||
|
|
* more information about the visibility timeout, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility
|
|||
|
|
* Timeout</a> in the <i>Amazon Simple Queue Service Developer Guide</i>.</p> </li>
|
|||
|
|
* </ul> <p>The following attributes apply only to <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html">server-side-encryption</a>:</p>
|
|||
|
|
* <ul> <li> <p> <code>KmsMasterKeyId</code> – The ID of an AWS-managed customer
|
|||
|
|
* master key (CMK) for Amazon SQS or a custom CMK. For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key
|
|||
|
|
* Terms</a>. While the alias of the AWS-managed CMK for Amazon SQS is always
|
|||
|
|
* <code>alias/aws/sqs</code>, the alias of a custom CMK can, for example, be
|
|||
|
|
* <code>alias/<i>MyAlias</i> </code>. For more examples, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a>
|
|||
|
|
* in the <i>AWS Key Management Service API Reference</i>. </p> </li> <li> <p>
|
|||
|
|
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in seconds, for
|
|||
|
|
* which Amazon SQS can reuse a <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data
|
|||
|
|
* key</a> to encrypt or decrypt messages before calling AWS KMS again. An integer
|
|||
|
|
* representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
|||
|
|
* hours). Default: 300 (5 minutes). A shorter time period provides better security
|
|||
|
|
* but results in more calls to KMS which might incur charges after Free Tier. For
|
|||
|
|
* more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work">How
|
|||
|
|
* Does the Data Key Reuse Period Work?</a>. </p> </li> </ul> <p>The following
|
|||
|
|
* attribute applies only to <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO
|
|||
|
|
* (first-in-first-out) queues</a>:</p> <ul> <li> <p>
|
|||
|
|
* <code>ContentBasedDeduplication</code> – Enables content-based deduplication.
|
|||
|
|
* For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing">Exactly-Once
|
|||
|
|
* Processing</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. </p>
|
|||
|
|
* <ul> <li> <p>Every message must have a unique
|
|||
|
|
* <code>MessageDeduplicationId</code>,</p> <ul> <li> <p>You may provide a
|
|||
|
|
* <code>MessageDeduplicationId</code> explicitly.</p> </li> <li> <p>If you aren't
|
|||
|
|
* able to provide a <code>MessageDeduplicationId</code> and you enable
|
|||
|
|
* <code>ContentBasedDeduplication</code> for your queue, Amazon SQS uses a SHA-256
|
|||
|
|
* hash to generate the <code>MessageDeduplicationId</code> using the body of the
|
|||
|
|
* message (but not the attributes of the message). </p> </li> <li> <p>If you don't
|
|||
|
|
* provide a <code>MessageDeduplicationId</code> and the queue doesn't have
|
|||
|
|
* <code>ContentBasedDeduplication</code> set, the action fails with an error.</p>
|
|||
|
|
* </li> <li> <p>If the queue has <code>ContentBasedDeduplication</code> set, your
|
|||
|
|
* <code>MessageDeduplicationId</code> overrides the generated one.</p> </li> </ul>
|
|||
|
|
* </li> <li> <p>When <code>ContentBasedDeduplication</code> is in effect, messages
|
|||
|
|
* with identical content sent within the deduplication interval are treated as
|
|||
|
|
* duplicates and only one copy of the message is delivered.</p> </li> <li> <p>If
|
|||
|
|
* you send one message with <code>ContentBasedDeduplication</code> enabled and
|
|||
|
|
* then another message with a <code>MessageDeduplicationId</code> that is the same
|
|||
|
|
* as the one generated for the first <code>MessageDeduplicationId</code>, the two
|
|||
|
|
* messages are treated as duplicates and only one copy of the message is
|
|||
|
|
* delivered. </p> </li> </ul> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline void SetAttributes(const Aws::Map<QueueAttributeName, Aws::String>& value) { m_attributesHasBeenSet = true; m_attributes = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map of attributes to set.</p> <p>The following lists the names,
|
|||
|
|
* descriptions, and values of the special request parameters that the
|
|||
|
|
* <code>SetQueueAttributes</code> action uses:</p> <ul> <li> <p>
|
|||
|
|
* <code>DelaySeconds</code> – The length of time, in seconds, for which the
|
|||
|
|
* delivery of all messages in the queue is delayed. Valid values: An integer from
|
|||
|
|
* 0 to 900 (15 minutes). Default: 0. </p> </li> <li> <p>
|
|||
|
|
* <code>MaximumMessageSize</code> – The limit of how many bytes a message can
|
|||
|
|
* contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
|
|||
|
|
* (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). </p> </li>
|
|||
|
|
* <li> <p> <code>MessageRetentionPeriod</code> – The length of time, in seconds,
|
|||
|
|
* for which Amazon SQS retains a message. Valid values: An integer representing
|
|||
|
|
* seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).
|
|||
|
|
* </p> </li> <li> <p> <code>Policy</code> – The queue's policy. A valid AWS
|
|||
|
|
* policy. For more information about policy structure, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview
|
|||
|
|
* of AWS IAM Policies</a> in the <i>Amazon IAM User Guide</i>. </p> </li> <li> <p>
|
|||
|
|
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in seconds, for
|
|||
|
|
* which a <code> <a>ReceiveMessage</a> </code> action waits for a message to
|
|||
|
|
* arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0. </p> </li>
|
|||
|
|
* <li> <p> <code>RedrivePolicy</code> – The string that includes the parameters
|
|||
|
|
* for the dead-letter queue functionality of the source queue as a JSON object.
|
|||
|
|
* For more information about the redrive policy and dead-letter queues, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">Using
|
|||
|
|
* Amazon SQS Dead-Letter Queues</a> in the <i>Amazon Simple Queue Service
|
|||
|
|
* Developer Guide</i>.</p> <ul> <li> <p> <code>deadLetterTargetArn</code> – The
|
|||
|
|
* Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves
|
|||
|
|
* messages after the value of <code>maxReceiveCount</code> is exceeded.</p> </li>
|
|||
|
|
* <li> <p> <code>maxReceiveCount</code> – The number of times a message is
|
|||
|
|
* delivered to the source queue before being moved to the dead-letter queue. When
|
|||
|
|
* the <code>ReceiveCount</code> for a message exceeds the
|
|||
|
|
* <code>maxReceiveCount</code> for a queue, Amazon SQS moves the message to the
|
|||
|
|
* dead-letter-queue.</p> </li> </ul> <p>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.</p> </li> <li> <p>
|
|||
|
|
* <code>VisibilityTimeout</code> – The visibility timeout for the queue, in
|
|||
|
|
* seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For
|
|||
|
|
* more information about the visibility timeout, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility
|
|||
|
|
* Timeout</a> in the <i>Amazon Simple Queue Service Developer Guide</i>.</p> </li>
|
|||
|
|
* </ul> <p>The following attributes apply only to <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html">server-side-encryption</a>:</p>
|
|||
|
|
* <ul> <li> <p> <code>KmsMasterKeyId</code> – The ID of an AWS-managed customer
|
|||
|
|
* master key (CMK) for Amazon SQS or a custom CMK. For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key
|
|||
|
|
* Terms</a>. While the alias of the AWS-managed CMK for Amazon SQS is always
|
|||
|
|
* <code>alias/aws/sqs</code>, the alias of a custom CMK can, for example, be
|
|||
|
|
* <code>alias/<i>MyAlias</i> </code>. For more examples, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a>
|
|||
|
|
* in the <i>AWS Key Management Service API Reference</i>. </p> </li> <li> <p>
|
|||
|
|
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in seconds, for
|
|||
|
|
* which Amazon SQS can reuse a <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data
|
|||
|
|
* key</a> to encrypt or decrypt messages before calling AWS KMS again. An integer
|
|||
|
|
* representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
|||
|
|
* hours). Default: 300 (5 minutes). A shorter time period provides better security
|
|||
|
|
* but results in more calls to KMS which might incur charges after Free Tier. For
|
|||
|
|
* more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work">How
|
|||
|
|
* Does the Data Key Reuse Period Work?</a>. </p> </li> </ul> <p>The following
|
|||
|
|
* attribute applies only to <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO
|
|||
|
|
* (first-in-first-out) queues</a>:</p> <ul> <li> <p>
|
|||
|
|
* <code>ContentBasedDeduplication</code> – Enables content-based deduplication.
|
|||
|
|
* For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing">Exactly-Once
|
|||
|
|
* Processing</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. </p>
|
|||
|
|
* <ul> <li> <p>Every message must have a unique
|
|||
|
|
* <code>MessageDeduplicationId</code>,</p> <ul> <li> <p>You may provide a
|
|||
|
|
* <code>MessageDeduplicationId</code> explicitly.</p> </li> <li> <p>If you aren't
|
|||
|
|
* able to provide a <code>MessageDeduplicationId</code> and you enable
|
|||
|
|
* <code>ContentBasedDeduplication</code> for your queue, Amazon SQS uses a SHA-256
|
|||
|
|
* hash to generate the <code>MessageDeduplicationId</code> using the body of the
|
|||
|
|
* message (but not the attributes of the message). </p> </li> <li> <p>If you don't
|
|||
|
|
* provide a <code>MessageDeduplicationId</code> and the queue doesn't have
|
|||
|
|
* <code>ContentBasedDeduplication</code> set, the action fails with an error.</p>
|
|||
|
|
* </li> <li> <p>If the queue has <code>ContentBasedDeduplication</code> set, your
|
|||
|
|
* <code>MessageDeduplicationId</code> overrides the generated one.</p> </li> </ul>
|
|||
|
|
* </li> <li> <p>When <code>ContentBasedDeduplication</code> is in effect, messages
|
|||
|
|
* with identical content sent within the deduplication interval are treated as
|
|||
|
|
* duplicates and only one copy of the message is delivered.</p> </li> <li> <p>If
|
|||
|
|
* you send one message with <code>ContentBasedDeduplication</code> enabled and
|
|||
|
|
* then another message with a <code>MessageDeduplicationId</code> that is the same
|
|||
|
|
* as the one generated for the first <code>MessageDeduplicationId</code>, the two
|
|||
|
|
* messages are treated as duplicates and only one copy of the message is
|
|||
|
|
* delivered. </p> </li> </ul> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline void SetAttributes(Aws::Map<QueueAttributeName, Aws::String>&& value) { m_attributesHasBeenSet = true; m_attributes = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map of attributes to set.</p> <p>The following lists the names,
|
|||
|
|
* descriptions, and values of the special request parameters that the
|
|||
|
|
* <code>SetQueueAttributes</code> action uses:</p> <ul> <li> <p>
|
|||
|
|
* <code>DelaySeconds</code> – The length of time, in seconds, for which the
|
|||
|
|
* delivery of all messages in the queue is delayed. Valid values: An integer from
|
|||
|
|
* 0 to 900 (15 minutes). Default: 0. </p> </li> <li> <p>
|
|||
|
|
* <code>MaximumMessageSize</code> – The limit of how many bytes a message can
|
|||
|
|
* contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
|
|||
|
|
* (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). </p> </li>
|
|||
|
|
* <li> <p> <code>MessageRetentionPeriod</code> – The length of time, in seconds,
|
|||
|
|
* for which Amazon SQS retains a message. Valid values: An integer representing
|
|||
|
|
* seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).
|
|||
|
|
* </p> </li> <li> <p> <code>Policy</code> – The queue's policy. A valid AWS
|
|||
|
|
* policy. For more information about policy structure, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview
|
|||
|
|
* of AWS IAM Policies</a> in the <i>Amazon IAM User Guide</i>. </p> </li> <li> <p>
|
|||
|
|
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in seconds, for
|
|||
|
|
* which a <code> <a>ReceiveMessage</a> </code> action waits for a message to
|
|||
|
|
* arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0. </p> </li>
|
|||
|
|
* <li> <p> <code>RedrivePolicy</code> – The string that includes the parameters
|
|||
|
|
* for the dead-letter queue functionality of the source queue as a JSON object.
|
|||
|
|
* For more information about the redrive policy and dead-letter queues, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">Using
|
|||
|
|
* Amazon SQS Dead-Letter Queues</a> in the <i>Amazon Simple Queue Service
|
|||
|
|
* Developer Guide</i>.</p> <ul> <li> <p> <code>deadLetterTargetArn</code> – The
|
|||
|
|
* Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves
|
|||
|
|
* messages after the value of <code>maxReceiveCount</code> is exceeded.</p> </li>
|
|||
|
|
* <li> <p> <code>maxReceiveCount</code> – The number of times a message is
|
|||
|
|
* delivered to the source queue before being moved to the dead-letter queue. When
|
|||
|
|
* the <code>ReceiveCount</code> for a message exceeds the
|
|||
|
|
* <code>maxReceiveCount</code> for a queue, Amazon SQS moves the message to the
|
|||
|
|
* dead-letter-queue.</p> </li> </ul> <p>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.</p> </li> <li> <p>
|
|||
|
|
* <code>VisibilityTimeout</code> – The visibility timeout for the queue, in
|
|||
|
|
* seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For
|
|||
|
|
* more information about the visibility timeout, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility
|
|||
|
|
* Timeout</a> in the <i>Amazon Simple Queue Service Developer Guide</i>.</p> </li>
|
|||
|
|
* </ul> <p>The following attributes apply only to <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html">server-side-encryption</a>:</p>
|
|||
|
|
* <ul> <li> <p> <code>KmsMasterKeyId</code> – The ID of an AWS-managed customer
|
|||
|
|
* master key (CMK) for Amazon SQS or a custom CMK. For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key
|
|||
|
|
* Terms</a>. While the alias of the AWS-managed CMK for Amazon SQS is always
|
|||
|
|
* <code>alias/aws/sqs</code>, the alias of a custom CMK can, for example, be
|
|||
|
|
* <code>alias/<i>MyAlias</i> </code>. For more examples, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a>
|
|||
|
|
* in the <i>AWS Key Management Service API Reference</i>. </p> </li> <li> <p>
|
|||
|
|
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in seconds, for
|
|||
|
|
* which Amazon SQS can reuse a <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data
|
|||
|
|
* key</a> to encrypt or decrypt messages before calling AWS KMS again. An integer
|
|||
|
|
* representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
|||
|
|
* hours). Default: 300 (5 minutes). A shorter time period provides better security
|
|||
|
|
* but results in more calls to KMS which might incur charges after Free Tier. For
|
|||
|
|
* more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work">How
|
|||
|
|
* Does the Data Key Reuse Period Work?</a>. </p> </li> </ul> <p>The following
|
|||
|
|
* attribute applies only to <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO
|
|||
|
|
* (first-in-first-out) queues</a>:</p> <ul> <li> <p>
|
|||
|
|
* <code>ContentBasedDeduplication</code> – Enables content-based deduplication.
|
|||
|
|
* For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing">Exactly-Once
|
|||
|
|
* Processing</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. </p>
|
|||
|
|
* <ul> <li> <p>Every message must have a unique
|
|||
|
|
* <code>MessageDeduplicationId</code>,</p> <ul> <li> <p>You may provide a
|
|||
|
|
* <code>MessageDeduplicationId</code> explicitly.</p> </li> <li> <p>If you aren't
|
|||
|
|
* able to provide a <code>MessageDeduplicationId</code> and you enable
|
|||
|
|
* <code>ContentBasedDeduplication</code> for your queue, Amazon SQS uses a SHA-256
|
|||
|
|
* hash to generate the <code>MessageDeduplicationId</code> using the body of the
|
|||
|
|
* message (but not the attributes of the message). </p> </li> <li> <p>If you don't
|
|||
|
|
* provide a <code>MessageDeduplicationId</code> and the queue doesn't have
|
|||
|
|
* <code>ContentBasedDeduplication</code> set, the action fails with an error.</p>
|
|||
|
|
* </li> <li> <p>If the queue has <code>ContentBasedDeduplication</code> set, your
|
|||
|
|
* <code>MessageDeduplicationId</code> overrides the generated one.</p> </li> </ul>
|
|||
|
|
* </li> <li> <p>When <code>ContentBasedDeduplication</code> is in effect, messages
|
|||
|
|
* with identical content sent within the deduplication interval are treated as
|
|||
|
|
* duplicates and only one copy of the message is delivered.</p> </li> <li> <p>If
|
|||
|
|
* you send one message with <code>ContentBasedDeduplication</code> enabled and
|
|||
|
|
* then another message with a <code>MessageDeduplicationId</code> that is the same
|
|||
|
|
* as the one generated for the first <code>MessageDeduplicationId</code>, the two
|
|||
|
|
* messages are treated as duplicates and only one copy of the message is
|
|||
|
|
* delivered. </p> </li> </ul> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline SetQueueAttributesRequest& WithAttributes(const Aws::Map<QueueAttributeName, Aws::String>& value) { SetAttributes(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map of attributes to set.</p> <p>The following lists the names,
|
|||
|
|
* descriptions, and values of the special request parameters that the
|
|||
|
|
* <code>SetQueueAttributes</code> action uses:</p> <ul> <li> <p>
|
|||
|
|
* <code>DelaySeconds</code> – The length of time, in seconds, for which the
|
|||
|
|
* delivery of all messages in the queue is delayed. Valid values: An integer from
|
|||
|
|
* 0 to 900 (15 minutes). Default: 0. </p> </li> <li> <p>
|
|||
|
|
* <code>MaximumMessageSize</code> – The limit of how many bytes a message can
|
|||
|
|
* contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
|
|||
|
|
* (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). </p> </li>
|
|||
|
|
* <li> <p> <code>MessageRetentionPeriod</code> – The length of time, in seconds,
|
|||
|
|
* for which Amazon SQS retains a message. Valid values: An integer representing
|
|||
|
|
* seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).
|
|||
|
|
* </p> </li> <li> <p> <code>Policy</code> – The queue's policy. A valid AWS
|
|||
|
|
* policy. For more information about policy structure, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview
|
|||
|
|
* of AWS IAM Policies</a> in the <i>Amazon IAM User Guide</i>. </p> </li> <li> <p>
|
|||
|
|
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in seconds, for
|
|||
|
|
* which a <code> <a>ReceiveMessage</a> </code> action waits for a message to
|
|||
|
|
* arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0. </p> </li>
|
|||
|
|
* <li> <p> <code>RedrivePolicy</code> – The string that includes the parameters
|
|||
|
|
* for the dead-letter queue functionality of the source queue as a JSON object.
|
|||
|
|
* For more information about the redrive policy and dead-letter queues, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">Using
|
|||
|
|
* Amazon SQS Dead-Letter Queues</a> in the <i>Amazon Simple Queue Service
|
|||
|
|
* Developer Guide</i>.</p> <ul> <li> <p> <code>deadLetterTargetArn</code> – The
|
|||
|
|
* Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves
|
|||
|
|
* messages after the value of <code>maxReceiveCount</code> is exceeded.</p> </li>
|
|||
|
|
* <li> <p> <code>maxReceiveCount</code> – The number of times a message is
|
|||
|
|
* delivered to the source queue before being moved to the dead-letter queue. When
|
|||
|
|
* the <code>ReceiveCount</code> for a message exceeds the
|
|||
|
|
* <code>maxReceiveCount</code> for a queue, Amazon SQS moves the message to the
|
|||
|
|
* dead-letter-queue.</p> </li> </ul> <p>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.</p> </li> <li> <p>
|
|||
|
|
* <code>VisibilityTimeout</code> – The visibility timeout for the queue, in
|
|||
|
|
* seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For
|
|||
|
|
* more information about the visibility timeout, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility
|
|||
|
|
* Timeout</a> in the <i>Amazon Simple Queue Service Developer Guide</i>.</p> </li>
|
|||
|
|
* </ul> <p>The following attributes apply only to <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html">server-side-encryption</a>:</p>
|
|||
|
|
* <ul> <li> <p> <code>KmsMasterKeyId</code> – The ID of an AWS-managed customer
|
|||
|
|
* master key (CMK) for Amazon SQS or a custom CMK. For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key
|
|||
|
|
* Terms</a>. While the alias of the AWS-managed CMK for Amazon SQS is always
|
|||
|
|
* <code>alias/aws/sqs</code>, the alias of a custom CMK can, for example, be
|
|||
|
|
* <code>alias/<i>MyAlias</i> </code>. For more examples, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a>
|
|||
|
|
* in the <i>AWS Key Management Service API Reference</i>. </p> </li> <li> <p>
|
|||
|
|
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in seconds, for
|
|||
|
|
* which Amazon SQS can reuse a <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data
|
|||
|
|
* key</a> to encrypt or decrypt messages before calling AWS KMS again. An integer
|
|||
|
|
* representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
|||
|
|
* hours). Default: 300 (5 minutes). A shorter time period provides better security
|
|||
|
|
* but results in more calls to KMS which might incur charges after Free Tier. For
|
|||
|
|
* more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work">How
|
|||
|
|
* Does the Data Key Reuse Period Work?</a>. </p> </li> </ul> <p>The following
|
|||
|
|
* attribute applies only to <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO
|
|||
|
|
* (first-in-first-out) queues</a>:</p> <ul> <li> <p>
|
|||
|
|
* <code>ContentBasedDeduplication</code> – Enables content-based deduplication.
|
|||
|
|
* For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing">Exactly-Once
|
|||
|
|
* Processing</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. </p>
|
|||
|
|
* <ul> <li> <p>Every message must have a unique
|
|||
|
|
* <code>MessageDeduplicationId</code>,</p> <ul> <li> <p>You may provide a
|
|||
|
|
* <code>MessageDeduplicationId</code> explicitly.</p> </li> <li> <p>If you aren't
|
|||
|
|
* able to provide a <code>MessageDeduplicationId</code> and you enable
|
|||
|
|
* <code>ContentBasedDeduplication</code> for your queue, Amazon SQS uses a SHA-256
|
|||
|
|
* hash to generate the <code>MessageDeduplicationId</code> using the body of the
|
|||
|
|
* message (but not the attributes of the message). </p> </li> <li> <p>If you don't
|
|||
|
|
* provide a <code>MessageDeduplicationId</code> and the queue doesn't have
|
|||
|
|
* <code>ContentBasedDeduplication</code> set, the action fails with an error.</p>
|
|||
|
|
* </li> <li> <p>If the queue has <code>ContentBasedDeduplication</code> set, your
|
|||
|
|
* <code>MessageDeduplicationId</code> overrides the generated one.</p> </li> </ul>
|
|||
|
|
* </li> <li> <p>When <code>ContentBasedDeduplication</code> is in effect, messages
|
|||
|
|
* with identical content sent within the deduplication interval are treated as
|
|||
|
|
* duplicates and only one copy of the message is delivered.</p> </li> <li> <p>If
|
|||
|
|
* you send one message with <code>ContentBasedDeduplication</code> enabled and
|
|||
|
|
* then another message with a <code>MessageDeduplicationId</code> that is the same
|
|||
|
|
* as the one generated for the first <code>MessageDeduplicationId</code>, the two
|
|||
|
|
* messages are treated as duplicates and only one copy of the message is
|
|||
|
|
* delivered. </p> </li> </ul> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline SetQueueAttributesRequest& WithAttributes(Aws::Map<QueueAttributeName, Aws::String>&& value) { SetAttributes(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map of attributes to set.</p> <p>The following lists the names,
|
|||
|
|
* descriptions, and values of the special request parameters that the
|
|||
|
|
* <code>SetQueueAttributes</code> action uses:</p> <ul> <li> <p>
|
|||
|
|
* <code>DelaySeconds</code> – The length of time, in seconds, for which the
|
|||
|
|
* delivery of all messages in the queue is delayed. Valid values: An integer from
|
|||
|
|
* 0 to 900 (15 minutes). Default: 0. </p> </li> <li> <p>
|
|||
|
|
* <code>MaximumMessageSize</code> – The limit of how many bytes a message can
|
|||
|
|
* contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
|
|||
|
|
* (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). </p> </li>
|
|||
|
|
* <li> <p> <code>MessageRetentionPeriod</code> – The length of time, in seconds,
|
|||
|
|
* for which Amazon SQS retains a message. Valid values: An integer representing
|
|||
|
|
* seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).
|
|||
|
|
* </p> </li> <li> <p> <code>Policy</code> – The queue's policy. A valid AWS
|
|||
|
|
* policy. For more information about policy structure, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview
|
|||
|
|
* of AWS IAM Policies</a> in the <i>Amazon IAM User Guide</i>. </p> </li> <li> <p>
|
|||
|
|
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in seconds, for
|
|||
|
|
* which a <code> <a>ReceiveMessage</a> </code> action waits for a message to
|
|||
|
|
* arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0. </p> </li>
|
|||
|
|
* <li> <p> <code>RedrivePolicy</code> – The string that includes the parameters
|
|||
|
|
* for the dead-letter queue functionality of the source queue as a JSON object.
|
|||
|
|
* For more information about the redrive policy and dead-letter queues, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">Using
|
|||
|
|
* Amazon SQS Dead-Letter Queues</a> in the <i>Amazon Simple Queue Service
|
|||
|
|
* Developer Guide</i>.</p> <ul> <li> <p> <code>deadLetterTargetArn</code> – The
|
|||
|
|
* Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves
|
|||
|
|
* messages after the value of <code>maxReceiveCount</code> is exceeded.</p> </li>
|
|||
|
|
* <li> <p> <code>maxReceiveCount</code> – The number of times a message is
|
|||
|
|
* delivered to the source queue before being moved to the dead-letter queue. When
|
|||
|
|
* the <code>ReceiveCount</code> for a message exceeds the
|
|||
|
|
* <code>maxReceiveCount</code> for a queue, Amazon SQS moves the message to the
|
|||
|
|
* dead-letter-queue.</p> </li> </ul> <p>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.</p> </li> <li> <p>
|
|||
|
|
* <code>VisibilityTimeout</code> – The visibility timeout for the queue, in
|
|||
|
|
* seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For
|
|||
|
|
* more information about the visibility timeout, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility
|
|||
|
|
* Timeout</a> in the <i>Amazon Simple Queue Service Developer Guide</i>.</p> </li>
|
|||
|
|
* </ul> <p>The following attributes apply only to <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html">server-side-encryption</a>:</p>
|
|||
|
|
* <ul> <li> <p> <code>KmsMasterKeyId</code> – The ID of an AWS-managed customer
|
|||
|
|
* master key (CMK) for Amazon SQS or a custom CMK. For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key
|
|||
|
|
* Terms</a>. While the alias of the AWS-managed CMK for Amazon SQS is always
|
|||
|
|
* <code>alias/aws/sqs</code>, the alias of a custom CMK can, for example, be
|
|||
|
|
* <code>alias/<i>MyAlias</i> </code>. For more examples, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a>
|
|||
|
|
* in the <i>AWS Key Management Service API Reference</i>. </p> </li> <li> <p>
|
|||
|
|
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in seconds, for
|
|||
|
|
* which Amazon SQS can reuse a <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data
|
|||
|
|
* key</a> to encrypt or decrypt messages before calling AWS KMS again. An integer
|
|||
|
|
* representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
|||
|
|
* hours). Default: 300 (5 minutes). A shorter time period provides better security
|
|||
|
|
* but results in more calls to KMS which might incur charges after Free Tier. For
|
|||
|
|
* more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work">How
|
|||
|
|
* Does the Data Key Reuse Period Work?</a>. </p> </li> </ul> <p>The following
|
|||
|
|
* attribute applies only to <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO
|
|||
|
|
* (first-in-first-out) queues</a>:</p> <ul> <li> <p>
|
|||
|
|
* <code>ContentBasedDeduplication</code> – Enables content-based deduplication.
|
|||
|
|
* For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing">Exactly-Once
|
|||
|
|
* Processing</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. </p>
|
|||
|
|
* <ul> <li> <p>Every message must have a unique
|
|||
|
|
* <code>MessageDeduplicationId</code>,</p> <ul> <li> <p>You may provide a
|
|||
|
|
* <code>MessageDeduplicationId</code> explicitly.</p> </li> <li> <p>If you aren't
|
|||
|
|
* able to provide a <code>MessageDeduplicationId</code> and you enable
|
|||
|
|
* <code>ContentBasedDeduplication</code> for your queue, Amazon SQS uses a SHA-256
|
|||
|
|
* hash to generate the <code>MessageDeduplicationId</code> using the body of the
|
|||
|
|
* message (but not the attributes of the message). </p> </li> <li> <p>If you don't
|
|||
|
|
* provide a <code>MessageDeduplicationId</code> and the queue doesn't have
|
|||
|
|
* <code>ContentBasedDeduplication</code> set, the action fails with an error.</p>
|
|||
|
|
* </li> <li> <p>If the queue has <code>ContentBasedDeduplication</code> set, your
|
|||
|
|
* <code>MessageDeduplicationId</code> overrides the generated one.</p> </li> </ul>
|
|||
|
|
* </li> <li> <p>When <code>ContentBasedDeduplication</code> is in effect, messages
|
|||
|
|
* with identical content sent within the deduplication interval are treated as
|
|||
|
|
* duplicates and only one copy of the message is delivered.</p> </li> <li> <p>If
|
|||
|
|
* you send one message with <code>ContentBasedDeduplication</code> enabled and
|
|||
|
|
* then another message with a <code>MessageDeduplicationId</code> that is the same
|
|||
|
|
* as the one generated for the first <code>MessageDeduplicationId</code>, the two
|
|||
|
|
* messages are treated as duplicates and only one copy of the message is
|
|||
|
|
* delivered. </p> </li> </ul> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline SetQueueAttributesRequest& AddAttributes(const QueueAttributeName& key, const Aws::String& value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, value); return *this; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map of attributes to set.</p> <p>The following lists the names,
|
|||
|
|
* descriptions, and values of the special request parameters that the
|
|||
|
|
* <code>SetQueueAttributes</code> action uses:</p> <ul> <li> <p>
|
|||
|
|
* <code>DelaySeconds</code> – The length of time, in seconds, for which the
|
|||
|
|
* delivery of all messages in the queue is delayed. Valid values: An integer from
|
|||
|
|
* 0 to 900 (15 minutes). Default: 0. </p> </li> <li> <p>
|
|||
|
|
* <code>MaximumMessageSize</code> – The limit of how many bytes a message can
|
|||
|
|
* contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
|
|||
|
|
* (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). </p> </li>
|
|||
|
|
* <li> <p> <code>MessageRetentionPeriod</code> – The length of time, in seconds,
|
|||
|
|
* for which Amazon SQS retains a message. Valid values: An integer representing
|
|||
|
|
* seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).
|
|||
|
|
* </p> </li> <li> <p> <code>Policy</code> – The queue's policy. A valid AWS
|
|||
|
|
* policy. For more information about policy structure, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview
|
|||
|
|
* of AWS IAM Policies</a> in the <i>Amazon IAM User Guide</i>. </p> </li> <li> <p>
|
|||
|
|
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in seconds, for
|
|||
|
|
* which a <code> <a>ReceiveMessage</a> </code> action waits for a message to
|
|||
|
|
* arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0. </p> </li>
|
|||
|
|
* <li> <p> <code>RedrivePolicy</code> – The string that includes the parameters
|
|||
|
|
* for the dead-letter queue functionality of the source queue as a JSON object.
|
|||
|
|
* For more information about the redrive policy and dead-letter queues, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">Using
|
|||
|
|
* Amazon SQS Dead-Letter Queues</a> in the <i>Amazon Simple Queue Service
|
|||
|
|
* Developer Guide</i>.</p> <ul> <li> <p> <code>deadLetterTargetArn</code> – The
|
|||
|
|
* Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves
|
|||
|
|
* messages after the value of <code>maxReceiveCount</code> is exceeded.</p> </li>
|
|||
|
|
* <li> <p> <code>maxReceiveCount</code> – The number of times a message is
|
|||
|
|
* delivered to the source queue before being moved to the dead-letter queue. When
|
|||
|
|
* the <code>ReceiveCount</code> for a message exceeds the
|
|||
|
|
* <code>maxReceiveCount</code> for a queue, Amazon SQS moves the message to the
|
|||
|
|
* dead-letter-queue.</p> </li> </ul> <p>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.</p> </li> <li> <p>
|
|||
|
|
* <code>VisibilityTimeout</code> – The visibility timeout for the queue, in
|
|||
|
|
* seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For
|
|||
|
|
* more information about the visibility timeout, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility
|
|||
|
|
* Timeout</a> in the <i>Amazon Simple Queue Service Developer Guide</i>.</p> </li>
|
|||
|
|
* </ul> <p>The following attributes apply only to <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html">server-side-encryption</a>:</p>
|
|||
|
|
* <ul> <li> <p> <code>KmsMasterKeyId</code> – The ID of an AWS-managed customer
|
|||
|
|
* master key (CMK) for Amazon SQS or a custom CMK. For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key
|
|||
|
|
* Terms</a>. While the alias of the AWS-managed CMK for Amazon SQS is always
|
|||
|
|
* <code>alias/aws/sqs</code>, the alias of a custom CMK can, for example, be
|
|||
|
|
* <code>alias/<i>MyAlias</i> </code>. For more examples, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a>
|
|||
|
|
* in the <i>AWS Key Management Service API Reference</i>. </p> </li> <li> <p>
|
|||
|
|
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in seconds, for
|
|||
|
|
* which Amazon SQS can reuse a <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data
|
|||
|
|
* key</a> to encrypt or decrypt messages before calling AWS KMS again. An integer
|
|||
|
|
* representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
|||
|
|
* hours). Default: 300 (5 minutes). A shorter time period provides better security
|
|||
|
|
* but results in more calls to KMS which might incur charges after Free Tier. For
|
|||
|
|
* more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work">How
|
|||
|
|
* Does the Data Key Reuse Period Work?</a>. </p> </li> </ul> <p>The following
|
|||
|
|
* attribute applies only to <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO
|
|||
|
|
* (first-in-first-out) queues</a>:</p> <ul> <li> <p>
|
|||
|
|
* <code>ContentBasedDeduplication</code> – Enables content-based deduplication.
|
|||
|
|
* For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing">Exactly-Once
|
|||
|
|
* Processing</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. </p>
|
|||
|
|
* <ul> <li> <p>Every message must have a unique
|
|||
|
|
* <code>MessageDeduplicationId</code>,</p> <ul> <li> <p>You may provide a
|
|||
|
|
* <code>MessageDeduplicationId</code> explicitly.</p> </li> <li> <p>If you aren't
|
|||
|
|
* able to provide a <code>MessageDeduplicationId</code> and you enable
|
|||
|
|
* <code>ContentBasedDeduplication</code> for your queue, Amazon SQS uses a SHA-256
|
|||
|
|
* hash to generate the <code>MessageDeduplicationId</code> using the body of the
|
|||
|
|
* message (but not the attributes of the message). </p> </li> <li> <p>If you don't
|
|||
|
|
* provide a <code>MessageDeduplicationId</code> and the queue doesn't have
|
|||
|
|
* <code>ContentBasedDeduplication</code> set, the action fails with an error.</p>
|
|||
|
|
* </li> <li> <p>If the queue has <code>ContentBasedDeduplication</code> set, your
|
|||
|
|
* <code>MessageDeduplicationId</code> overrides the generated one.</p> </li> </ul>
|
|||
|
|
* </li> <li> <p>When <code>ContentBasedDeduplication</code> is in effect, messages
|
|||
|
|
* with identical content sent within the deduplication interval are treated as
|
|||
|
|
* duplicates and only one copy of the message is delivered.</p> </li> <li> <p>If
|
|||
|
|
* you send one message with <code>ContentBasedDeduplication</code> enabled and
|
|||
|
|
* then another message with a <code>MessageDeduplicationId</code> that is the same
|
|||
|
|
* as the one generated for the first <code>MessageDeduplicationId</code>, the two
|
|||
|
|
* messages are treated as duplicates and only one copy of the message is
|
|||
|
|
* delivered. </p> </li> </ul> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline SetQueueAttributesRequest& AddAttributes(QueueAttributeName&& key, const Aws::String& value) { m_attributesHasBeenSet = true; m_attributes.emplace(std::move(key), value); return *this; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map of attributes to set.</p> <p>The following lists the names,
|
|||
|
|
* descriptions, and values of the special request parameters that the
|
|||
|
|
* <code>SetQueueAttributes</code> action uses:</p> <ul> <li> <p>
|
|||
|
|
* <code>DelaySeconds</code> – The length of time, in seconds, for which the
|
|||
|
|
* delivery of all messages in the queue is delayed. Valid values: An integer from
|
|||
|
|
* 0 to 900 (15 minutes). Default: 0. </p> </li> <li> <p>
|
|||
|
|
* <code>MaximumMessageSize</code> – The limit of how many bytes a message can
|
|||
|
|
* contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
|
|||
|
|
* (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). </p> </li>
|
|||
|
|
* <li> <p> <code>MessageRetentionPeriod</code> – The length of time, in seconds,
|
|||
|
|
* for which Amazon SQS retains a message. Valid values: An integer representing
|
|||
|
|
* seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).
|
|||
|
|
* </p> </li> <li> <p> <code>Policy</code> – The queue's policy. A valid AWS
|
|||
|
|
* policy. For more information about policy structure, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview
|
|||
|
|
* of AWS IAM Policies</a> in the <i>Amazon IAM User Guide</i>. </p> </li> <li> <p>
|
|||
|
|
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in seconds, for
|
|||
|
|
* which a <code> <a>ReceiveMessage</a> </code> action waits for a message to
|
|||
|
|
* arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0. </p> </li>
|
|||
|
|
* <li> <p> <code>RedrivePolicy</code> – The string that includes the parameters
|
|||
|
|
* for the dead-letter queue functionality of the source queue as a JSON object.
|
|||
|
|
* For more information about the redrive policy and dead-letter queues, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">Using
|
|||
|
|
* Amazon SQS Dead-Letter Queues</a> in the <i>Amazon Simple Queue Service
|
|||
|
|
* Developer Guide</i>.</p> <ul> <li> <p> <code>deadLetterTargetArn</code> – The
|
|||
|
|
* Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves
|
|||
|
|
* messages after the value of <code>maxReceiveCount</code> is exceeded.</p> </li>
|
|||
|
|
* <li> <p> <code>maxReceiveCount</code> – The number of times a message is
|
|||
|
|
* delivered to the source queue before being moved to the dead-letter queue. When
|
|||
|
|
* the <code>ReceiveCount</code> for a message exceeds the
|
|||
|
|
* <code>maxReceiveCount</code> for a queue, Amazon SQS moves the message to the
|
|||
|
|
* dead-letter-queue.</p> </li> </ul> <p>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.</p> </li> <li> <p>
|
|||
|
|
* <code>VisibilityTimeout</code> – The visibility timeout for the queue, in
|
|||
|
|
* seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For
|
|||
|
|
* more information about the visibility timeout, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility
|
|||
|
|
* Timeout</a> in the <i>Amazon Simple Queue Service Developer Guide</i>.</p> </li>
|
|||
|
|
* </ul> <p>The following attributes apply only to <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html">server-side-encryption</a>:</p>
|
|||
|
|
* <ul> <li> <p> <code>KmsMasterKeyId</code> – The ID of an AWS-managed customer
|
|||
|
|
* master key (CMK) for Amazon SQS or a custom CMK. For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key
|
|||
|
|
* Terms</a>. While the alias of the AWS-managed CMK for Amazon SQS is always
|
|||
|
|
* <code>alias/aws/sqs</code>, the alias of a custom CMK can, for example, be
|
|||
|
|
* <code>alias/<i>MyAlias</i> </code>. For more examples, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a>
|
|||
|
|
* in the <i>AWS Key Management Service API Reference</i>. </p> </li> <li> <p>
|
|||
|
|
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in seconds, for
|
|||
|
|
* which Amazon SQS can reuse a <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data
|
|||
|
|
* key</a> to encrypt or decrypt messages before calling AWS KMS again. An integer
|
|||
|
|
* representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
|||
|
|
* hours). Default: 300 (5 minutes). A shorter time period provides better security
|
|||
|
|
* but results in more calls to KMS which might incur charges after Free Tier. For
|
|||
|
|
* more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work">How
|
|||
|
|
* Does the Data Key Reuse Period Work?</a>. </p> </li> </ul> <p>The following
|
|||
|
|
* attribute applies only to <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO
|
|||
|
|
* (first-in-first-out) queues</a>:</p> <ul> <li> <p>
|
|||
|
|
* <code>ContentBasedDeduplication</code> – Enables content-based deduplication.
|
|||
|
|
* For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing">Exactly-Once
|
|||
|
|
* Processing</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. </p>
|
|||
|
|
* <ul> <li> <p>Every message must have a unique
|
|||
|
|
* <code>MessageDeduplicationId</code>,</p> <ul> <li> <p>You may provide a
|
|||
|
|
* <code>MessageDeduplicationId</code> explicitly.</p> </li> <li> <p>If you aren't
|
|||
|
|
* able to provide a <code>MessageDeduplicationId</code> and you enable
|
|||
|
|
* <code>ContentBasedDeduplication</code> for your queue, Amazon SQS uses a SHA-256
|
|||
|
|
* hash to generate the <code>MessageDeduplicationId</code> using the body of the
|
|||
|
|
* message (but not the attributes of the message). </p> </li> <li> <p>If you don't
|
|||
|
|
* provide a <code>MessageDeduplicationId</code> and the queue doesn't have
|
|||
|
|
* <code>ContentBasedDeduplication</code> set, the action fails with an error.</p>
|
|||
|
|
* </li> <li> <p>If the queue has <code>ContentBasedDeduplication</code> set, your
|
|||
|
|
* <code>MessageDeduplicationId</code> overrides the generated one.</p> </li> </ul>
|
|||
|
|
* </li> <li> <p>When <code>ContentBasedDeduplication</code> is in effect, messages
|
|||
|
|
* with identical content sent within the deduplication interval are treated as
|
|||
|
|
* duplicates and only one copy of the message is delivered.</p> </li> <li> <p>If
|
|||
|
|
* you send one message with <code>ContentBasedDeduplication</code> enabled and
|
|||
|
|
* then another message with a <code>MessageDeduplicationId</code> that is the same
|
|||
|
|
* as the one generated for the first <code>MessageDeduplicationId</code>, the two
|
|||
|
|
* messages are treated as duplicates and only one copy of the message is
|
|||
|
|
* delivered. </p> </li> </ul> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline SetQueueAttributesRequest& AddAttributes(const QueueAttributeName& key, Aws::String&& value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, std::move(value)); return *this; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map of attributes to set.</p> <p>The following lists the names,
|
|||
|
|
* descriptions, and values of the special request parameters that the
|
|||
|
|
* <code>SetQueueAttributes</code> action uses:</p> <ul> <li> <p>
|
|||
|
|
* <code>DelaySeconds</code> – The length of time, in seconds, for which the
|
|||
|
|
* delivery of all messages in the queue is delayed. Valid values: An integer from
|
|||
|
|
* 0 to 900 (15 minutes). Default: 0. </p> </li> <li> <p>
|
|||
|
|
* <code>MaximumMessageSize</code> – The limit of how many bytes a message can
|
|||
|
|
* contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
|
|||
|
|
* (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). </p> </li>
|
|||
|
|
* <li> <p> <code>MessageRetentionPeriod</code> – The length of time, in seconds,
|
|||
|
|
* for which Amazon SQS retains a message. Valid values: An integer representing
|
|||
|
|
* seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).
|
|||
|
|
* </p> </li> <li> <p> <code>Policy</code> – The queue's policy. A valid AWS
|
|||
|
|
* policy. For more information about policy structure, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview
|
|||
|
|
* of AWS IAM Policies</a> in the <i>Amazon IAM User Guide</i>. </p> </li> <li> <p>
|
|||
|
|
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in seconds, for
|
|||
|
|
* which a <code> <a>ReceiveMessage</a> </code> action waits for a message to
|
|||
|
|
* arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0. </p> </li>
|
|||
|
|
* <li> <p> <code>RedrivePolicy</code> – The string that includes the parameters
|
|||
|
|
* for the dead-letter queue functionality of the source queue as a JSON object.
|
|||
|
|
* For more information about the redrive policy and dead-letter queues, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">Using
|
|||
|
|
* Amazon SQS Dead-Letter Queues</a> in the <i>Amazon Simple Queue Service
|
|||
|
|
* Developer Guide</i>.</p> <ul> <li> <p> <code>deadLetterTargetArn</code> – The
|
|||
|
|
* Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves
|
|||
|
|
* messages after the value of <code>maxReceiveCount</code> is exceeded.</p> </li>
|
|||
|
|
* <li> <p> <code>maxReceiveCount</code> – The number of times a message is
|
|||
|
|
* delivered to the source queue before being moved to the dead-letter queue. When
|
|||
|
|
* the <code>ReceiveCount</code> for a message exceeds the
|
|||
|
|
* <code>maxReceiveCount</code> for a queue, Amazon SQS moves the message to the
|
|||
|
|
* dead-letter-queue.</p> </li> </ul> <p>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.</p> </li> <li> <p>
|
|||
|
|
* <code>VisibilityTimeout</code> – The visibility timeout for the queue, in
|
|||
|
|
* seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For
|
|||
|
|
* more information about the visibility timeout, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility
|
|||
|
|
* Timeout</a> in the <i>Amazon Simple Queue Service Developer Guide</i>.</p> </li>
|
|||
|
|
* </ul> <p>The following attributes apply only to <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html">server-side-encryption</a>:</p>
|
|||
|
|
* <ul> <li> <p> <code>KmsMasterKeyId</code> – The ID of an AWS-managed customer
|
|||
|
|
* master key (CMK) for Amazon SQS or a custom CMK. For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key
|
|||
|
|
* Terms</a>. While the alias of the AWS-managed CMK for Amazon SQS is always
|
|||
|
|
* <code>alias/aws/sqs</code>, the alias of a custom CMK can, for example, be
|
|||
|
|
* <code>alias/<i>MyAlias</i> </code>. For more examples, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a>
|
|||
|
|
* in the <i>AWS Key Management Service API Reference</i>. </p> </li> <li> <p>
|
|||
|
|
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in seconds, for
|
|||
|
|
* which Amazon SQS can reuse a <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data
|
|||
|
|
* key</a> to encrypt or decrypt messages before calling AWS KMS again. An integer
|
|||
|
|
* representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
|||
|
|
* hours). Default: 300 (5 minutes). A shorter time period provides better security
|
|||
|
|
* but results in more calls to KMS which might incur charges after Free Tier. For
|
|||
|
|
* more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work">How
|
|||
|
|
* Does the Data Key Reuse Period Work?</a>. </p> </li> </ul> <p>The following
|
|||
|
|
* attribute applies only to <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO
|
|||
|
|
* (first-in-first-out) queues</a>:</p> <ul> <li> <p>
|
|||
|
|
* <code>ContentBasedDeduplication</code> – Enables content-based deduplication.
|
|||
|
|
* For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing">Exactly-Once
|
|||
|
|
* Processing</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. </p>
|
|||
|
|
* <ul> <li> <p>Every message must have a unique
|
|||
|
|
* <code>MessageDeduplicationId</code>,</p> <ul> <li> <p>You may provide a
|
|||
|
|
* <code>MessageDeduplicationId</code> explicitly.</p> </li> <li> <p>If you aren't
|
|||
|
|
* able to provide a <code>MessageDeduplicationId</code> and you enable
|
|||
|
|
* <code>ContentBasedDeduplication</code> for your queue, Amazon SQS uses a SHA-256
|
|||
|
|
* hash to generate the <code>MessageDeduplicationId</code> using the body of the
|
|||
|
|
* message (but not the attributes of the message). </p> </li> <li> <p>If you don't
|
|||
|
|
* provide a <code>MessageDeduplicationId</code> and the queue doesn't have
|
|||
|
|
* <code>ContentBasedDeduplication</code> set, the action fails with an error.</p>
|
|||
|
|
* </li> <li> <p>If the queue has <code>ContentBasedDeduplication</code> set, your
|
|||
|
|
* <code>MessageDeduplicationId</code> overrides the generated one.</p> </li> </ul>
|
|||
|
|
* </li> <li> <p>When <code>ContentBasedDeduplication</code> is in effect, messages
|
|||
|
|
* with identical content sent within the deduplication interval are treated as
|
|||
|
|
* duplicates and only one copy of the message is delivered.</p> </li> <li> <p>If
|
|||
|
|
* you send one message with <code>ContentBasedDeduplication</code> enabled and
|
|||
|
|
* then another message with a <code>MessageDeduplicationId</code> that is the same
|
|||
|
|
* as the one generated for the first <code>MessageDeduplicationId</code>, the two
|
|||
|
|
* messages are treated as duplicates and only one copy of the message is
|
|||
|
|
* delivered. </p> </li> </ul> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline SetQueueAttributesRequest& AddAttributes(QueueAttributeName&& key, Aws::String&& value) { m_attributesHasBeenSet = true; m_attributes.emplace(std::move(key), std::move(value)); return *this; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map of attributes to set.</p> <p>The following lists the names,
|
|||
|
|
* descriptions, and values of the special request parameters that the
|
|||
|
|
* <code>SetQueueAttributes</code> action uses:</p> <ul> <li> <p>
|
|||
|
|
* <code>DelaySeconds</code> – The length of time, in seconds, for which the
|
|||
|
|
* delivery of all messages in the queue is delayed. Valid values: An integer from
|
|||
|
|
* 0 to 900 (15 minutes). Default: 0. </p> </li> <li> <p>
|
|||
|
|
* <code>MaximumMessageSize</code> – The limit of how many bytes a message can
|
|||
|
|
* contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
|
|||
|
|
* (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). </p> </li>
|
|||
|
|
* <li> <p> <code>MessageRetentionPeriod</code> – The length of time, in seconds,
|
|||
|
|
* for which Amazon SQS retains a message. Valid values: An integer representing
|
|||
|
|
* seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).
|
|||
|
|
* </p> </li> <li> <p> <code>Policy</code> – The queue's policy. A valid AWS
|
|||
|
|
* policy. For more information about policy structure, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview
|
|||
|
|
* of AWS IAM Policies</a> in the <i>Amazon IAM User Guide</i>. </p> </li> <li> <p>
|
|||
|
|
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in seconds, for
|
|||
|
|
* which a <code> <a>ReceiveMessage</a> </code> action waits for a message to
|
|||
|
|
* arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0. </p> </li>
|
|||
|
|
* <li> <p> <code>RedrivePolicy</code> – The string that includes the parameters
|
|||
|
|
* for the dead-letter queue functionality of the source queue as a JSON object.
|
|||
|
|
* For more information about the redrive policy and dead-letter queues, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">Using
|
|||
|
|
* Amazon SQS Dead-Letter Queues</a> in the <i>Amazon Simple Queue Service
|
|||
|
|
* Developer Guide</i>.</p> <ul> <li> <p> <code>deadLetterTargetArn</code> – The
|
|||
|
|
* Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves
|
|||
|
|
* messages after the value of <code>maxReceiveCount</code> is exceeded.</p> </li>
|
|||
|
|
* <li> <p> <code>maxReceiveCount</code> – The number of times a message is
|
|||
|
|
* delivered to the source queue before being moved to the dead-letter queue. When
|
|||
|
|
* the <code>ReceiveCount</code> for a message exceeds the
|
|||
|
|
* <code>maxReceiveCount</code> for a queue, Amazon SQS moves the message to the
|
|||
|
|
* dead-letter-queue.</p> </li> </ul> <p>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.</p> </li> <li> <p>
|
|||
|
|
* <code>VisibilityTimeout</code> – The visibility timeout for the queue, in
|
|||
|
|
* seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For
|
|||
|
|
* more information about the visibility timeout, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility
|
|||
|
|
* Timeout</a> in the <i>Amazon Simple Queue Service Developer Guide</i>.</p> </li>
|
|||
|
|
* </ul> <p>The following attributes apply only to <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html">server-side-encryption</a>:</p>
|
|||
|
|
* <ul> <li> <p> <code>KmsMasterKeyId</code> – The ID of an AWS-managed customer
|
|||
|
|
* master key (CMK) for Amazon SQS or a custom CMK. For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key
|
|||
|
|
* Terms</a>. While the alias of the AWS-managed CMK for Amazon SQS is always
|
|||
|
|
* <code>alias/aws/sqs</code>, the alias of a custom CMK can, for example, be
|
|||
|
|
* <code>alias/<i>MyAlias</i> </code>. For more examples, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a>
|
|||
|
|
* in the <i>AWS Key Management Service API Reference</i>. </p> </li> <li> <p>
|
|||
|
|
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in seconds, for
|
|||
|
|
* which Amazon SQS can reuse a <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data
|
|||
|
|
* key</a> to encrypt or decrypt messages before calling AWS KMS again. An integer
|
|||
|
|
* representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
|||
|
|
* hours). Default: 300 (5 minutes). A shorter time period provides better security
|
|||
|
|
* but results in more calls to KMS which might incur charges after Free Tier. For
|
|||
|
|
* more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work">How
|
|||
|
|
* Does the Data Key Reuse Period Work?</a>. </p> </li> </ul> <p>The following
|
|||
|
|
* attribute applies only to <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO
|
|||
|
|
* (first-in-first-out) queues</a>:</p> <ul> <li> <p>
|
|||
|
|
* <code>ContentBasedDeduplication</code> – Enables content-based deduplication.
|
|||
|
|
* For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing">Exactly-Once
|
|||
|
|
* Processing</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. </p>
|
|||
|
|
* <ul> <li> <p>Every message must have a unique
|
|||
|
|
* <code>MessageDeduplicationId</code>,</p> <ul> <li> <p>You may provide a
|
|||
|
|
* <code>MessageDeduplicationId</code> explicitly.</p> </li> <li> <p>If you aren't
|
|||
|
|
* able to provide a <code>MessageDeduplicationId</code> and you enable
|
|||
|
|
* <code>ContentBasedDeduplication</code> for your queue, Amazon SQS uses a SHA-256
|
|||
|
|
* hash to generate the <code>MessageDeduplicationId</code> using the body of the
|
|||
|
|
* message (but not the attributes of the message). </p> </li> <li> <p>If you don't
|
|||
|
|
* provide a <code>MessageDeduplicationId</code> and the queue doesn't have
|
|||
|
|
* <code>ContentBasedDeduplication</code> set, the action fails with an error.</p>
|
|||
|
|
* </li> <li> <p>If the queue has <code>ContentBasedDeduplication</code> set, your
|
|||
|
|
* <code>MessageDeduplicationId</code> overrides the generated one.</p> </li> </ul>
|
|||
|
|
* </li> <li> <p>When <code>ContentBasedDeduplication</code> is in effect, messages
|
|||
|
|
* with identical content sent within the deduplication interval are treated as
|
|||
|
|
* duplicates and only one copy of the message is delivered.</p> </li> <li> <p>If
|
|||
|
|
* you send one message with <code>ContentBasedDeduplication</code> enabled and
|
|||
|
|
* then another message with a <code>MessageDeduplicationId</code> that is the same
|
|||
|
|
* as the one generated for the first <code>MessageDeduplicationId</code>, the two
|
|||
|
|
* messages are treated as duplicates and only one copy of the message is
|
|||
|
|
* delivered. </p> </li> </ul> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline SetQueueAttributesRequest& AddAttributes(QueueAttributeName&& key, const char* value) { m_attributesHasBeenSet = true; m_attributes.emplace(std::move(key), value); return *this; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map of attributes to set.</p> <p>The following lists the names,
|
|||
|
|
* descriptions, and values of the special request parameters that the
|
|||
|
|
* <code>SetQueueAttributes</code> action uses:</p> <ul> <li> <p>
|
|||
|
|
* <code>DelaySeconds</code> – The length of time, in seconds, for which the
|
|||
|
|
* delivery of all messages in the queue is delayed. Valid values: An integer from
|
|||
|
|
* 0 to 900 (15 minutes). Default: 0. </p> </li> <li> <p>
|
|||
|
|
* <code>MaximumMessageSize</code> – The limit of how many bytes a message can
|
|||
|
|
* contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
|
|||
|
|
* (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). </p> </li>
|
|||
|
|
* <li> <p> <code>MessageRetentionPeriod</code> – The length of time, in seconds,
|
|||
|
|
* for which Amazon SQS retains a message. Valid values: An integer representing
|
|||
|
|
* seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).
|
|||
|
|
* </p> </li> <li> <p> <code>Policy</code> – The queue's policy. A valid AWS
|
|||
|
|
* policy. For more information about policy structure, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview
|
|||
|
|
* of AWS IAM Policies</a> in the <i>Amazon IAM User Guide</i>. </p> </li> <li> <p>
|
|||
|
|
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in seconds, for
|
|||
|
|
* which a <code> <a>ReceiveMessage</a> </code> action waits for a message to
|
|||
|
|
* arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0. </p> </li>
|
|||
|
|
* <li> <p> <code>RedrivePolicy</code> – The string that includes the parameters
|
|||
|
|
* for the dead-letter queue functionality of the source queue as a JSON object.
|
|||
|
|
* For more information about the redrive policy and dead-letter queues, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">Using
|
|||
|
|
* Amazon SQS Dead-Letter Queues</a> in the <i>Amazon Simple Queue Service
|
|||
|
|
* Developer Guide</i>.</p> <ul> <li> <p> <code>deadLetterTargetArn</code> – The
|
|||
|
|
* Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves
|
|||
|
|
* messages after the value of <code>maxReceiveCount</code> is exceeded.</p> </li>
|
|||
|
|
* <li> <p> <code>maxReceiveCount</code> – The number of times a message is
|
|||
|
|
* delivered to the source queue before being moved to the dead-letter queue. When
|
|||
|
|
* the <code>ReceiveCount</code> for a message exceeds the
|
|||
|
|
* <code>maxReceiveCount</code> for a queue, Amazon SQS moves the message to the
|
|||
|
|
* dead-letter-queue.</p> </li> </ul> <p>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.</p> </li> <li> <p>
|
|||
|
|
* <code>VisibilityTimeout</code> – The visibility timeout for the queue, in
|
|||
|
|
* seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For
|
|||
|
|
* more information about the visibility timeout, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility
|
|||
|
|
* Timeout</a> in the <i>Amazon Simple Queue Service Developer Guide</i>.</p> </li>
|
|||
|
|
* </ul> <p>The following attributes apply only to <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html">server-side-encryption</a>:</p>
|
|||
|
|
* <ul> <li> <p> <code>KmsMasterKeyId</code> – The ID of an AWS-managed customer
|
|||
|
|
* master key (CMK) for Amazon SQS or a custom CMK. For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key
|
|||
|
|
* Terms</a>. While the alias of the AWS-managed CMK for Amazon SQS is always
|
|||
|
|
* <code>alias/aws/sqs</code>, the alias of a custom CMK can, for example, be
|
|||
|
|
* <code>alias/<i>MyAlias</i> </code>. For more examples, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a>
|
|||
|
|
* in the <i>AWS Key Management Service API Reference</i>. </p> </li> <li> <p>
|
|||
|
|
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in seconds, for
|
|||
|
|
* which Amazon SQS can reuse a <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data
|
|||
|
|
* key</a> to encrypt or decrypt messages before calling AWS KMS again. An integer
|
|||
|
|
* representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
|||
|
|
* hours). Default: 300 (5 minutes). A shorter time period provides better security
|
|||
|
|
* but results in more calls to KMS which might incur charges after Free Tier. For
|
|||
|
|
* more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work">How
|
|||
|
|
* Does the Data Key Reuse Period Work?</a>. </p> </li> </ul> <p>The following
|
|||
|
|
* attribute applies only to <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO
|
|||
|
|
* (first-in-first-out) queues</a>:</p> <ul> <li> <p>
|
|||
|
|
* <code>ContentBasedDeduplication</code> – Enables content-based deduplication.
|
|||
|
|
* For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing">Exactly-Once
|
|||
|
|
* Processing</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. </p>
|
|||
|
|
* <ul> <li> <p>Every message must have a unique
|
|||
|
|
* <code>MessageDeduplicationId</code>,</p> <ul> <li> <p>You may provide a
|
|||
|
|
* <code>MessageDeduplicationId</code> explicitly.</p> </li> <li> <p>If you aren't
|
|||
|
|
* able to provide a <code>MessageDeduplicationId</code> and you enable
|
|||
|
|
* <code>ContentBasedDeduplication</code> for your queue, Amazon SQS uses a SHA-256
|
|||
|
|
* hash to generate the <code>MessageDeduplicationId</code> using the body of the
|
|||
|
|
* message (but not the attributes of the message). </p> </li> <li> <p>If you don't
|
|||
|
|
* provide a <code>MessageDeduplicationId</code> and the queue doesn't have
|
|||
|
|
* <code>ContentBasedDeduplication</code> set, the action fails with an error.</p>
|
|||
|
|
* </li> <li> <p>If the queue has <code>ContentBasedDeduplication</code> set, your
|
|||
|
|
* <code>MessageDeduplicationId</code> overrides the generated one.</p> </li> </ul>
|
|||
|
|
* </li> <li> <p>When <code>ContentBasedDeduplication</code> is in effect, messages
|
|||
|
|
* with identical content sent within the deduplication interval are treated as
|
|||
|
|
* duplicates and only one copy of the message is delivered.</p> </li> <li> <p>If
|
|||
|
|
* you send one message with <code>ContentBasedDeduplication</code> enabled and
|
|||
|
|
* then another message with a <code>MessageDeduplicationId</code> that is the same
|
|||
|
|
* as the one generated for the first <code>MessageDeduplicationId</code>, the two
|
|||
|
|
* messages are treated as duplicates and only one copy of the message is
|
|||
|
|
* delivered. </p> </li> </ul> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline SetQueueAttributesRequest& AddAttributes(const QueueAttributeName& key, const char* value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, value); return *this; }
|
|||
|
|
|
|||
|
|
private:
|
|||
|
|
|
|||
|
|
Aws::String m_queueUrl;
|
|||
|
|
bool m_queueUrlHasBeenSet;
|
|||
|
|
|
|||
|
|
Aws::Map<QueueAttributeName, Aws::String> m_attributes;
|
|||
|
|
bool m_attributesHasBeenSet;
|
|||
|
|
};
|
|||
|
|
|
|||
|
|
} // namespace Model
|
|||
|
|
} // namespace SQS
|
|||
|
|
} // namespace Aws
|