/*******************************************************************************
* 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.ElasticFileSystem;
using Amazon.ElasticFileSystem.Model;
namespace Amazon.PowerShell.Cmdlets.EFS
{
///
/// Creates a mount target for a file system. You can then mount the file system on EC2
/// instances by using the mount target.
///
///
///
/// You can create one mount target in each Availability Zone in your VPC. All EC2 instances
/// in a VPC within a given Availability Zone share a single mount target for a given
/// file system. If you have multiple subnets in an Availability Zone, you create a mount
/// target in one of the subnets. EC2 instances do not need to be in the same subnet as
/// the mount target in order to access their file system.
///
/// You can create only one mount target for an EFS file system using One Zone storage
/// classes. You must create that mount target in the same Availability Zone in which
/// the file system is located. Use the AvailabilityZoneName
and AvailabiltyZoneId
/// properties in the DescribeFileSystems response object to get this information.
/// Use the subnetId
associated with the file system's Availability Zone
/// when creating the mount target.
///
/// For more information, see Amazon
/// EFS: How it Works.
///
/// To create a mount target for a file system, the file system's lifecycle state must
/// be available
. For more information, see DescribeFileSystems.
///
/// In the request, provide the following:
/// -
/// The file system ID for which you are creating the mount target.
///
-
/// A subnet ID, which determines the following:
///
-
/// The VPC in which Amazon EFS creates the mount target
///
-
/// The Availability Zone in which Amazon EFS creates the mount target
///
-
/// The IP address range from which Amazon EFS selects the IP address of the mount target
/// (if you don't specify an IP address in the request)
///
/// After creating the mount target, Amazon EFS returns a response that includes, a MountTargetId
/// and an IpAddress
. You use this IP address when mounting the file system
/// in an EC2 instance. You can also use the mount target's DNS name when mounting the
/// file system. The EC2 instance on which you mount the file system by using the mount
/// target can resolve the mount target's DNS name to its IP address. For more information,
/// see How
/// it Works: Implementation Overview.
///
/// Note that you can create mount targets for a file system in only one VPC, and there
/// can be only one mount target per Availability Zone. That is, if the file system already
/// has one or more mount targets created for it, the subnet specified in the request
/// to add another mount target must meet the following requirements:
/// -
/// Must belong to the same VPC as the subnets of the existing mount targets
///
-
/// Must not be in the same Availability Zone as any of the subnets of the existing mount
/// targets
///
/// If the request satisfies the requirements, Amazon EFS does the following:
/// -
/// Creates a new mount target in the specified subnet.
///
-
/// Also creates a new network interface in the subnet as follows:
///
-
/// If the request provides an
IpAddress
, Amazon EFS assigns that IP address
/// to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet
/// (in the same way that the Amazon EC2 CreateNetworkInterface
call does
/// when a request does not specify a primary private IP address).
/// -
/// If the request provides
SecurityGroups
, this network interface is associated
/// with those security groups. Otherwise, it belongs to the default security group for
/// the subnet's VPC.
/// -
/// Assigns the description
Mount target fsmt-id for file system fs-id
where fsmt-id
is the mount target ID, and fs-id
is the FileSystemId
.
/// -
/// Sets the
requesterManaged
property of the network interface to true
,
/// and the requesterId
value to EFS
.
///
/// Each Amazon EFS mount target has one corresponding requester-managed EC2 network interface.
/// After the network interface is created, Amazon EFS sets the NetworkInterfaceId
/// field in the mount target's description to the network interface ID, and the IpAddress
/// field to its address. If network interface creation fails, the entire CreateMountTarget
/// operation fails.
///
/// The CreateMountTarget
call returns only after creating the network interface,
/// but while the mount target state is still creating
, you can check the
/// mount target creation status by calling the DescribeMountTargets operation,
/// which among other things returns the mount target state.
///
/// We recommend that you create a mount target in each of the Availability Zones. There
/// are cost considerations for using a file system in an Availability Zone through a
/// mount target created in another Availability Zone. For more information, see Amazon
/// EFS. In addition, by always using a mount target local to the instance's Availability
/// Zone, you eliminate a partial failure scenario. If the Availability Zone in which
/// your mount target is created goes down, then you can't access your file system through
/// that mount target.
///
/// This operation requires permissions for the following action on the file system:
/// elasticfilesystem:CreateMountTarget
/// This operation also requires permissions for the following Amazon EC2 actions:
/// ec2:DescribeSubnets
ec2:DescribeNetworkInterfaces
ec2:CreateNetworkInterface
///
[Cmdlet("New", "EFSMountTarget", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.ElasticFileSystem.Model.CreateMountTargetResponse")]
[AWSCmdlet("Calls the Amazon Elastic File System CreateMountTarget API operation.", Operation = new[] {"CreateMountTarget"}, SelectReturnType = typeof(Amazon.ElasticFileSystem.Model.CreateMountTargetResponse))]
[AWSCmdletOutput("Amazon.ElasticFileSystem.Model.CreateMountTargetResponse",
"This cmdlet returns an Amazon.ElasticFileSystem.Model.CreateMountTargetResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewEFSMountTargetCmdlet : AmazonElasticFileSystemClientCmdlet, IExecutor
{
#region Parameter FileSystemId
///
///
/// The ID of the file system for which to create the mount target.
///
///
#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 FileSystemId { get; set; }
#endregion
#region Parameter IpAddress
///
///
/// Valid IPv4 address within the address range of the specified subnet.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String IpAddress { get; set; }
#endregion
#region Parameter SecurityGroup
///
///
/// Up to five VPC security group IDs, of the form sg-xxxxxxxx
. These must
/// be for the same VPC as subnet specified.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("SecurityGroups")]
public System.String[] SecurityGroup { get; set; }
#endregion
#region Parameter SubnetId
///
///
/// The ID of the subnet to add the mount target in. For file systems that use One Zone
/// storage classes, use the subnet that is associated with the file system's Availability
/// Zone.
///
///
#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 SubnetId { 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.ElasticFileSystem.Model.CreateMountTargetResponse).
/// Specifying the name of a property of type Amazon.ElasticFileSystem.Model.CreateMountTargetResponse 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 FileSystemId parameter.
/// The -PassThru parameter is deprecated, use -Select '^FileSystemId' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^FileSystemId' 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.FileSystemId), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-EFSMountTarget (CreateMountTarget)"))
{
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.FileSystemId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.FileSystemId = this.FileSystemId;
#if MODULAR
if (this.FileSystemId == null && ParameterWasBound(nameof(this.FileSystemId)))
{
WriteWarning("You are passing $null as a value for parameter FileSystemId 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.IpAddress = this.IpAddress;
if (this.SecurityGroup != null)
{
context.SecurityGroup = new List(this.SecurityGroup);
}
context.SubnetId = this.SubnetId;
#if MODULAR
if (this.SubnetId == null && ParameterWasBound(nameof(this.SubnetId)))
{
WriteWarning("You are passing $null as a value for parameter SubnetId 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.ElasticFileSystem.Model.CreateMountTargetRequest();
if (cmdletContext.FileSystemId != null)
{
request.FileSystemId = cmdletContext.FileSystemId;
}
if (cmdletContext.IpAddress != null)
{
request.IpAddress = cmdletContext.IpAddress;
}
if (cmdletContext.SecurityGroup != null)
{
request.SecurityGroups = cmdletContext.SecurityGroup;
}
if (cmdletContext.SubnetId != null)
{
request.SubnetId = cmdletContext.SubnetId;
}
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.ElasticFileSystem.Model.CreateMountTargetResponse CallAWSServiceOperation(IAmazonElasticFileSystem client, Amazon.ElasticFileSystem.Model.CreateMountTargetRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic File System", "CreateMountTarget");
try
{
#if DESKTOP
return client.CreateMountTarget(request);
#elif CORECLR
return client.CreateMountTargetAsync(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 FileSystemId { get; set; }
public System.String IpAddress { get; set; }
public List SecurityGroup { get; set; }
public System.String SubnetId { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}