/******************************************************************************* * 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.DataPipeline; using Amazon.DataPipeline.Model; namespace Amazon.PowerShell.Cmdlets.DP { /// /// Adds tasks, schedules, and preconditions to the specified pipeline. You can use PutPipelineDefinition /// to populate a new pipeline. /// /// /// PutPipelineDefinition also validates the configuration as it adds it /// to the pipeline. Changes to the pipeline are saved unless one of the following three /// validation errors exists in the pipeline. ///
  1. An object is missing a name or identifier field.
  2. A string or reference /// field is empty.
  3. The number of objects in the pipeline exceeds the maximum /// allowed objects.
  4. The pipeline is in a FINISHED state.
/// Pipeline object definitions are passed to the PutPipelineDefinition /// action and returned by the GetPipelineDefinition action. /// ///
[Cmdlet("Write", "DPPipelineDefinition", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.DataPipeline.Model.PutPipelineDefinitionResponse")] [AWSCmdlet("Calls the AWS Data Pipeline PutPipelineDefinition API operation.", Operation = new[] {"PutPipelineDefinition"}, SelectReturnType = typeof(Amazon.DataPipeline.Model.PutPipelineDefinitionResponse))] [AWSCmdletOutput("Amazon.DataPipeline.Model.PutPipelineDefinitionResponse", "This cmdlet returns an Amazon.DataPipeline.Model.PutPipelineDefinitionResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class WriteDPPipelineDefinitionCmdlet : AmazonDataPipelineClientCmdlet, IExecutor { #region Parameter ParameterObject /// /// /// The parameter objects used with the pipeline. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("ParameterObjects")] public Amazon.DataPipeline.Model.ParameterObject[] ParameterObject { get; set; } #endregion #region Parameter ParameterValue /// /// /// The parameter values used with the pipeline. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("ParameterValues")] public Amazon.DataPipeline.Model.ParameterValue[] ParameterValue { get; set; } #endregion #region Parameter PipelineId /// /// /// The ID of the pipeline. /// /// #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 PipelineId { get; set; } #endregion #region Parameter PipelineObject /// /// /// The objects that define the pipeline. These objects overwrite the existing pipeline /// definition. /// /// #if !MODULAR [System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyCollection] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [Alias("PipelineObjects")] public Amazon.DataPipeline.Model.PipelineObject[] PipelineObject { 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.DataPipeline.Model.PutPipelineDefinitionResponse). /// Specifying the name of a property of type Amazon.DataPipeline.Model.PutPipelineDefinitionResponse 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 PipelineId parameter. /// The -PassThru parameter is deprecated, use -Select '^PipelineId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^PipelineId' 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.PipelineId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Write-DPPipelineDefinition (PutPipelineDefinition)")) { 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.PipelineId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute if (this.ParameterObject != null) { context.ParameterObject = new List(this.ParameterObject); } if (this.ParameterValue != null) { context.ParameterValue = new List(this.ParameterValue); } context.PipelineId = this.PipelineId; #if MODULAR if (this.PipelineId == null && ParameterWasBound(nameof(this.PipelineId))) { WriteWarning("You are passing $null as a value for parameter PipelineId 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.PipelineObject != null) { context.PipelineObject = new List(this.PipelineObject); } #if MODULAR if (this.PipelineObject == null && ParameterWasBound(nameof(this.PipelineObject))) { WriteWarning("You are passing $null as a value for parameter PipelineObject 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.DataPipeline.Model.PutPipelineDefinitionRequest(); if (cmdletContext.ParameterObject != null) { request.ParameterObjects = cmdletContext.ParameterObject; } if (cmdletContext.ParameterValue != null) { request.ParameterValues = cmdletContext.ParameterValue; } if (cmdletContext.PipelineId != null) { request.PipelineId = cmdletContext.PipelineId; } if (cmdletContext.PipelineObject != null) { request.PipelineObjects = cmdletContext.PipelineObject; } 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.DataPipeline.Model.PutPipelineDefinitionResponse CallAWSServiceOperation(IAmazonDataPipeline client, Amazon.DataPipeline.Model.PutPipelineDefinitionRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Data Pipeline", "PutPipelineDefinition"); try { #if DESKTOP return client.PutPipelineDefinition(request); #elif CORECLR return client.PutPipelineDefinitionAsync(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 ParameterObject { get; set; } public List ParameterValue { get; set; } public System.String PipelineId { get; set; } public List PipelineObject { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }