/******************************************************************************* * 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 { /// /// Provisions the specified product. /// /// /// /// A provisioned product is a resourced instance of a product. For example, provisioning /// a product that's based on an CloudFormation template launches an CloudFormation stack /// and its underlying resources. You can check the status of this request using DescribeRecord. /// /// /// If the request contains a tag key with an empty list of values, there's a tag conflict /// for that key. Don't include conflicted keys as tags, or this will cause the error /// "Parameter validation failed: Missing required parameter in Tags[N]:Value". /// /// /// When provisioning a product that's been added to a portfolio, you must grant your /// user, group, or role access to the portfolio. For more information, see Granting /// users access in the Service Catalog User Guide. /// /// [Cmdlet("New", "SCProvisionedProduct", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.ServiceCatalog.Model.RecordDetail")] [AWSCmdlet("Calls the AWS Service Catalog ProvisionProduct API operation.", Operation = new[] {"ProvisionProduct"}, SelectReturnType = typeof(Amazon.ServiceCatalog.Model.ProvisionProductResponse))] [AWSCmdletOutput("Amazon.ServiceCatalog.Model.RecordDetail or Amazon.ServiceCatalog.Model.ProvisionProductResponse", "This cmdlet returns an Amazon.ServiceCatalog.Model.RecordDetail object.", "The service call response (type Amazon.ServiceCatalog.Model.ProvisionProductResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewSCProvisionedProductCmdlet : AmazonServiceCatalogClientCmdlet, IExecutor { #region Parameter AcceptLanguage /// /// /// The language code. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String AcceptLanguage { get; set; } #endregion #region Parameter NotificationArn /// /// /// Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("NotificationArns")] public System.String[] NotificationArn { get; set; } #endregion #region Parameter PathId /// /// /// The path identifier of the product. This value is optional if the product has a default /// path, and required if the product has more than one path. To list the paths for a /// product, use ListLaunchPaths. You must provide the name or ID, but not both. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String PathId { get; set; } #endregion #region Parameter PathName /// /// /// The name of the path. You must provide the name or ID, but not both. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String PathName { get; set; } #endregion #region Parameter ProductId /// /// /// The product identifier. You must provide the name or ID, but not both. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ProductId { get; set; } #endregion #region Parameter ProductName /// /// /// The name of the product. You must provide the name or ID, but not both. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ProductName { get; set; } #endregion #region Parameter ProvisionedProductName /// /// /// A user-friendly name for the provisioned product. This value must be unique for the /// Amazon Web Services account and cannot be updated after the product is provisioned. /// /// #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 ProvisionedProductName { get; set; } #endregion #region Parameter ProvisioningArtifactId /// /// /// The identifier of the provisioning artifact. You must provide the name or ID, but /// not both. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ProvisioningArtifactId { get; set; } #endregion #region Parameter ProvisioningArtifactName /// /// /// The name of the provisioning artifact. You must provide the name or ID, but not both. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ProvisioningArtifactName { get; set; } #endregion #region Parameter ProvisioningParameter /// /// /// Parameters specified by the administrator that are required for provisioning the product. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("ProvisioningParameters")] public Amazon.ServiceCatalog.Model.ProvisioningParameter[] ProvisioningParameter { get; set; } #endregion #region Parameter ProvisionToken /// /// /// An idempotency token that uniquely identifies the provisioning request. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ProvisionToken { get; set; } #endregion #region Parameter ProvisioningPreferences_StackSetAccount /// /// /// One or more Amazon Web Services accounts where the provisioned product will be available.Applicable only to a CFN_STACKSET provisioned product type.The specified accounts should be within the list of accounts from the STACKSET /// constraint. To get the list of accounts in the STACKSET constraint, use /// the DescribeProvisioningParameters operation.If no values are specified, the default value is all acounts from the STACKSET /// constraint. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("ProvisioningPreferences_StackSetAccounts")] public System.String[] ProvisioningPreferences_StackSetAccount { get; set; } #endregion #region Parameter ProvisioningPreferences_StackSetFailureToleranceCount /// /// /// The number of accounts, per Region, for which this operation can fail before Service /// Catalog stops the operation in that Region. If the operation is stopped in a Region, /// Service Catalog doesn't attempt the operation in any subsequent Regions.Applicable only to a CFN_STACKSET provisioned product type.Conditional: You must specify either StackSetFailureToleranceCount or /// StackSetFailureTolerancePercentage, but not both.The default value is 0 if no value is specified. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? ProvisioningPreferences_StackSetFailureToleranceCount { get; set; } #endregion #region Parameter ProvisioningPreferences_StackSetFailureTolerancePercentage /// /// /// The percentage of accounts, per Region, for which this stack operation can fail before /// Service Catalog stops the operation in that Region. If the operation is stopped in /// a Region, Service Catalog doesn't attempt the operation in any subsequent Regions.When calculating the number of accounts based on the specified percentage, Service /// Catalog rounds down to the next whole number.Applicable only to a CFN_STACKSET provisioned product type.Conditional: You must specify either StackSetFailureToleranceCount or /// StackSetFailureTolerancePercentage, but not both. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? ProvisioningPreferences_StackSetFailureTolerancePercentage { get; set; } #endregion #region Parameter ProvisioningPreferences_StackSetMaxConcurrencyCount /// /// /// The maximum number of accounts in which to perform this operation at one time. This /// is dependent on the value of StackSetFailureToleranceCount. StackSetMaxConcurrentCount /// is at most one more than the StackSetFailureToleranceCount.Note that this setting lets you specify the maximum for operations. For large deployments, /// under certain circumstances the actual number of accounts acted upon concurrently /// may be lower due to service throttling.Applicable only to a CFN_STACKSET provisioned product type.Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, /// but not both. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? ProvisioningPreferences_StackSetMaxConcurrencyCount { get; set; } #endregion #region Parameter ProvisioningPreferences_StackSetMaxConcurrencyPercentage /// /// /// The maximum percentage of accounts in which to perform this operation at one time.When calculating the number of accounts based on the specified percentage, Service /// Catalog rounds down to the next whole number. This is true except in cases where rounding /// down would result is zero. In this case, Service Catalog sets the number as 1 /// instead.Note that this setting lets you specify the maximum for operations. For large deployments, /// under certain circumstances the actual number of accounts acted upon concurrently /// may be lower due to service throttling.Applicable only to a CFN_STACKSET provisioned product type.Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, /// but not both. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? ProvisioningPreferences_StackSetMaxConcurrencyPercentage { get; set; } #endregion #region Parameter ProvisioningPreferences_StackSetRegion /// /// /// One or more Amazon Web Services Regions where the provisioned product will be available.Applicable only to a CFN_STACKSET provisioned product type.The specified Regions should be within the list of Regions from the STACKSET /// constraint. To get the list of Regions in the STACKSET constraint, use /// the DescribeProvisioningParameters operation.If no values are specified, the default value is all Regions from the STACKSET /// constraint. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("ProvisioningPreferences_StackSetRegions")] public System.String[] ProvisioningPreferences_StackSetRegion { get; set; } #endregion #region Parameter Tag /// /// /// One or more tags. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Tags")] public Amazon.ServiceCatalog.Model.Tag[] Tag { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'RecordDetail'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceCatalog.Model.ProvisionProductResponse). /// Specifying the name of a property of type Amazon.ServiceCatalog.Model.ProvisionProductResponse 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; } = "RecordDetail"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the ProvisionedProductName parameter. /// The -PassThru parameter is deprecated, use -Select '^ProvisionedProductName' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ProvisionedProductName' 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.ProvisionedProductName), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-SCProvisionedProduct (ProvisionProduct)")) { 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.ProvisionedProductName; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.AcceptLanguage = this.AcceptLanguage; if (this.NotificationArn != null) { context.NotificationArn = new List(this.NotificationArn); } context.PathId = this.PathId; context.PathName = this.PathName; context.ProductId = this.ProductId; context.ProductName = this.ProductName; context.ProvisionedProductName = this.ProvisionedProductName; #if MODULAR if (this.ProvisionedProductName == null && ParameterWasBound(nameof(this.ProvisionedProductName))) { WriteWarning("You are passing $null as a value for parameter ProvisionedProductName 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.ProvisioningArtifactId = this.ProvisioningArtifactId; context.ProvisioningArtifactName = this.ProvisioningArtifactName; if (this.ProvisioningParameter != null) { context.ProvisioningParameter = new List(this.ProvisioningParameter); } if (this.ProvisioningPreferences_StackSetAccount != null) { context.ProvisioningPreferences_StackSetAccount = new List(this.ProvisioningPreferences_StackSetAccount); } context.ProvisioningPreferences_StackSetFailureToleranceCount = this.ProvisioningPreferences_StackSetFailureToleranceCount; context.ProvisioningPreferences_StackSetFailureTolerancePercentage = this.ProvisioningPreferences_StackSetFailureTolerancePercentage; context.ProvisioningPreferences_StackSetMaxConcurrencyCount = this.ProvisioningPreferences_StackSetMaxConcurrencyCount; context.ProvisioningPreferences_StackSetMaxConcurrencyPercentage = this.ProvisioningPreferences_StackSetMaxConcurrencyPercentage; if (this.ProvisioningPreferences_StackSetRegion != null) { context.ProvisioningPreferences_StackSetRegion = new List(this.ProvisioningPreferences_StackSetRegion); } context.ProvisionToken = this.ProvisionToken; if (this.Tag != null) { context.Tag = new List(this.Tag); } // 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.ProvisionProductRequest(); if (cmdletContext.AcceptLanguage != null) { request.AcceptLanguage = cmdletContext.AcceptLanguage; } if (cmdletContext.NotificationArn != null) { request.NotificationArns = cmdletContext.NotificationArn; } if (cmdletContext.PathId != null) { request.PathId = cmdletContext.PathId; } if (cmdletContext.PathName != null) { request.PathName = cmdletContext.PathName; } if (cmdletContext.ProductId != null) { request.ProductId = cmdletContext.ProductId; } if (cmdletContext.ProductName != null) { request.ProductName = cmdletContext.ProductName; } if (cmdletContext.ProvisionedProductName != null) { request.ProvisionedProductName = cmdletContext.ProvisionedProductName; } if (cmdletContext.ProvisioningArtifactId != null) { request.ProvisioningArtifactId = cmdletContext.ProvisioningArtifactId; } if (cmdletContext.ProvisioningArtifactName != null) { request.ProvisioningArtifactName = cmdletContext.ProvisioningArtifactName; } if (cmdletContext.ProvisioningParameter != null) { request.ProvisioningParameters = cmdletContext.ProvisioningParameter; } // populate ProvisioningPreferences var requestProvisioningPreferencesIsNull = true; request.ProvisioningPreferences = new Amazon.ServiceCatalog.Model.ProvisioningPreferences(); List requestProvisioningPreferences_provisioningPreferences_StackSetAccount = null; if (cmdletContext.ProvisioningPreferences_StackSetAccount != null) { requestProvisioningPreferences_provisioningPreferences_StackSetAccount = cmdletContext.ProvisioningPreferences_StackSetAccount; } if (requestProvisioningPreferences_provisioningPreferences_StackSetAccount != null) { request.ProvisioningPreferences.StackSetAccounts = requestProvisioningPreferences_provisioningPreferences_StackSetAccount; requestProvisioningPreferencesIsNull = false; } System.Int32? requestProvisioningPreferences_provisioningPreferences_StackSetFailureToleranceCount = null; if (cmdletContext.ProvisioningPreferences_StackSetFailureToleranceCount != null) { requestProvisioningPreferences_provisioningPreferences_StackSetFailureToleranceCount = cmdletContext.ProvisioningPreferences_StackSetFailureToleranceCount.Value; } if (requestProvisioningPreferences_provisioningPreferences_StackSetFailureToleranceCount != null) { request.ProvisioningPreferences.StackSetFailureToleranceCount = requestProvisioningPreferences_provisioningPreferences_StackSetFailureToleranceCount.Value; requestProvisioningPreferencesIsNull = false; } System.Int32? requestProvisioningPreferences_provisioningPreferences_StackSetFailureTolerancePercentage = null; if (cmdletContext.ProvisioningPreferences_StackSetFailureTolerancePercentage != null) { requestProvisioningPreferences_provisioningPreferences_StackSetFailureTolerancePercentage = cmdletContext.ProvisioningPreferences_StackSetFailureTolerancePercentage.Value; } if (requestProvisioningPreferences_provisioningPreferences_StackSetFailureTolerancePercentage != null) { request.ProvisioningPreferences.StackSetFailureTolerancePercentage = requestProvisioningPreferences_provisioningPreferences_StackSetFailureTolerancePercentage.Value; requestProvisioningPreferencesIsNull = false; } System.Int32? requestProvisioningPreferences_provisioningPreferences_StackSetMaxConcurrencyCount = null; if (cmdletContext.ProvisioningPreferences_StackSetMaxConcurrencyCount != null) { requestProvisioningPreferences_provisioningPreferences_StackSetMaxConcurrencyCount = cmdletContext.ProvisioningPreferences_StackSetMaxConcurrencyCount.Value; } if (requestProvisioningPreferences_provisioningPreferences_StackSetMaxConcurrencyCount != null) { request.ProvisioningPreferences.StackSetMaxConcurrencyCount = requestProvisioningPreferences_provisioningPreferences_StackSetMaxConcurrencyCount.Value; requestProvisioningPreferencesIsNull = false; } System.Int32? requestProvisioningPreferences_provisioningPreferences_StackSetMaxConcurrencyPercentage = null; if (cmdletContext.ProvisioningPreferences_StackSetMaxConcurrencyPercentage != null) { requestProvisioningPreferences_provisioningPreferences_StackSetMaxConcurrencyPercentage = cmdletContext.ProvisioningPreferences_StackSetMaxConcurrencyPercentage.Value; } if (requestProvisioningPreferences_provisioningPreferences_StackSetMaxConcurrencyPercentage != null) { request.ProvisioningPreferences.StackSetMaxConcurrencyPercentage = requestProvisioningPreferences_provisioningPreferences_StackSetMaxConcurrencyPercentage.Value; requestProvisioningPreferencesIsNull = false; } List requestProvisioningPreferences_provisioningPreferences_StackSetRegion = null; if (cmdletContext.ProvisioningPreferences_StackSetRegion != null) { requestProvisioningPreferences_provisioningPreferences_StackSetRegion = cmdletContext.ProvisioningPreferences_StackSetRegion; } if (requestProvisioningPreferences_provisioningPreferences_StackSetRegion != null) { request.ProvisioningPreferences.StackSetRegions = requestProvisioningPreferences_provisioningPreferences_StackSetRegion; requestProvisioningPreferencesIsNull = false; } // determine if request.ProvisioningPreferences should be set to null if (requestProvisioningPreferencesIsNull) { request.ProvisioningPreferences = null; } if (cmdletContext.ProvisionToken != null) { request.ProvisionToken = cmdletContext.ProvisionToken; } 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.ServiceCatalog.Model.ProvisionProductResponse CallAWSServiceOperation(IAmazonServiceCatalog client, Amazon.ServiceCatalog.Model.ProvisionProductRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Service Catalog", "ProvisionProduct"); try { #if DESKTOP return client.ProvisionProduct(request); #elif CORECLR return client.ProvisionProductAsync(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 List NotificationArn { get; set; } public System.String PathId { get; set; } public System.String PathName { get; set; } public System.String ProductId { get; set; } public System.String ProductName { get; set; } public System.String ProvisionedProductName { get; set; } public System.String ProvisioningArtifactId { get; set; } public System.String ProvisioningArtifactName { get; set; } public List ProvisioningParameter { get; set; } public List ProvisioningPreferences_StackSetAccount { get; set; } public System.Int32? ProvisioningPreferences_StackSetFailureToleranceCount { get; set; } public System.Int32? ProvisioningPreferences_StackSetFailureTolerancePercentage { get; set; } public System.Int32? ProvisioningPreferences_StackSetMaxConcurrencyCount { get; set; } public System.Int32? ProvisioningPreferences_StackSetMaxConcurrencyPercentage { get; set; } public List ProvisioningPreferences_StackSetRegion { get; set; } public System.String ProvisionToken { get; set; } public List Tag { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.RecordDetail; } } }