/******************************************************************************* * 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 { /// /// Describes the access that is assigned to the specific file transfer protocol-enabled /// server, as identified by its ServerId property and its ExternalId. /// /// /// /// The response from this call returns the properties of the access that is associated /// with the ServerId value that was specified. /// /// [Cmdlet("Get", "TFRAccess")] [OutputType("Amazon.Transfer.Model.DescribeAccessResponse")] [AWSCmdlet("Calls the AWS Transfer for SFTP DescribeAccess API operation.", Operation = new[] {"DescribeAccess"}, SelectReturnType = typeof(Amazon.Transfer.Model.DescribeAccessResponse))] [AWSCmdletOutput("Amazon.Transfer.Model.DescribeAccessResponse", "This cmdlet returns an Amazon.Transfer.Model.DescribeAccessResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetTFRAccessCmdlet : AmazonTransferClientCmdlet, IExecutor { #region Parameter ExternalId /// /// /// A unique identifier that is required to identify specific groups within your directory. /// The users of the group that you associate have access to your Amazon S3 or Amazon /// EFS resources over the enabled protocols using Transfer Family. If you know the group /// name, you can view the SID values by running the following command using Windows PowerShell.Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties /// * | Select SamAccountName,ObjectSidIn that command, replace YourGroupName with the name of your Active Directory /// group.The regular expression used to validate this parameter is a string of characters consisting /// of uppercase and lowercase alphanumeric characters with no spaces. You can also include /// underscores or any of the following characters: =,.@:/- /// /// #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 ExternalId { get; set; } #endregion #region Parameter ServerId /// /// /// A system-assigned unique identifier for a server that has this access assigned. /// /// #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 ServerId { 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.Transfer.Model.DescribeAccessResponse). /// Specifying the name of a property of type Amazon.Transfer.Model.DescribeAccessResponse 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 ServerId parameter. /// The -PassThru parameter is deprecated, use -Select '^ServerId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ServerId' instead. This parameter will be removed in a future version.")] [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter PassThru { get; set; } #endregion protected override void ProcessRecord() { this._AWSSignerType = "v4"; base.ProcessRecord(); 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.ServerId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.ExternalId = this.ExternalId; #if MODULAR if (this.ExternalId == null && ParameterWasBound(nameof(this.ExternalId))) { WriteWarning("You are passing $null as a value for parameter ExternalId 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.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 // 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.DescribeAccessRequest(); if (cmdletContext.ExternalId != null) { request.ExternalId = cmdletContext.ExternalId; } if (cmdletContext.ServerId != null) { request.ServerId = cmdletContext.ServerId; } 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.DescribeAccessResponse CallAWSServiceOperation(IAmazonTransfer client, Amazon.Transfer.Model.DescribeAccessRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Transfer for SFTP", "DescribeAccess"); try { #if DESKTOP return client.DescribeAccess(request); #elif CORECLR return client.DescribeAccessAsync(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 ExternalId { get; set; } public System.String ServerId { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }