/******************************************************************************* * 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.StorageGateway; using Amazon.StorageGateway.Model; namespace Amazon.PowerShell.Cmdlets.SG { /// /// Associate an Amazon FSx file system with the FSx File Gateway. After the association /// process is complete, the file shares on the Amazon FSx file system are available for /// access through the gateway. This operation only supports the FSx File Gateway type. /// [Cmdlet("New", "SGSGFileSystemAssociation", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("System.String")] [AWSCmdlet("Calls the AWS Storage Gateway AssociateFileSystem API operation.", Operation = new[] {"AssociateFileSystem"}, SelectReturnType = typeof(Amazon.StorageGateway.Model.AssociateFileSystemResponse))] [AWSCmdletOutput("System.String or Amazon.StorageGateway.Model.AssociateFileSystemResponse", "This cmdlet returns a System.String object.", "The service call response (type Amazon.StorageGateway.Model.AssociateFileSystemResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewSGSGFileSystemAssociationCmdlet : AmazonStorageGatewayClientCmdlet, IExecutor { protected override bool IsSensitiveRequest { get; set; } = true; #region Parameter AuditDestinationARN /// /// /// The Amazon Resource Name (ARN) of the storage used for the audit logs. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String AuditDestinationARN { get; set; } #endregion #region Parameter CacheAttributes_CacheStaleTimeoutInSecond /// /// /// Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time /// since the last refresh after which access to the directory would cause the file gateway /// to first refresh that directory's contents from the Amazon S3 bucket or Amazon FSx /// file system. The TTL duration is in seconds.Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days) /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("CacheAttributes_CacheStaleTimeoutInSeconds")] public System.Int32? CacheAttributes_CacheStaleTimeoutInSecond { get; set; } #endregion #region Parameter GatewayARN /// /// /// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. /// /// #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 GatewayARN { get; set; } #endregion #region Parameter EndpointNetworkConfiguration_IpAddress /// /// /// A list of gateway IP addresses on which the associated Amazon FSx file system is available.If multiple file systems are associated with this gateway, this field is required. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("EndpointNetworkConfiguration_IpAddresses")] public System.String[] EndpointNetworkConfiguration_IpAddress { get; set; } #endregion #region Parameter LocationARN /// /// /// The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the /// FSx File Gateway. /// /// #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 LocationARN { get; set; } #endregion #region Parameter Password /// /// /// The password of the user credential. /// /// #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 Tag /// /// /// A list of up to 50 tags that can be assigned to the file system association. Each /// tag is a key-value pair. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Tags")] public Amazon.StorageGateway.Model.Tag[] Tag { get; set; } #endregion #region Parameter UserName /// /// /// The user name of the user credential that has permission to access the root share /// D$ of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated /// admin user group. /// /// #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 UserName { get; set; } #endregion #region Parameter ClientToken /// /// /// A unique string value that you supply that is used by the FSx File Gateway to ensure /// idempotent file system association creation. /// /// #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 ClientToken { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'FileSystemAssociationARN'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.StorageGateway.Model.AssociateFileSystemResponse). /// Specifying the name of a property of type Amazon.StorageGateway.Model.AssociateFileSystemResponse 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; } = "FileSystemAssociationARN"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the GatewayARN parameter. /// The -PassThru parameter is deprecated, use -Select '^GatewayARN' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^GatewayARN' 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.UserName), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-SGSGFileSystemAssociation (AssociateFileSystem)")) { 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.GatewayARN; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.AuditDestinationARN = this.AuditDestinationARN; context.CacheAttributes_CacheStaleTimeoutInSecond = this.CacheAttributes_CacheStaleTimeoutInSecond; context.ClientToken = this.ClientToken; #if MODULAR if (this.ClientToken == null && ParameterWasBound(nameof(this.ClientToken))) { WriteWarning("You are passing $null as a value for parameter ClientToken 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.EndpointNetworkConfiguration_IpAddress != null) { context.EndpointNetworkConfiguration_IpAddress = new List(this.EndpointNetworkConfiguration_IpAddress); } context.GatewayARN = this.GatewayARN; #if MODULAR if (this.GatewayARN == null && ParameterWasBound(nameof(this.GatewayARN))) { WriteWarning("You are passing $null as a value for parameter GatewayARN 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.LocationARN = this.LocationARN; #if MODULAR if (this.LocationARN == null && ParameterWasBound(nameof(this.LocationARN))) { WriteWarning("You are passing $null as a value for parameter LocationARN 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.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 if (this.Tag != null) { context.Tag = new List(this.Tag); } context.UserName = this.UserName; #if MODULAR if (this.UserName == null && ParameterWasBound(nameof(this.UserName))) { WriteWarning("You are passing $null as a value for parameter UserName 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.StorageGateway.Model.AssociateFileSystemRequest(); if (cmdletContext.AuditDestinationARN != null) { request.AuditDestinationARN = cmdletContext.AuditDestinationARN; } // populate CacheAttributes var requestCacheAttributesIsNull = true; request.CacheAttributes = new Amazon.StorageGateway.Model.CacheAttributes(); System.Int32? requestCacheAttributes_cacheAttributes_CacheStaleTimeoutInSecond = null; if (cmdletContext.CacheAttributes_CacheStaleTimeoutInSecond != null) { requestCacheAttributes_cacheAttributes_CacheStaleTimeoutInSecond = cmdletContext.CacheAttributes_CacheStaleTimeoutInSecond.Value; } if (requestCacheAttributes_cacheAttributes_CacheStaleTimeoutInSecond != null) { request.CacheAttributes.CacheStaleTimeoutInSeconds = requestCacheAttributes_cacheAttributes_CacheStaleTimeoutInSecond.Value; requestCacheAttributesIsNull = false; } // determine if request.CacheAttributes should be set to null if (requestCacheAttributesIsNull) { request.CacheAttributes = null; } if (cmdletContext.ClientToken != null) { request.ClientToken = cmdletContext.ClientToken; } // populate EndpointNetworkConfiguration var requestEndpointNetworkConfigurationIsNull = true; request.EndpointNetworkConfiguration = new Amazon.StorageGateway.Model.EndpointNetworkConfiguration(); List requestEndpointNetworkConfiguration_endpointNetworkConfiguration_IpAddress = null; if (cmdletContext.EndpointNetworkConfiguration_IpAddress != null) { requestEndpointNetworkConfiguration_endpointNetworkConfiguration_IpAddress = cmdletContext.EndpointNetworkConfiguration_IpAddress; } if (requestEndpointNetworkConfiguration_endpointNetworkConfiguration_IpAddress != null) { request.EndpointNetworkConfiguration.IpAddresses = requestEndpointNetworkConfiguration_endpointNetworkConfiguration_IpAddress; requestEndpointNetworkConfigurationIsNull = false; } // determine if request.EndpointNetworkConfiguration should be set to null if (requestEndpointNetworkConfigurationIsNull) { request.EndpointNetworkConfiguration = null; } if (cmdletContext.GatewayARN != null) { request.GatewayARN = cmdletContext.GatewayARN; } if (cmdletContext.LocationARN != null) { request.LocationARN = cmdletContext.LocationARN; } if (cmdletContext.Password != null) { request.Password = cmdletContext.Password; } if (cmdletContext.Tag != null) { request.Tags = cmdletContext.Tag; } if (cmdletContext.UserName != null) { request.UserName = cmdletContext.UserName; } 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.StorageGateway.Model.AssociateFileSystemResponse CallAWSServiceOperation(IAmazonStorageGateway client, Amazon.StorageGateway.Model.AssociateFileSystemRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Storage Gateway", "AssociateFileSystem"); try { #if DESKTOP return client.AssociateFileSystem(request); #elif CORECLR return client.AssociateFileSystemAsync(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 AuditDestinationARN { get; set; } public System.Int32? CacheAttributes_CacheStaleTimeoutInSecond { get; set; } public System.String ClientToken { get; set; } public List EndpointNetworkConfiguration_IpAddress { get; set; } public System.String GatewayARN { get; set; } public System.String LocationARN { get; set; } public System.String Password { get; set; } public List Tag { get; set; } public System.String UserName { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.FileSystemAssociationARN; } } }