/******************************************************************************* * 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: /// /// /// 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: /// /// 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:The following attributes apply only to dead-letter /// queues: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:The following attributes apply only to FIFO /// (first-in-first-out) queues:The following attributes apply only to high /// throughput for FIFO queues:To enable high throughput for FIFO queues, do the following: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: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: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; } } }