/******************************************************************************* * 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.Backup; using Amazon.Backup.Model; namespace Amazon.PowerShell.Cmdlets.BAK { /// /// Updates an existing framework identified by its FrameworkName with the /// input document in JSON format. /// [Cmdlet("Update", "BAKFramework", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.Backup.Model.UpdateFrameworkResponse")] [AWSCmdlet("Calls the AWS Backup UpdateFramework API operation.", Operation = new[] {"UpdateFramework"}, SelectReturnType = typeof(Amazon.Backup.Model.UpdateFrameworkResponse))] [AWSCmdletOutput("Amazon.Backup.Model.UpdateFrameworkResponse", "This cmdlet returns an Amazon.Backup.Model.UpdateFrameworkResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class UpdateBAKFrameworkCmdlet : AmazonBackupClientCmdlet, IExecutor { #region Parameter FrameworkControl /// /// /// A list of the controls that make up the framework. Each control in the list has a /// name, input parameters, and scope. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("FrameworkControls")] public Amazon.Backup.Model.FrameworkControl[] FrameworkControl { get; set; } #endregion #region Parameter FrameworkDescription /// /// /// An optional description of the framework with a maximum 1,024 characters. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String FrameworkDescription { get; set; } #endregion #region Parameter FrameworkName /// /// /// The unique name of a framework. This name is between 1 and 256 characters, starting /// with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores /// (_). /// /// #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 FrameworkName { get; set; } #endregion #region Parameter IdempotencyToken /// /// /// A customer-chosen string that you can use to distinguish between otherwise identical /// calls to UpdateFrameworkInput. Retrying a successful request with the /// same idempotency token results in a success message with no action taken. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String IdempotencyToken { 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.Backup.Model.UpdateFrameworkResponse). /// Specifying the name of a property of type Amazon.Backup.Model.UpdateFrameworkResponse 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 FrameworkName parameter. /// The -PassThru parameter is deprecated, use -Select '^FrameworkName' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^FrameworkName' 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.FrameworkName), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-BAKFramework (UpdateFramework)")) { 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.FrameworkName; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute if (this.FrameworkControl != null) { context.FrameworkControl = new List(this.FrameworkControl); } context.FrameworkDescription = this.FrameworkDescription; context.FrameworkName = this.FrameworkName; #if MODULAR if (this.FrameworkName == null && ParameterWasBound(nameof(this.FrameworkName))) { WriteWarning("You are passing $null as a value for parameter FrameworkName 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.IdempotencyToken = this.IdempotencyToken; // 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.Backup.Model.UpdateFrameworkRequest(); if (cmdletContext.FrameworkControl != null) { request.FrameworkControls = cmdletContext.FrameworkControl; } if (cmdletContext.FrameworkDescription != null) { request.FrameworkDescription = cmdletContext.FrameworkDescription; } if (cmdletContext.FrameworkName != null) { request.FrameworkName = cmdletContext.FrameworkName; } if (cmdletContext.IdempotencyToken != null) { request.IdempotencyToken = cmdletContext.IdempotencyToken; } 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.Backup.Model.UpdateFrameworkResponse CallAWSServiceOperation(IAmazonBackup client, Amazon.Backup.Model.UpdateFrameworkRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Backup", "UpdateFramework"); try { #if DESKTOP return client.UpdateFramework(request); #elif CORECLR return client.UpdateFrameworkAsync(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 List FrameworkControl { get; set; } public System.String FrameworkDescription { get; set; } public System.String FrameworkName { get; set; } public System.String IdempotencyToken { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }