/******************************************************************************* * 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.ServiceCatalog; using Amazon.ServiceCatalog.Model; namespace Amazon.PowerShell.Cmdlets.SC { /// /// Updates the specified constraint. /// [Cmdlet("Update", "SCConstraint", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.ServiceCatalog.Model.UpdateConstraintResponse")] [AWSCmdlet("Calls the AWS Service Catalog UpdateConstraint API operation.", Operation = new[] {"UpdateConstraint"}, SelectReturnType = typeof(Amazon.ServiceCatalog.Model.UpdateConstraintResponse))] [AWSCmdletOutput("Amazon.ServiceCatalog.Model.UpdateConstraintResponse", "This cmdlet returns an Amazon.ServiceCatalog.Model.UpdateConstraintResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class UpdateSCConstraintCmdlet : AmazonServiceCatalogClientCmdlet, IExecutor { #region Parameter AcceptLanguage /// /// /// The language code. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String AcceptLanguage { get; set; } #endregion #region Parameter Description /// /// /// The updated description of the constraint. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Description { get; set; } #endregion #region Parameter Id /// /// /// The identifier of the constraint. /// /// #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 Id { get; set; } #endregion #region Parameter Parameter /// /// /// The constraint parameters, in JSON format. The syntax depends on the constraint type /// as follows:
LAUNCH
You are required to specify either the RoleArn or the LocalRoleName /// but can't use both.Specify the RoleArn property as follows:{"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"}Specify the LocalRoleName property as follows:{"LocalRoleName": "SCBasicLaunchRole"}If you specify the LocalRoleName property, when an account uses the launch /// constraint, the IAM role with that name in the account will be used. This allows launch-role /// constraints to be account-agnostic so the administrator can create fewer resources /// per shared account.The given role name must exist in the account used to create the launch constraint /// and the account of the user who launches a product with this launch constraint.You cannot have both a LAUNCH and a STACKSET constraint.You also cannot have more than one LAUNCH constraint on a product and /// portfolio.
NOTIFICATION
Specify the NotificationArns property as follows:{"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]}
RESOURCE_UPDATE
Specify the TagUpdatesOnProvisionedProduct property as follows:{"Version":"2.0","Properties":{"TagUpdateOnProvisionedProduct":"String"}}The TagUpdatesOnProvisionedProduct property accepts a string value of /// ALLOWED or NOT_ALLOWED.
STACKSET
Specify the Parameters property as follows:{"Version": "String", "Properties": {"AccountList": [ "String" ], "RegionList": /// [ "String" ], "AdminRole": "String", "ExecutionRole": "String"}}You cannot have both a LAUNCH and a STACKSET constraint.You also cannot have more than one STACKSET constraint on a product and /// portfolio.Products with a STACKSET constraint will launch an CloudFormation stack /// set.
TEMPLATE
Specify the Rules property. For more information, see Template /// Constraint Rules.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Parameters")] public System.String Parameter { 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.ServiceCatalog.Model.UpdateConstraintResponse). /// Specifying the name of a property of type Amazon.ServiceCatalog.Model.UpdateConstraintResponse 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 Id parameter. /// The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Id' 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.Id), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-SCConstraint (UpdateConstraint)")) { 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.Id; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.AcceptLanguage = this.AcceptLanguage; context.Description = this.Description; context.Id = this.Id; #if MODULAR if (this.Id == null && ParameterWasBound(nameof(this.Id))) { WriteWarning("You are passing $null as a value for parameter Id 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.Parameter = this.Parameter; // 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.ServiceCatalog.Model.UpdateConstraintRequest(); if (cmdletContext.AcceptLanguage != null) { request.AcceptLanguage = cmdletContext.AcceptLanguage; } if (cmdletContext.Description != null) { request.Description = cmdletContext.Description; } if (cmdletContext.Id != null) { request.Id = cmdletContext.Id; } if (cmdletContext.Parameter != null) { request.Parameters = cmdletContext.Parameter; } 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.ServiceCatalog.Model.UpdateConstraintResponse CallAWSServiceOperation(IAmazonServiceCatalog client, Amazon.ServiceCatalog.Model.UpdateConstraintRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Service Catalog", "UpdateConstraint"); try { #if DESKTOP return client.UpdateConstraint(request); #elif CORECLR return client.UpdateConstraintAsync(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 AcceptLanguage { get; set; } public System.String Description { get; set; } public System.String Id { get; set; } public System.String Parameter { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }