/******************************************************************************* * 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 { /// /// Updates the parameter values for stack instances for the specified accounts, within /// the specified Amazon Web Services Regions. A stack instance refers to a stack in a /// specific account and Region. /// /// /// /// You can only update stack instances in Amazon Web Services Regions and accounts where /// they already exist; to create additional stack instances, use CreateStackInstances. /// /// During stack set updates, any parameters overridden for a stack instance aren't updated, /// but retain their overridden value. /// /// You can only update the parameter values that are specified in the stack set; /// to add or delete a parameter itself, use UpdateStackSet /// to update the stack set template. If you add a parameter to a template, before you /// can override the parameter value specified in the stack set you must first use UpdateStackSet /// to update all stack instances with the updated template and parameter value specified /// in the stack set. Once a stack instance has been updated with the new parameter, you /// can then override the parameter value using UpdateStackInstances. /// /// [Cmdlet("Update", "CFNStackInstance", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("System.String")] [AWSCmdlet("Calls the AWS CloudFormation UpdateStackInstances API operation.", Operation = new[] {"UpdateStackInstances"}, SelectReturnType = typeof(Amazon.CloudFormation.Model.UpdateStackInstancesResponse))] [AWSCmdletOutput("System.String or Amazon.CloudFormation.Model.UpdateStackInstancesResponse", "This cmdlet returns a System.String object.", "The service call response (type Amazon.CloudFormation.Model.UpdateStackInstancesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class UpdateCFNStackInstanceCmdlet : AmazonCloudFormationClientCmdlet, IExecutor { #region Parameter DeploymentTargets_AccountFilterType /// /// /// Limit deployment targets to individual accounts or include additional accounts with /// provided OUs.The following is a list of possible values for the AccountFilterType /// operation. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.CloudFormation.AccountFilterType")] public Amazon.CloudFormation.AccountFilterType DeploymentTargets_AccountFilterType { get; set; } #endregion #region Parameter Account /// /// /// [Self-managed permissions] The names of one or more Amazon Web Services accounts for /// which you want to update parameter values for stack instances. The overridden parameter /// values will be applied to all stack instances in the specified accounts and Amazon /// Web Services Regions.You can specify Accounts or DeploymentTargets, but not both. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Accounts")] public System.String[] Account { get; set; } #endregion #region Parameter DeploymentTargets_Account /// /// /// The names of one or more Amazon Web Services accounts for which you want to deploy /// stack set updates. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("DeploymentTargets_Accounts")] public System.String[] DeploymentTargets_Account { get; set; } #endregion #region Parameter DeploymentTargets_AccountsUrl /// /// /// Returns the value of the AccountsUrl property. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String DeploymentTargets_AccountsUrl { get; set; } #endregion #region Parameter CallAs /// /// /// [Service-managed permissions] Specifies whether you are acting as an account administrator /// in the organization's management account or as a delegated administrator in a member /// account.By default, SELF is specified. Use SELF for stack sets with /// self-managed permissions. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.CloudFormation.CallAs")] public Amazon.CloudFormation.CallAs CallAs { get; set; } #endregion #region Parameter OperationId /// /// /// The unique identifier for this stack set operation.The operation ID also functions as an idempotency token, to ensure that CloudFormation /// performs the stack set operation only once, even if you retry the request multiple /// times. You might retry stack set operation requests to ensure that CloudFormation /// successfully received them.If you don't specify an operation ID, the SDK generates one automatically. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String OperationId { get; set; } #endregion #region Parameter OperationPreference /// /// /// Preferences for how CloudFormation performs this stack set operation. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("OperationPreferences")] public Amazon.CloudFormation.Model.StackSetOperationPreferences OperationPreference { get; set; } #endregion #region Parameter DeploymentTargets_OrganizationalUnitId /// /// /// The organization root ID or organizational unit (OU) IDs to which StackSets deploys. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("DeploymentTargets_OrganizationalUnitIds")] public System.String[] DeploymentTargets_OrganizationalUnitId { get; set; } #endregion #region Parameter ParameterOverride /// /// /// A list of input parameters whose values you want to update for the specified stack /// instances.Any overridden parameter values will be applied to all stack instances in the specified /// accounts and Amazon Web Services Regions. When specifying parameters and their values, /// be aware of how CloudFormation sets parameter values during stack instance update /// operations:During stack set updates, any parameter values overridden for a stack instance aren't /// updated, but retain their overridden value.You can only override the parameter values that are specified in the stack /// set; to add or delete a parameter itself, use UpdateStackSet to update /// the stack set template. If you add a parameter to a template, before you can override /// the parameter value specified in the stack set you must first use UpdateStackSet /// to update all stack instances with the updated template and parameter value specified /// in the stack set. Once a stack instance has been updated with the new parameter, you /// can then override the parameter value using UpdateStackInstances. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("ParameterOverrides")] public Amazon.CloudFormation.Model.Parameter[] ParameterOverride { get; set; } #endregion #region Parameter StackInstanceRegion /// /// /// The names of one or more Amazon Web Services Regions in which you want to update parameter /// values for stack instances. The overridden parameter values will be applied to all /// stack instances in the specified accounts and Amazon Web Services Regions. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyCollection] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String[] StackInstanceRegion { get; set; } #endregion #region Parameter StackSetName /// /// /// The name or unique ID of the stack set associated with the stack instances. /// /// #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 StackSetName { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'OperationId'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFormation.Model.UpdateStackInstancesResponse). /// Specifying the name of a property of type Amazon.CloudFormation.Model.UpdateStackInstancesResponse 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; } = "OperationId"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the StackSetName parameter. /// The -PassThru parameter is deprecated, use -Select '^StackSetName' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^StackSetName' 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.StackSetName), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-CFNStackInstance (UpdateStackInstances)")) { 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.StackSetName; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute if (this.Account != null) { context.Account = new List(this.Account); } context.CallAs = this.CallAs; context.DeploymentTargets_AccountFilterType = this.DeploymentTargets_AccountFilterType; if (this.DeploymentTargets_Account != null) { context.DeploymentTargets_Account = new List(this.DeploymentTargets_Account); } context.DeploymentTargets_AccountsUrl = this.DeploymentTargets_AccountsUrl; if (this.DeploymentTargets_OrganizationalUnitId != null) { context.DeploymentTargets_OrganizationalUnitId = new List(this.DeploymentTargets_OrganizationalUnitId); } context.OperationId = this.OperationId; context.OperationPreference = this.OperationPreference; if (this.ParameterOverride != null) { context.ParameterOverride = new List(this.ParameterOverride); } if (this.StackInstanceRegion != null) { context.StackInstanceRegion = new List(this.StackInstanceRegion); } #if MODULAR if (this.StackInstanceRegion == null && ParameterWasBound(nameof(this.StackInstanceRegion))) { WriteWarning("You are passing $null as a value for parameter StackInstanceRegion 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.StackSetName = this.StackSetName; #if MODULAR if (this.StackSetName == null && ParameterWasBound(nameof(this.StackSetName))) { WriteWarning("You are passing $null as a value for parameter StackSetName 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.UpdateStackInstancesRequest(); if (cmdletContext.Account != null) { request.Accounts = cmdletContext.Account; } if (cmdletContext.CallAs != null) { request.CallAs = cmdletContext.CallAs; } // populate DeploymentTargets var requestDeploymentTargetsIsNull = true; request.DeploymentTargets = new Amazon.CloudFormation.Model.DeploymentTargets(); Amazon.CloudFormation.AccountFilterType requestDeploymentTargets_deploymentTargets_AccountFilterType = null; if (cmdletContext.DeploymentTargets_AccountFilterType != null) { requestDeploymentTargets_deploymentTargets_AccountFilterType = cmdletContext.DeploymentTargets_AccountFilterType; } if (requestDeploymentTargets_deploymentTargets_AccountFilterType != null) { request.DeploymentTargets.AccountFilterType = requestDeploymentTargets_deploymentTargets_AccountFilterType; requestDeploymentTargetsIsNull = false; } List requestDeploymentTargets_deploymentTargets_Account = null; if (cmdletContext.DeploymentTargets_Account != null) { requestDeploymentTargets_deploymentTargets_Account = cmdletContext.DeploymentTargets_Account; } if (requestDeploymentTargets_deploymentTargets_Account != null) { request.DeploymentTargets.Accounts = requestDeploymentTargets_deploymentTargets_Account; requestDeploymentTargetsIsNull = false; } System.String requestDeploymentTargets_deploymentTargets_AccountsUrl = null; if (cmdletContext.DeploymentTargets_AccountsUrl != null) { requestDeploymentTargets_deploymentTargets_AccountsUrl = cmdletContext.DeploymentTargets_AccountsUrl; } if (requestDeploymentTargets_deploymentTargets_AccountsUrl != null) { request.DeploymentTargets.AccountsUrl = requestDeploymentTargets_deploymentTargets_AccountsUrl; requestDeploymentTargetsIsNull = false; } List requestDeploymentTargets_deploymentTargets_OrganizationalUnitId = null; if (cmdletContext.DeploymentTargets_OrganizationalUnitId != null) { requestDeploymentTargets_deploymentTargets_OrganizationalUnitId = cmdletContext.DeploymentTargets_OrganizationalUnitId; } if (requestDeploymentTargets_deploymentTargets_OrganizationalUnitId != null) { request.DeploymentTargets.OrganizationalUnitIds = requestDeploymentTargets_deploymentTargets_OrganizationalUnitId; requestDeploymentTargetsIsNull = false; } // determine if request.DeploymentTargets should be set to null if (requestDeploymentTargetsIsNull) { request.DeploymentTargets = null; } if (cmdletContext.OperationId != null) { request.OperationId = cmdletContext.OperationId; } if (cmdletContext.OperationPreference != null) { request.OperationPreferences = cmdletContext.OperationPreference; } if (cmdletContext.ParameterOverride != null) { request.ParameterOverrides = cmdletContext.ParameterOverride; } if (cmdletContext.StackInstanceRegion != null) { request.Regions = cmdletContext.StackInstanceRegion; } if (cmdletContext.StackSetName != null) { request.StackSetName = cmdletContext.StackSetName; } 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.UpdateStackInstancesResponse CallAWSServiceOperation(IAmazonCloudFormation client, Amazon.CloudFormation.Model.UpdateStackInstancesRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS CloudFormation", "UpdateStackInstances"); try { #if DESKTOP return client.UpdateStackInstances(request); #elif CORECLR return client.UpdateStackInstancesAsync(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 Account { get; set; } public Amazon.CloudFormation.CallAs CallAs { get; set; } public Amazon.CloudFormation.AccountFilterType DeploymentTargets_AccountFilterType { get; set; } public List DeploymentTargets_Account { get; set; } public System.String DeploymentTargets_AccountsUrl { get; set; } public List DeploymentTargets_OrganizationalUnitId { get; set; } public System.String OperationId { get; set; } public Amazon.CloudFormation.Model.StackSetOperationPreferences OperationPreference { get; set; } public List ParameterOverride { get; set; } public List StackInstanceRegion { get; set; } public System.String StackSetName { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.OperationId; } } }