com.amazonaws.services.sqs.model.SetQueueAttributesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sqs Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.sqs.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SetQueueAttributesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The URL of the Amazon SQS queue whose attributes are set.
*
*
* Queue URLs and names are case-sensitive.
*
*/
private String queueUrl;
/**
*
* A map of attributes to set.
*
*
* The following lists the names, descriptions, and values of the special request parameters that the
* SetQueueAttributes action uses:
*
*
* -
*
* DelaySeconds – 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.
*
*
* -
*
* MaximumMessageSize – 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).
*
*
* -
*
* MessageRetentionPeriod – 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). When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to
* propagate throughout the Amazon SQS system. Changes made to the MessageRetentionPeriod attribute can
* take up to 15 minutes and will impact existing messages in the queue potentially causing them to be expired and
* deleted if the MessageRetentionPeriod is reduced below the age of existing messages.
*
*
* -
*
* Policy – The queue's policy. A valid Amazon Web Services policy. For more information about policy
* structure, see Overview of
* Amazon Web Services IAM Policies in the Identity and Access Management User Guide.
*
*
* -
*
* ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a
* ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to 20
* (seconds). Default: 0.
*
*
* -
*
* VisibilityTimeout – 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 Visibility Timeout in the Amazon SQS Developer Guide.
*
*
*
*
* The following attributes apply only to dead-letter queues:
*
*
* -
*
* RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of
* the source queue as a JSON object. The parameters are as follows:
*
*
* -
*
* deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS
* moves messages after the value of maxReceiveCount is exceeded.
*
*
* -
*
* maxReceiveCount – The number of times a message is delivered to the source queue before being moved
* to the dead-letter queue. Default: 10. When the ReceiveCount for a message exceeds the
* maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
*
*
*
*
* -
*
* RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter
* queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters
* are as follows:
*
*
* -
*
* redrivePermission – The permission type that defines which source queues can specify the current
* queue as the dead-letter queue. Valid values are:
*
*
* -
*
* allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can
* specify this queue as the dead-letter queue.
*
*
* -
*
* denyAll – No source queues can specify this queue as the dead-letter queue.
*
*
* -
*
* byQueue – Only queues specified by the sourceQueueArns parameter can specify this queue
* as the dead-letter queue.
*
*
*
*
* -
*
* sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify this queue
* as the dead-letter queue and redrive messages. You can specify this parameter only when the
* redrivePermission parameter is set to byQueue. You can specify up to 10 source queue
* ARNs. To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission
* parameter to allowAll.
*
*
*
*
*
*
*
* 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.
*
*
*
* The following attributes apply only to server-side-encryption:
*
*
* -
*
* KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS
* or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the
* alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the Key Management Service API Reference.
*
*
* -
*
* KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or
* decrypt messages before calling 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 How Does the Data Key Reuse Period Work?.
*
*
* -
*
* SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only
* one server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS).
*
*
*
*
* The following attribute applies only to FIFO
* (first-in-first-out) queues:
*
*
* -
*
* ContentBasedDeduplication – Enables content-based deduplication. For more information, see Exactly-once processing in the Amazon SQS Developer Guide. Note the following:
*
*
* -
*
* Every message must have a unique MessageDeduplicationId.
*
*
* -
*
* You may provide a MessageDeduplicationId explicitly.
*
*
* -
*
* If you aren't able to provide a MessageDeduplicationId and you enable
* ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the
* MessageDeduplicationId using the body of the message (but not the attributes of the message).
*
*
* -
*
* If you don't provide a MessageDeduplicationId and the queue doesn't have
* ContentBasedDeduplication set, the action fails with an error.
*
*
* -
*
* If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides
* the generated one.
*
*
*
*
* -
*
* When ContentBasedDeduplication 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.
*
*
* -
*
* If you send one message with ContentBasedDeduplication enabled and then another message with a
* MessageDeduplicationId that is the same as the one generated for the first
* MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message
* is delivered.
*
*
*
*
*
*
* The following attributes apply only to high
* throughput for FIFO queues:
*
*
* -
*
* DeduplicationScope – Specifies whether message deduplication occurs at the message group or queue
* level. Valid values are messageGroup and queue.
*
*
* -
*
* FifoThroughputLimit – Specifies whether the FIFO queue throughput quota applies to the entire queue
* or per message group. Valid values are perQueue and perMessageGroupId. The
* perMessageGroupId value is allowed only when the value for DeduplicationScope is
* messageGroup.
*
*
*
*
* To enable high throughput for FIFO queues, do the following:
*
*
* -
*
* Set DeduplicationScope to messageGroup.
*
*
* -
*
* Set FifoThroughputLimit to perMessageGroupId.
*
*
*
*
* If you set these attributes to anything other than the values shown for enabling high throughput, normal
* throughput is in effect and deduplication occurs as specified.
*
*
* For information on throughput quotas, see Quotas
* related to messages in the Amazon SQS Developer Guide.
*
*/
private com.amazonaws.internal.SdkInternalMap attributes;
/**
* Default constructor for SetQueueAttributesRequest object. Callers should use the setter or fluent setter
* (with...) methods to initialize the object after creating it.
*/
public SetQueueAttributesRequest() {
}
/**
* Constructs a new SetQueueAttributesRequest object. Callers should use the setter or fluent setter (with...)
* methods to initialize any additional object members.
*
* @param queueUrl
* The URL of the Amazon SQS queue whose attributes are set.
*
* Queue URLs and names are case-sensitive.
* @param attributes
* A map of attributes to set.
*
*
* The following lists the names, descriptions, and values of the special request parameters that the
* SetQueueAttributes action uses:
*
*
* -
*
* DelaySeconds – 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.
*
*
* -
*
* MaximumMessageSize – 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).
*
*
* -
*
* MessageRetentionPeriod – 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). When you change a queue's attributes, the change can take up to 60 seconds for
* most of the attributes to propagate throughout the Amazon SQS system. Changes made to the
* MessageRetentionPeriod attribute can take up to 15 minutes and will impact existing messages
* in the queue potentially causing them to be expired and deleted if the MessageRetentionPeriod
* is reduced below the age of existing messages.
*
*
* -
*
* Policy – The queue's policy. A valid Amazon Web Services policy. For more information about
* policy structure, see Overview of Amazon Web
* Services IAM Policies in the Identity and Access Management User Guide.
*
*
* -
*
* ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a
* ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0
* to 20 (seconds). Default: 0.
*
*
* -
*
* VisibilityTimeout – 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
* Visibility Timeout in the Amazon SQS Developer Guide.
*
*
*
*
* The following attributes apply only to dead-letter queues:
*
*
* -
*
* RedrivePolicy – The string that includes the parameters for the dead-letter queue
* functionality of the source queue as a JSON object. The parameters are as follows:
*
*
* -
*
* deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon
* SQS moves messages after the value of maxReceiveCount is exceeded.
*
*
* -
*
* maxReceiveCount – The number of times a message is delivered to the source queue before being
* moved to the dead-letter queue. Default: 10. When the ReceiveCount for a message exceeds the
* maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
*
*
*
*
* -
*
* RedriveAllowPolicy – The string that includes the parameters for the permissions for the
* dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON
* object. The parameters are as follows:
*
*
* -
*
* redrivePermission – The permission type that defines which source queues can specify the
* current queue as the dead-letter queue. Valid values are:
*
*
* -
*
* allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region
* can specify this queue as the dead-letter queue.
*
*
* -
*
* denyAll – No source queues can specify this queue as the dead-letter queue.
*
*
* -
*
* byQueue – Only queues specified by the sourceQueueArns parameter can specify
* this queue as the dead-letter queue.
*
*
*
*
* -
*
* sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify this
* queue as the dead-letter queue and redrive messages. You can specify this parameter only when the
* redrivePermission parameter is set to byQueue. You can specify up to 10 source
* queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the
* redrivePermission parameter to allowAll.
*
*
*
*
*
*
*
* 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.
*
*
*
* The following attributes apply only to server-side-encryption:
*
*
* -
*
* KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for
* Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs
* , the alias of a custom CMK can, for example, be alias/MyAlias . For more examples,
* see KeyId in the Key Management Service API Reference.
*
*
* -
*
* KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse
* a data key to
* encrypt or decrypt messages before calling 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 How Does the Data Key Reuse Period Work?.
*
*
* -
*
* SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys.
* Only one server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS).
*
*
*
*
* The following attribute applies only to FIFO
* (first-in-first-out) queues:
*
*
* -
*
* ContentBasedDeduplication – Enables content-based deduplication. For more information, see Exactly-once processing in the Amazon SQS Developer Guide. Note the following:
*
*
* -
*
* Every message must have a unique MessageDeduplicationId.
*
*
* -
*
* You may provide a MessageDeduplicationId explicitly.
*
*
* -
*
* If you aren't able to provide a MessageDeduplicationId and you enable
* ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the
* MessageDeduplicationId using the body of the message (but not the attributes of the message).
*
*
* -
*
* If you don't provide a MessageDeduplicationId and the queue doesn't have
* ContentBasedDeduplication set, the action fails with an error.
*
*
* -
*
* If the queue has ContentBasedDeduplication set, your MessageDeduplicationId
* overrides the generated one.
*
*
*
*
* -
*
* When ContentBasedDeduplication 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.
*
*
* -
*
* If you send one message with ContentBasedDeduplication enabled and then another message with
* a MessageDeduplicationId that is the same as the one generated for the first
* MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the
* message is delivered.
*
*
*
*
*
*
* The following attributes apply only to high throughput for FIFO queues:
*
*
* -
*
* DeduplicationScope – Specifies whether message deduplication occurs at the message group or
* queue level. Valid values are messageGroup and queue.
*
*
* -
*
* FifoThroughputLimit – Specifies whether the FIFO queue throughput quota applies to the entire
* queue or per message group. Valid values are perQueue and perMessageGroupId. The
* perMessageGroupId value is allowed only when the value for DeduplicationScope is
* messageGroup.
*
*
*
*
* To enable high throughput for FIFO queues, do the following:
*
*
* -
*
* Set DeduplicationScope to messageGroup.
*
*
* -
*
* Set FifoThroughputLimit to perMessageGroupId.
*
*
*
*
* If you set these attributes to anything other than the values shown for enabling high throughput, normal
* throughput is in effect and deduplication occurs as specified.
*
*
* For information on throughput quotas, see Quotas related to messages in the Amazon SQS Developer Guide.
*/
public SetQueueAttributesRequest(String queueUrl, java.util.Map attributes) {
setQueueUrl(queueUrl);
setAttributes(attributes);
}
/**
*
* The URL of the Amazon SQS queue whose attributes are set.
*
*
* Queue URLs and names are case-sensitive.
*
*
* @param queueUrl
* The URL of the Amazon SQS queue whose attributes are set.
*
* Queue URLs and names are case-sensitive.
*/
public void setQueueUrl(String queueUrl) {
this.queueUrl = queueUrl;
}
/**
*
* The URL of the Amazon SQS queue whose attributes are set.
*
*
* Queue URLs and names are case-sensitive.
*
*
* @return The URL of the Amazon SQS queue whose attributes are set.
*
* Queue URLs and names are case-sensitive.
*/
public String getQueueUrl() {
return this.queueUrl;
}
/**
*
* The URL of the Amazon SQS queue whose attributes are set.
*
*
* Queue URLs and names are case-sensitive.
*
*
* @param queueUrl
* The URL of the Amazon SQS queue whose attributes are set.
*
* Queue URLs and names are case-sensitive.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SetQueueAttributesRequest withQueueUrl(String queueUrl) {
setQueueUrl(queueUrl);
return this;
}
/**
*
* A map of attributes to set.
*
*
* The following lists the names, descriptions, and values of the special request parameters that the
* SetQueueAttributes action uses:
*
*
* -
*
* DelaySeconds – 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.
*
*
* -
*
* MaximumMessageSize – 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).
*
*
* -
*
* MessageRetentionPeriod – 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). When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to
* propagate throughout the Amazon SQS system. Changes made to the MessageRetentionPeriod attribute can
* take up to 15 minutes and will impact existing messages in the queue potentially causing them to be expired and
* deleted if the MessageRetentionPeriod is reduced below the age of existing messages.
*
*
* -
*
* Policy – The queue's policy. A valid Amazon Web Services policy. For more information about policy
* structure, see Overview of
* Amazon Web Services IAM Policies in the Identity and Access Management User Guide.
*
*
* -
*
* ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a
* ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to 20
* (seconds). Default: 0.
*
*
* -
*
* VisibilityTimeout – 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 Visibility Timeout in the Amazon SQS Developer Guide.
*
*
*
*
* The following attributes apply only to dead-letter queues:
*
*
* -
*
* RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of
* the source queue as a JSON object. The parameters are as follows:
*
*
* -
*
* deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS
* moves messages after the value of maxReceiveCount is exceeded.
*
*
* -
*
* maxReceiveCount – The number of times a message is delivered to the source queue before being moved
* to the dead-letter queue. Default: 10. When the ReceiveCount for a message exceeds the
* maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
*
*
*
*
* -
*
* RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter
* queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters
* are as follows:
*
*
* -
*
* redrivePermission – The permission type that defines which source queues can specify the current
* queue as the dead-letter queue. Valid values are:
*
*
* -
*
* allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can
* specify this queue as the dead-letter queue.
*
*
* -
*
* denyAll – No source queues can specify this queue as the dead-letter queue.
*
*
* -
*
* byQueue – Only queues specified by the sourceQueueArns parameter can specify this queue
* as the dead-letter queue.
*
*
*
*
* -
*
* sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify this queue
* as the dead-letter queue and redrive messages. You can specify this parameter only when the
* redrivePermission parameter is set to byQueue. You can specify up to 10 source queue
* ARNs. To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission
* parameter to allowAll.
*
*
*
*
*
*
*
* 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.
*
*
*
* The following attributes apply only to server-side-encryption:
*
*
* -
*
* KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS
* or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the
* alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the Key Management Service API Reference.
*
*
* -
*
* KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or
* decrypt messages before calling 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 How Does the Data Key Reuse Period Work?.
*
*
* -
*
* SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only
* one server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS).
*
*
*
*
* The following attribute applies only to FIFO
* (first-in-first-out) queues:
*
*
* -
*
* ContentBasedDeduplication – Enables content-based deduplication. For more information, see Exactly-once processing in the Amazon SQS Developer Guide. Note the following:
*
*
* -
*
* Every message must have a unique MessageDeduplicationId.
*
*
* -
*
* You may provide a MessageDeduplicationId explicitly.
*
*
* -
*
* If you aren't able to provide a MessageDeduplicationId and you enable
* ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the
* MessageDeduplicationId using the body of the message (but not the attributes of the message).
*
*
* -
*
* If you don't provide a MessageDeduplicationId and the queue doesn't have
* ContentBasedDeduplication set, the action fails with an error.
*
*
* -
*
* If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides
* the generated one.
*
*
*
*
* -
*
* When ContentBasedDeduplication 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.
*
*
* -
*
* If you send one message with ContentBasedDeduplication enabled and then another message with a
* MessageDeduplicationId that is the same as the one generated for the first
* MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message
* is delivered.
*
*
*
*
*
*
* The following attributes apply only to high
* throughput for FIFO queues:
*
*
* -
*
* DeduplicationScope – Specifies whether message deduplication occurs at the message group or queue
* level. Valid values are messageGroup and queue.
*
*
* -
*
* FifoThroughputLimit – Specifies whether the FIFO queue throughput quota applies to the entire queue
* or per message group. Valid values are perQueue and perMessageGroupId. The
* perMessageGroupId value is allowed only when the value for DeduplicationScope is
* messageGroup.
*
*
*
*
* To enable high throughput for FIFO queues, do the following:
*
*
* -
*
* Set DeduplicationScope to messageGroup.
*
*
* -
*
* Set FifoThroughputLimit to perMessageGroupId.
*
*
*
*
* If you set these attributes to anything other than the values shown for enabling high throughput, normal
* throughput is in effect and deduplication occurs as specified.
*
*
* For information on throughput quotas, see Quotas
* related to messages in the Amazon SQS Developer Guide.
*
*
* @return A map of attributes to set.
*
* The following lists the names, descriptions, and values of the special request parameters that the
* SetQueueAttributes action uses:
*
*
* -
*
* DelaySeconds – 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.
*
*
* -
*
* MaximumMessageSize – 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).
*
*
* -
*
* MessageRetentionPeriod – 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). When you change a queue's attributes, the change can take up to 60 seconds for
* most of the attributes to propagate throughout the Amazon SQS system. Changes made to the
* MessageRetentionPeriod attribute can take up to 15 minutes and will impact existing messages
* in the queue potentially causing them to be expired and deleted if the
* MessageRetentionPeriod is reduced below the age of existing messages.
*
*
* -
*
* Policy – The queue's policy. A valid Amazon Web Services policy. For more information about
* policy structure, see Overview of Amazon Web
* Services IAM Policies in the Identity and Access Management User Guide.
*
*
* -
*
* ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a
* ReceiveMessage action waits for a message to arrive. Valid values: An integer from
* 0 to 20 (seconds). Default: 0.
*
*
* -
*
* VisibilityTimeout – 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
* Visibility Timeout in the Amazon SQS Developer Guide.
*
*
*
*
* The following attributes apply only to dead-letter queues:
*
*
* -
*
* RedrivePolicy – The string that includes the parameters for the dead-letter queue
* functionality of the source queue as a JSON object. The parameters are as follows:
*
*
* -
*
* deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which
* Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
*
*
* -
*
* maxReceiveCount – The number of times a message is delivered to the source queue before
* being moved to the dead-letter queue. Default: 10. When the ReceiveCount for a message
* exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the
* dead-letter-queue.
*
*
*
*
* -
*
* RedriveAllowPolicy – The string that includes the parameters for the permissions for the
* dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON
* object. The parameters are as follows:
*
*
* -
*
* redrivePermission – The permission type that defines which source queues can specify the
* current queue as the dead-letter queue. Valid values are:
*
*
* -
*
* allowAll – (Default) Any source queues in this Amazon Web Services account in the same
* Region can specify this queue as the dead-letter queue.
*
*
* -
*
* denyAll – No source queues can specify this queue as the dead-letter queue.
*
*
* -
*
* byQueue – Only queues specified by the sourceQueueArns parameter can specify
* this queue as the dead-letter queue.
*
*
*
*
* -
*
* sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify
* this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the
* redrivePermission parameter is set to byQueue. You can specify up to 10 source
* queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the
* redrivePermission parameter to allowAll.
*
*
*
*
*
*
*
* 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.
*
*
*
* The following attributes apply only to server-side-encryption:
*
*
* -
*
* KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for
* Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always
* alias/aws/sqs, the alias of a custom CMK can, for example, be
* alias/MyAlias . For more examples, see KeyId in the Key Management Service API Reference.
*
*
* -
*
* KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can
* reuse a data
* key to encrypt or decrypt messages before calling 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 How Does the Data Key Reuse Period Work?.
*
*
* -
*
* SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys.
* Only one server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS).
*
*
*
*
* The following attribute applies only to FIFO
* (first-in-first-out) queues:
*
*
* -
*
* ContentBasedDeduplication – Enables content-based deduplication. For more information, see
* Exactly-once processing in the Amazon SQS Developer Guide. Note the following:
*
*
* -
*
* Every message must have a unique MessageDeduplicationId.
*
*
* -
*
* You may provide a MessageDeduplicationId explicitly.
*
*
* -
*
* If you aren't able to provide a MessageDeduplicationId and you enable
* ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the
* MessageDeduplicationId using the body of the message (but not the attributes of the
* message).
*
*
* -
*
* If you don't provide a MessageDeduplicationId and the queue doesn't have
* ContentBasedDeduplication set, the action fails with an error.
*
*
* -
*
* If the queue has ContentBasedDeduplication set, your MessageDeduplicationId
* overrides the generated one.
*
*
*
*
* -
*
* When ContentBasedDeduplication 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.
*
*
* -
*
* If you send one message with ContentBasedDeduplication enabled and then another message with
* a MessageDeduplicationId that is the same as the one generated for the first
* MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the
* message is delivered.
*
*
*
*
*
*
* The following attributes apply only to high throughput for FIFO queues:
*
*
* -
*
* DeduplicationScope – Specifies whether message deduplication occurs at the message group or
* queue level. Valid values are messageGroup and queue.
*
*
* -
*
* FifoThroughputLimit – Specifies whether the FIFO queue throughput quota applies to the
* entire queue or per message group. Valid values are perQueue and
* perMessageGroupId. The perMessageGroupId value is allowed only when the value
* for DeduplicationScope is messageGroup.
*
*
*
*
* To enable high throughput for FIFO queues, do the following:
*
*
* -
*
* Set DeduplicationScope to messageGroup.
*
*
* -
*
* Set FifoThroughputLimit to perMessageGroupId.
*
*
*
*
* If you set these attributes to anything other than the values shown for enabling high throughput, normal
* throughput is in effect and deduplication occurs as specified.
*
*
* For information on throughput quotas, see Quotas related to messages in the Amazon SQS Developer Guide.
*/
public java.util.Map getAttributes() {
if (attributes == null) {
attributes = new com.amazonaws.internal.SdkInternalMap();
}
return attributes;
}
/**
*
* A map of attributes to set.
*
*
* The following lists the names, descriptions, and values of the special request parameters that the
* SetQueueAttributes action uses:
*
*
* -
*
* DelaySeconds – 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.
*
*
* -
*
* MaximumMessageSize – 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).
*
*
* -
*
* MessageRetentionPeriod – 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). When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to
* propagate throughout the Amazon SQS system. Changes made to the MessageRetentionPeriod attribute can
* take up to 15 minutes and will impact existing messages in the queue potentially causing them to be expired and
* deleted if the MessageRetentionPeriod is reduced below the age of existing messages.
*
*
* -
*
* Policy – The queue's policy. A valid Amazon Web Services policy. For more information about policy
* structure, see Overview of
* Amazon Web Services IAM Policies in the Identity and Access Management User Guide.
*
*
* -
*
* ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a
* ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to 20
* (seconds). Default: 0.
*
*
* -
*
* VisibilityTimeout – 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 Visibility Timeout in the Amazon SQS Developer Guide.
*
*
*
*
* The following attributes apply only to dead-letter queues:
*
*
* -
*
* RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of
* the source queue as a JSON object. The parameters are as follows:
*
*
* -
*
* deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS
* moves messages after the value of maxReceiveCount is exceeded.
*
*
* -
*
* maxReceiveCount – The number of times a message is delivered to the source queue before being moved
* to the dead-letter queue. Default: 10. When the ReceiveCount for a message exceeds the
* maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
*
*
*
*
* -
*
* RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter
* queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters
* are as follows:
*
*
* -
*
* redrivePermission – The permission type that defines which source queues can specify the current
* queue as the dead-letter queue. Valid values are:
*
*
* -
*
* allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can
* specify this queue as the dead-letter queue.
*
*
* -
*
* denyAll – No source queues can specify this queue as the dead-letter queue.
*
*
* -
*
* byQueue – Only queues specified by the sourceQueueArns parameter can specify this queue
* as the dead-letter queue.
*
*
*
*
* -
*
* sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify this queue
* as the dead-letter queue and redrive messages. You can specify this parameter only when the
* redrivePermission parameter is set to byQueue. You can specify up to 10 source queue
* ARNs. To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission
* parameter to allowAll.
*
*
*
*
*
*
*
* 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.
*
*
*
* The following attributes apply only to server-side-encryption:
*
*
* -
*
* KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS
* or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the
* alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the Key Management Service API Reference.
*
*
* -
*
* KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or
* decrypt messages before calling 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 How Does the Data Key Reuse Period Work?.
*
*
* -
*
* SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only
* one server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS).
*
*
*
*
* The following attribute applies only to FIFO
* (first-in-first-out) queues:
*
*
* -
*
* ContentBasedDeduplication – Enables content-based deduplication. For more information, see Exactly-once processing in the Amazon SQS Developer Guide. Note the following:
*
*
* -
*
* Every message must have a unique MessageDeduplicationId.
*
*
* -
*
* You may provide a MessageDeduplicationId explicitly.
*
*
* -
*
* If you aren't able to provide a MessageDeduplicationId and you enable
* ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the
* MessageDeduplicationId using the body of the message (but not the attributes of the message).
*
*
* -
*
* If you don't provide a MessageDeduplicationId and the queue doesn't have
* ContentBasedDeduplication set, the action fails with an error.
*
*
* -
*
* If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides
* the generated one.
*
*
*
*
* -
*
* When ContentBasedDeduplication 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.
*
*
* -
*
* If you send one message with ContentBasedDeduplication enabled and then another message with a
* MessageDeduplicationId that is the same as the one generated for the first
* MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message
* is delivered.
*
*
*
*
*
*
* The following attributes apply only to high
* throughput for FIFO queues:
*
*
* -
*
* DeduplicationScope – Specifies whether message deduplication occurs at the message group or queue
* level. Valid values are messageGroup and queue.
*
*
* -
*
* FifoThroughputLimit – Specifies whether the FIFO queue throughput quota applies to the entire queue
* or per message group. Valid values are perQueue and perMessageGroupId. The
* perMessageGroupId value is allowed only when the value for DeduplicationScope is
* messageGroup.
*
*
*
*
* To enable high throughput for FIFO queues, do the following:
*
*
* -
*
* Set DeduplicationScope to messageGroup.
*
*
* -
*
* Set FifoThroughputLimit to perMessageGroupId.
*
*
*
*
* If you set these attributes to anything other than the values shown for enabling high throughput, normal
* throughput is in effect and deduplication occurs as specified.
*
*
* For information on throughput quotas, see Quotas
* related to messages in the Amazon SQS Developer Guide.
*
*
* @param attributes
* A map of attributes to set.
*
* The following lists the names, descriptions, and values of the special request parameters that the
* SetQueueAttributes action uses:
*
*
* -
*
* DelaySeconds – 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.
*
*
* -
*
* MaximumMessageSize – 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).
*
*
* -
*
* MessageRetentionPeriod – 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). When you change a queue's attributes, the change can take up to 60 seconds for
* most of the attributes to propagate throughout the Amazon SQS system. Changes made to the
* MessageRetentionPeriod attribute can take up to 15 minutes and will impact existing messages
* in the queue potentially causing them to be expired and deleted if the MessageRetentionPeriod
* is reduced below the age of existing messages.
*
*
* -
*
* Policy – The queue's policy. A valid Amazon Web Services policy. For more information about
* policy structure, see Overview of Amazon Web
* Services IAM Policies in the Identity and Access Management User Guide.
*
*
* -
*
* ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a
* ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0
* to 20 (seconds). Default: 0.
*
*
* -
*
* VisibilityTimeout – 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
* Visibility Timeout in the Amazon SQS Developer Guide.
*
*
*
*
* The following attributes apply only to dead-letter queues:
*
*
* -
*
* RedrivePolicy – The string that includes the parameters for the dead-letter queue
* functionality of the source queue as a JSON object. The parameters are as follows:
*
*
* -
*
* deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon
* SQS moves messages after the value of maxReceiveCount is exceeded.
*
*
* -
*
* maxReceiveCount – The number of times a message is delivered to the source queue before being
* moved to the dead-letter queue. Default: 10. When the ReceiveCount for a message exceeds the
* maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
*
*
*
*
* -
*
* RedriveAllowPolicy – The string that includes the parameters for the permissions for the
* dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON
* object. The parameters are as follows:
*
*
* -
*
* redrivePermission – The permission type that defines which source queues can specify the
* current queue as the dead-letter queue. Valid values are:
*
*
* -
*
* allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region
* can specify this queue as the dead-letter queue.
*
*
* -
*
* denyAll – No source queues can specify this queue as the dead-letter queue.
*
*
* -
*
* byQueue – Only queues specified by the sourceQueueArns parameter can specify
* this queue as the dead-letter queue.
*
*
*
*
* -
*
* sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify this
* queue as the dead-letter queue and redrive messages. You can specify this parameter only when the
* redrivePermission parameter is set to byQueue. You can specify up to 10 source
* queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the
* redrivePermission parameter to allowAll.
*
*
*
*
*
*
*
* 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.
*
*
*
* The following attributes apply only to server-side-encryption:
*
*
* -
*
* KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for
* Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs
* , the alias of a custom CMK can, for example, be alias/MyAlias . For more examples,
* see KeyId in the Key Management Service API Reference.
*
*
* -
*
* KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse
* a data key to
* encrypt or decrypt messages before calling 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 How Does the Data Key Reuse Period Work?.
*
*
* -
*
* SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys.
* Only one server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS).
*
*
*
*
* The following attribute applies only to FIFO
* (first-in-first-out) queues:
*
*
* -
*
* ContentBasedDeduplication – Enables content-based deduplication. For more information, see Exactly-once processing in the Amazon SQS Developer Guide. Note the following:
*
*
* -
*
* Every message must have a unique MessageDeduplicationId.
*
*
* -
*
* You may provide a MessageDeduplicationId explicitly.
*
*
* -
*
* If you aren't able to provide a MessageDeduplicationId and you enable
* ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the
* MessageDeduplicationId using the body of the message (but not the attributes of the message).
*
*
* -
*
* If you don't provide a MessageDeduplicationId and the queue doesn't have
* ContentBasedDeduplication set, the action fails with an error.
*
*
* -
*
* If the queue has ContentBasedDeduplication set, your MessageDeduplicationId
* overrides the generated one.
*
*
*
*
* -
*
* When ContentBasedDeduplication 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.
*
*
* -
*
* If you send one message with ContentBasedDeduplication enabled and then another message with
* a MessageDeduplicationId that is the same as the one generated for the first
* MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the
* message is delivered.
*
*
*
*
*
*
* The following attributes apply only to high throughput for FIFO queues:
*
*
* -
*
* DeduplicationScope – Specifies whether message deduplication occurs at the message group or
* queue level. Valid values are messageGroup and queue.
*
*
* -
*
* FifoThroughputLimit – Specifies whether the FIFO queue throughput quota applies to the entire
* queue or per message group. Valid values are perQueue and perMessageGroupId. The
* perMessageGroupId value is allowed only when the value for DeduplicationScope is
* messageGroup.
*
*
*
*
* To enable high throughput for FIFO queues, do the following:
*
*
* -
*
* Set DeduplicationScope to messageGroup.
*
*
* -
*
* Set FifoThroughputLimit to perMessageGroupId.
*
*
*
*
* If you set these attributes to anything other than the values shown for enabling high throughput, normal
* throughput is in effect and deduplication occurs as specified.
*
*
* For information on throughput quotas, see Quotas related to messages in the Amazon SQS Developer Guide.
*/
public void setAttributes(java.util.Map attributes) {
this.attributes = attributes == null ? null : new com.amazonaws.internal.SdkInternalMap(attributes);
}
/**
*
* A map of attributes to set.
*
*
* The following lists the names, descriptions, and values of the special request parameters that the
* SetQueueAttributes action uses:
*
*
* -
*
* DelaySeconds – 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.
*
*
* -
*
* MaximumMessageSize – 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).
*
*
* -
*
* MessageRetentionPeriod – 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). When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to
* propagate throughout the Amazon SQS system. Changes made to the MessageRetentionPeriod attribute can
* take up to 15 minutes and will impact existing messages in the queue potentially causing them to be expired and
* deleted if the MessageRetentionPeriod is reduced below the age of existing messages.
*
*
* -
*
* Policy – The queue's policy. A valid Amazon Web Services policy. For more information about policy
* structure, see Overview of
* Amazon Web Services IAM Policies in the Identity and Access Management User Guide.
*
*
* -
*
* ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a
* ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to 20
* (seconds). Default: 0.
*
*
* -
*
* VisibilityTimeout – 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 Visibility Timeout in the Amazon SQS Developer Guide.
*
*
*
*
* The following attributes apply only to dead-letter queues:
*
*
* -
*
* RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of
* the source queue as a JSON object. The parameters are as follows:
*
*
* -
*
* deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS
* moves messages after the value of maxReceiveCount is exceeded.
*
*
* -
*
* maxReceiveCount – The number of times a message is delivered to the source queue before being moved
* to the dead-letter queue. Default: 10. When the ReceiveCount for a message exceeds the
* maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
*
*
*
*
* -
*
* RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter
* queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters
* are as follows:
*
*
* -
*
* redrivePermission – The permission type that defines which source queues can specify the current
* queue as the dead-letter queue. Valid values are:
*
*
* -
*
* allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can
* specify this queue as the dead-letter queue.
*
*
* -
*
* denyAll – No source queues can specify this queue as the dead-letter queue.
*
*
* -
*
* byQueue – Only queues specified by the sourceQueueArns parameter can specify this queue
* as the dead-letter queue.
*
*
*
*
* -
*
* sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify this queue
* as the dead-letter queue and redrive messages. You can specify this parameter only when the
* redrivePermission parameter is set to byQueue. You can specify up to 10 source queue
* ARNs. To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission
* parameter to allowAll.
*
*
*
*
*
*
*
* 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.
*
*
*
* The following attributes apply only to server-side-encryption:
*
*
* -
*
* KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS
* or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the
* alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the Key Management Service API Reference.
*
*
* -
*
* KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or
* decrypt messages before calling 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 How Does the Data Key Reuse Period Work?.
*
*
* -
*
* SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only
* one server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS).
*
*
*
*
* The following attribute applies only to FIFO
* (first-in-first-out) queues:
*
*
* -
*
* ContentBasedDeduplication – Enables content-based deduplication. For more information, see Exactly-once processing in the Amazon SQS Developer Guide. Note the following:
*
*
* -
*
* Every message must have a unique MessageDeduplicationId.
*
*
* -
*
* You may provide a MessageDeduplicationId explicitly.
*
*
* -
*
* If you aren't able to provide a MessageDeduplicationId and you enable
* ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the
* MessageDeduplicationId using the body of the message (but not the attributes of the message).
*
*
* -
*
* If you don't provide a MessageDeduplicationId and the queue doesn't have
* ContentBasedDeduplication set, the action fails with an error.
*
*
* -
*
* If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides
* the generated one.
*
*
*
*
* -
*
* When ContentBasedDeduplication 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.
*
*
* -
*
* If you send one message with ContentBasedDeduplication enabled and then another message with a
* MessageDeduplicationId that is the same as the one generated for the first
* MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message
* is delivered.
*
*
*
*
*
*
* The following attributes apply only to high
* throughput for FIFO queues:
*
*
* -
*
* DeduplicationScope – Specifies whether message deduplication occurs at the message group or queue
* level. Valid values are messageGroup and queue.
*
*
* -
*
* FifoThroughputLimit – Specifies whether the FIFO queue throughput quota applies to the entire queue
* or per message group. Valid values are perQueue and perMessageGroupId. The
* perMessageGroupId value is allowed only when the value for DeduplicationScope is
* messageGroup.
*
*
*
*
* To enable high throughput for FIFO queues, do the following:
*
*
* -
*
* Set DeduplicationScope to messageGroup.
*
*
* -
*
* Set FifoThroughputLimit to perMessageGroupId.
*
*
*
*
* If you set these attributes to anything other than the values shown for enabling high throughput, normal
* throughput is in effect and deduplication occurs as specified.
*
*
* For information on throughput quotas, see Quotas
* related to messages in the Amazon SQS Developer Guide.
*
*
* @param attributes
* A map of attributes to set.
*
* The following lists the names, descriptions, and values of the special request parameters that the
* SetQueueAttributes action uses:
*
*
* -
*
* DelaySeconds – 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.
*
*
* -
*
* MaximumMessageSize – 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).
*
*
* -
*
* MessageRetentionPeriod – 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). When you change a queue's attributes, the change can take up to 60 seconds for
* most of the attributes to propagate throughout the Amazon SQS system. Changes made to the
* MessageRetentionPeriod attribute can take up to 15 minutes and will impact existing messages
* in the queue potentially causing them to be expired and deleted if the MessageRetentionPeriod
* is reduced below the age of existing messages.
*
*
* -
*
* Policy – The queue's policy. A valid Amazon Web Services policy. For more information about
* policy structure, see Overview of Amazon Web
* Services IAM Policies in the Identity and Access Management User Guide.
*
*
* -
*
* ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a
* ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0
* to 20 (seconds). Default: 0.
*
*
* -
*
* VisibilityTimeout – 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
* Visibility Timeout in the Amazon SQS Developer Guide.
*
*
*
*
* The following attributes apply only to dead-letter queues:
*
*
* -
*
* RedrivePolicy – The string that includes the parameters for the dead-letter queue
* functionality of the source queue as a JSON object. The parameters are as follows:
*
*
* -
*
* deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon
* SQS moves messages after the value of maxReceiveCount is exceeded.
*
*
* -
*
* maxReceiveCount – The number of times a message is delivered to the source queue before being
* moved to the dead-letter queue. Default: 10. When the ReceiveCount for a message exceeds the
* maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
*
*
*
*
* -
*
* RedriveAllowPolicy – The string that includes the parameters for the permissions for the
* dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON
* object. The parameters are as follows:
*
*
* -
*
* redrivePermission – The permission type that defines which source queues can specify the
* current queue as the dead-letter queue. Valid values are:
*
*
* -
*
* allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region
* can specify this queue as the dead-letter queue.
*
*
* -
*
* denyAll – No source queues can specify this queue as the dead-letter queue.
*
*
* -
*
* byQueue – Only queues specified by the sourceQueueArns parameter can specify
* this queue as the dead-letter queue.
*
*
*
*
* -
*
* sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify this
* queue as the dead-letter queue and redrive messages. You can specify this parameter only when the
* redrivePermission parameter is set to byQueue. You can specify up to 10 source
* queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the
* redrivePermission parameter to allowAll.
*
*
*
*
*
*
*
* 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.
*
*
*
* The following attributes apply only to server-side-encryption:
*
*
* -
*
* KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for
* Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs
* , the alias of a custom CMK can, for example, be alias/MyAlias . For more examples,
* see KeyId in the Key Management Service API Reference.
*
*
* -
*
* KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse
* a data key to
* encrypt or decrypt messages before calling 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 How Does the Data Key Reuse Period Work?.
*
*
* -
*
* SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys.
* Only one server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS).
*
*
*
*
* The following attribute applies only to FIFO
* (first-in-first-out) queues:
*
*
* -
*
* ContentBasedDeduplication – Enables content-based deduplication. For more information, see Exactly-once processing in the Amazon SQS Developer Guide. Note the following:
*
*
* -
*
* Every message must have a unique MessageDeduplicationId.
*
*
* -
*
* You may provide a MessageDeduplicationId explicitly.
*
*
* -
*
* If you aren't able to provide a MessageDeduplicationId and you enable
* ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the
* MessageDeduplicationId using the body of the message (but not the attributes of the message).
*
*
* -
*
* If you don't provide a MessageDeduplicationId and the queue doesn't have
* ContentBasedDeduplication set, the action fails with an error.
*
*
* -
*
* If the queue has ContentBasedDeduplication set, your MessageDeduplicationId
* overrides the generated one.
*
*
*
*
* -
*
* When ContentBasedDeduplication 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.
*
*
* -
*
* If you send one message with ContentBasedDeduplication enabled and then another message with
* a MessageDeduplicationId that is the same as the one generated for the first
* MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the
* message is delivered.
*
*
*
*
*
*
* The following attributes apply only to high throughput for FIFO queues:
*
*
* -
*
* DeduplicationScope – Specifies whether message deduplication occurs at the message group or
* queue level. Valid values are messageGroup and queue.
*
*
* -
*
* FifoThroughputLimit – Specifies whether the FIFO queue throughput quota applies to the entire
* queue or per message group. Valid values are perQueue and perMessageGroupId. The
* perMessageGroupId value is allowed only when the value for DeduplicationScope is
* messageGroup.
*
*
*
*
* To enable high throughput for FIFO queues, do the following:
*
*
* -
*
* Set DeduplicationScope to messageGroup.
*
*
* -
*
* Set FifoThroughputLimit to perMessageGroupId.
*
*
*
*
* If you set these attributes to anything other than the values shown for enabling high throughput, normal
* throughput is in effect and deduplication occurs as specified.
*
*
* For information on throughput quotas, see Quotas related to messages in the Amazon SQS Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SetQueueAttributesRequest withAttributes(java.util.Map attributes) {
setAttributes(attributes);
return this;
}
/**
* Add a single Attributes entry
*
* @see SetQueueAttributesRequest#withAttributes
* @returns a reference to this object so that method calls can be chained together.
*/
public SetQueueAttributesRequest addAttributesEntry(String key, String value) {
if (null == this.attributes) {
this.attributes = new com.amazonaws.internal.SdkInternalMap();
}
if (this.attributes.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.attributes.put(key, value);
return this;
}
/**
* Removes all the entries added into Attributes.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SetQueueAttributesRequest clearAttributesEntries() {
this.attributes = null;
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getQueueUrl() != null)
sb.append("QueueUrl: ").append(getQueueUrl()).append(",");
if (getAttributes() != null)
sb.append("Attributes: ").append(getAttributes());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SetQueueAttributesRequest == false)
return false;
SetQueueAttributesRequest other = (SetQueueAttributesRequest) obj;
if (other.getQueueUrl() == null ^ this.getQueueUrl() == null)
return false;
if (other.getQueueUrl() != null && other.getQueueUrl().equals(this.getQueueUrl()) == false)
return false;
if (other.getAttributes() == null ^ this.getAttributes() == null)
return false;
if (other.getAttributes() != null && other.getAttributes().equals(this.getAttributes()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getQueueUrl() == null) ? 0 : getQueueUrl().hashCode());
hashCode = prime * hashCode + ((getAttributes() == null) ? 0 : getAttributes().hashCode());
return hashCode;
}
@Override
public SetQueueAttributesRequest clone() {
return (SetQueueAttributesRequest) super.clone();
}
}