/******************************************************************************* * 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.Greengrass; using Amazon.Greengrass.Model; namespace Amazon.PowerShell.Cmdlets.GG { /// /// Deploys multiple groups in one operation. This action starts the bulk deployment of /// a specified set of group versions. Each group version deployment will be triggered /// with an adaptive rate that has a fixed upper limit. We recommend that you include /// an ''X-Amzn-Client-Token'' token in every ''StartBulkDeployment'' request. These requests /// are idempotent with respect to the token and the request parameters. /// [Cmdlet("Start", "GGBulkDeployment", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.Greengrass.Model.StartBulkDeploymentResponse")] [AWSCmdlet("Calls the AWS Greengrass StartBulkDeployment API operation.", Operation = new[] {"StartBulkDeployment"}, SelectReturnType = typeof(Amazon.Greengrass.Model.StartBulkDeploymentResponse))] [AWSCmdletOutput("Amazon.Greengrass.Model.StartBulkDeploymentResponse", "This cmdlet returns an Amazon.Greengrass.Model.StartBulkDeploymentResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class StartGGBulkDeploymentCmdlet : AmazonGreengrassClientCmdlet, IExecutor { #region Parameter AmznClientToken /// /// /// A client token used to correlate requests /// and responses. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String AmznClientToken { get; set; } #endregion #region Parameter ExecutionRoleArn /// /// /// The ARN of the execution role to associate /// with the bulk deployment operation. This IAM role must allow the ''greengrass:CreateDeployment'' /// action for all group versions that are listed in the input file. This IAM role must /// have access to the S3 bucket containing the input file. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String ExecutionRoleArn { get; set; } #endregion #region Parameter InputFileUri /// /// /// The URI of the input file contained in the /// S3 bucket. The execution role must have ''getObject'' permissions on this bucket to /// access the input file. The input file is a JSON-serialized, line delimited file with /// UTF-8 encoding that provides a list of group and version IDs and the deployment type. /// This file must be less than 100 MB. Currently, AWS IoT Greengrass supports only ''NewDeployment'' /// deployment types. /// /// #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 InputFileUri { get; set; } #endregion #region Parameter Tag /// /// /// Tag(s) to add to the new resource. /// /// [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 '*'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Greengrass.Model.StartBulkDeploymentResponse). /// Specifying the name of a property of type Amazon.Greengrass.Model.StartBulkDeploymentResponse 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 InputFileUri parameter. /// The -PassThru parameter is deprecated, use -Select '^InputFileUri' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^InputFileUri' 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.InputFileUri), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Start-GGBulkDeployment (StartBulkDeployment)")) { 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.InputFileUri; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.AmznClientToken = this.AmznClientToken; context.ExecutionRoleArn = this.ExecutionRoleArn; #if MODULAR if (this.ExecutionRoleArn == null && ParameterWasBound(nameof(this.ExecutionRoleArn))) { WriteWarning("You are passing $null as a value for parameter ExecutionRoleArn 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.InputFileUri = this.InputFileUri; #if MODULAR if (this.InputFileUri == null && ParameterWasBound(nameof(this.InputFileUri))) { WriteWarning("You are passing $null as a value for parameter InputFileUri 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.Greengrass.Model.StartBulkDeploymentRequest(); if (cmdletContext.AmznClientToken != null) { request.AmznClientToken = cmdletContext.AmznClientToken; } if (cmdletContext.ExecutionRoleArn != null) { request.ExecutionRoleArn = cmdletContext.ExecutionRoleArn; } if (cmdletContext.InputFileUri != null) { request.InputFileUri = cmdletContext.InputFileUri; } 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.Greengrass.Model.StartBulkDeploymentResponse CallAWSServiceOperation(IAmazonGreengrass client, Amazon.Greengrass.Model.StartBulkDeploymentRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Greengrass", "StartBulkDeployment"); try { #if DESKTOP return client.StartBulkDeployment(request); #elif CORECLR return client.StartBulkDeploymentAsync(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 AmznClientToken { get; set; } public System.String ExecutionRoleArn { get; set; } public System.String InputFileUri { get; set; } public Dictionary Tag { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }