/******************************************************************************* * 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.Proton; using Amazon.Proton.Model; namespace Amazon.PowerShell.Cmdlets.PRO { /// /// Create an Proton component. A component is an infrastructure extension for a service /// instance. /// /// /// /// For more information about components, see Proton /// components in the Proton User Guide. /// /// [Cmdlet("New", "PROComponent", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.Proton.Model.Component")] [AWSCmdlet("Calls the AWS Proton CreateComponent API operation.", Operation = new[] {"CreateComponent"}, SelectReturnType = typeof(Amazon.Proton.Model.CreateComponentResponse))] [AWSCmdletOutput("Amazon.Proton.Model.Component or Amazon.Proton.Model.CreateComponentResponse", "This cmdlet returns an Amazon.Proton.Model.Component object.", "The service call response (type Amazon.Proton.Model.CreateComponentResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewPROComponentCmdlet : AmazonProtonClientCmdlet, IExecutor { protected override bool IsSensitiveRequest { get; set; } = true; protected override bool IsSensitiveResponse { get; set; } = true; #region Parameter Description /// /// /// An optional customer-provided description of the component. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Description { get; set; } #endregion #region Parameter EnvironmentName /// /// /// The name of the Proton environment that you want to associate this component with. /// You must specify this when you don't specify serviceInstanceName and /// serviceName. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String EnvironmentName { get; set; } #endregion #region Parameter Manifest /// /// /// A path to a manifest file that lists the Infrastructure as Code (IaC) file, template /// language, and rendering engine for infrastructure that a custom component provisions. /// /// #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 Manifest { get; set; } #endregion #region Parameter Name /// /// /// The customer-provided name of the component. /// /// #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 Name { get; set; } #endregion #region Parameter ServiceInstanceName /// /// /// The name of the service instance that you want to attach this component to. If you /// don't specify this, the component isn't attached to any service instance. Specify /// both serviceInstanceName and serviceName or neither of them. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ServiceInstanceName { get; set; } #endregion #region Parameter ServiceName /// /// /// The name of the service that serviceInstanceName is associated with. /// If you don't specify this, the component isn't attached to any service instance. Specify /// both serviceInstanceName and serviceName or neither of them. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ServiceName { get; set; } #endregion #region Parameter ServiceSpec /// /// /// The service spec that you want the component to use to access service inputs. Set /// this only when you attach the component to a service instance. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ServiceSpec { get; set; } #endregion #region Parameter Tag /// /// /// An optional list of metadata items that you can associate with the Proton component. /// A tag is a key-value pair.For more information, see Proton /// resources and tagging in the Proton User Guide. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Tags")] public Amazon.Proton.Model.Tag[] Tag { get; set; } #endregion #region Parameter TemplateFile /// /// /// A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom /// component provisions.Components support a single IaC file, even if you use Terraform as your template language. /// /// #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 TemplateFile { get; set; } #endregion #region Parameter ClientToken /// /// /// The client token for the created component. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ClientToken { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'Component'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.CreateComponentResponse). /// Specifying the name of a property of type Amazon.Proton.Model.CreateComponentResponse 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; } = "Component"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the Name parameter. /// The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Name' 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.Name), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-PROComponent (CreateComponent)")) { 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.Name; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.ClientToken = this.ClientToken; context.Description = this.Description; context.EnvironmentName = this.EnvironmentName; context.Manifest = this.Manifest; #if MODULAR if (this.Manifest == null && ParameterWasBound(nameof(this.Manifest))) { WriteWarning("You are passing $null as a value for parameter Manifest 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.Name = this.Name; #if MODULAR if (this.Name == null && ParameterWasBound(nameof(this.Name))) { WriteWarning("You are passing $null as a value for parameter Name 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.ServiceInstanceName = this.ServiceInstanceName; context.ServiceName = this.ServiceName; context.ServiceSpec = this.ServiceSpec; if (this.Tag != null) { context.Tag = new List(this.Tag); } context.TemplateFile = this.TemplateFile; #if MODULAR if (this.TemplateFile == null && ParameterWasBound(nameof(this.TemplateFile))) { WriteWarning("You are passing $null as a value for parameter TemplateFile 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.Proton.Model.CreateComponentRequest(); if (cmdletContext.ClientToken != null) { request.ClientToken = cmdletContext.ClientToken; } if (cmdletContext.Description != null) { request.Description = cmdletContext.Description; } if (cmdletContext.EnvironmentName != null) { request.EnvironmentName = cmdletContext.EnvironmentName; } if (cmdletContext.Manifest != null) { request.Manifest = cmdletContext.Manifest; } if (cmdletContext.Name != null) { request.Name = cmdletContext.Name; } if (cmdletContext.ServiceInstanceName != null) { request.ServiceInstanceName = cmdletContext.ServiceInstanceName; } if (cmdletContext.ServiceName != null) { request.ServiceName = cmdletContext.ServiceName; } if (cmdletContext.ServiceSpec != null) { request.ServiceSpec = cmdletContext.ServiceSpec; } if (cmdletContext.Tag != null) { request.Tags = cmdletContext.Tag; } if (cmdletContext.TemplateFile != null) { request.TemplateFile = cmdletContext.TemplateFile; } 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.Proton.Model.CreateComponentResponse CallAWSServiceOperation(IAmazonProton client, Amazon.Proton.Model.CreateComponentRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Proton", "CreateComponent"); try { #if DESKTOP return client.CreateComponent(request); #elif CORECLR return client.CreateComponentAsync(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 ClientToken { get; set; } public System.String Description { get; set; } public System.String EnvironmentName { get; set; } public System.String Manifest { get; set; } public System.String Name { get; set; } public System.String ServiceInstanceName { get; set; } public System.String ServiceName { get; set; } public System.String ServiceSpec { get; set; } public List Tag { get; set; } public System.String TemplateFile { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Component; } } }