/******************************************************************************* * 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 { /// /// Creates a plan. /// /// /// /// A plan includes the list of resources to be created (when provisioning a new product) /// or modified (when updating a provisioned product) when the plan is executed. /// /// You can create one plan for each provisioned product. To create a plan for an existing /// provisioned product, the product status must be AVAILABLE or TAINTED. /// /// To view the resource changes in the change set, use DescribeProvisionedProductPlan. /// To create or modify the provisioned product, use ExecuteProvisionedProductPlan. /// /// [Cmdlet("New", "SCProvisionedProductPlan", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.ServiceCatalog.Model.CreateProvisionedProductPlanResponse")] [AWSCmdlet("Calls the AWS Service Catalog CreateProvisionedProductPlan API operation.", Operation = new[] {"CreateProvisionedProductPlan"}, SelectReturnType = typeof(Amazon.ServiceCatalog.Model.CreateProvisionedProductPlanResponse))] [AWSCmdletOutput("Amazon.ServiceCatalog.Model.CreateProvisionedProductPlanResponse", "This cmdlet returns an Amazon.ServiceCatalog.Model.CreateProvisionedProductPlanResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewSCProvisionedProductPlanCmdlet : AmazonServiceCatalogClientCmdlet, IExecutor { #region Parameter AcceptLanguage /// /// /// The language code. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String AcceptLanguage { get; set; } #endregion #region Parameter IdempotencyToken /// /// /// A unique identifier that you provide to ensure idempotency. If multiple requests differ /// only by the idempotency token, the same response is returned for each repeated request. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String IdempotencyToken { 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. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String PathId { get; set; } #endregion #region Parameter PlanName /// /// /// The name of the plan. /// /// #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 PlanName { get; set; } #endregion #region Parameter PlanType /// /// /// The plan type. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [AWSConstantClassSource("Amazon.ServiceCatalog.ProvisionedProductPlanType")] public Amazon.ServiceCatalog.ProvisionedProductPlanType PlanType { get; set; } #endregion #region Parameter ProductId /// /// /// The product identifier. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String ProductId { 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(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = 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. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String ProvisioningArtifactId { 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.UpdateProvisioningParameter[] ProvisioningParameter { get; set; } #endregion #region Parameter Tag /// /// /// One or more tags.If the plan is for an existing provisioned product, the product must have a RESOURCE_UPDATE /// constraint with TagUpdatesOnProvisionedProduct set to ALLOWED /// to allow tag updates. /// /// [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 '*'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceCatalog.Model.CreateProvisionedProductPlanResponse). /// Specifying the name of a property of type Amazon.ServiceCatalog.Model.CreateProvisionedProductPlanResponse 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 PlanName parameter. /// The -PassThru parameter is deprecated, use -Select '^PlanName' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^PlanName' 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.PlanName), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-SCProvisionedProductPlan (CreateProvisionedProductPlan)")) { 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.PlanName; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.AcceptLanguage = this.AcceptLanguage; context.IdempotencyToken = this.IdempotencyToken; if (this.NotificationArn != null) { context.NotificationArn = new List(this.NotificationArn); } context.PathId = this.PathId; context.PlanName = this.PlanName; #if MODULAR if (this.PlanName == null && ParameterWasBound(nameof(this.PlanName))) { WriteWarning("You are passing $null as a value for parameter PlanName 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.PlanType = this.PlanType; #if MODULAR if (this.PlanType == null && ParameterWasBound(nameof(this.PlanType))) { WriteWarning("You are passing $null as a value for parameter PlanType 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.ProductId = this.ProductId; #if MODULAR if (this.ProductId == null && ParameterWasBound(nameof(this.ProductId))) { WriteWarning("You are passing $null as a value for parameter ProductId 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.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; #if MODULAR if (this.ProvisioningArtifactId == null && ParameterWasBound(nameof(this.ProvisioningArtifactId))) { WriteWarning("You are passing $null as a value for parameter ProvisioningArtifactId 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 if (this.ProvisioningParameter != null) { context.ProvisioningParameter = new List(this.ProvisioningParameter); } 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.CreateProvisionedProductPlanRequest(); if (cmdletContext.AcceptLanguage != null) { request.AcceptLanguage = cmdletContext.AcceptLanguage; } if (cmdletContext.IdempotencyToken != null) { request.IdempotencyToken = cmdletContext.IdempotencyToken; } if (cmdletContext.NotificationArn != null) { request.NotificationArns = cmdletContext.NotificationArn; } if (cmdletContext.PathId != null) { request.PathId = cmdletContext.PathId; } if (cmdletContext.PlanName != null) { request.PlanName = cmdletContext.PlanName; } if (cmdletContext.PlanType != null) { request.PlanType = cmdletContext.PlanType; } if (cmdletContext.ProductId != null) { request.ProductId = cmdletContext.ProductId; } if (cmdletContext.ProvisionedProductName != null) { request.ProvisionedProductName = cmdletContext.ProvisionedProductName; } if (cmdletContext.ProvisioningArtifactId != null) { request.ProvisioningArtifactId = cmdletContext.ProvisioningArtifactId; } if (cmdletContext.ProvisioningParameter != null) { request.ProvisioningParameters = cmdletContext.ProvisioningParameter; } 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.CreateProvisionedProductPlanResponse CallAWSServiceOperation(IAmazonServiceCatalog client, Amazon.ServiceCatalog.Model.CreateProvisionedProductPlanRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Service Catalog", "CreateProvisionedProductPlan"); try { #if DESKTOP return client.CreateProvisionedProductPlan(request); #elif CORECLR return client.CreateProvisionedProductPlanAsync(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 IdempotencyToken { get; set; } public List NotificationArn { get; set; } public System.String PathId { get; set; } public System.String PlanName { get; set; } public Amazon.ServiceCatalog.ProvisionedProductPlanType PlanType { get; set; } public System.String ProductId { get; set; } public System.String ProvisionedProductName { get; set; } public System.String ProvisioningArtifactId { get; set; } public List ProvisioningParameter { get; set; } public List Tag { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }