/******************************************************************************* * 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.CloudFormation; using Amazon.CloudFormation.Model; namespace Amazon.PowerShell.Cmdlets.CFN { /// /// For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues /// rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the /// cause of the failure, you can manually /// fix the error and continue the rollback. By continuing the rollback, you can return /// your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and /// then try to update the stack again. /// /// /// /// A stack goes into the UPDATE_ROLLBACK_FAILED state when CloudFormation /// can't roll back all changes after a failed stack update. For example, you might have /// a stack that's rolling back to an old database instance that was deleted outside of /// CloudFormation. Because CloudFormation doesn't know the database was deleted, it assumes /// that the database instance still exists and attempts to roll back to it, causing the /// update rollback to fail. /// /// [Cmdlet("Resume", "CFNUpdateRollback", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("None")] [AWSCmdlet("Calls the AWS CloudFormation ContinueUpdateRollback API operation.", Operation = new[] {"ContinueUpdateRollback"}, SelectReturnType = typeof(Amazon.CloudFormation.Model.ContinueUpdateRollbackResponse))] [AWSCmdletOutput("None or Amazon.CloudFormation.Model.ContinueUpdateRollbackResponse", "This cmdlet does not generate any output." + "The service response (type Amazon.CloudFormation.Model.ContinueUpdateRollbackResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class ResumeCFNUpdateRollbackCmdlet : AmazonCloudFormationClientCmdlet, IExecutor { #region Parameter ClientRequestToken /// /// /// A unique identifier for this ContinueUpdateRollback request. Specify /// this token if you plan to retry requests so that CloudFormation knows that you're /// not attempting to continue the rollback to a stack with the same name. You might retry /// ContinueUpdateRollback requests to ensure that CloudFormation successfully /// received them. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ClientRequestToken { get; set; } #endregion #region Parameter ResourcesToSkip /// /// /// A list of the logical IDs of the resources that CloudFormation skips during the continue /// update rollback operation. You can specify only resources that are in the UPDATE_FAILED /// state because a rollback failed. You can't specify resources that are in the UPDATE_FAILED /// state for other reasons, for example, because an update was canceled. To check why /// a resource update failed, use the DescribeStackResources action, and view the /// resource status reason.Specify this property to skip rolling back resources that CloudFormation can't successfully /// roll back. We recommend that you /// troubleshoot resources before skipping them. CloudFormation sets the status of /// the specified resources to UPDATE_COMPLETE and continues to roll back /// the stack. After the rollback is complete, the state of the skipped resources will /// be inconsistent with the state of the resources in the stack template. Before performing /// another stack update, you must update the stack or resources to be consistent with /// each other. If you don't, subsequent stack updates might fail, and the stack will /// become unrecoverable.Specify the minimum number of resources required to successfully roll back your stack. /// For example, a failed resource update might cause dependent resources to fail. In /// this case, it might not be necessary to skip the dependent resources.To skip resources that are part of nested stacks, use the following format: NestedStackName.ResourceLogicalID. /// If you want to specify the logical ID of a stack resource (Type: AWS::CloudFormation::Stack) /// in the ResourcesToSkip list, then its corresponding embedded stack must /// be in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, /// or DELETE_FAILED.Don't confuse a child stack's name with its corresponding logical ID defined in the /// parent stack. For an example of a continue update rollback operation with nested stacks, /// see Using /// ResourcesToSkip to recover a nested stacks hierarchy. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String[] ResourcesToSkip { get; set; } #endregion #region Parameter RoleARN /// /// /// The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that /// CloudFormation assumes to roll back the stack. CloudFormation uses the role's credentials /// to make calls on your behalf. CloudFormation always uses this role for all future /// operations on the stack. Provided that users have permission to operate on the stack, /// CloudFormation uses this role even if the users don't have permission to pass it. /// Ensure that the role grants least permission.If you don't specify a value, CloudFormation uses the role that was previously associated /// with the stack. If no role is available, CloudFormation uses a temporary session that's /// generated from your user credentials. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String RoleARN { get; set; } #endregion #region Parameter StackName /// /// /// The name or the unique ID of the stack that you want to continue rolling back.Don't specify the name of a nested stack (a stack that was created by using the AWS::CloudFormation::Stack /// resource). Instead, use this operation on the parent stack (the stack that contains /// the AWS::CloudFormation::Stack resource). /// /// #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 StackName { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFormation.Model.ContinueUpdateRollbackResponse). /// 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 StackName parameter. /// The -PassThru parameter is deprecated, use -Select '^StackName' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^StackName' 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.StackName), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Resume-CFNUpdateRollback (ContinueUpdateRollback)")) { 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.StackName; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.ClientRequestToken = this.ClientRequestToken; if (this.ResourcesToSkip != null) { context.ResourcesToSkip = new List(this.ResourcesToSkip); } context.RoleARN = this.RoleARN; context.StackName = this.StackName; #if MODULAR if (this.StackName == null && ParameterWasBound(nameof(this.StackName))) { WriteWarning("You are passing $null as a value for parameter StackName 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 // 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.CloudFormation.Model.ContinueUpdateRollbackRequest(); if (cmdletContext.ClientRequestToken != null) { request.ClientRequestToken = cmdletContext.ClientRequestToken; } if (cmdletContext.ResourcesToSkip != null) { request.ResourcesToSkip = cmdletContext.ResourcesToSkip; } if (cmdletContext.RoleARN != null) { request.RoleARN = cmdletContext.RoleARN; } if (cmdletContext.StackName != null) { request.StackName = cmdletContext.StackName; } 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.CloudFormation.Model.ContinueUpdateRollbackResponse CallAWSServiceOperation(IAmazonCloudFormation client, Amazon.CloudFormation.Model.ContinueUpdateRollbackRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS CloudFormation", "ContinueUpdateRollback"); try { #if DESKTOP return client.ContinueUpdateRollback(request); #elif CORECLR return client.ContinueUpdateRollbackAsync(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 ClientRequestToken { get; set; } public List ResourcesToSkip { get; set; } public System.String RoleARN { get; set; } public System.String StackName { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => null; } } }