/******************************************************************************* * 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 { /// /// Creates an endpoint for a Server Message Block (SMB) file server that DataSync can /// use for a data transfer. /// /// /// /// Before you begin, make sure that you understand how DataSync accesses /// an SMB file server. /// /// [Cmdlet("New", "DSYNLocationSmb", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("System.String")] [AWSCmdlet("Calls the AWS DataSync CreateLocationSmb API operation.", Operation = new[] {"CreateLocationSmb"}, SelectReturnType = typeof(Amazon.DataSync.Model.CreateLocationSmbResponse))] [AWSCmdletOutput("System.String or Amazon.DataSync.Model.CreateLocationSmbResponse", "This cmdlet returns a System.String object.", "The service call response (type Amazon.DataSync.Model.CreateLocationSmbResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewDSYNLocationSmbCmdlet : AmazonDataSyncClientCmdlet, IExecutor { protected override bool IsSensitiveRequest { get; set; } = true; #region Parameter AgentArn /// /// /// Specifies the DataSync agent (or agents) which you want to connect to your SMB file /// server. You specify an agent by using its Amazon Resource Name (ARN). /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyCollection] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [Alias("AgentArns")] public System.String[] AgentArn { get; set; } #endregion #region Parameter Domain /// /// /// Specifies the Windows domain name that your SMB file server belongs to. For more information, see required /// permissions for SMB locations. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Domain { get; set; } #endregion #region Parameter Password /// /// /// Specifies the password of the user who can mount your SMB file server and has permission /// to access the files and folders involved in your transfer.For more information, see required /// permissions for SMB locations. /// /// #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 Password { get; set; } #endregion #region Parameter ServerHostname /// /// /// Specifies the Domain Name Service (DNS) name or IP address of the SMB file server /// that your DataSync agent will mount.You can't specify an IP version 6 (IPv6) address. /// /// #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 ServerHostname { get; set; } #endregion #region Parameter Subdirectory /// /// /// Specifies the name of the share exported by your SMB file server where DataSync will /// read or write data. You can include a subdirectory in the share path (for example, /// /path/to/subdirectory). Make sure that other SMB clients in your network /// can also mount this path.To copy all data in the specified subdirectory, DataSync must be able to mount the /// SMB share and access all of its data. For more information, see required /// permissions for SMB locations. /// /// #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 Subdirectory { get; set; } #endregion #region Parameter Tag /// /// /// Specifies labels that help you categorize, filter, and search for your Amazon Web /// Services resources. We recommend creating at least a name tag for your location. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Tags")] public Amazon.DataSync.Model.TagListEntry[] Tag { get; set; } #endregion #region Parameter User /// /// /// Specifies the user name that can mount your SMB file server and has permission to /// access the files and folders involved in your transfer.For information about choosing a user with the right level of access for your transfer, /// see required /// permissions for SMB locations. /// /// #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 User { get; set; } #endregion #region Parameter MountOptions_Version /// /// /// By default, DataSync automatically chooses an SMB protocol version based on negotiation /// with your SMB file server. You also can configure DataSync to use a specific SMB version, /// but we recommend doing this only if DataSync has trouble negotiating with the SMB /// file server automatically.These are the following options for configuring the SMB version: /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.DataSync.SmbVersion")] public Amazon.DataSync.SmbVersion MountOptions_Version { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'LocationArn'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DataSync.Model.CreateLocationSmbResponse). /// Specifying the name of a property of type Amazon.DataSync.Model.CreateLocationSmbResponse 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; } = "LocationArn"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the ServerHostname parameter. /// The -PassThru parameter is deprecated, use -Select '^ServerHostname' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ServerHostname' 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.ServerHostname), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-DSYNLocationSmb (CreateLocationSmb)")) { 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.ServerHostname; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute if (this.AgentArn != null) { context.AgentArn = new List(this.AgentArn); } #if MODULAR if (this.AgentArn == null && ParameterWasBound(nameof(this.AgentArn))) { WriteWarning("You are passing $null as a value for parameter AgentArn 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.Domain = this.Domain; context.MountOptions_Version = this.MountOptions_Version; context.Password = this.Password; #if MODULAR if (this.Password == null && ParameterWasBound(nameof(this.Password))) { WriteWarning("You are passing $null as a value for parameter Password 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.ServerHostname = this.ServerHostname; #if MODULAR if (this.ServerHostname == null && ParameterWasBound(nameof(this.ServerHostname))) { WriteWarning("You are passing $null as a value for parameter ServerHostname 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.Subdirectory = this.Subdirectory; #if MODULAR if (this.Subdirectory == null && ParameterWasBound(nameof(this.Subdirectory))) { WriteWarning("You are passing $null as a value for parameter Subdirectory 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.Tag != null) { context.Tag = new List(this.Tag); } context.User = this.User; #if MODULAR if (this.User == null && ParameterWasBound(nameof(this.User))) { WriteWarning("You are passing $null as a value for parameter User 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.CreateLocationSmbRequest(); if (cmdletContext.AgentArn != null) { request.AgentArns = cmdletContext.AgentArn; } if (cmdletContext.Domain != null) { request.Domain = cmdletContext.Domain; } // populate MountOptions var requestMountOptionsIsNull = true; request.MountOptions = new Amazon.DataSync.Model.SmbMountOptions(); Amazon.DataSync.SmbVersion requestMountOptions_mountOptions_Version = null; if (cmdletContext.MountOptions_Version != null) { requestMountOptions_mountOptions_Version = cmdletContext.MountOptions_Version; } if (requestMountOptions_mountOptions_Version != null) { request.MountOptions.Version = requestMountOptions_mountOptions_Version; requestMountOptionsIsNull = false; } // determine if request.MountOptions should be set to null if (requestMountOptionsIsNull) { request.MountOptions = null; } if (cmdletContext.Password != null) { request.Password = cmdletContext.Password; } if (cmdletContext.ServerHostname != null) { request.ServerHostname = cmdletContext.ServerHostname; } if (cmdletContext.Subdirectory != null) { request.Subdirectory = cmdletContext.Subdirectory; } if (cmdletContext.Tag != null) { request.Tags = cmdletContext.Tag; } if (cmdletContext.User != null) { request.User = cmdletContext.User; } 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.CreateLocationSmbResponse CallAWSServiceOperation(IAmazonDataSync client, Amazon.DataSync.Model.CreateLocationSmbRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS DataSync", "CreateLocationSmb"); try { #if DESKTOP return client.CreateLocationSmb(request); #elif CORECLR return client.CreateLocationSmbAsync(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 AgentArn { get; set; } public System.String Domain { get; set; } public Amazon.DataSync.SmbVersion MountOptions_Version { get; set; } public System.String Password { get; set; } public System.String ServerHostname { get; set; } public System.String Subdirectory { get; set; } public List Tag { get; set; } public System.String User { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.LocationArn; } } }