/*******************************************************************************
* 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.DataSync;
using Amazon.DataSync.Model;
namespace Amazon.PowerShell.Cmdlets.DSYN
{
///
/// Updates the metadata associated with a task.
///
[Cmdlet("Update", "DSYNTask", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("None")]
[AWSCmdlet("Calls the AWS DataSync UpdateTask API operation.", Operation = new[] {"UpdateTask"}, SelectReturnType = typeof(Amazon.DataSync.Model.UpdateTaskResponse))]
[AWSCmdletOutput("None or Amazon.DataSync.Model.UpdateTaskResponse",
"This cmdlet does not generate any output." +
"The service response (type Amazon.DataSync.Model.UpdateTaskResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class UpdateDSYNTaskCmdlet : AmazonDataSyncClientCmdlet, IExecutor
{
#region Parameter CloudWatchLogGroupArn
///
///
/// The Amazon Resource Name (ARN) of the resource name of the Amazon CloudWatch log group.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String CloudWatchLogGroupArn { get; set; }
#endregion
#region Parameter Exclude
///
///
/// Specifies a list of filter rules that exclude specific data during your transfer.
/// For more information and examples, see Filtering
/// data transferred by DataSync.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Excludes")]
public Amazon.DataSync.Model.FilterRule[] Exclude { get; set; }
#endregion
#region Parameter Include
///
///
/// Specifies a list of filter rules that include specific data during your transfer.
/// For more information and examples, see Filtering
/// data transferred by DataSync.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Includes")]
public Amazon.DataSync.Model.FilterRule[] Include { get; set; }
#endregion
#region Parameter Name
///
///
/// The name of the task to update.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Name { get; set; }
#endregion
#region Parameter Option
///
///
/// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Options")]
public Amazon.DataSync.Model.Options Option { get; set; }
#endregion
#region Parameter Schedule_ScheduleExpression
///
///
/// A cron expression that specifies when DataSync initiates a scheduled transfer from
/// a source to a destination location.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Schedule_ScheduleExpression { get; set; }
#endregion
#region Parameter TaskArn
///
///
/// The Amazon Resource Name (ARN) of the resource name of the task to update.
///
///
#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 TaskArn { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DataSync.Model.UpdateTaskResponse).
/// 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 TaskArn parameter.
/// The -PassThru parameter is deprecated, use -Select '^TaskArn' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^TaskArn' 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.TaskArn), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-DSYNTask (UpdateTask)"))
{
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.TaskArn;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.CloudWatchLogGroupArn = this.CloudWatchLogGroupArn;
if (this.Exclude != null)
{
context.Exclude = new List(this.Exclude);
}
if (this.Include != null)
{
context.Include = new List(this.Include);
}
context.Name = this.Name;
context.Option = this.Option;
context.Schedule_ScheduleExpression = this.Schedule_ScheduleExpression;
context.TaskArn = this.TaskArn;
#if MODULAR
if (this.TaskArn == null && ParameterWasBound(nameof(this.TaskArn)))
{
WriteWarning("You are passing $null as a value for parameter TaskArn 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.DataSync.Model.UpdateTaskRequest();
if (cmdletContext.CloudWatchLogGroupArn != null)
{
request.CloudWatchLogGroupArn = cmdletContext.CloudWatchLogGroupArn;
}
if (cmdletContext.Exclude != null)
{
request.Excludes = cmdletContext.Exclude;
}
if (cmdletContext.Include != null)
{
request.Includes = cmdletContext.Include;
}
if (cmdletContext.Name != null)
{
request.Name = cmdletContext.Name;
}
if (cmdletContext.Option != null)
{
request.Options = cmdletContext.Option;
}
// populate Schedule
var requestScheduleIsNull = true;
request.Schedule = new Amazon.DataSync.Model.TaskSchedule();
System.String requestSchedule_schedule_ScheduleExpression = null;
if (cmdletContext.Schedule_ScheduleExpression != null)
{
requestSchedule_schedule_ScheduleExpression = cmdletContext.Schedule_ScheduleExpression;
}
if (requestSchedule_schedule_ScheduleExpression != null)
{
request.Schedule.ScheduleExpression = requestSchedule_schedule_ScheduleExpression;
requestScheduleIsNull = false;
}
// determine if request.Schedule should be set to null
if (requestScheduleIsNull)
{
request.Schedule = null;
}
if (cmdletContext.TaskArn != null)
{
request.TaskArn = cmdletContext.TaskArn;
}
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.DataSync.Model.UpdateTaskResponse CallAWSServiceOperation(IAmazonDataSync client, Amazon.DataSync.Model.UpdateTaskRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS DataSync", "UpdateTask");
try
{
#if DESKTOP
return client.UpdateTask(request);
#elif CORECLR
return client.UpdateTaskAsync(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 CloudWatchLogGroupArn { get; set; }
public List Exclude { get; set; }
public List Include { get; set; }
public System.String Name { get; set; }
public Amazon.DataSync.Model.Options Option { get; set; }
public System.String Schedule_ScheduleExpression { get; set; }
public System.String TaskArn { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => null;
}
}
}