/******************************************************************************* * 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.APIGateway; using Amazon.APIGateway.Model; namespace Amazon.PowerShell.Cmdlets.AG { /// /// Creates a Deployment resource, which makes a specified RestApi callable over the internet. /// [Cmdlet("New", "AGDeployment", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.APIGateway.Model.CreateDeploymentResponse")] [AWSCmdlet("Calls the Amazon API Gateway CreateDeployment API operation.", Operation = new[] {"CreateDeployment"}, SelectReturnType = typeof(Amazon.APIGateway.Model.CreateDeploymentResponse))] [AWSCmdletOutput("Amazon.APIGateway.Model.CreateDeploymentResponse", "This cmdlet returns an Amazon.APIGateway.Model.CreateDeploymentResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewAGDeploymentCmdlet : AmazonAPIGatewayClientCmdlet, IExecutor { #region Parameter CacheClusterEnabled /// /// /// Enables a cache cluster for the Stage resource specified in the input. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? CacheClusterEnabled { get; set; } #endregion #region Parameter CacheClusterSize /// /// /// The stage's cache capacity in GB. For more information about choosing a cache size, /// see Enabling /// API caching to enhance responsiveness. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.APIGateway.CacheClusterSize")] public Amazon.APIGateway.CacheClusterSize CacheClusterSize { get; set; } #endregion #region Parameter Description /// /// /// The description for the Deployment resource to create. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Description { get; set; } #endregion #region Parameter CanarySettings_PercentTraffic /// /// /// The percentage (0.0-100.0) of traffic routed to the canary deployment. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Double? CanarySettings_PercentTraffic { get; set; } #endregion #region Parameter RestApiId /// /// /// The string identifier of the associated RestApi. /// /// #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 RestApiId { get; set; } #endregion #region Parameter StageDescription /// /// /// The description of the Stage resource for the Deployment resource to create. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String StageDescription { get; set; } #endregion #region Parameter StageName /// /// /// The name of the Stage resource for the Deployment resource to create. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String StageName { get; set; } #endregion #region Parameter CanarySettings_StageVariableOverride /// /// /// A stage variable overrides used for the canary release deployment. They can override /// existing stage variables or add new stage variables for the canary release deployment. /// These stage variables are represented as a string-to-string map between stage variable /// names and their values. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("CanarySettings_StageVariableOverrides")] public System.Collections.Hashtable CanarySettings_StageVariableOverride { get; set; } #endregion #region Parameter TracingEnabled /// /// /// Specifies whether active tracing with X-ray is enabled for the Stage. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? TracingEnabled { get; set; } #endregion #region Parameter CanarySettings_UseStageCache /// /// /// A Boolean flag to indicate whether the canary release deployment uses the stage cache /// or not. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? CanarySettings_UseStageCache { get; set; } #endregion #region Parameter Variable /// /// /// A map that defines the stage variables for the Stage resource that is associated with /// the new deployment. Variable names can have alphanumeric and underscore characters, /// and the values must match [A-Za-z0-9-._~:/?#&=,]+. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Variables")] public System.Collections.Hashtable Variable { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is '*'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.APIGateway.Model.CreateDeploymentResponse). /// Specifying the name of a property of type Amazon.APIGateway.Model.CreateDeploymentResponse 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; } = "*"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the RestApiId parameter. /// The -PassThru parameter is deprecated, use -Select '^RestApiId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^RestApiId' 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.StageName), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-AGDeployment (CreateDeployment)")) { 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.RestApiId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.CacheClusterEnabled = this.CacheClusterEnabled; context.CacheClusterSize = this.CacheClusterSize; context.CanarySettings_PercentTraffic = this.CanarySettings_PercentTraffic; if (this.CanarySettings_StageVariableOverride != null) { context.CanarySettings_StageVariableOverride = new Dictionary(StringComparer.Ordinal); foreach (var hashKey in this.CanarySettings_StageVariableOverride.Keys) { context.CanarySettings_StageVariableOverride.Add((String)hashKey, (String)(this.CanarySettings_StageVariableOverride[hashKey])); } } context.CanarySettings_UseStageCache = this.CanarySettings_UseStageCache; context.Description = this.Description; context.RestApiId = this.RestApiId; #if MODULAR if (this.RestApiId == null && ParameterWasBound(nameof(this.RestApiId))) { WriteWarning("You are passing $null as a value for parameter RestApiId 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 context.StageDescription = this.StageDescription; context.StageName = this.StageName; context.TracingEnabled = this.TracingEnabled; if (this.Variable != null) { context.Variable = new Dictionary(StringComparer.Ordinal); foreach (var hashKey in this.Variable.Keys) { context.Variable.Add((String)hashKey, (String)(this.Variable[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.APIGateway.Model.CreateDeploymentRequest(); if (cmdletContext.CacheClusterEnabled != null) { request.CacheClusterEnabled = cmdletContext.CacheClusterEnabled.Value; } if (cmdletContext.CacheClusterSize != null) { request.CacheClusterSize = cmdletContext.CacheClusterSize; } // populate CanarySettings var requestCanarySettingsIsNull = true; request.CanarySettings = new Amazon.APIGateway.Model.DeploymentCanarySettings(); System.Double? requestCanarySettings_canarySettings_PercentTraffic = null; if (cmdletContext.CanarySettings_PercentTraffic != null) { requestCanarySettings_canarySettings_PercentTraffic = cmdletContext.CanarySettings_PercentTraffic.Value; } if (requestCanarySettings_canarySettings_PercentTraffic != null) { request.CanarySettings.PercentTraffic = requestCanarySettings_canarySettings_PercentTraffic.Value; requestCanarySettingsIsNull = false; } Dictionary requestCanarySettings_canarySettings_StageVariableOverride = null; if (cmdletContext.CanarySettings_StageVariableOverride != null) { requestCanarySettings_canarySettings_StageVariableOverride = cmdletContext.CanarySettings_StageVariableOverride; } if (requestCanarySettings_canarySettings_StageVariableOverride != null) { request.CanarySettings.StageVariableOverrides = requestCanarySettings_canarySettings_StageVariableOverride; requestCanarySettingsIsNull = false; } System.Boolean? requestCanarySettings_canarySettings_UseStageCache = null; if (cmdletContext.CanarySettings_UseStageCache != null) { requestCanarySettings_canarySettings_UseStageCache = cmdletContext.CanarySettings_UseStageCache.Value; } if (requestCanarySettings_canarySettings_UseStageCache != null) { request.CanarySettings.UseStageCache = requestCanarySettings_canarySettings_UseStageCache.Value; requestCanarySettingsIsNull = false; } // determine if request.CanarySettings should be set to null if (requestCanarySettingsIsNull) { request.CanarySettings = null; } if (cmdletContext.Description != null) { request.Description = cmdletContext.Description; } if (cmdletContext.RestApiId != null) { request.RestApiId = cmdletContext.RestApiId; } if (cmdletContext.StageDescription != null) { request.StageDescription = cmdletContext.StageDescription; } if (cmdletContext.StageName != null) { request.StageName = cmdletContext.StageName; } if (cmdletContext.TracingEnabled != null) { request.TracingEnabled = cmdletContext.TracingEnabled.Value; } if (cmdletContext.Variable != null) { request.Variables = cmdletContext.Variable; } 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.APIGateway.Model.CreateDeploymentResponse CallAWSServiceOperation(IAmazonAPIGateway client, Amazon.APIGateway.Model.CreateDeploymentRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon API Gateway", "CreateDeployment"); try { #if DESKTOP return client.CreateDeployment(request); #elif CORECLR return client.CreateDeploymentAsync(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 System.Boolean? CacheClusterEnabled { get; set; } public Amazon.APIGateway.CacheClusterSize CacheClusterSize { get; set; } public System.Double? CanarySettings_PercentTraffic { get; set; } public Dictionary CanarySettings_StageVariableOverride { get; set; } public System.Boolean? CanarySettings_UseStageCache { get; set; } public System.String Description { get; set; } public System.String RestApiId { get; set; } public System.String StageDescription { get; set; } public System.String StageName { get; set; } public System.Boolean? TracingEnabled { get; set; } public Dictionary Variable { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }