/*******************************************************************************
* Copyright 2012-2019 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.
* *****************************************************************************
*
* AWS Tools for Windows (TM) PowerShell (TM)
*
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Management.Automation;
using System.Text;
using Amazon.PowerShell.Common;
using Amazon.Runtime;
using Amazon.SQS;
using Amazon.SQS.Model;
namespace Amazon.PowerShell.Cmdlets.SQS
{
///
/// Creates a new standard or FIFO queue. You can pass one or more attributes in the request.
/// Keep the following in mind:
///
/// -
/// If you don't specify the
FifoQueue
attribute, Amazon SQS creates a standard
/// queue.
///
/// You can't change the queue type after you create it and you can't convert an existing
/// standard queue into a FIFO queue. You must either create a new FIFO queue for your
/// application or delete your existing standard queue and recreate it as a FIFO queue.
/// For more information, see Moving
/// From a Standard Queue to a FIFO Queue in the Amazon SQS Developer Guide.
///
/// -
/// If you don't provide a value for an attribute, the queue is created with the default
/// value for the attribute.
///
-
/// If you delete a queue, you must wait at least 60 seconds before creating a queue with
/// the same name.
///
/// To successfully create a new queue, you must provide a queue name that adheres to
/// the limits
/// related to queues and is unique within the scope of your queues.
///
/// After you create a queue, you must wait at least one second after the queue is created
/// to be able to use the queue.
///
/// To get the queue URL, use the GetQueueUrl
action. GetQueueUrl
requires only the QueueName
parameter. be aware of existing queue
/// names:
/// -
/// If you provide the name of an existing queue along with the exact names and values
/// of all the queue's attributes,
CreateQueue
returns the queue URL for
/// the existing queue.
/// -
/// If the queue name, attribute names, or attribute values don't match an existing queue,
///
CreateQueue
returns an error.
///
/// Cross-account permissions don't apply to this action. For more information, see Grant
/// cross-account permissions to a role and a username in the Amazon SQS Developer
/// Guide.
///
///
[Cmdlet("New", "SQSQueue", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.String")]
[AWSCmdlet("Calls the Amazon Simple Queue Service (SQS) CreateQueue API operation.", Operation = new[] {"CreateQueue"}, SelectReturnType = typeof(Amazon.SQS.Model.CreateQueueResponse))]
[AWSCmdletOutput("System.String or Amazon.SQS.Model.CreateQueueResponse",
"This cmdlet returns a System.String object.",
"The service call response (type Amazon.SQS.Model.CreateQueueResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewSQSQueueCmdlet : AmazonSQSClientCmdlet, IExecutor
{
#region Parameter Attribute
///
///
/// A map of attributes with their corresponding values.The following lists the names, descriptions, and values of the special request parameters
/// that the CreateQueue
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 seconds
/// (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) 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 from 60 seconds (1 minute) to 1,209,600
/// seconds (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 IAM 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 Amazon Web Services 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 attributes apply only to FIFO
/// (first-in-first-out) queues:FifoQueue
– Designates a queue as FIFO. Valid values are true
/// and false
. If you don't specify the FifoQueue
attribute,
/// Amazon SQS creates a standard queue. You can provide this attribute only during queue
/// creation. You can't change it for an existing queue. When you set this attribute,
/// you must also provide the MessageGroupId
for your messages explicitly.For more information, see FIFO
/// queue logic in the Amazon SQS Developer Guide.ContentBasedDeduplication
– Enables content-based deduplication. Valid
/// values are true
and false
. 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.
///
///
[System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)]
[Alias("Attributes")]
public System.Collections.Hashtable Attribute { get; set; }
#endregion
#region Parameter QueueName
///
///
/// The name of the new queue. The following limits apply to this name:- A queue name can have up to 80 characters.
- Valid values: alphanumeric characters, hyphens (
-
), and underscores (_
). - A FIFO queue name must end with the
.fifo
suffix.
Queue URLs and names are case-sensitive.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
#else
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String QueueName { get; set; }
#endregion
#region Parameter Tag
///
///
/// Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging
/// Your Amazon SQS Queues in the Amazon SQS Developer Guide.When you use queue tags, keep the following guidelines in mind:- Adding more than 50 tags to a queue isn't recommended.
- Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
- Tags are case-sensitive.
- A new tag with a key identical to that of an existing tag overwrites the existing
/// tag.
For a full list of tag restrictions, see Quotas
/// related to queues in the Amazon SQS Developer Guide.To be able to tag a queue on creation, you must have the sqs:CreateQueue
/// and sqs:TagQueue
permissions.Cross-account permissions don't apply to this action. For more information, see Grant
/// cross-account permissions to a role and a username in the Amazon SQS Developer
/// Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Tags")]
public System.Collections.Hashtable Tag { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'QueueUrl'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SQS.Model.CreateQueueResponse).
/// Specifying the name of a property of type Amazon.SQS.Model.CreateQueueResponse will result in that property being returned.
/// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "QueueUrl";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the QueueName parameter.
/// The -PassThru parameter is deprecated, use -Select '^QueueName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^QueueName' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { get; set; }
#endregion
#region Parameter Force
///
/// This parameter overrides confirmation prompts to force
/// the cmdlet to continue its operation. This parameter should always
/// be used with caution.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter Force { get; set; }
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.QueueName), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-SQSQueue (CreateQueue)"))
{
return;
}
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
if (this.PassThru.IsPresent)
{
throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select));
}
}
else if (this.PassThru.IsPresent)
{
context.Select = (response, cmdlet) => this.QueueName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (this.Attribute != null)
{
context.Attribute = new Dictionary(StringComparer.Ordinal);
foreach (var hashKey in this.Attribute.Keys)
{
context.Attribute.Add((String)hashKey, (String)(this.Attribute[hashKey]));
}
}
context.QueueName = this.QueueName;
#if MODULAR
if (this.QueueName == null && ParameterWasBound(nameof(this.QueueName)))
{
WriteWarning("You are passing $null as a value for parameter QueueName which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
if (this.Tag != null)
{
context.Tag = new Dictionary(StringComparer.Ordinal);
foreach (var hashKey in this.Tag.Keys)
{
context.Tag.Add((String)hashKey, (String)(this.Tag[hashKey]));
}
}
// allow further manipulation of loaded context prior to processing
PostExecutionContextLoad(context);
var output = Execute(context) as CmdletOutput;
ProcessOutput(output);
}
#region IExecutor Members
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
// create request
var request = new Amazon.SQS.Model.CreateQueueRequest();
if (cmdletContext.Attribute != null)
{
request.Attributes = cmdletContext.Attribute;
}
if (cmdletContext.QueueName != null)
{
request.QueueName = cmdletContext.QueueName;
}
if (cmdletContext.Tag != null)
{
request.Tags = cmdletContext.Tag;
}
CmdletOutput output;
// issue call
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
pipelineOutput = cmdletContext.Select(response, this);
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
}
catch (Exception e)
{
output = new CmdletOutput { ErrorResponse = e };
}
return output;
}
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.SQS.Model.CreateQueueResponse CallAWSServiceOperation(IAmazonSQS client, Amazon.SQS.Model.CreateQueueRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Simple Queue Service (SQS)", "CreateQueue");
try
{
#if DESKTOP
return client.CreateQueue(request);
#elif CORECLR
return client.CreateQueueAsync(request).GetAwaiter().GetResult();
#else
#error "Unknown build edition"
#endif
}
catch (AmazonServiceException exc)
{
var webException = exc.InnerException as System.Net.WebException;
if (webException != null)
{
throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException);
}
throw;
}
}
#endregion
internal partial class CmdletContext : ExecutorContext
{
public Dictionary Attribute { get; set; }
public System.String QueueName { get; set; }
public Dictionary Tag { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.QueueUrl;
}
}
}