/******************************************************************************* * 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.GameLift; using Amazon.GameLift.Model; namespace Amazon.PowerShell.Cmdlets.GML { /// /// Creates an alias for a fleet. In most situations, you can use an alias ID in place /// of a fleet ID. An alias provides a level of abstraction for a fleet that is useful /// when redirecting player traffic from one fleet to another, such as when updating your /// game build. /// /// /// /// Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. /// A simple alias points to an active fleet. A terminal alias is used to display messaging /// or link to a URL instead of routing players to an active fleet. For example, you might /// use a terminal alias when a game version is no longer supported and you want to direct /// players to an upgrade site. /// /// To create a fleet alias, specify an alias name, routing strategy, and optional description. /// Each simple alias can point to only one fleet, but a fleet can have multiple aliases. /// If successful, a new alias record is returned, including an alias ID and an ARN. You /// can reassign an alias to another fleet by calling UpdateAlias. /// Related actionsAll /// APIs by task /// [Cmdlet("New", "GMLAlias", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.GameLift.Model.Alias")] [AWSCmdlet("Calls the Amazon GameLift Service CreateAlias API operation.", Operation = new[] {"CreateAlias"}, SelectReturnType = typeof(Amazon.GameLift.Model.CreateAliasResponse))] [AWSCmdletOutput("Amazon.GameLift.Model.Alias or Amazon.GameLift.Model.CreateAliasResponse", "This cmdlet returns an Amazon.GameLift.Model.Alias object.", "The service call response (type Amazon.GameLift.Model.CreateAliasResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewGMLAliasCmdlet : AmazonGameLiftClientCmdlet, IExecutor { #region Parameter Description /// /// /// A human-readable description of the alias. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Description { get; set; } #endregion #region Parameter RoutingStrategy_FleetId /// /// /// A unique identifier for the fleet that the alias points to. This value is the fleet /// ID, not the fleet ARN. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String RoutingStrategy_FleetId { get; set; } #endregion #region Parameter RoutingStrategy_Message /// /// /// The message text to be used with a terminal routing strategy. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String RoutingStrategy_Message { get; set; } #endregion #region Parameter Name /// /// /// A descriptive label that is associated with an alias. Alias names do not need to be /// unique. /// /// #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 Name { get; set; } #endregion #region Parameter Tag /// /// /// A list of labels to assign to the new alias resource. Tags are developer-defined key-value /// pairs. Tagging Amazon Web Services resources are useful for resource management, access /// management and cost allocation. For more information, see /// Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Tags")] public Amazon.GameLift.Model.Tag[] Tag { get; set; } #endregion #region Parameter RoutingStrategy_Type /// /// /// The type of routing strategy for the alias.Possible routing types include the following: /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.GameLift.RoutingStrategyType")] public Amazon.GameLift.RoutingStrategyType RoutingStrategy_Type { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'Alias'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.CreateAliasResponse). /// Specifying the name of a property of type Amazon.GameLift.Model.CreateAliasResponse 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; } = "Alias"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the Name parameter. /// The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Name' 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.Name), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-GMLAlias (CreateAlias)")) { 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.Name; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.Description = this.Description; context.Name = this.Name; #if MODULAR if (this.Name == null && ParameterWasBound(nameof(this.Name))) { WriteWarning("You are passing $null as a value for parameter Name 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.RoutingStrategy_FleetId = this.RoutingStrategy_FleetId; context.RoutingStrategy_Message = this.RoutingStrategy_Message; context.RoutingStrategy_Type = this.RoutingStrategy_Type; if (this.Tag != null) { context.Tag = new List(this.Tag); } // 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.GameLift.Model.CreateAliasRequest(); if (cmdletContext.Description != null) { request.Description = cmdletContext.Description; } if (cmdletContext.Name != null) { request.Name = cmdletContext.Name; } // populate RoutingStrategy var requestRoutingStrategyIsNull = true; request.RoutingStrategy = new Amazon.GameLift.Model.RoutingStrategy(); System.String requestRoutingStrategy_routingStrategy_FleetId = null; if (cmdletContext.RoutingStrategy_FleetId != null) { requestRoutingStrategy_routingStrategy_FleetId = cmdletContext.RoutingStrategy_FleetId; } if (requestRoutingStrategy_routingStrategy_FleetId != null) { request.RoutingStrategy.FleetId = requestRoutingStrategy_routingStrategy_FleetId; requestRoutingStrategyIsNull = false; } System.String requestRoutingStrategy_routingStrategy_Message = null; if (cmdletContext.RoutingStrategy_Message != null) { requestRoutingStrategy_routingStrategy_Message = cmdletContext.RoutingStrategy_Message; } if (requestRoutingStrategy_routingStrategy_Message != null) { request.RoutingStrategy.Message = requestRoutingStrategy_routingStrategy_Message; requestRoutingStrategyIsNull = false; } Amazon.GameLift.RoutingStrategyType requestRoutingStrategy_routingStrategy_Type = null; if (cmdletContext.RoutingStrategy_Type != null) { requestRoutingStrategy_routingStrategy_Type = cmdletContext.RoutingStrategy_Type; } if (requestRoutingStrategy_routingStrategy_Type != null) { request.RoutingStrategy.Type = requestRoutingStrategy_routingStrategy_Type; requestRoutingStrategyIsNull = false; } // determine if request.RoutingStrategy should be set to null if (requestRoutingStrategyIsNull) { request.RoutingStrategy = null; } 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.GameLift.Model.CreateAliasResponse CallAWSServiceOperation(IAmazonGameLift client, Amazon.GameLift.Model.CreateAliasRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon GameLift Service", "CreateAlias"); try { #if DESKTOP return client.CreateAlias(request); #elif CORECLR return client.CreateAliasAsync(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.String Description { get; set; } public System.String Name { get; set; } public System.String RoutingStrategy_FleetId { get; set; } public System.String RoutingStrategy_Message { get; set; } public Amazon.GameLift.RoutingStrategyType RoutingStrategy_Type { get; set; } public List Tag { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Alias; } } }