/*******************************************************************************
* 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.Transfer;
using Amazon.Transfer.Model;
namespace Amazon.PowerShell.Cmdlets.TFR
{
///
/// Updates some of the parameters for an existing agreement. Provide the AgreementId
/// and the ServerId
for the agreement that you want to update, along with
/// the new values for the parameters to update.
///
[Cmdlet("Update", "TFRAgreement", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.String")]
[AWSCmdlet("Calls the AWS Transfer for SFTP UpdateAgreement API operation.", Operation = new[] {"UpdateAgreement"}, SelectReturnType = typeof(Amazon.Transfer.Model.UpdateAgreementResponse))]
[AWSCmdletOutput("System.String or Amazon.Transfer.Model.UpdateAgreementResponse",
"This cmdlet returns a System.String object.",
"The service call response (type Amazon.Transfer.Model.UpdateAgreementResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class UpdateTFRAgreementCmdlet : AmazonTransferClientCmdlet, IExecutor
{
#region Parameter AccessRole
///
///
/// With AS2, you can send files by calling StartFileTransfer
and specifying
/// the file paths in the request parameter, SendFilePaths
. We use the file’s
/// parent directory (for example, for --send-file-paths /bucket/dir/file.txt
,
/// parent directory is /bucket/dir/
) to temporarily store a processed AS2
/// message file, store the MDN when we receive them from the partner, and write a final
/// JSON file containing relevant metadata of the transmission. So, the AccessRole
/// needs to provide read and write access to the parent directory of the file location
/// used in the StartFileTransfer
request. Additionally, you need to provide
/// read and write access to the parent directory of the files that you intend to send
/// with StartFileTransfer
.If you are using Basic authentication for your AS2 connector, the access role requires
/// the secretsmanager:GetSecretValue
permission for the secret. If the secret
/// is encrypted using a customer-managed key instead of the Amazon Web Services managed
/// key in Secrets Manager, then the role also needs the kms:Decrypt
permission
/// for that key.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String AccessRole { get; set; }
#endregion
#region Parameter AgreementId
///
///
/// A unique identifier for the agreement. This identifier is returned when you create
/// an agreement.
///
///
#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 AgreementId { get; set; }
#endregion
#region Parameter BaseDirectory
///
///
/// To change the landing directory (folder) for files that are transferred, provide the
/// bucket folder that you want to use; for example, /DOC-EXAMPLE-BUCKET/home/mydirectory
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String BaseDirectory { get; set; }
#endregion
#region Parameter Description
///
///
/// To replace the existing description, provide a short description for the agreement.
///
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Description { get; set; }
#endregion
#region Parameter LocalProfileId
///
///
/// A unique identifier for the AS2 local profile.To change the local profile identifier, provide a new value here.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String LocalProfileId { get; set; }
#endregion
#region Parameter PartnerProfileId
///
///
/// A unique identifier for the partner profile. To change the partner profile identifier,
/// provide a new value here.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String PartnerProfileId { get; set; }
#endregion
#region Parameter ServerId
///
///
/// A system-assigned unique identifier for a server instance. This is the specific server
/// that the agreement uses.
///
///
#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 ServerId { get; set; }
#endregion
#region Parameter Status
///
///
/// You can update the status for the agreement, either activating an inactive agreement
/// or the reverse.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.Transfer.AgreementStatusType")]
public Amazon.Transfer.AgreementStatusType Status { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'AgreementId'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Transfer.Model.UpdateAgreementResponse).
/// Specifying the name of a property of type Amazon.Transfer.Model.UpdateAgreementResponse 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; } = "AgreementId";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the AgreementId parameter.
/// The -PassThru parameter is deprecated, use -Select '^AgreementId' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^AgreementId' 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.AgreementId), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-TFRAgreement (UpdateAgreement)"))
{
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.AgreementId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.AccessRole = this.AccessRole;
context.AgreementId = this.AgreementId;
#if MODULAR
if (this.AgreementId == null && ParameterWasBound(nameof(this.AgreementId)))
{
WriteWarning("You are passing $null as a value for parameter AgreementId 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.BaseDirectory = this.BaseDirectory;
context.Description = this.Description;
context.LocalProfileId = this.LocalProfileId;
context.PartnerProfileId = this.PartnerProfileId;
context.ServerId = this.ServerId;
#if MODULAR
if (this.ServerId == null && ParameterWasBound(nameof(this.ServerId)))
{
WriteWarning("You are passing $null as a value for parameter ServerId 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.Status = this.Status;
// 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.Transfer.Model.UpdateAgreementRequest();
if (cmdletContext.AccessRole != null)
{
request.AccessRole = cmdletContext.AccessRole;
}
if (cmdletContext.AgreementId != null)
{
request.AgreementId = cmdletContext.AgreementId;
}
if (cmdletContext.BaseDirectory != null)
{
request.BaseDirectory = cmdletContext.BaseDirectory;
}
if (cmdletContext.Description != null)
{
request.Description = cmdletContext.Description;
}
if (cmdletContext.LocalProfileId != null)
{
request.LocalProfileId = cmdletContext.LocalProfileId;
}
if (cmdletContext.PartnerProfileId != null)
{
request.PartnerProfileId = cmdletContext.PartnerProfileId;
}
if (cmdletContext.ServerId != null)
{
request.ServerId = cmdletContext.ServerId;
}
if (cmdletContext.Status != null)
{
request.Status = cmdletContext.Status;
}
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.Transfer.Model.UpdateAgreementResponse CallAWSServiceOperation(IAmazonTransfer client, Amazon.Transfer.Model.UpdateAgreementRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Transfer for SFTP", "UpdateAgreement");
try
{
#if DESKTOP
return client.UpdateAgreement(request);
#elif CORECLR
return client.UpdateAgreementAsync(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 AccessRole { get; set; }
public System.String AgreementId { get; set; }
public System.String BaseDirectory { get; set; }
public System.String Description { get; set; }
public System.String LocalProfileId { get; set; }
public System.String PartnerProfileId { get; set; }
public System.String ServerId { get; set; }
public Amazon.Transfer.AgreementStatusType Status { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.AgreementId;
}
}
}