/******************************************************************************* * 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 a new Amazon GameLift build resource for your game server binary files. Combine /// game server binaries into a zip file for use with Amazon GameLift. /// /// /// When setting up a new game build for Amazon GameLift, we recommend using the CLI command /// upload-build. This helper command combines two tasks: (1) it uploads your build files from /// a file directory to an Amazon GameLift Amazon S3 location, and (2) it creates a new /// build resource. /// /// You can use the CreateBuild operation in the following scenarios: /// /// If successful, this operation creates a new build resource with a unique build ID /// and places it in INITIALIZED status. A build must be in READY /// status before you can create fleets with it. /// Learn moreUploading /// Your Game /// Create a Build with Files in Amazon S3All /// APIs by task /// [Cmdlet("New", "GMLBuild", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.GameLift.Model.CreateBuildResponse")] [AWSCmdlet("Calls the Amazon GameLift Service CreateBuild API operation.", Operation = new[] {"CreateBuild"}, SelectReturnType = typeof(Amazon.GameLift.Model.CreateBuildResponse))] [AWSCmdletOutput("Amazon.GameLift.Model.CreateBuildResponse", "This cmdlet returns an Amazon.GameLift.Model.CreateBuildResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewGMLBuildCmdlet : AmazonGameLiftClientCmdlet, IExecutor { protected override bool IsSensitiveResponse { get; set; } = true; #region Parameter StorageLocation_Bucket /// /// /// An Amazon S3 bucket identifier. Thename of the S3 bucket.Amazon GameLift doesn't support uploading from Amazon S3 buckets with names that contain /// a dot (.). /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String StorageLocation_Bucket { get; set; } #endregion #region Parameter StorageLocation_Key /// /// /// The name of the zip file that contains the build files or script files. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String StorageLocation_Key { get; set; } #endregion #region Parameter Name /// /// /// A descriptive label associated with a build. Build names don't need to be unique. /// You can change this value later. /// /// [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] public System.String Name { get; set; } #endregion #region Parameter StorageLocation_ObjectVersion /// /// /// The version of the file, if object versioning is turned on for the bucket. Amazon /// GameLift uses this information when retrieving files from an S3 bucket that you own. /// Use this parameter to specify a specific version of the file. If not set, the latest /// version of the file is retrieved. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String StorageLocation_ObjectVersion { get; set; } #endregion #region Parameter OperatingSystem /// /// /// The operating system that your game server binaries run on. This value determines /// the type of fleet resources that you use for this build. If your game build contains /// multiple executables, they all must run on the same operating system. You must specify /// a valid operating system in this request. There is no default value. You can't change /// a build's operating system later.If you have active fleets using the Windows Server 2012 operating system, you can /// continue to create new builds using this OS until October 10, 2023, when Microsoft /// ends its support. All others must use Windows Server 2016 when creating new Windows-based /// builds. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.GameLift.OperatingSystem")] public Amazon.GameLift.OperatingSystem OperatingSystem { get; set; } #endregion #region Parameter StorageLocation_RoleArn /// /// /// The Amazon Resource Name (ARN) /// for an IAM role that allows Amazon GameLift to access the S3 bucket. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String StorageLocation_RoleArn { get; set; } #endregion #region Parameter ServerSdkVersion /// /// /// A server SDK version you used when integrating your game server build with Amazon /// GameLift. For more information see Integrate /// games with custom game servers. By default Amazon GameLift sets this value to /// 4.0.2. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ServerSdkVersion { get; set; } #endregion #region Parameter Tag /// /// /// A list of labels to assign to the new build 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. /// Once the resource is created, you can use TagResource, /// UntagResource, /// and ListTagsForResource /// to add, remove, and view tags. The maximum tag limit may be lower than stated. See /// the Amazon Web Services General Reference for actual tagging limits. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Tags")] public Amazon.GameLift.Model.Tag[] Tag { get; set; } #endregion #region Parameter Version /// /// /// Version information associated with a build or script. Version strings don't need /// to be unique. You can change this value later. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Version { 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.GameLift.Model.CreateBuildResponse). /// Specifying the name of a property of type Amazon.GameLift.Model.CreateBuildResponse 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 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-GMLBuild (CreateBuild)")) { 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.Name = this.Name; context.OperatingSystem = this.OperatingSystem; context.ServerSdkVersion = this.ServerSdkVersion; context.StorageLocation_Bucket = this.StorageLocation_Bucket; context.StorageLocation_Key = this.StorageLocation_Key; context.StorageLocation_ObjectVersion = this.StorageLocation_ObjectVersion; context.StorageLocation_RoleArn = this.StorageLocation_RoleArn; if (this.Tag != null) { context.Tag = new List(this.Tag); } context.Version = this.Version; // 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.CreateBuildRequest(); if (cmdletContext.Name != null) { request.Name = cmdletContext.Name; } if (cmdletContext.OperatingSystem != null) { request.OperatingSystem = cmdletContext.OperatingSystem; } if (cmdletContext.ServerSdkVersion != null) { request.ServerSdkVersion = cmdletContext.ServerSdkVersion; } // populate StorageLocation var requestStorageLocationIsNull = true; request.StorageLocation = new Amazon.GameLift.Model.S3Location(); System.String requestStorageLocation_storageLocation_Bucket = null; if (cmdletContext.StorageLocation_Bucket != null) { requestStorageLocation_storageLocation_Bucket = cmdletContext.StorageLocation_Bucket; } if (requestStorageLocation_storageLocation_Bucket != null) { request.StorageLocation.Bucket = requestStorageLocation_storageLocation_Bucket; requestStorageLocationIsNull = false; } System.String requestStorageLocation_storageLocation_Key = null; if (cmdletContext.StorageLocation_Key != null) { requestStorageLocation_storageLocation_Key = cmdletContext.StorageLocation_Key; } if (requestStorageLocation_storageLocation_Key != null) { request.StorageLocation.Key = requestStorageLocation_storageLocation_Key; requestStorageLocationIsNull = false; } System.String requestStorageLocation_storageLocation_ObjectVersion = null; if (cmdletContext.StorageLocation_ObjectVersion != null) { requestStorageLocation_storageLocation_ObjectVersion = cmdletContext.StorageLocation_ObjectVersion; } if (requestStorageLocation_storageLocation_ObjectVersion != null) { request.StorageLocation.ObjectVersion = requestStorageLocation_storageLocation_ObjectVersion; requestStorageLocationIsNull = false; } System.String requestStorageLocation_storageLocation_RoleArn = null; if (cmdletContext.StorageLocation_RoleArn != null) { requestStorageLocation_storageLocation_RoleArn = cmdletContext.StorageLocation_RoleArn; } if (requestStorageLocation_storageLocation_RoleArn != null) { request.StorageLocation.RoleArn = requestStorageLocation_storageLocation_RoleArn; requestStorageLocationIsNull = false; } // determine if request.StorageLocation should be set to null if (requestStorageLocationIsNull) { request.StorageLocation = null; } if (cmdletContext.Tag != null) { request.Tags = cmdletContext.Tag; } if (cmdletContext.Version != null) { request.Version = cmdletContext.Version; } 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.CreateBuildResponse CallAWSServiceOperation(IAmazonGameLift client, Amazon.GameLift.Model.CreateBuildRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon GameLift Service", "CreateBuild"); try { #if DESKTOP return client.CreateBuild(request); #elif CORECLR return client.CreateBuildAsync(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 Name { get; set; } public Amazon.GameLift.OperatingSystem OperatingSystem { get; set; } public System.String ServerSdkVersion { get; set; } public System.String StorageLocation_Bucket { get; set; } public System.String StorageLocation_Key { get; set; } public System.String StorageLocation_ObjectVersion { get; set; } public System.String StorageLocation_RoleArn { get; set; } public List Tag { get; set; } public System.String Version { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }