AWS.Tools.ElasticFileSystem.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.ElasticFileSystem</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.EFS.AddEFSResourceTagCmdlet"> <summary> Creates a tag for an EFS resource. You can create tags for EFS file systems and access points using this API operation. <para> This operation requires permissions for the <c>elasticfilesystem:TagResource</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.AddEFSResourceTagCmdlet.ResourceId"> <summary> <para> <para>The ID specifying the EFS resource that you want to create a tag for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.AddEFSResourceTagCmdlet.Tag"> <summary> <para> <para>An array of <c>Tag</c> objects to add. Each <c>Tag</c> object is a key-value pair.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.AddEFSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticFileSystem.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.AddEFSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceId parameter. The -PassThru parameter is deprecated, use -Select '^ResourceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.AddEFSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.EditEFSMountTargetSecurityGroupCmdlet"> <summary> Modifies the set of security groups in effect for a mount target. <para> When you create a mount target, Amazon EFS also creates a new network interface. For more information, see <a>CreateMountTarget</a>. This operation replaces the security groups in effect for the network interface associated with a mount target, with the <c>SecurityGroups</c> provided in the request. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not <c>deleted</c>. </para><para> The operation requires permissions for the following actions: </para><ul><li><para><c>elasticfilesystem:ModifyMountTargetSecurityGroups</c> action on the mount target's file system. </para></li><li><para><c>ec2:ModifyNetworkInterfaceAttribute</c> action on the mount target's network interface. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.EditEFSMountTargetSecurityGroupCmdlet.MountTargetId"> <summary> <para> <para>The ID of the mount target whose security groups you want to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.EditEFSMountTargetSecurityGroupCmdlet.SecurityGroup"> <summary> <para> <para>An array of up to five VPC security group IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.EditEFSMountTargetSecurityGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticFileSystem.Model.ModifyMountTargetSecurityGroupsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.EditEFSMountTargetSecurityGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SecurityGroup parameter. The -PassThru parameter is deprecated, use -Select '^SecurityGroup' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.EditEFSMountTargetSecurityGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.GetEFSAccessPointCmdlet"> <summary> Returns the description of a specific Amazon EFS access point if the <c>AccessPointId</c> is provided. If you provide an EFS <c>FileSystemId</c>, it returns descriptions of all access points for that file system. You can provide either an <c>AccessPointId</c> or a <c>FileSystemId</c> in the request, but not both. <para> This operation requires permissions for the <c>elasticfilesystem:DescribeAccessPoints</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSAccessPointCmdlet.AccessPointId"> <summary> <para> <para>(Optional) Specifies an EFS access point to describe in the response; mutually exclusive with <c>FileSystemId</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSAccessPointCmdlet.FileSystemId"> <summary> <para> <para>(Optional) If you provide a <c>FileSystemId</c>, EFS returns all access points for that file system; mutually exclusive with <c>AccessPointId</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSAccessPointCmdlet.MaxResult"> <summary> <para> <para>(Optional) When retrieving all access points for a file system, you can optionally specify the <c>MaxItems</c> parameter to limit the number of objects returned in a response. The default value is 100. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSAccessPointCmdlet.NextToken"> <summary> <para> <para><c>NextToken</c> is present if the response is paginated. You can use <c>NextMarker</c> in the subsequent request to fetch the next page of access point descriptions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSAccessPointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AccessPoints'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticFileSystem.Model.DescribeAccessPointsResponse). Specifying the name of a property of type Amazon.ElasticFileSystem.Model.DescribeAccessPointsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSAccessPointCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.GetEFSAccountPreferenceCmdlet"> <summary> Returns the account preferences settings for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSAccountPreferenceCmdlet.MaxResult"> <summary> <para> <para>(Optional) When retrieving account preferences, you can optionally specify the <c>MaxItems</c> parameter to limit the number of objects returned in a response. The default value is 100. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSAccountPreferenceCmdlet.NextToken"> <summary> <para> <para>(Optional) You can use <c>NextToken</c> in a subsequent request to fetch the next page of Amazon Web Services account preferences if the response payload was paginated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSAccountPreferenceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourceIdPreference'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticFileSystem.Model.DescribeAccountPreferencesResponse). Specifying the name of a property of type Amazon.ElasticFileSystem.Model.DescribeAccountPreferencesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.GetEFSBackupPolicyCmdlet"> <summary> Returns the backup policy for the specified EFS file system. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSBackupPolicyCmdlet.FileSystemId"> <summary> <para> <para>Specifies which EFS file system for which to retrieve the <c>BackupPolicy</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSBackupPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BackupPolicy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticFileSystem.Model.DescribeBackupPolicyResponse). Specifying the name of a property of type Amazon.ElasticFileSystem.Model.DescribeBackupPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSBackupPolicyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.GetEFSFileSystemCmdlet"> <summary> Returns the description of a specific Amazon EFS file system if either the file system <c>CreationToken</c> or the <c>FileSystemId</c> is provided. Otherwise, it returns descriptions of all file systems owned by the caller's Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling. <para> When retrieving all file system descriptions, you can optionally specify the <c>MaxItems</c> parameter to limit the number of descriptions in a response. This number is automatically set to 100. If more file system descriptions remain, Amazon EFS returns a <c>NextMarker</c>, an opaque token, in the response. In this case, you should send a subsequent request with the <c>Marker</c> request parameter set to the value of <c>NextMarker</c>. </para><para> To retrieve a list of your file system descriptions, this operation is used in an iterative process, where <c>DescribeFileSystems</c> is called first without the <c>Marker</c> and then the operation continues to call it with the <c>Marker</c> parameter set to the value of the <c>NextMarker</c> from the previous response until the response has no <c>NextMarker</c>. </para><para> The order of file systems returned in the response of one <c>DescribeFileSystems</c> call and the order of file systems returned across the responses of a multi-call iteration is unspecified. </para><para> This operation requires permissions for the <c>elasticfilesystem:DescribeFileSystems</c> action. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSFileSystemCmdlet.CreationToken"> <summary> <para> <para>(Optional) Restricts the list to the file system with this creation token (String). You specify a creation token when you create an Amazon EFS file system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSFileSystemCmdlet.FileSystemId"> <summary> <para> <para>(Optional) ID of the file system whose description you want to retrieve (String).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSFileSystemCmdlet.Marker"> <summary> <para> <para>(Optional) Opaque pagination token returned from a previous <c>DescribeFileSystems</c> operation (String). If present, specifies to continue the list from where the returning call had left off. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.NextMarker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSFileSystemCmdlet.MaxItem"> <summary> <para> <para>(Optional) Specifies the maximum number of file systems to return in the response (integer). This number is automatically set to 100. The response is paginated at 100 per page if you have more than 100 file systems. </para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSFileSystemCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FileSystems'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticFileSystem.Model.DescribeFileSystemsResponse). Specifying the name of a property of type Amazon.ElasticFileSystem.Model.DescribeFileSystemsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSFileSystemCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSFileSystemCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.GetEFSFileSystemPolicyCmdlet"> <summary> Returns the <c>FileSystemPolicy</c> for the specified EFS file system. <para> This operation requires permissions for the <c>elasticfilesystem:DescribeFileSystemPolicy</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSFileSystemPolicyCmdlet.FileSystemId"> <summary> <para> <para>Specifies which EFS file system to retrieve the <c>FileSystemPolicy</c> for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSFileSystemPolicyCmdlet.Select"> <summary> 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.DescribeFileSystemPolicyResponse). Specifying the name of a property of type Amazon.ElasticFileSystem.Model.DescribeFileSystemPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSFileSystemPolicyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.GetEFSLifecycleConfigurationCmdlet"> <summary> Returns the current <c>LifecycleConfiguration</c> object for the specified Amazon EFS file system. Lifecycle management uses the <c>LifecycleConfiguration</c> object to identify when to move files between storage classes. For a file system without a <c>LifecycleConfiguration</c> object, the call returns an empty array in the response. <para> This operation requires permissions for the <c>elasticfilesystem:DescribeLifecycleConfiguration</c> operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSLifecycleConfigurationCmdlet.FileSystemId"> <summary> <para> <para>The ID of the file system whose <c>LifecycleConfiguration</c> object you want to retrieve (String).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSLifecycleConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LifecyclePolicies'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticFileSystem.Model.DescribeLifecycleConfigurationResponse). Specifying the name of a property of type Amazon.ElasticFileSystem.Model.DescribeLifecycleConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSLifecycleConfigurationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.GetEFSMountTargetCmdlet"> <summary> Returns the descriptions of all the current mount targets, or a specific mount target, for a file system. When requesting all of the current mount targets, the order of mount targets returned in the response is unspecified. <para> This operation requires permissions for the <c>elasticfilesystem:DescribeMountTargets</c> action, on either the file system ID that you specify in <c>FileSystemId</c>, or on the file system of the mount target that you specify in <c>MountTargetId</c>. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSMountTargetCmdlet.AccessPointId"> <summary> <para> <para>(Optional) The ID of the access point whose mount targets that you want to list. It must be included in your request if a <c>FileSystemId</c> or <c>MountTargetId</c> is not included in your request. Accepts either an access point ID or ARN as input.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSMountTargetCmdlet.FileSystemId"> <summary> <para> <para>(Optional) ID of the file system whose mount targets you want to list (String). It must be included in your request if an <c>AccessPointId</c> or <c>MountTargetId</c> is not included. Accepts either a file system ID or ARN as input.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSMountTargetCmdlet.MountTargetId"> <summary> <para> <para>(Optional) ID of the mount target that you want to have described (String). It must be included in your request if <c>FileSystemId</c> is not included. Accepts either a mount target ID or ARN as input.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSMountTargetCmdlet.Marker"> <summary> <para> <para>(Optional) Opaque pagination token returned from a previous <c>DescribeMountTargets</c> operation (String). If present, it specifies to continue the list from where the previous returning call left off.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.NextMarker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSMountTargetCmdlet.MaxItem"> <summary> <para> <para>(Optional) Maximum number of mount targets to return in the response. Currently, this number is automatically set to 10, and other values are ignored. The response is paginated at 100 per page if you have more than 100 mount targets.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSMountTargetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MountTargets'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticFileSystem.Model.DescribeMountTargetsResponse). Specifying the name of a property of type Amazon.ElasticFileSystem.Model.DescribeMountTargetsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSMountTargetCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSMountTargetCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.GetEFSMountTargetSecurityGroupCmdlet"> <summary> Returns the security groups currently in effect for a mount target. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not <c>deleted</c>. <para> This operation requires permissions for the following actions: </para><ul><li><para><c>elasticfilesystem:DescribeMountTargetSecurityGroups</c> action on the mount target's file system. </para></li><li><para><c>ec2:DescribeNetworkInterfaceAttribute</c> action on the mount target's network interface. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSMountTargetSecurityGroupCmdlet.MountTargetId"> <summary> <para> <para>The ID of the mount target whose security groups you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSMountTargetSecurityGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SecurityGroups'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticFileSystem.Model.DescribeMountTargetSecurityGroupsResponse). Specifying the name of a property of type Amazon.ElasticFileSystem.Model.DescribeMountTargetSecurityGroupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSMountTargetSecurityGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MountTargetId parameter. The -PassThru parameter is deprecated, use -Select '^MountTargetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.GetEFSReplicationConfigurationCmdlet"> <summary> Retrieves the replication configuration for a specific file system. If a file system is not specified, all of the replication configurations for the Amazon Web Services account in an Amazon Web Services Region are retrieved. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSReplicationConfigurationCmdlet.FileSystemId"> <summary> <para> <para>You can retrieve the replication configuration for a specific file system by providing its file system ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSReplicationConfigurationCmdlet.MaxResult"> <summary> <para> <para>(Optional) To limit the number of objects returned in a response, you can specify the <c>MaxItems</c> parameter. The default value is 100. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSReplicationConfigurationCmdlet.NextToken"> <summary> <para> <para><c>NextToken</c> is present if the response is paginated. You can use <c>NextToken</c> in a subsequent request to fetch the next page of output.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSReplicationConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Replications'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticFileSystem.Model.DescribeReplicationConfigurationsResponse). Specifying the name of a property of type Amazon.ElasticFileSystem.Model.DescribeReplicationConfigurationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSReplicationConfigurationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.GetEFSResourceTagCmdlet"> <summary> Lists all tags for a top-level EFS resource. You must provide the ID of the resource that you want to retrieve the tags for. <para> This operation requires permissions for the <c>elasticfilesystem:DescribeAccessPoints</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSResourceTagCmdlet.ResourceId"> <summary> <para> <para>Specifies the EFS resource you want to retrieve tags for. You can retrieve tags for EFS file systems and access points using this API endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSResourceTagCmdlet.MaxResult"> <summary> <para> <para>(Optional) Specifies the maximum number of tag objects to return in the response. The default value is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSResourceTagCmdlet.NextToken"> <summary> <para> <para>(Optional) You can use <c>NextToken</c> in a subsequent request to fetch the next page of access point descriptions if the response payload was paginated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticFileSystem.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.ElasticFileSystem.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceId parameter. The -PassThru parameter is deprecated, use -Select '^ResourceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.GetEFSTagCmdlet"> <summary> <note><para> DEPRECATED - The <c>DescribeTags</c> action is deprecated and not maintained. To view tags associated with EFS resources, use the <c>ListTagsForResource</c> API action. </para></note><para> Returns the tags associated with a file system. The order of tags returned in the response of one <c>DescribeTags</c> call and the order of tags returned across the responses of a multiple-call iteration (when using pagination) is unspecified. </para><para> This operation requires permissions for the <c>elasticfilesystem:DescribeTags</c> action. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration.<br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSTagCmdlet.FileSystemId"> <summary> <para> <para>The ID of the file system whose tag set you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSTagCmdlet.Marker"> <summary> <para> <para>(Optional) An opaque pagination token returned from a previous <c>DescribeTags</c> operation (String). If present, it specifies to continue the list from where the previous call left off.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.NextMarker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSTagCmdlet.MaxItem"> <summary> <para> <para>(Optional) The maximum number of file system tags to return in the response. Currently, this number is automatically set to 100, and other values are ignored. The response is paginated at 100 per page if you have more than 100 tags.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticFileSystem.Model.DescribeTagsResponse). Specifying the name of a property of type Amazon.ElasticFileSystem.Model.DescribeTagsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSTagCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSTagCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.NewEFSAccessPointCmdlet"> <summary> Creates an EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group override any identity information provided by the NFS client. The file system path is exposed as the access point's root directory. Applications using the access point can only access data in the application's own directory and any subdirectories. To learn more, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html">Mounting a file system using EFS access points</a>. <note><para> If multiple requests to create access points on the same file system are sent in quick succession, and the file system is near the limit of 1,000 access points, you may experience a throttling response for these requests. This is to ensure that the file system does not exceed the stated access point limit. </para></note><para> This operation requires permissions for the <c>elasticfilesystem:CreateAccessPoint</c> action. </para><para> Access points can be tagged on creation. If tags are specified in the creation action, IAM performs additional authorization on the <c>elasticfilesystem:TagResource</c> action to verify if users have permissions to create tags. Therefore, you must grant explicit permissions to use the <c>elasticfilesystem:TagResource</c> action. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/using-tags-efs.html#supported-iam-actions-tagging.html">Granting permissions to tag resources during creation</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSAccessPointCmdlet.FileSystemId"> <summary> <para> <para>The ID of the EFS file system that the access point provides access to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSAccessPointCmdlet.PosixUser_Gid"> <summary> <para> <para>The POSIX group ID used for all file system operations using this access point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSAccessPointCmdlet.CreationInfo_OwnerGid"> <summary> <para> <para>Specifies the POSIX group ID to apply to the <c>RootDirectory</c>. Accepts values from 0 to 2^32 (4294967295).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSAccessPointCmdlet.CreationInfo_OwnerUid"> <summary> <para> <para>Specifies the POSIX user ID to apply to the <c>RootDirectory</c>. Accepts values from 0 to 2^32 (4294967295).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSAccessPointCmdlet.RootDirectory_Path"> <summary> <para> <para>Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the <c>CreationInfo</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSAccessPointCmdlet.CreationInfo_Permission"> <summary> <para> <para>Specifies the POSIX permissions to apply to the <c>RootDirectory</c>, in the format of an octal number representing the file's mode bits.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSAccessPointCmdlet.PosixUser_SecondaryGid"> <summary> <para> <para>Secondary POSIX group IDs used for all file system operations using this access point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSAccessPointCmdlet.Tag"> <summary> <para> <para>Creates tags associated with the access point. Each tag is a key-value pair, each key must be unique. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSAccessPointCmdlet.PosixUser_Uid"> <summary> <para> <para>The POSIX user ID used for all file system operations using this access point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSAccessPointCmdlet.ClientToken"> <summary> <para> <para>A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSAccessPointCmdlet.Select"> <summary> 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.CreateAccessPointResponse). Specifying the name of a property of type Amazon.ElasticFileSystem.Model.CreateAccessPointResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSAccessPointCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSAccessPointCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.NewEFSFileSystemCmdlet"> <summary> Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's Amazon Web Services account with the specified creation token, this operation does the following: <ul><li><para> Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state <c>creating</c>. </para></li><li><para> Returns with the description of the created file system. </para></li></ul><para> Otherwise, this operation returns a <c>FileSystemAlreadyExists</c> error with the ID of the existing file system. </para><note><para> For basic use cases, you can use a randomly generated UUID for the creation token. </para></note><para> The idempotent operation allows you to retry a <c>CreateFileSystem</c> call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the <c>FileSystemAlreadyExists</c> error. </para><para> For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/creating-using-create-fs.html#creating-using-create-fs-part1">Creating a file system</a> in the <i>Amazon EFS User Guide</i>. </para><note><para> The <c>CreateFileSystem</c> call returns while the file system's lifecycle state is still <c>creating</c>. You can check the file system creation status by calling the <a>DescribeFileSystems</a> operation, which among other things returns the file system state. </para></note><para> This operation accepts an optional <c>PerformanceMode</c> parameter that you choose for your file system. We recommend <c>generalPurpose</c> performance mode for all file systems. File systems using the <c>maxIO</c> mode is a previous generation performance type that is designed for highly parallelized workloads that can tolerate higher latencies than the General Purpose mode. Max I/O mode is not supported for One Zone file systems or file systems that use Elastic throughput. </para><important><para> Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems. </para></important><para> The performance mode can't be changed after the file system has been created. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/performance.html#performancemodes.html">Amazon EFS performance modes</a>. </para><para> You can set the throughput mode for the file system using the <c>ThroughputMode</c> parameter. </para><para> After the file system is fully created, Amazon EFS sets its lifecycle state to <c>available</c>, at which point you can create one or more mount targets for the file system in your VPC. For more information, see <a>CreateMountTarget</a>. You mount your Amazon EFS file system on an EC2 instances in your VPC by using the mount target. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html">Amazon EFS: How it Works</a>. </para><para> This operation requires permissions for the <c>elasticfilesystem:CreateFileSystem</c> action. </para><para> File systems can be tagged on creation. If tags are specified in the creation action, IAM performs additional authorization on the <c>elasticfilesystem:TagResource</c> action to verify if users have permissions to create tags. Therefore, you must grant explicit permissions to use the <c>elasticfilesystem:TagResource</c> action. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/using-tags-efs.html#supported-iam-actions-tagging.html">Granting permissions to tag resources during creation</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSFileSystemCmdlet.AvailabilityZoneName"> <summary> <para> <para>Used to create a One Zone file system. It specifies the Amazon Web Services Availability Zone in which to create the file system. Use the format <c>us-east-1a</c> to specify the Availability Zone. For more information about One Zone file systems, see <a href="https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html">Using EFS storage classes</a> in the <i>Amazon EFS User Guide</i>.</para><note><para>One Zone file systems are not available in all Availability Zones in Amazon Web Services Regions where Amazon EFS is available.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSFileSystemCmdlet.Backup"> <summary> <para> <para>Specifies whether automatic backups are enabled on the file system that you are creating. Set the value to <c>true</c> to enable automatic backups. If you are creating a One Zone file system, automatic backups are enabled by default. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#automatic-backups">Automatic backups</a> in the <i>Amazon EFS User Guide</i>.</para><para>Default is <c>false</c>. However, if you specify an <c>AvailabilityZoneName</c>, the default is <c>true</c>.</para><note><para>Backup is not available in all Amazon Web Services Regions where Amazon EFS is available.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSFileSystemCmdlet.CreationToken"> <summary> <para> <para>A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSFileSystemCmdlet.Encrypted"> <summary> <para> <para>A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying an existing Key Management Service key (KMS key). If you don't specify a KMS key, then the default KMS key for Amazon EFS, <c>/aws/elasticfilesystem</c>, is used to protect the encrypted file system. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSFileSystemCmdlet.KmsKeyId"> <summary> <para> <para>The ID of the KMS key that you want to use to protect the encrypted file system. This parameter is required only if you want to use a non-default KMS key. If this parameter is not specified, the default KMS key for Amazon EFS is used. You can specify a KMS key ID using the following formats:</para><ul><li><para>Key ID - A unique identifier of the key, for example <c>1234abcd-12ab-34cd-56ef-1234567890ab</c>.</para></li><li><para>ARN - An Amazon Resource Name (ARN) for the key, for example <c>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</c>.</para></li><li><para>Key alias - A previously created display name for a key, for example <c>alias/projectKey1</c>.</para></li><li><para>Key alias ARN - An ARN for a key alias, for example <c>arn:aws:kms:us-west-2:444455556666:alias/projectKey1</c>.</para></li></ul><para>If you use <c>KmsKeyId</c>, you must set the <a>CreateFileSystemRequest$Encrypted</a> parameter to true.</para><important><para>EFS accepts only symmetric KMS keys. You cannot use asymmetric KMS keys with Amazon EFS file systems.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSFileSystemCmdlet.PerformanceMode"> <summary> <para> <para>The Performance mode of the file system. We recommend <c>generalPurpose</c> performance mode for all file systems. File systems using the <c>maxIO</c> performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. The <c>maxIO</c> mode is not supported on One Zone file systems.</para><important><para>Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.</para></important><para>Default is <c>generalPurpose</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSFileSystemCmdlet.ProvisionedThroughputInMibp"> <summary> <para> <para>The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. Required if <c>ThroughputMode</c> is set to <c>provisioned</c>. Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact Amazon Web Services Support. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits">Amazon EFS quotas that you can increase</a> in the <i>Amazon EFS User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSFileSystemCmdlet.Tag"> <summary> <para> <para>Use to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a <c>"Key":"Name","Value":"{value}"</c> key-value pair. Each key must be unique. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSFileSystemCmdlet.ThroughputMode"> <summary> <para> <para>Specifies the throughput mode for the file system. The mode can be <c>bursting</c>, <c>provisioned</c>, or <c>elastic</c>. If you set <c>ThroughputMode</c> to <c>provisioned</c>, you must also set a value for <c>ProvisionedThroughputInMibps</c>. After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput">Specifying throughput with provisioned mode</a> in the <i>Amazon EFS User Guide</i>. </para><para>Default is <c>bursting</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSFileSystemCmdlet.Select"> <summary> 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.CreateFileSystemResponse). Specifying the name of a property of type Amazon.ElasticFileSystem.Model.CreateFileSystemResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSFileSystemCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.NewEFSMountTargetCmdlet"> <summary> Creates a mount target for a file system. You can then mount the file system on EC2 instances by using the mount target. <para> 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. </para><para> You can create only one mount target for a One Zone file system. You must create that mount target in the same Availability Zone in which the file system is located. Use the <c>AvailabilityZoneName</c> and <c>AvailabiltyZoneId</c> properties in the <a>DescribeFileSystems</a> response object to get this information. Use the <c>subnetId</c> associated with the file system's Availability Zone when creating the mount target. </para><para> For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html">Amazon EFS: How it Works</a>. </para><para> To create a mount target for a file system, the file system's lifecycle state must be <c>available</c>. For more information, see <a>DescribeFileSystems</a>. </para><para> In the request, provide the following: </para><ul><li><para> The file system ID for which you are creating the mount target. </para></li><li><para> A subnet ID, which determines the following: </para><ul><li><para> The VPC in which Amazon EFS creates the mount target </para></li><li><para> The Availability Zone in which Amazon EFS creates the mount target </para></li><li><para> 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) </para></li></ul></li></ul><para> After creating the mount target, Amazon EFS returns a response that includes, a <c>MountTargetId</c> and an <c>IpAddress</c>. 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 <a href="https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html#how-it-works-implementation">How it Works: Implementation Overview</a>. </para><para> 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: </para><ul><li><para> Must belong to the same VPC as the subnets of the existing mount targets </para></li><li><para> Must not be in the same Availability Zone as any of the subnets of the existing mount targets </para></li></ul><para> If the request satisfies the requirements, Amazon EFS does the following: </para><ul><li><para> Creates a new mount target in the specified subnet. </para></li><li><para> Also creates a new network interface in the subnet as follows: </para><ul><li><para> If the request provides an <c>IpAddress</c>, 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 <c>CreateNetworkInterface</c> call does when a request does not specify a primary private IP address). </para></li><li><para> If the request provides <c>SecurityGroups</c>, this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC. </para></li><li><para> Assigns the description <c>Mount target <i>fsmt-id</i> for file system <i>fs-id</i></c> where <c><i>fsmt-id</i></c> is the mount target ID, and <c><i>fs-id</i></c> is the <c>FileSystemId</c>. </para></li><li><para> Sets the <c>requesterManaged</c> property of the network interface to <c>true</c>, and the <c>requesterId</c> value to <c>EFS</c>. </para></li></ul><para> Each Amazon EFS mount target has one corresponding requester-managed EC2 network interface. After the network interface is created, Amazon EFS sets the <c>NetworkInterfaceId</c> field in the mount target's description to the network interface ID, and the <c>IpAddress</c> field to its address. If network interface creation fails, the entire <c>CreateMountTarget</c> operation fails. </para></li></ul><note><para> The <c>CreateMountTarget</c> call returns only after creating the network interface, but while the mount target state is still <c>creating</c>, you can check the mount target creation status by calling the <a>DescribeMountTargets</a> operation, which among other things returns the mount target state. </para></note><para> 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 <a href="http://aws.amazon.com/efs/">Amazon EFS</a>. 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. </para><para> This operation requires permissions for the following action on the file system: </para><ul><li><para><c>elasticfilesystem:CreateMountTarget</c></para></li></ul><para> This operation also requires permissions for the following Amazon EC2 actions: </para><ul><li><para><c>ec2:DescribeSubnets</c></para></li><li><para><c>ec2:DescribeNetworkInterfaces</c></para></li><li><para><c>ec2:CreateNetworkInterface</c></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSMountTargetCmdlet.FileSystemId"> <summary> <para> <para>The ID of the file system for which to create the mount target.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSMountTargetCmdlet.IpAddress"> <summary> <para> <para>Valid IPv4 address within the address range of the specified subnet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSMountTargetCmdlet.SecurityGroup"> <summary> <para> <para>Up to five VPC security group IDs, of the form <c>sg-xxxxxxxx</c>. These must be for the same VPC as subnet specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSMountTargetCmdlet.SubnetId"> <summary> <para> <para>The ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is associated with the file system's Availability Zone.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSMountTargetCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSMountTargetCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSMountTargetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.NewEFSReplicationConfigurationCmdlet"> <summary> Creates a replication configuration that replicates an existing EFS file system to a new, read-only file system. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html">Amazon EFS replication</a> in the <i>Amazon EFS User Guide</i>. The replication configuration specifies the following: <ul><li><para><b>Source file system</b> – The EFS file system that you want replicated. The source file system cannot be a destination file system in an existing replication configuration. </para></li><li><para><b>Amazon Web Services Region</b> – The Amazon Web Services Region in which the destination file system is created. Amazon EFS replication is available in all Amazon Web Services Regions in which EFS is available. The Region must be enabled. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable">Managing Amazon Web Services Regions</a> in the <i>Amazon Web Services General Reference Reference Guide</i>. </para></li><li><para><b>Destination file system configuration</b> – The configuration of the destination file system to which the source file system will be replicated. There can only be one destination file system in a replication configuration. </para><para> Parameters for the replication configuration include: </para><ul><li><para><b>File system ID</b> – The ID of the destination file system for the replication. If no ID is provided, then EFS creates a new file system with the default settings. For existing file systems, the file system's replication overwrite protection must be disabled. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-replication#replicate-existing-destination"> Replicating to an existing file system</a>. </para></li><li><para><b>Availability Zone</b> – If you want the destination file system to use One Zone storage, you must specify the Availability Zone to create the file system in. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html"> EFS file system types</a> in the <i>Amazon EFS User Guide</i>. </para></li><li><para><b>Encryption</b> – All destination file systems are created with encryption at rest enabled. You can specify the Key Management Service (KMS) key that is used to encrypt the destination file system. If you don't specify a KMS key, your service-managed KMS key for Amazon EFS is used. </para><note><para> After the file system is created, you cannot change the KMS key. </para></note></li></ul></li></ul><note><para> After the file system is created, you cannot change the KMS key. </para></note><para> For new destination file systems, the following properties are set by default: </para><ul><li><para><b>Performance mode</b> - The destination file system's performance mode matches that of the source file system, unless the destination file system uses EFS One Zone storage. In that case, the General Purpose performance mode is used. The performance mode cannot be changed. </para></li><li><para><b>Throughput mode</b> - The destination file system's throughput mode matches that of the source file system. After the file system is created, you can modify the throughput mode. </para></li></ul><ul><li><para><b>Lifecycle management</b> – Lifecycle management is not enabled on the destination file system. After the destination file system is created, you can enable lifecycle management. </para></li><li><para><b>Automatic backups</b> – Automatic daily backups are enabled on the destination file system. After the file system is created, you can change this setting. </para></li></ul><para> For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html">Amazon EFS replication</a> in the <i>Amazon EFS User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSReplicationConfigurationCmdlet.Destination"> <summary> <para> <para>An array of destination configuration objects. Only one destination configuration object is supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSReplicationConfigurationCmdlet.SourceFileSystemId"> <summary> <para> <para>Specifies the Amazon EFS file system that you want to replicate. This file system cannot already be a source or destination file system in another replication configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSReplicationConfigurationCmdlet.Select"> <summary> 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.CreateReplicationConfigurationResponse). Specifying the name of a property of type Amazon.ElasticFileSystem.Model.CreateReplicationConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSReplicationConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SourceFileSystemId parameter. The -PassThru parameter is deprecated, use -Select '^SourceFileSystemId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSReplicationConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.NewEFSTagCmdlet"> <summary> <note><para> DEPRECATED - <c>CreateTags</c> is deprecated and not maintained. To create tags for EFS resources, use the API action. </para></note><para> Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If a tag key specified in the request already exists on the file system, this operation overwrites its value with the value provided in the request. If you add the <c>Name</c> tag to your file system, Amazon EFS returns it in the response to the <a>DescribeFileSystems</a> operation. </para><para> This operation requires permission for the <c>elasticfilesystem:CreateTags</c> action. </para><br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSTagCmdlet.FileSystemId"> <summary> <para> <para>The ID of the file system whose tags you want to modify (String). This operation modifies the tags only, not the file system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSTagCmdlet.Tag"> <summary> <para> <para>An array of <c>Tag</c> objects to add. Each <c>Tag</c> object is a key-value pair. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticFileSystem.Model.CreateTagsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Tag parameter. The -PassThru parameter is deprecated, use -Select '^Tag' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSAccessPointCmdlet"> <summary> Deletes the specified access point. After deletion is complete, new clients can no longer connect to the access points. Clients connected to the access point at the time of deletion will continue to function until they terminate their connection. <para> This operation requires permissions for the <c>elasticfilesystem:DeleteAccessPoint</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSAccessPointCmdlet.AccessPointId"> <summary> <para> <para>The ID of the access point that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSAccessPointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticFileSystem.Model.DeleteAccessPointResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSAccessPointCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AccessPointId parameter. The -PassThru parameter is deprecated, use -Select '^AccessPointId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSAccessPointCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSFileSystemCmdlet"> <summary> Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you can't access any contents of the deleted file system. <para> You need to manually delete mount targets attached to a file system before you can delete an EFS file system. This step is performed for you when you use the Amazon Web Services console to delete a file system. </para><note><para> You cannot delete a file system that is part of an EFS Replication configuration. You need to delete the replication configuration first. </para></note><para> You can't delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see <a>DescribeMountTargets</a> and <a>DeleteMountTarget</a>. </para><note><para> The <c>DeleteFileSystem</c> call returns while the file system state is still <c>deleting</c>. You can check the file system deletion status by calling the <a>DescribeFileSystems</a> operation, which returns a list of file systems in your account. If you pass file system ID or creation token for the deleted file system, the <a>DescribeFileSystems</a> returns a <c>404 FileSystemNotFound</c> error. </para></note><para> This operation requires permissions for the <c>elasticfilesystem:DeleteFileSystem</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSFileSystemCmdlet.FileSystemId"> <summary> <para> <para>The ID of the file system you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSFileSystemCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticFileSystem.Model.DeleteFileSystemResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSFileSystemCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSFileSystemCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSFileSystemPolicyCmdlet"> <summary> Deletes the <c>FileSystemPolicy</c> for the specified file system. The default <c>FileSystemPolicy</c> goes into effect once the existing policy is deleted. For more information about the default file system policy, see <a href="https://docs.aws.amazon.com/efs/latest/ug/res-based-policies-efs.html">Using Resource-based Policies with EFS</a>. <para> This operation requires permissions for the <c>elasticfilesystem:DeleteFileSystemPolicy</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSFileSystemPolicyCmdlet.FileSystemId"> <summary> <para> <para>Specifies the EFS file system for which to delete the <c>FileSystemPolicy</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSFileSystemPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticFileSystem.Model.DeleteFileSystemPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSFileSystemPolicyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSFileSystemPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSMountTargetCmdlet"> <summary> Deletes the specified mount target. <para> This operation forcibly breaks any mounts of the file system by using the mount target that is being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes might be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC by using another mount target. </para><para> This operation requires permissions for the following action on the file system: </para><ul><li><para><c>elasticfilesystem:DeleteMountTarget</c></para></li></ul><note><para> The <c>DeleteMountTarget</c> call returns while the mount target state is still <c>deleting</c>. You can check the mount target deletion by calling the <a>DescribeMountTargets</a> operation, which returns a list of mount target descriptions for the given file system. </para></note><para> The operation also requires permissions for the following Amazon EC2 action on the mount target's network interface: </para><ul><li><para><c>ec2:DeleteNetworkInterface</c></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSMountTargetCmdlet.MountTargetId"> <summary> <para> <para>The ID of the mount target to delete (String).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSMountTargetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticFileSystem.Model.DeleteMountTargetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSMountTargetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MountTargetId parameter. The -PassThru parameter is deprecated, use -Select '^MountTargetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSMountTargetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSReplicationConfigurationCmdlet"> <summary> Deletes a replication configuration. Deleting a replication configuration ends the replication process. After a replication configuration is deleted, the destination file system becomes <c>Writeable</c> and its replication overwrite protection is re-enabled. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/delete-replications.html">Delete a replication configuration</a>. <para> This operation requires permissions for the <c>elasticfilesystem:DeleteReplicationConfiguration</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSReplicationConfigurationCmdlet.SourceFileSystemId"> <summary> <para> <para>The ID of the source file system in the replication configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSReplicationConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticFileSystem.Model.DeleteReplicationConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSReplicationConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SourceFileSystemId parameter. The -PassThru parameter is deprecated, use -Select '^SourceFileSystemId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSReplicationConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSResourceTagCmdlet"> <summary> Removes tags from an EFS resource. You can remove tags from EFS file systems and access points using this API operation. <para> This operation requires permissions for the <c>elasticfilesystem:UntagResource</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSResourceTagCmdlet.ResourceId"> <summary> <para> <para>Specifies the EFS resource that you want to remove tags from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSResourceTagCmdlet.TagKey"> <summary> <para> <para>The keys of the key-value tag pairs that you want to remove from the specified EFS resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticFileSystem.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceId parameter. The -PassThru parameter is deprecated, use -Select '^ResourceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSTagCmdlet"> <summary> <note><para> DEPRECATED - <c>DeleteTags</c> is deprecated and not maintained. To remove tags from EFS resources, use the API action. </para></note><para> Deletes the specified tags from a file system. If the <c>DeleteTags</c> request includes a tag key that doesn't exist, Amazon EFS ignores it and doesn't cause an error. For more information about tags and related restrictions, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Tag restrictions</a> in the <i>Billing and Cost Management User Guide</i>. </para><para> This operation requires permissions for the <c>elasticfilesystem:DeleteTags</c> action. </para><br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSTagCmdlet.FileSystemId"> <summary> <para> <para>The ID of the file system whose tags you want to delete (String).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSTagCmdlet.TagKey"> <summary> <para> <para>A list of tag keys to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticFileSystem.Model.DeleteTagsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSTagCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.UpdateEFSFileSystemCmdlet"> <summary> Updates the throughput mode or the amount of provisioned throughput of an existing file system. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.UpdateEFSFileSystemCmdlet.FileSystemId"> <summary> <para> <para>The ID of the file system that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.UpdateEFSFileSystemCmdlet.ProvisionedThroughputInMibp"> <summary> <para> <para>(Optional) The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. Required if <c>ThroughputMode</c> is set to <c>provisioned</c>. Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact Amazon Web Services Support. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits">Amazon EFS quotas that you can increase</a> in the <i>Amazon EFS User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.UpdateEFSFileSystemCmdlet.ThroughputMode"> <summary> <para> <para>(Optional) Updates the file system's throughput mode. If you're not updating your throughput mode, you don't need to provide this value in your request. If you are changing the <c>ThroughputMode</c> to <c>provisioned</c>, you must also set a value for <c>ProvisionedThroughputInMibps</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.UpdateEFSFileSystemCmdlet.Select"> <summary> 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.UpdateFileSystemResponse). Specifying the name of a property of type Amazon.ElasticFileSystem.Model.UpdateFileSystemResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.UpdateEFSFileSystemCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.UpdateEFSFileSystemCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.UpdateEFSFileSystemProtectionCmdlet"> <summary> Updates protection on the file system. <para> This operation requires permissions for the <c>elasticfilesystem:UpdateFileSystemProtection</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.UpdateEFSFileSystemProtectionCmdlet.FileSystemId"> <summary> <para> <para>The ID of the file system to update. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.UpdateEFSFileSystemProtectionCmdlet.ReplicationOverwriteProtection"> <summary> <para> <para>The status of the file system's replication overwrite protection.</para><ul><li><para><c>ENABLED</c> – The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is <c>ENABLED</c> by default. </para></li><li><para><c>DISABLED</c> – The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication.</para></li><li><para><c>REPLICATING</c> – The file system is being used as the destination file system in a replication configuration. The file system is read-only and is only modified only by EFS replication.</para></li></ul><para>If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.UpdateEFSFileSystemProtectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReplicationOverwriteProtection'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticFileSystem.Model.UpdateFileSystemProtectionResponse). Specifying the name of a property of type Amazon.ElasticFileSystem.Model.UpdateFileSystemProtectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.UpdateEFSFileSystemProtectionCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.UpdateEFSFileSystemProtectionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.WriteEFSAccountPreferenceCmdlet"> <summary> Use this operation to set the account preference in the current Amazon Web Services Region to use long 17 character (63 bit) or short 8 character (32 bit) resource IDs for new EFS file system and mount target resources. All existing resource IDs are not affected by any changes you make. You can set the ID preference during the opt-in period as EFS transitions to long resource IDs. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/manage-efs-resource-ids.html">Managing Amazon EFS resource IDs</a>. <note><para> Starting in October, 2021, you will receive an error if you try to set the account preference to use the short 8 character format resource ID. Contact Amazon Web Services support if you receive an error and must use short IDs for file system and mount target resources. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.WriteEFSAccountPreferenceCmdlet.ResourceIdType"> <summary> <para> <para>Specifies the EFS resource ID preference to set for the user's Amazon Web Services account, in the current Amazon Web Services Region, either <c>LONG_ID</c> (17 characters), or <c>SHORT_ID</c> (8 characters).</para><note><para>Starting in October, 2021, you will receive an error when setting the account preference to <c>SHORT_ID</c>. Contact Amazon Web Services support if you receive an error and must use short IDs for file system and mount target resources.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.WriteEFSAccountPreferenceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourceIdPreference'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticFileSystem.Model.PutAccountPreferencesResponse). Specifying the name of a property of type Amazon.ElasticFileSystem.Model.PutAccountPreferencesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.WriteEFSAccountPreferenceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceIdType parameter. The -PassThru parameter is deprecated, use -Select '^ResourceIdType' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.WriteEFSAccountPreferenceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.WriteEFSBackupPolicyCmdlet"> <summary> Updates the file system's backup policy. Use this action to start or stop automatic backups of the file system. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.WriteEFSBackupPolicyCmdlet.FileSystemId"> <summary> <para> <para>Specifies which EFS file system to update the backup policy for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.WriteEFSBackupPolicyCmdlet.BackupPolicy_Status"> <summary> <para> <para>Describes the status of the file system's backup policy.</para><ul><li><para><b><c>ENABLED</c></b> – EFS is automatically backing up the file system.</para></li><li><para><b><c>ENABLING</c></b> – EFS is turning on automatic backups for the file system.</para></li><li><para><b><c>DISABLED</c></b> – Automatic back ups are turned off for the file system.</para></li><li><para><b><c>DISABLING</c></b> – EFS is turning off automatic backups for the file system.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.WriteEFSBackupPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BackupPolicy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticFileSystem.Model.PutBackupPolicyResponse). Specifying the name of a property of type Amazon.ElasticFileSystem.Model.PutBackupPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.WriteEFSBackupPolicyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.WriteEFSBackupPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.WriteEFSFileSystemPolicyCmdlet"> <summary> Applies an Amazon EFS <c>FileSystemPolicy</c> to an Amazon EFS file system. A file system policy is an IAM resource-based policy and can contain multiple policy statements. A file system always has exactly one file system policy, which can be the default policy or an explicit policy set or updated using this API operation. EFS file system policies have a 20,000 character limit. When an explicit policy is set, it overrides the default policy. For more information about the default file system policy, see <a href="https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html#default-filesystempolicy">Default EFS File System Policy</a>. <note><para> EFS file system policies have a 20,000 character limit. </para></note><para> This operation requires permissions for the <c>elasticfilesystem:PutFileSystemPolicy</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.WriteEFSFileSystemPolicyCmdlet.BypassPolicyLockoutSafetyCheck"> <summary> <para> <para>(Optional) A boolean that specifies whether or not to bypass the <c>FileSystemPolicy</c> lockout safety check. The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future <c>PutFileSystemPolicy</c> requests on this file system. Set <c>BypassPolicyLockoutSafetyCheck</c> to <c>True</c> only when you intend to prevent the IAM principal that is making the request from making subsequent <c>PutFileSystemPolicy</c> requests on this file system. The default value is <c>False</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.WriteEFSFileSystemPolicyCmdlet.FileSystemId"> <summary> <para> <para>The ID of the EFS file system that you want to create or update the <c>FileSystemPolicy</c> for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.WriteEFSFileSystemPolicyCmdlet.Policy"> <summary> <para> <para>The <c>FileSystemPolicy</c> that you're creating. Accepts a JSON formatted policy definition. EFS file system policies have a 20,000 character limit. To find out more about the elements that make up a file system policy, see <a href="https://docs.aws.amazon.com/efs/latest/ug/access-control-overview.html#access-control-manage-access-intro-resource-policies">EFS Resource-based Policies</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.WriteEFSFileSystemPolicyCmdlet.Select"> <summary> 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.PutFileSystemPolicyResponse). Specifying the name of a property of type Amazon.ElasticFileSystem.Model.PutFileSystemPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.WriteEFSFileSystemPolicyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.WriteEFSFileSystemPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.WriteEFSLifecycleConfigurationCmdlet"> <summary> Use this action to manage storage for your file system. A <c>LifecycleConfiguration</c> consists of one or more <c>LifecyclePolicy</c> objects that define the following: <ul><li><para><b><c>TransitionToIA</c></b> – When to move files in the file system from primary storage (Standard storage class) into the Infrequent Access (IA) storage. </para></li><li><para><b><c>TransitionToArchive</c></b> – When to move files in the file system from their current storage class (either IA or Standard storage) into the Archive storage. </para><para> File systems cannot transition into Archive storage before transitioning into IA storage. Therefore, TransitionToArchive must either not be set or must be later than TransitionToIA. </para><note><para> The Archive storage class is available only for file systems that use the Elastic Throughput mode and the General Purpose Performance mode. </para></note></li></ul><ul><li><para><b><c>TransitionToPrimaryStorageClass</c></b> – Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA or Archive storage. </para></li></ul><para> For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html"> Managing file system storage</a>. </para><para> Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system. If a <c>LifecycleConfiguration</c> object already exists for the specified file system, a <c>PutLifecycleConfiguration</c> call modifies the existing configuration. A <c>PutLifecycleConfiguration</c> call with an empty <c>LifecyclePolicies</c> array in the request body deletes any existing <c>LifecycleConfiguration</c>. In the request, specify the following: </para><ul><li><para> The ID for the file system for which you are enabling, disabling, or modifying Lifecycle management. </para></li><li><para> A <c>LifecyclePolicies</c> array of <c>LifecyclePolicy</c> objects that define when to move files to IA storage, to Archive storage, and back to primary storage. </para><note><para> Amazon EFS requires that each <c>LifecyclePolicy</c> object have only have a single transition, so the <c>LifecyclePolicies</c> array needs to be structured with separate <c>LifecyclePolicy</c> objects. See the example requests in the following section for more information. </para></note></li></ul><para> This operation requires permissions for the <c>elasticfilesystem:PutLifecycleConfiguration</c> operation. </para><para> To apply a <c>LifecycleConfiguration</c> object to an encrypted file system, you need the same Key Management Service permissions as when you created the encrypted file system. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.WriteEFSLifecycleConfigurationCmdlet.FileSystemId"> <summary> <para> <para>The ID of the file system for which you are creating the <c>LifecycleConfiguration</c> object (String).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.WriteEFSLifecycleConfigurationCmdlet.LifecyclePolicy"> <summary> <para> <para>An array of <c>LifecyclePolicy</c> objects that define the file system's <c>LifecycleConfiguration</c> object. A <c>LifecycleConfiguration</c> object informs EFS Lifecycle management of the following:</para><ul><li><para><b><c>TransitionToIA</c></b> – When to move files in the file system from primary storage (Standard storage class) into the Infrequent Access (IA) storage.</para></li><li><para><b><c>TransitionToArchive</c></b> – When to move files in the file system from their current storage class (either IA or Standard storage) into the Archive storage.</para><para>File systems cannot transition into Archive storage before transitioning into IA storage. Therefore, TransitionToArchive must either not be set or must be later than TransitionToIA.</para><note><para> The Archive storage class is available only for file systems that use the Elastic Throughput mode and the General Purpose Performance mode. </para></note></li><li><para><b><c>TransitionToPrimaryStorageClass</c></b> – Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA or Archive storage.</para></li></ul><note><para>When using the <c>put-lifecycle-configuration</c> CLI command or the <c>PutLifecycleConfiguration</c> API action, Amazon EFS requires that each <c>LifecyclePolicy</c> object have only a single transition. This means that in a request body, <c>LifecyclePolicies</c> must be structured as an array of <c>LifecyclePolicy</c> objects, one object for each storage transition. See the example requests in the following section for more information.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.WriteEFSLifecycleConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LifecyclePolicies'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticFileSystem.Model.PutLifecycleConfigurationResponse). Specifying the name of a property of type Amazon.ElasticFileSystem.Model.PutLifecycleConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.WriteEFSLifecycleConfigurationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.WriteEFSLifecycleConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |