AWS.Tools.DataSync.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.DataSync</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.DSYN.AddDSYNResourceTagCmdlet"> <summary> Applies a <i>tag</i> to an Amazon Web Services resource. Tags are key-value pairs that can help you manage, filter, and search for your resources. <para> These include DataSync resources, such as locations, tasks, and task executions. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.AddDSYNResourceTagCmdlet.ResourceArn"> <summary> <para> <para>Specifies the Amazon Resource Name (ARN) of the resource to apply the tag to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.AddDSYNResourceTagCmdlet.Tag"> <summary> <para> <para>Specifies the tags that you want to apply to the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.AddDSYNResourceTagCmdlet.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.DataSync.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.AddDSYNResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.AddDSYNResourceTagCmdlet.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.DSYN.AddDSYNStorageSystemCmdlet"> <summary> Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to collect information about. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.AddDSYNStorageSystemCmdlet.AgentArn"> <summary> <para> <para>Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads from your on-premises storage system's management interface.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.AddDSYNStorageSystemCmdlet.CloudWatchLogGroupArn"> <summary> <para> <para>Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging discovery job events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.AddDSYNStorageSystemCmdlet.Name"> <summary> <para> <para>Specifies a familiar name for your on-premises storage system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.AddDSYNStorageSystemCmdlet.Credentials_Password"> <summary> <para> <para>Specifies the password for your storage system's management interface.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.AddDSYNStorageSystemCmdlet.ServerConfiguration_ServerHostname"> <summary> <para> <para>The domain name or IP address of your storage system's management interface.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.AddDSYNStorageSystemCmdlet.ServerConfiguration_ServerPort"> <summary> <para> <para>The network port for accessing the storage system's management interface.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.AddDSYNStorageSystemCmdlet.SystemType"> <summary> <para> <para>Specifies the type of on-premises storage system that you want DataSync Discovery to collect information about.</para><note><para>DataSync Discovery currently supports NetApp Fabric-Attached Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or later.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.AddDSYNStorageSystemCmdlet.Tag"> <summary> <para> <para>Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your on-premises storage system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.AddDSYNStorageSystemCmdlet.Credentials_Username"> <summary> <para> <para>Specifies the user name for your storage system's management interface.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.AddDSYNStorageSystemCmdlet.ClientToken"> <summary> <para> <para>Specifies a client token to make sure requests with this API operation are idempotent. If you don't specify a client token, DataSync generates one for you automatically.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.AddDSYNStorageSystemCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StorageSystemArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DataSync.Model.AddStorageSystemResponse). Specifying the name of a property of type Amazon.DataSync.Model.AddStorageSystemResponse 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.DSYN.AddDSYNStorageSystemCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SystemType parameter. The -PassThru parameter is deprecated, use -Select '^SystemType' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.AddDSYNStorageSystemCmdlet.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.DSYN.GetDSYNAgentCmdlet"> <summary> Returns metadata about an DataSync agent, such as its name, endpoint type, and status. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNAgentCmdlet.AgentArn"> <summary> <para> <para>Specifies the Amazon Resource Name (ARN) of the DataSync agent to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNAgentCmdlet.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.DataSync.Model.DescribeAgentResponse). Specifying the name of a property of type Amazon.DataSync.Model.DescribeAgentResponse 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.DSYN.GetDSYNAgentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgentArn parameter. The -PassThru parameter is deprecated, use -Select '^AgentArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNAgentListCmdlet"> <summary> Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region specified in the request. <para> With pagination, you can reduce the number of agents returned in a response. If you get a truncated list of agents in a response, the response contains a marker that you can specify in your next request to fetch the next page of agents. </para><para><code>ListAgents</code> is eventually consistent. This means the result of running the operation might not reflect that you just created or deleted an agent. For example, if you create an agent with <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateAgent.html">CreateAgent</a> and then immediately run <code>ListAgents</code>, that agent might not show up in the list right away. In situations like this, you can always confirm whether an agent has been created (or deleted) by using <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeAgent.html">DescribeAgent</a>. </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.DSYN.GetDSYNAgentListCmdlet.MaxResult"> <summary> <para> <para>Specifies the maximum number of DataSync agents to list in a response. By default, a response shows a maximum of 100 agents.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNAgentListCmdlet.NextToken"> <summary> <para> <para>Specifies an opaque string that indicates the position to begin the next list of results in the response.</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 '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNAgentListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Agents'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DataSync.Model.ListAgentsResponse). Specifying the name of a property of type Amazon.DataSync.Model.ListAgentsResponse 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.DSYN.GetDSYNAgentListCmdlet.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 NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNDiscoveryJobCmdlet"> <summary> Returns information about a DataSync discovery job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNDiscoveryJobCmdlet.DiscoveryJobArn"> <summary> <para> <para>Specifies the Amazon Resource Name (ARN) of the discovery job that you want information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNDiscoveryJobCmdlet.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.DataSync.Model.DescribeDiscoveryJobResponse). Specifying the name of a property of type Amazon.DataSync.Model.DescribeDiscoveryJobResponse 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.DSYN.GetDSYNDiscoveryJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DiscoveryJobArn parameter. The -PassThru parameter is deprecated, use -Select '^DiscoveryJobArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNDiscoveryJobListCmdlet"> <summary> Provides a list of the existing discovery jobs in the Amazon Web Services Region and Amazon Web Services account where you're using DataSync Discovery.<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.DSYN.GetDSYNDiscoveryJobListCmdlet.StorageSystemArn"> <summary> <para> <para>Specifies the Amazon Resource Name (ARN) of an on-premises storage system. Use this parameter if you only want to list the discovery jobs that are associated with a specific storage system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNDiscoveryJobListCmdlet.MaxResult"> <summary> <para> <para>Specifies how many results you want in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNDiscoveryJobListCmdlet.NextToken"> <summary> <para> <para>Specifies an opaque string that indicates the position to begin the next list of results in the response.</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 '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNDiscoveryJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DiscoveryJobs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DataSync.Model.ListDiscoveryJobsResponse). Specifying the name of a property of type Amazon.DataSync.Model.ListDiscoveryJobsResponse 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.DSYN.GetDSYNDiscoveryJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StorageSystemArn parameter. The -PassThru parameter is deprecated, use -Select '^StorageSystemArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNDiscoveryJobListCmdlet.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 NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationEfsCmdlet"> <summary> Returns metadata about your DataSync location for an Amazon EFS file system. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationEfsCmdlet.LocationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon EFS file system location that you want information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationEfsCmdlet.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.DataSync.Model.DescribeLocationEfsResponse). Specifying the name of a property of type Amazon.DataSync.Model.DescribeLocationEfsResponse 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.DSYN.GetDSYNLocationEfsCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LocationArn parameter. The -PassThru parameter is deprecated, use -Select '^LocationArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationFsxLustreCmdlet"> <summary> Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationFsxLustreCmdlet.LocationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the FSx for Lustre location to describe. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationFsxLustreCmdlet.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.DataSync.Model.DescribeLocationFsxLustreResponse). Specifying the name of a property of type Amazon.DataSync.Model.DescribeLocationFsxLustreResponse 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.DSYN.GetDSYNLocationFsxLustreCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LocationArn parameter. The -PassThru parameter is deprecated, use -Select '^LocationArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationFsxOntapCmdlet"> <summary> Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured. <note><para> If your location uses SMB, the <code>DescribeLocationFsxOntap</code> operation doesn't actually return a <code>Password</code>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationFsxOntapCmdlet.LocationArn"> <summary> <para> <para>Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP file system location that you want information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationFsxOntapCmdlet.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.DataSync.Model.DescribeLocationFsxOntapResponse). Specifying the name of a property of type Amazon.DataSync.Model.DescribeLocationFsxOntapResponse 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.DSYN.GetDSYNLocationFsxOntapCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LocationArn parameter. The -PassThru parameter is deprecated, use -Select '^LocationArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationFsxOpenZfCmdlet"> <summary> Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured. <note><para> Response elements related to <code>SMB</code> aren't supported with the <code>DescribeLocationFsxOpenZfs</code> operation. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationFsxOpenZfCmdlet.LocationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the FSx for OpenZFS location to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationFsxOpenZfCmdlet.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.DataSync.Model.DescribeLocationFsxOpenZfsResponse). Specifying the name of a property of type Amazon.DataSync.Model.DescribeLocationFsxOpenZfsResponse 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.DSYN.GetDSYNLocationFsxOpenZfCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LocationArn parameter. The -PassThru parameter is deprecated, use -Select '^LocationArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationFsxWindowCmdlet"> <summary> Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationFsxWindowCmdlet.LocationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the FSx for Windows File Server location to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationFsxWindowCmdlet.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.DataSync.Model.DescribeLocationFsxWindowsResponse). Specifying the name of a property of type Amazon.DataSync.Model.DescribeLocationFsxWindowsResponse 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.DSYN.GetDSYNLocationFsxWindowCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LocationArn parameter. The -PassThru parameter is deprecated, use -Select '^LocationArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationHdfCmdlet"> <summary> Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationHdfCmdlet.LocationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the HDFS cluster location to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationHdfCmdlet.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.DataSync.Model.DescribeLocationHdfsResponse). Specifying the name of a property of type Amazon.DataSync.Model.DescribeLocationHdfsResponse 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.DSYN.GetDSYNLocationHdfCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LocationArn parameter. The -PassThru parameter is deprecated, use -Select '^LocationArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationListCmdlet"> <summary> Returns a list of source and destination locations. <para> If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations. </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.DSYN.GetDSYNLocationListCmdlet.Filter"> <summary> <para> <para>You can use API filters to narrow down the list of resources returned by <code>ListLocations</code>. For example, to retrieve all tasks on a specific source location, you can use <code>ListLocations</code> with filter name <code>LocationType S3</code> and <code>Operator Equals</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of locations to return.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationListCmdlet.NextToken"> <summary> <para> <para>An opaque string that indicates the position at which to begin the next list of locations.</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 '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Locations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DataSync.Model.ListLocationsResponse). Specifying the name of a property of type Amazon.DataSync.Model.ListLocationsResponse 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.DSYN.GetDSYNLocationListCmdlet.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 NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationNfsCmdlet"> <summary> Returns metadata, such as the path information, about an NFS location. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationNfsCmdlet.LocationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the NFS location to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationNfsCmdlet.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.DataSync.Model.DescribeLocationNfsResponse). Specifying the name of a property of type Amazon.DataSync.Model.DescribeLocationNfsResponse 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.DSYN.GetDSYNLocationNfsCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LocationArn parameter. The -PassThru parameter is deprecated, use -Select '^LocationArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationObjectStorageCmdlet"> <summary> Returns metadata about your DataSync location for an object storage system. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationObjectStorageCmdlet.LocationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the object storage system location that you want information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationObjectStorageCmdlet.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.DataSync.Model.DescribeLocationObjectStorageResponse). Specifying the name of a property of type Amazon.DataSync.Model.DescribeLocationObjectStorageResponse 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.DSYN.GetDSYNLocationObjectStorageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LocationArn parameter. The -PassThru parameter is deprecated, use -Select '^LocationArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationS3Cmdlet"> <summary> Returns metadata, such as bucket name, about an Amazon S3 bucket location. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationS3Cmdlet.LocationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon S3 bucket location to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationS3Cmdlet.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.DataSync.Model.DescribeLocationS3Response). Specifying the name of a property of type Amazon.DataSync.Model.DescribeLocationS3Response 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.DSYN.GetDSYNLocationS3Cmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LocationArn parameter. The -PassThru parameter is deprecated, use -Select '^LocationArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationSmbCmdlet"> <summary> Returns metadata, such as the path and user information about an SMB location. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationSmbCmdlet.LocationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the SMB location to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNLocationSmbCmdlet.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.DataSync.Model.DescribeLocationSmbResponse). Specifying the name of a property of type Amazon.DataSync.Model.DescribeLocationSmbResponse 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.DSYN.GetDSYNLocationSmbCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LocationArn parameter. The -PassThru parameter is deprecated, use -Select '^LocationArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNResourceTagListCmdlet"> <summary> Returns all the tags associated with an Amazon Web Services resource.<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.DSYN.GetDSYNResourceTagListCmdlet.ResourceArn"> <summary> <para> <para>Specifies the Amazon Resource Name (ARN) of the resource that you want tag information on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNResourceTagListCmdlet.MaxResult"> <summary> <para> <para>Specifies how many results that you want in the response.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNResourceTagListCmdlet.NextToken"> <summary> <para> <para>Specifies an opaque string that indicates the position to begin the next list of results in the response.</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 '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNResourceTagListCmdlet.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.DataSync.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.DataSync.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.DSYN.GetDSYNResourceTagListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNResourceTagListCmdlet.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 NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNStorageSystemCmdlet"> <summary> Returns information about an on-premises storage system that you're using with DataSync Discovery. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNStorageSystemCmdlet.StorageSystemArn"> <summary> <para> <para>Specifies the Amazon Resource Name (ARN) of an on-premises storage system that you're using with DataSync Discovery.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNStorageSystemCmdlet.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.DataSync.Model.DescribeStorageSystemResponse). Specifying the name of a property of type Amazon.DataSync.Model.DescribeStorageSystemResponse 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.DSYN.GetDSYNStorageSystemCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StorageSystemArn parameter. The -PassThru parameter is deprecated, use -Select '^StorageSystemArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNStorageSystemListCmdlet"> <summary> Lists the on-premises storage systems that you're using with DataSync Discovery.<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.DSYN.GetDSYNStorageSystemListCmdlet.MaxResult"> <summary> <para> <para>Specifies how many results you want in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNStorageSystemListCmdlet.NextToken"> <summary> <para> <para>Specifies an opaque string that indicates the position to begin the next list of results in the response. </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 '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNStorageSystemListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StorageSystems'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DataSync.Model.ListStorageSystemsResponse). Specifying the name of a property of type Amazon.DataSync.Model.ListStorageSystemsResponse 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.DSYN.GetDSYNStorageSystemListCmdlet.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 NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNStorageSystemResourceCmdlet"> <summary> Returns information that DataSync Discovery collects about resources in your on-premises storage system.<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.DSYN.GetDSYNStorageSystemResourceCmdlet.DiscoveryJobArn"> <summary> <para> <para>Specifies the Amazon Resource Name (ARN) of the discovery job that's collecting data from your on-premises storage system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNStorageSystemResourceCmdlet.Filter"> <summary> <para> <para>Filters the storage system resources that you want returned. For example, this might be volumes associated with a specific storage virtual machine (SVM).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNStorageSystemResourceCmdlet.ResourceId"> <summary> <para> <para>Specifies the universally unique identifiers (UUIDs) of the storage system resources that you want information about. You can't use this parameter in combination with the <code>Filter</code> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNStorageSystemResourceCmdlet.ResourceType"> <summary> <para> <para>Specifies what kind of storage system resources that you want information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNStorageSystemResourceCmdlet.MaxResult"> <summary> <para> <para>Specifies the maximum number of storage system resources that you want to list in a response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNStorageSystemResourceCmdlet.NextToken"> <summary> <para> <para>Specifies an opaque string that indicates the position to begin the next list of results in the response.</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 '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNStorageSystemResourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourceDetails'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DataSync.Model.DescribeStorageSystemResourcesResponse). Specifying the name of a property of type Amazon.DataSync.Model.DescribeStorageSystemResourcesResponse 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.DSYN.GetDSYNStorageSystemResourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DiscoveryJobArn parameter. The -PassThru parameter is deprecated, use -Select '^DiscoveryJobArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNStorageSystemResourceCmdlet.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 NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNStorageSystemResourceMetricCmdlet"> <summary> Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system.<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.DSYN.GetDSYNStorageSystemResourceMetricCmdlet.DiscoveryJobArn"> <summary> <para> <para>Specifies the Amazon Resource Name (ARN) of the discovery job that collects information about your on-premises storage system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNStorageSystemResourceMetricCmdlet.EndTime"> <summary> <para> <para>Specifies a time within the total duration that the discovery job ran. To see information gathered during a certain time frame, use this parameter with <code>StartTime</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNStorageSystemResourceMetricCmdlet.ResourceId"> <summary> <para> <para>Specifies the universally unique identifier (UUID) of the storage system resource that you want information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNStorageSystemResourceMetricCmdlet.ResourceType"> <summary> <para> <para>Specifies the kind of storage system resource that you want information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNStorageSystemResourceMetricCmdlet.StartTime"> <summary> <para> <para>Specifies a time within the total duration that the discovery job ran. To see information gathered during a certain time frame, use this parameter with <code>EndTime</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNStorageSystemResourceMetricCmdlet.MaxResult"> <summary> <para> <para>Specifies how many results that you want in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNStorageSystemResourceMetricCmdlet.NextToken"> <summary> <para> <para>Specifies an opaque string that indicates the position to begin the next list of results in the response.</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 '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNStorageSystemResourceMetricCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Metrics'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DataSync.Model.DescribeStorageSystemResourceMetricsResponse). Specifying the name of a property of type Amazon.DataSync.Model.DescribeStorageSystemResourceMetricsResponse 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.DSYN.GetDSYNStorageSystemResourceMetricCmdlet.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.DSYN.GetDSYNStorageSystemResourceMetricCmdlet.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 NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNTaskCmdlet"> <summary> Returns metadata about a task. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNTaskCmdlet.TaskArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the task to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNTaskCmdlet.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.DataSync.Model.DescribeTaskResponse). Specifying the name of a property of type Amazon.DataSync.Model.DescribeTaskResponse 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.DSYN.GetDSYNTaskCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TaskArn parameter. The -PassThru parameter is deprecated, use -Select '^TaskArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNTaskExecutionCmdlet"> <summary> Returns detailed metadata about a task that is being executed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNTaskExecutionCmdlet.TaskExecutionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the task that is being executed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNTaskExecutionCmdlet.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.DataSync.Model.DescribeTaskExecutionResponse). Specifying the name of a property of type Amazon.DataSync.Model.DescribeTaskExecutionResponse 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.DSYN.GetDSYNTaskExecutionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TaskExecutionArn parameter. The -PassThru parameter is deprecated, use -Select '^TaskExecutionArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNTaskExecutionListCmdlet"> <summary> Returns a list of executed tasks.<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.DSYN.GetDSYNTaskExecutionListCmdlet.TaskArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the task whose tasks you want to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNTaskExecutionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of executed tasks to list.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNTaskExecutionListCmdlet.NextToken"> <summary> <para> <para>An opaque string that indicates the position at which to begin the next list of the executed tasks.</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 '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNTaskExecutionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TaskExecutions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DataSync.Model.ListTaskExecutionsResponse). Specifying the name of a property of type Amazon.DataSync.Model.ListTaskExecutionsResponse 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.DSYN.GetDSYNTaskExecutionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TaskArn parameter. The -PassThru parameter is deprecated, use -Select '^TaskArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNTaskExecutionListCmdlet.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 NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNTaskListCmdlet"> <summary> Returns a list of the DataSync tasks you created.<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.DSYN.GetDSYNTaskListCmdlet.Filter"> <summary> <para> <para>You can use API filters to narrow down the list of resources returned by <code>ListTasks</code>. For example, to retrieve all tasks on a specific source location, you can use <code>ListTasks</code> with filter name <code>LocationId</code> and <code>Operator Equals</code> with the ARN for the location.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNTaskListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of tasks to return.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNTaskListCmdlet.NextToken"> <summary> <para> <para>An opaque string that indicates the position at which to begin the next list of tasks.</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 '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.GetDSYNTaskListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tasks'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DataSync.Model.ListTasksResponse). Specifying the name of a property of type Amazon.DataSync.Model.ListTasksResponse 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.DSYN.GetDSYNTaskListCmdlet.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 NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNAgentCmdlet"> <summary> Activates an DataSync agent that you've deployed in your storage environment. The activation process associates the agent with your Amazon Web Services account. <para> If you haven't deployed an agent yet, see the following topics to learn more: </para><ul><li><para><a href="https://docs.aws.amazon.com/datasync/latest/userguide/agent-requirements.html">Agent requirements</a></para></li><li><para><a href="https://docs.aws.amazon.com/datasync/latest/userguide/configure-agent.html">Create an agent</a></para></li></ul><note><para> If you're transferring between Amazon Web Services storage services, you don't need a DataSync agent. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNAgentCmdlet.ActivationKey"> <summary> <para> <para>Specifies your DataSync agent's activation key. If you don't have an activation key, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html">Activate your agent</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNAgentCmdlet.AgentName"> <summary> <para> <para>Specifies a name for your agent. You can see this name in the DataSync console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNAgentCmdlet.SecurityGroupArn"> <summary> <para> <para>Specifies the Amazon Resource Name (ARN) of the security group that protects your task's <a href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces">network interfaces</a> when <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc">using a virtual private cloud (VPC) endpoint</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNAgentCmdlet.SubnetArn"> <summary> <para> <para>Specifies the ARN of the subnet where you want to run your DataSync task when using a VPC endpoint. This is the subnet where DataSync creates and manages the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces">network interfaces</a> for your transfer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNAgentCmdlet.Tag"> <summary> <para> <para>Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least one tag for your agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNAgentCmdlet.VpcEndpointId"> <summary> <para> <para>Specifies the ID of the VPC endpoint that you want your agent to connect to. For example, a VPC endpoint ID looks like <code>vpce-01234d5aff67890e1</code>.</para><important><para>The VPC endpoint you use must include the DataSync service name (for example, <code>com.amazonaws.us-east-2.datasync</code>).</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNAgentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AgentArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DataSync.Model.CreateAgentResponse). Specifying the name of a property of type Amazon.DataSync.Model.CreateAgentResponse 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.DSYN.NewDSYNAgentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ActivationKey parameter. The -PassThru parameter is deprecated, use -Select '^ActivationKey' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNAgentCmdlet.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.DSYN.NewDSYNLocationEfsCmdlet"> <summary> Creates an endpoint for an Amazon EFS file system that DataSync can access for a transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html">Creating a location for Amazon EFS</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationEfsCmdlet.AccessPointArn"> <summary> <para> <para>Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to access the Amazon EFS file system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationEfsCmdlet.EfsFilesystemArn"> <summary> <para> <para>Specifies the ARN for the Amazon EFS file system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationEfsCmdlet.FileSystemAccessRoleArn"> <summary> <para> <para>Specifies an Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationEfsCmdlet.InTransitEncryption"> <summary> <para> <para>Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it copies data to or from the Amazon EFS file system.</para><para>If you specify an access point using <code>AccessPointArn</code> or an IAM role using <code>FileSystemAccessRoleArn</code>, you must set this parameter to <code>TLS1_2</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationEfsCmdlet.Ec2Config_SecurityGroupArn"> <summary> <para> <para>Specifies the Amazon Resource Names (ARNs) of the security groups associated with an Amazon EFS file system's mount target.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationEfsCmdlet.Subdirectory"> <summary> <para> <para>Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data (depending on if this is a source or destination location). By default, DataSync uses the root directory, but you can also include subdirectories.</para><note><para>You must specify a value with forward slashes (for example, <code>/path/to/folder</code>).</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationEfsCmdlet.Ec2Config_SubnetArn"> <summary> <para> <para>Specifies the ARN of a subnet where DataSync creates the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces">network interfaces</a> for managing traffic during your transfer.</para><para>The subnet must be located:</para><ul><li><para>In the same virtual private cloud (VPC) as the Amazon EFS file system.</para></li><li><para>In the same Availability Zone as at least one mount target for the Amazon EFS file system.</para></li></ul><note><para>You don't need to specify a subnet that includes a file system mount target.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationEfsCmdlet.Tag"> <summary> <para> <para>Specifies the key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationEfsCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LocationArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DataSync.Model.CreateLocationEfsResponse). Specifying the name of a property of type Amazon.DataSync.Model.CreateLocationEfsResponse 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.DSYN.NewDSYNLocationEfsCmdlet.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.DSYN.NewDSYNLocationFsxLustreCmdlet"> <summary> Creates an endpoint for an Amazon FSx for Lustre file system. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxLustreCmdlet.FsxFilesystemArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the FSx for Lustre file system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxLustreCmdlet.SecurityGroupArn"> <summary> <para> <para>The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Lustre file system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxLustreCmdlet.Subdirectory"> <summary> <para> <para>A subdirectory in the location's path. This subdirectory in the FSx for Lustre file system is used to read data from the FSx for Lustre source location or write data to the FSx for Lustre destination.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxLustreCmdlet.Tag"> <summary> <para> <para>The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxLustreCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LocationArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DataSync.Model.CreateLocationFsxLustreResponse). Specifying the name of a property of type Amazon.DataSync.Model.CreateLocationFsxLustreResponse 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.DSYN.NewDSYNLocationFsxLustreCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FsxFilesystemArn parameter. The -PassThru parameter is deprecated, use -Select '^FsxFilesystemArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxLustreCmdlet.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.DSYN.NewDSYNLocationFsxOntapCmdlet"> <summary> Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can access for a transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html">Creating a location for FSx for ONTAP</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxOntapCmdlet.SMB_Domain"> <summary> <para> <para>Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxOntapCmdlet.SMB_Password"> <summary> <para> <para>Specifies the password of a user who has permission to access your SVM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxOntapCmdlet.SecurityGroupArn"> <summary> <para> <para>Specifies the Amazon EC2 security groups that provide access to your file system's preferred subnet.</para><para>The security groups must allow outbound traffic on the following ports (depending on the protocol you use):</para><ul><li><para><b>Network File System (NFS)</b>: TCP ports 111, 635, and 2049</para></li><li><para><b>Server Message Block (SMB)</b>: TCP port 445</para></li></ul><para>Your file system's security groups must also allow inbound traffic on the same ports.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxOntapCmdlet.StorageVirtualMachineArn"> <summary> <para> <para>Specifies the ARN of the storage virtual machine (SVM) in your file system where you want to copy data to or from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxOntapCmdlet.Subdirectory"> <summary> <para> <para>Specifies a path to the file share in the SVM where you'll copy your data.</para><para>You can specify a junction path (also known as a mount point), qtree path (for NFS file shares), or share name (for SMB file shares). For example, your mount path might be <code>/vol1</code>, <code>/vol1/tree1</code>, or <code>/share1</code>.</para><note><para>Don't specify a junction path in the SVM's root volume. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html">Managing FSx for ONTAP storage virtual machines</a> in the <i>Amazon FSx for NetApp ONTAP User Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxOntapCmdlet.Tag"> <summary> <para> <para>Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxOntapCmdlet.SMB_User"> <summary> <para> <para>Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM.</para><para>If you provide a user in your Active Directory, note the following:</para><ul><li><para>If you're using Directory Service for Microsoft Active Directory, the user must be a member of the Amazon Web Services Delegated FSx Administrators group.</para></li><li><para>If you're using a self-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system.</para></li></ul><para>Make sure that the user has the permissions it needs to copy the data you want:</para><ul><li><para><code>SE_TCB_NAME</code>: Required to set object ownership and file metadata. With this privilege, you also can copy NTFS discretionary access lists (DACLs).</para></li><li><para><code>SE_SECURITY_NAME</code>: May be needed to copy NTFS system access control lists (SACLs). This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group. If you configure your task to copy SACLs, make sure that the user has the required privileges. For information about copying SACLs, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html#configure-ownership-and-permissions">Ownership and permissions-related options</a>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxOntapCmdlet.Protocol_NFS_MountOptions_Version"> <summary> <para> <para>Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails.</para><para>You can specify the following options:</para><ul><li><para><code>AUTOMATIC</code> (default): DataSync chooses NFS version 4.1.</para></li><li><para><code>NFS3</code>: Stateless protocol version that allows for asynchronous writes on the server.</para></li><li><para><code>NFSv4_0</code>: Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.</para></li><li><para><code>NFSv4_1</code>: Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0.</para></li></ul><note><para>DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxOntapCmdlet.Protocol_SMB_MountOptions_Version"> <summary> <para> <para>By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically.</para><para>These are the following options for configuring the SMB version:</para><ul><li><para><code>AUTOMATIC</code> (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1.</para><para>This is the recommended option. If you instead choose a specific version that your file server doesn't support, you may get an <code>Operation Not Supported</code> error.</para></li><li><para><code>SMB3</code>: Restricts the protocol negotiation to only SMB version 3.0.2.</para></li><li><para><code>SMB2</code>: Restricts the protocol negotiation to only SMB version 2.1.</para></li><li><para><code>SMB2_0</code>: Restricts the protocol negotiation to only SMB version 2.0.</para></li><li><para><code>SMB1</code>: Restricts the protocol negotiation to only SMB version 1.0.</para><note><para>The <code>SMB1</code> option isn't available when <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateLocationFsxOntap.html">creating an Amazon FSx for NetApp ONTAP location</a>.</para></note></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxOntapCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LocationArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DataSync.Model.CreateLocationFsxOntapResponse). Specifying the name of a property of type Amazon.DataSync.Model.CreateLocationFsxOntapResponse 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.DSYN.NewDSYNLocationFsxOntapCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StorageVirtualMachineArn parameter. The -PassThru parameter is deprecated, use -Select '^StorageVirtualMachineArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxOntapCmdlet.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.DSYN.NewDSYNLocationFsxOpenZfCmdlet"> <summary> Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync can access for a transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-openzfs-location.html">Creating a location for FSx for OpenZFS</a>. <note><para> Request parameters related to <code>SMB</code> aren't supported with the <code>CreateLocationFsxOpenZfs</code> operation. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxOpenZfCmdlet.SMB_Domain"> <summary> <para> <para>Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxOpenZfCmdlet.FsxFilesystemArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the FSx for OpenZFS file system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxOpenZfCmdlet.SMB_Password"> <summary> <para> <para>Specifies the password of a user who has permission to access your SVM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxOpenZfCmdlet.SecurityGroupArn"> <summary> <para> <para>The ARNs of the security groups that are used to configure the FSx for OpenZFS file system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxOpenZfCmdlet.Subdirectory"> <summary> <para> <para>A subdirectory in the location's path that must begin with <code>/fsx</code>. DataSync uses this subdirectory to read or write data (depending on whether the file system is a source or destination location).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxOpenZfCmdlet.Tag"> <summary> <para> <para>The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxOpenZfCmdlet.SMB_User"> <summary> <para> <para>Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM.</para><para>If you provide a user in your Active Directory, note the following:</para><ul><li><para>If you're using Directory Service for Microsoft Active Directory, the user must be a member of the Amazon Web Services Delegated FSx Administrators group.</para></li><li><para>If you're using a self-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system.</para></li></ul><para>Make sure that the user has the permissions it needs to copy the data you want:</para><ul><li><para><code>SE_TCB_NAME</code>: Required to set object ownership and file metadata. With this privilege, you also can copy NTFS discretionary access lists (DACLs).</para></li><li><para><code>SE_SECURITY_NAME</code>: May be needed to copy NTFS system access control lists (SACLs). This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group. If you configure your task to copy SACLs, make sure that the user has the required privileges. For information about copying SACLs, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html#configure-ownership-and-permissions">Ownership and permissions-related options</a>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxOpenZfCmdlet.MountOptions_Version"> <summary> <para> <para>Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails.</para><para>You can specify the following options:</para><ul><li><para><code>AUTOMATIC</code> (default): DataSync chooses NFS version 4.1.</para></li><li><para><code>NFS3</code>: Stateless protocol version that allows for asynchronous writes on the server.</para></li><li><para><code>NFSv4_0</code>: Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.</para></li><li><para><code>NFSv4_1</code>: Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0.</para></li></ul><note><para>DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxOpenZfCmdlet.Protocol_SMB_MountOptions_Version"> <summary> <para> <para>By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically.</para><para>These are the following options for configuring the SMB version:</para><ul><li><para><code>AUTOMATIC</code> (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1.</para><para>This is the recommended option. If you instead choose a specific version that your file server doesn't support, you may get an <code>Operation Not Supported</code> error.</para></li><li><para><code>SMB3</code>: Restricts the protocol negotiation to only SMB version 3.0.2.</para></li><li><para><code>SMB2</code>: Restricts the protocol negotiation to only SMB version 2.1.</para></li><li><para><code>SMB2_0</code>: Restricts the protocol negotiation to only SMB version 2.0.</para></li><li><para><code>SMB1</code>: Restricts the protocol negotiation to only SMB version 1.0.</para><note><para>The <code>SMB1</code> option isn't available when <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateLocationFsxOntap.html">creating an Amazon FSx for NetApp ONTAP location</a>.</para></note></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxOpenZfCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LocationArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DataSync.Model.CreateLocationFsxOpenZfsResponse). Specifying the name of a property of type Amazon.DataSync.Model.CreateLocationFsxOpenZfsResponse 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.DSYN.NewDSYNLocationFsxOpenZfCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FsxFilesystemArn parameter. The -PassThru parameter is deprecated, use -Select '^FsxFilesystemArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxOpenZfCmdlet.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.DSYN.NewDSYNLocationFsxWindowCmdlet"> <summary> Creates an endpoint for an Amazon FSx for Windows File Server file system. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxWindowCmdlet.Domain"> <summary> <para> <para>Specifies the name of the Windows domain that the FSx for Windows File Server belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxWindowCmdlet.FsxFilesystemArn"> <summary> <para> <para>Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxWindowCmdlet.Password"> <summary> <para> <para>Specifies the password of the user who has the permissions to access files and folders in the file system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxWindowCmdlet.SecurityGroupArn"> <summary> <para> <para>Specifies the ARNs of the security groups that provide access to your file system's preferred subnet.</para><note><para>If you choose a security group that doesn't allow connections from within itself, do one of the following:</para><ul><li><para>Configure the security group to allow it to communicate within itself.</para></li><li><para>Choose a different security group that can communicate with the mount target's security group.</para></li></ul></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxWindowCmdlet.Subdirectory"> <summary> <para> <para>Specifies a mount path for your file system using forward slashes. This is where DataSync reads or writes data (depending on if this is a source or destination location).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxWindowCmdlet.Tag"> <summary> <para> <para>Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxWindowCmdlet.User"> <summary> <para> <para>Specifies the user who has the permissions to access files, folders, and metadata in your file system.</para><para>For information about choosing a user with sufficient permissions, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions">Required permissions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxWindowCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LocationArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DataSync.Model.CreateLocationFsxWindowsResponse). Specifying the name of a property of type Amazon.DataSync.Model.CreateLocationFsxWindowsResponse 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.DSYN.NewDSYNLocationFsxWindowCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FsxFilesystemArn parameter. The -PassThru parameter is deprecated, use -Select '^FsxFilesystemArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationFsxWindowCmdlet.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.DSYN.NewDSYNLocationHdfCmdlet"> <summary> Creates an endpoint for a Hadoop Distributed File System (HDFS). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationHdfCmdlet.AgentArn"> <summary> <para> <para>The Amazon Resource Names (ARNs) of the agents that are used to connect to the HDFS cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationHdfCmdlet.AuthenticationType"> <summary> <para> <para>The type of authentication used to determine the identity of the user. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationHdfCmdlet.BlockSize"> <summary> <para> <para>The size of data blocks to write into the HDFS cluster. The block size must be a multiple of 512 bytes. The default block size is 128 mebibytes (MiB).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationHdfCmdlet.QopConfiguration_DataTransferProtection"> <summary> <para> <para>The data transfer protection setting configured on the HDFS cluster. This setting corresponds to your <code>dfs.data.transfer.protection</code> setting in the <code>hdfs-site.xml</code> file on your Hadoop cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationHdfCmdlet.KerberosKeytab"> <summary> <para> <para>The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. You can load the keytab from a file by providing the file's address. If you're using the CLI, it performs base64 encoding for you. Otherwise, provide the base64-encoded text. </para><note><para>If <code>KERBEROS</code> is specified for <code>AuthenticationType</code>, this parameter is required. </para></note> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationHdfCmdlet.KerberosKrb5Conf"> <summary> <para> <para>The <code>krb5.conf</code> file that contains the Kerberos configuration information. You can load the <code>krb5.conf</code> file by providing the file's address. If you're using the CLI, it performs the base64 encoding for you. Otherwise, provide the base64-encoded text. </para><note><para>If <code>KERBEROS</code> is specified for <code>AuthenticationType</code>, this parameter is required.</para></note> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationHdfCmdlet.KerberosPrincipal"> <summary> <para> <para>The Kerberos principal with access to the files and folders on the HDFS cluster. </para><note><para>If <code>KERBEROS</code> is specified for <code>AuthenticationType</code>, this parameter is required.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationHdfCmdlet.KmsKeyProviderUri"> <summary> <para> <para>The URI of the HDFS cluster's Key Management Server (KMS). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationHdfCmdlet.NameNode"> <summary> <para> <para>The NameNode that manages the HDFS namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes. You can use only one NameNode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationHdfCmdlet.ReplicationFactor"> <summary> <para> <para>The number of DataNodes to replicate the data to when writing to the HDFS cluster. By default, data is replicated to three DataNodes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationHdfCmdlet.QopConfiguration_RpcProtection"> <summary> <para> <para>The RPC protection setting configured on the HDFS cluster. This setting corresponds to your <code>hadoop.rpc.protection</code> setting in your <code>core-site.xml</code> file on your Hadoop cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationHdfCmdlet.SimpleUser"> <summary> <para> <para>The user name used to identify the client on the host operating system. </para><note><para>If <code>SIMPLE</code> is specified for <code>AuthenticationType</code>, this parameter is required. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationHdfCmdlet.Subdirectory"> <summary> <para> <para>A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster. If the subdirectory isn't specified, it will default to <code>/</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationHdfCmdlet.Tag"> <summary> <para> <para>The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationHdfCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LocationArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DataSync.Model.CreateLocationHdfsResponse). Specifying the name of a property of type Amazon.DataSync.Model.CreateLocationHdfsResponse 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.DSYN.NewDSYNLocationHdfCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AuthenticationType parameter. The -PassThru parameter is deprecated, use -Select '^AuthenticationType' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationHdfCmdlet.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.DSYN.NewDSYNLocationNfsCmdlet"> <summary> Defines a file system on a Network File System (NFS) server that can be read from or written to. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationNfsCmdlet.OnPremConfig_AgentArn"> <summary> <para> <para>ARNs of the agents to use for an NFS location.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationNfsCmdlet.ServerHostname"> <summary> <para> <para>The name of the NFS server. This value is the IP address or Domain Name Service (DNS) name of the NFS server. An agent that is installed on-premises uses this hostname to mount the NFS server in a network. </para><para>If you are copying data to or from your Snowcone device, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone">NFS Server on Snowcone</a> for more information.</para><note><para>This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationNfsCmdlet.Subdirectory"> <summary> <para> <para>The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network. </para><para>To see all the paths exported by your NFS server, run "<code>showmount -e nfs-server-name</code>" from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication. </para><para>To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data. To ensure this, either configure the NFS export with <code>no_root_squash,</code> or ensure that the permissions for all of the files that you want DataSync allow read access for all users. Doing either enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access.</para><para>If you are copying data to or from your Snowcone device, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone">NFS Server on Snowcone</a> for more information.</para><para>For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat Enterprise Linux documentation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationNfsCmdlet.Tag"> <summary> <para> <para>The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationNfsCmdlet.MountOptions_Version"> <summary> <para> <para>Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails.</para><para>You can specify the following options:</para><ul><li><para><code>AUTOMATIC</code> (default): DataSync chooses NFS version 4.1.</para></li><li><para><code>NFS3</code>: Stateless protocol version that allows for asynchronous writes on the server.</para></li><li><para><code>NFSv4_0</code>: Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.</para></li><li><para><code>NFSv4_1</code>: Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0.</para></li></ul><note><para>DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationNfsCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LocationArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DataSync.Model.CreateLocationNfsResponse). Specifying the name of a property of type Amazon.DataSync.Model.CreateLocationNfsResponse 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.DSYN.NewDSYNLocationNfsCmdlet.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.DSYN.NewDSYNLocationObjectStorageCmdlet"> <summary> Creates an endpoint for an object storage system that DataSync can access for a transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html">Creating a location for object storage</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationObjectStorageCmdlet.BucketAccessKey"> <summary> <para> <para>Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationObjectStorageCmdlet.AgentArn"> <summary> <para> <para>Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationObjectStorageCmdlet.BucketName"> <summary> <para> <para>Specifies the name of the object storage bucket involved in the transfer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationObjectStorageCmdlet.BucketSecretKey"> <summary> <para> <para>Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationObjectStorageCmdlet.ServerCertificate"> <summary> <para> <para>Specifies a file with the certificates that are used to sign the object storage server's certificate (for example, <code>file:///home/user/.ssh/storage_sys_certificate.pem</code>). The file you specify must include the following:</para><ul><li><para>The certificate of the signing certificate authority (CA)</para></li><li><para>Any intermediate certificates</para></li><li><para>base64 encoding</para></li><li><para>A <code>.pem</code> extension</para></li></ul><para>The file can be up to 32768 bytes (before base64 encoding).</para><para>To use this parameter, configure <code>ServerProtocol</code> to <code>HTTPS</code>.</para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationObjectStorageCmdlet.ServerHostname"> <summary> <para> <para>Specifies the domain name or IP address of the object storage server. A DataSync agent uses this hostname to mount the object storage server in a network.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationObjectStorageCmdlet.ServerPort"> <summary> <para> <para>Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationObjectStorageCmdlet.ServerProtocol"> <summary> <para> <para>Specifies the protocol that your object storage server uses to communicate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationObjectStorageCmdlet.Subdirectory"> <summary> <para> <para>Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationObjectStorageCmdlet.Tag"> <summary> <para> <para>Specifies the key-value pair that represents a tag that you want to add to the resource. Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for your location.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationObjectStorageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LocationArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DataSync.Model.CreateLocationObjectStorageResponse). Specifying the name of a property of type Amazon.DataSync.Model.CreateLocationObjectStorageResponse 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.DSYN.NewDSYNLocationObjectStorageCmdlet.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.DSYN.NewDSYNLocationS3Cmdlet"> <summary> A <i>location</i> is an endpoint for an Amazon S3 bucket. DataSync can use the location as a source or destination for copying data. <important><para> Before you create your location, make sure that you read the following sections: </para><ul><li><para><a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Storage class considerations with Amazon S3 locations</a></para></li><li><para><a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests">Evaluating S3 request costs when using DataSync</a></para></li></ul></important><para> For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-locations-cli.html#create-location-s3-cli">Creating an Amazon S3 location</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationS3Cmdlet.AgentArn"> <summary> <para> <para>If you're using DataSync on an Amazon Web Services Outpost, specify the Amazon Resource Names (ARNs) of the DataSync agents deployed on your Outpost. For more information about launching a DataSync agent on an Amazon Web Services Outpost, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent">Deploy your DataSync agent on Outposts</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationS3Cmdlet.S3Config_BucketAccessRoleArn"> <summary> <para> <para>The ARN of the IAM role for accessing the S3 bucket. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationS3Cmdlet.S3BucketArn"> <summary> <para> <para>The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web Services Outpost, this must be an access point ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationS3Cmdlet.S3StorageClass"> <summary> <para> <para>The Amazon S3 storage class that you want to store your files in when this location is used as a task destination. For buckets in Amazon Web Services Regions, the storage class defaults to Standard. For buckets on Outposts, the storage class defaults to Amazon Web Services S3 Outposts.</para><para>For more information about S3 storage classes, see <a href="http://aws.amazon.com/s3/storage-classes/">Amazon S3 Storage Classes</a>. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Considerations when working with S3 storage classes in DataSync</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationS3Cmdlet.Subdirectory"> <summary> <para> <para>A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationS3Cmdlet.Tag"> <summary> <para> <para>The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationS3Cmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LocationArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DataSync.Model.CreateLocationS3Response). Specifying the name of a property of type Amazon.DataSync.Model.CreateLocationS3Response 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.DSYN.NewDSYNLocationS3Cmdlet.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.DSYN.NewDSYNLocationSmbCmdlet"> <summary> Creates an endpoint for a Server Message Block (SMB) file server that DataSync can access for a transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html">Creating an SMB location</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationSmbCmdlet.AgentArn"> <summary> <para> <para>Specifies the DataSync agent (or agents) which you want to connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationSmbCmdlet.Domain"> <summary> <para> <para>Specifies the Windows domain name that your SMB file server belongs to. </para><para>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions">required permissions</a> for SMB locations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationSmbCmdlet.Password"> <summary> <para> <para>Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer.</para><para>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions">required permissions</a> for SMB locations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationSmbCmdlet.ServerHostname"> <summary> <para> <para>Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will mount.</para><note><para>You can't specify an IP version 6 (IPv6) address.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationSmbCmdlet.Subdirectory"> <summary> <para> <para>Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can include a subdirectory in the share path (for example, <code>/path/to/subdirectory</code>). Make sure that other SMB clients in your network can also mount this path.</para><para>To copy all data in the specified subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions">required permissions</a> for SMB locations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationSmbCmdlet.Tag"> <summary> <para> <para>Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationSmbCmdlet.User"> <summary> <para> <para>Specifies the user name that can mount your SMB file server and has permission to access the files and folders involved in your transfer.</para><para>For information about choosing a user with the right level of access for your transfer, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions">required permissions</a> for SMB locations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationSmbCmdlet.MountOptions_Version"> <summary> <para> <para>By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically.</para><para>These are the following options for configuring the SMB version:</para><ul><li><para><code>AUTOMATIC</code> (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1.</para><para>This is the recommended option. If you instead choose a specific version that your file server doesn't support, you may get an <code>Operation Not Supported</code> error.</para></li><li><para><code>SMB3</code>: Restricts the protocol negotiation to only SMB version 3.0.2.</para></li><li><para><code>SMB2</code>: Restricts the protocol negotiation to only SMB version 2.1.</para></li><li><para><code>SMB2_0</code>: Restricts the protocol negotiation to only SMB version 2.0.</para></li><li><para><code>SMB1</code>: Restricts the protocol negotiation to only SMB version 1.0.</para><note><para>The <code>SMB1</code> option isn't available when <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateLocationFsxOntap.html">creating an Amazon FSx for NetApp ONTAP location</a>.</para></note></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationSmbCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LocationArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DataSync.Model.CreateLocationSmbResponse). Specifying the name of a property of type Amazon.DataSync.Model.CreateLocationSmbResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationSmbCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServerHostname parameter. The -PassThru parameter is deprecated, use -Select '^ServerHostname' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNLocationSmbCmdlet.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.DSYN.NewDSYNRecommendationCmdlet"> <summary> Creates recommendations about where to migrate your data to in Amazon Web Services. Recommendations are generated based on information that DataSync Discovery collects about your on-premises storage system's resources. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html">Recommendations provided by DataSync Discovery</a>. <para> Once generated, you can view your recommendations by using the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeStorageSystemResources.html">DescribeStorageSystemResources</a> operation. </para><note><para> If your <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#discovery-job-statuses-table">discovery job completes successfully</a>, you don't need to use this operation. DataSync Discovery generates the recommendations for you automatically. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNRecommendationCmdlet.DiscoveryJobArn"> <summary> <para> <para>Specifies the Amazon Resource Name (ARN) of the discovery job that collects information about your on-premises storage system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNRecommendationCmdlet.ResourceId"> <summary> <para> <para>Specifies the universally unique identifiers (UUIDs) of the resources in your storage system that you want recommendations on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNRecommendationCmdlet.ResourceType"> <summary> <para> <para>Specifies the type of resource in your storage system that you want recommendations on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNRecommendationCmdlet.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.DataSync.Model.GenerateRecommendationsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNRecommendationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DiscoveryJobArn parameter. The -PassThru parameter is deprecated, use -Select '^DiscoveryJobArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNRecommendationCmdlet.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.DSYN.NewDSYNTaskCmdlet"> <summary> Configures a task, which defines where and how DataSync transfers your data. <para> A task includes a source location, a destination location, and the preferences for how and when you want to transfer your data (such as bandwidth limits, scheduling, among other options). </para><important><para> If you're planning to transfer data to or from an Amazon S3 location, review <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests">how DataSync can affect your S3 request charges</a> and the <a href="http://aws.amazon.com/datasync/pricing/">DataSync pricing page</a> before you begin. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNTaskCmdlet.CloudWatchLogGroupArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNTaskCmdlet.DestinationLocationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNTaskCmdlet.Exclude"> <summary> <para> <para>Specifies a list of filter rules that exclude specific data during your transfer. For more information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNTaskCmdlet.Include"> <summary> <para> <para>Specifies a list of filter rules that include specific data during your transfer. For more information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNTaskCmdlet.Name"> <summary> <para> <para>The name of a task. This value is a text reference that is used to identify the task in the console. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNTaskCmdlet.Option"> <summary> <para> <para>Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity.</para><para>You can also override these options before starting an individual run of a task (also known as a <i>task execution</i>). For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNTaskCmdlet.Schedule_ScheduleExpression"> <summary> <para> <para>A cron expression that specifies when DataSync initiates a scheduled transfer from a source to a destination location. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNTaskCmdlet.SourceLocationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the source location for the task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNTaskCmdlet.Tag"> <summary> <para> <para>Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task.</para><para><i>Tags</i> are key-value pairs that help you manage, filter, and search for your DataSync resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNTaskCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TaskArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DataSync.Model.CreateTaskResponse). Specifying the name of a property of type Amazon.DataSync.Model.CreateTaskResponse 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.DSYN.NewDSYNTaskCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SourceLocationArn parameter. The -PassThru parameter is deprecated, use -Select '^SourceLocationArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.NewDSYNTaskCmdlet.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.DSYN.RemoveDSYNAgentCmdlet"> <summary> Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your Amazon Web Services account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.RemoveDSYNAgentCmdlet.AgentArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the agent to delete. Use the <code>ListAgents</code> operation to return a list of agents for your account and Amazon Web Services Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.RemoveDSYNAgentCmdlet.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.DataSync.Model.DeleteAgentResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.RemoveDSYNAgentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgentArn parameter. The -PassThru parameter is deprecated, use -Select '^AgentArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.RemoveDSYNAgentCmdlet.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.DSYN.RemoveDSYNLocationCmdlet"> <summary> Deletes the configuration of a location used by DataSync. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.RemoveDSYNLocationCmdlet.LocationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the location to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.RemoveDSYNLocationCmdlet.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.DataSync.Model.DeleteLocationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.RemoveDSYNLocationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LocationArn parameter. The -PassThru parameter is deprecated, use -Select '^LocationArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.RemoveDSYNLocationCmdlet.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.DSYN.RemoveDSYNResourceTagCmdlet"> <summary> Removes tags from an Amazon Web Services resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.RemoveDSYNResourceTagCmdlet.Key"> <summary> <para> <para>Specifies the keys in the tags that you want to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.RemoveDSYNResourceTagCmdlet.ResourceArn"> <summary> <para> <para>Specifies the Amazon Resource Name (ARN) of the resource to remove the tags from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.RemoveDSYNResourceTagCmdlet.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.DataSync.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.RemoveDSYNResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.RemoveDSYNResourceTagCmdlet.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.DSYN.RemoveDSYNStorageSystemCmdlet"> <summary> Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs, collected data, and recommendations. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.RemoveDSYNStorageSystemCmdlet.StorageSystemArn"> <summary> <para> <para>Specifies the Amazon Resource Name (ARN) of the storage system that you want to permanently remove from DataSync Discovery.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.RemoveDSYNStorageSystemCmdlet.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.DataSync.Model.RemoveStorageSystemResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.RemoveDSYNStorageSystemCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StorageSystemArn parameter. The -PassThru parameter is deprecated, use -Select '^StorageSystemArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.RemoveDSYNStorageSystemCmdlet.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.DSYN.RemoveDSYNTaskCmdlet"> <summary> Deletes an DataSync task. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.RemoveDSYNTaskCmdlet.TaskArn"> <summary> <para> <para>Specifies the Amazon Resource Name (ARN) of the task that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.RemoveDSYNTaskCmdlet.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.DataSync.Model.DeleteTaskResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.RemoveDSYNTaskCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TaskArn parameter. The -PassThru parameter is deprecated, use -Select '^TaskArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.RemoveDSYNTaskCmdlet.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.DSYN.StartDSYNDiscoveryJobCmdlet"> <summary> Runs a DataSync discovery job on your on-premises storage system. If you haven't added the storage system to DataSync Discovery yet, do this first by using the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_AddStorageSystem.html">AddStorageSystem</a> operation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.StartDSYNDiscoveryJobCmdlet.CollectionDurationMinute"> <summary> <para> <para>Specifies in minutes how long you want the discovery job to run.</para><note><para>For more accurate recommendations, we recommend a duration of at least 14 days. Longer durations allow time to collect a sufficient number of data points and provide a realistic representation of storage performance and utilization.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.StartDSYNDiscoveryJobCmdlet.StorageSystemArn"> <summary> <para> <para>Specifies the Amazon Resource Name (ARN) of the on-premises storage system that you want to run the discovery job on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.StartDSYNDiscoveryJobCmdlet.Tag"> <summary> <para> <para>Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.StartDSYNDiscoveryJobCmdlet.ClientToken"> <summary> <para> <para>Specifies a client token to make sure requests with this API operation are idempotent. If you don't specify a client token, DataSync generates one for you automatically.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.StartDSYNDiscoveryJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DiscoveryJobArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DataSync.Model.StartDiscoveryJobResponse). Specifying the name of a property of type Amazon.DataSync.Model.StartDiscoveryJobResponse 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.DSYN.StartDSYNDiscoveryJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StorageSystemArn parameter. The -PassThru parameter is deprecated, use -Select '^StorageSystemArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.StartDSYNDiscoveryJobCmdlet.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.DSYN.StartDSYNTaskExecutionCmdlet"> <summary> Starts an DataSync task. For each task, you can only run one task execution at a time. <para> There are several phases to a task execution. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/working-with-task-executions.html#understand-task-execution-statuses">Task execution statuses</a>. </para><important><para> If you're planning to transfer data to or from an Amazon S3 location, review <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests">how DataSync can affect your S3 request charges</a> and the <a href="http://aws.amazon.com/datasync/pricing/">DataSync pricing page</a> before you begin. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.StartDSYNTaskExecutionCmdlet.Exclude"> <summary> <para> <para>Specifies a list of filter rules that determines which files to exclude from a task. The list contains a single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example, <code>"/folder1|/folder2"</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.StartDSYNTaskExecutionCmdlet.Include"> <summary> <para> <para>Specifies a list of filter rules that determines which files to include when running a task. The pattern should contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example, <code>"/folder1|/folder2"</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.StartDSYNTaskExecutionCmdlet.OverrideOption"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.StartDSYNTaskExecutionCmdlet.Tag"> <summary> <para> <para>Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task execution.</para><para><i>Tags</i> are key-value pairs that help you manage, filter, and search for your DataSync resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.StartDSYNTaskExecutionCmdlet.TaskArn"> <summary> <para> <para>Specifies the Amazon Resource Name (ARN) of the task that you want to start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.StartDSYNTaskExecutionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TaskExecutionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DataSync.Model.StartTaskExecutionResponse). Specifying the name of a property of type Amazon.DataSync.Model.StartTaskExecutionResponse 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.DSYN.StartDSYNTaskExecutionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TaskArn parameter. The -PassThru parameter is deprecated, use -Select '^TaskArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.StartDSYNTaskExecutionCmdlet.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.DSYN.StopDSYNDiscoveryJobCmdlet"> <summary> Stops a running DataSync discovery job. <para> You can stop a discovery job anytime. A job that's stopped before it's scheduled to end likely will provide you some information about your on-premises storage system resources. To get recommendations for a stopped job, you must use the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_GenerateRecommendations.html">GenerateRecommendations</a> operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.StopDSYNDiscoveryJobCmdlet.DiscoveryJobArn"> <summary> <para> <para>Specifies the Amazon Resource Name (ARN) of the discovery job that you want to stop. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.StopDSYNDiscoveryJobCmdlet.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.DataSync.Model.StopDiscoveryJobResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.StopDSYNDiscoveryJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DiscoveryJobArn parameter. The -PassThru parameter is deprecated, use -Select '^DiscoveryJobArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.StopDSYNDiscoveryJobCmdlet.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.DSYN.StopDSYNTaskExecutionCmdlet"> <summary> Stops an DataSync task execution that's in progress. The transfer of some files are abruptly interrupted. File contents that're transferred to the destination might be incomplete or inconsistent with the source files. <para> However, if you start a new task execution using the same task and allow it to finish, file content on the destination will be complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, DataSync successfully completes the transfer when you start the next task execution. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.StopDSYNTaskExecutionCmdlet.TaskExecutionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the task execution to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.StopDSYNTaskExecutionCmdlet.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.DataSync.Model.CancelTaskExecutionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.StopDSYNTaskExecutionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TaskExecutionArn parameter. The -PassThru parameter is deprecated, use -Select '^TaskExecutionArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.StopDSYNTaskExecutionCmdlet.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.DSYN.UpdateDSYNAgentCmdlet"> <summary> Updates the name of an agent. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNAgentCmdlet.AgentArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the agent to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNAgentCmdlet.Name"> <summary> <para> <para>The name that you want to use to configure the agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNAgentCmdlet.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.DataSync.Model.UpdateAgentResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNAgentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgentArn parameter. The -PassThru parameter is deprecated, use -Select '^AgentArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNAgentCmdlet.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.DSYN.UpdateDSYNDiscoveryJobCmdlet"> <summary> Edits a DataSync discovery job configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNDiscoveryJobCmdlet.CollectionDurationMinute"> <summary> <para> <para>Specifies in minutes how long that you want the discovery job to run. (You can't set this parameter to less than the number of minutes that the job has already run for.)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNDiscoveryJobCmdlet.DiscoveryJobArn"> <summary> <para> <para>Specifies the Amazon Resource Name (ARN) of the discovery job that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNDiscoveryJobCmdlet.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.DataSync.Model.UpdateDiscoveryJobResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNDiscoveryJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DiscoveryJobArn parameter. The -PassThru parameter is deprecated, use -Select '^DiscoveryJobArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNDiscoveryJobCmdlet.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.DSYN.UpdateDSYNLocationHdfCmdlet"> <summary> Updates some parameters of a previously created location for a Hadoop Distributed File System cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationHdfCmdlet.AgentArn"> <summary> <para> <para>The ARNs of the agents that are used to connect to the HDFS cluster. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationHdfCmdlet.AuthenticationType"> <summary> <para> <para>The type of authentication used to determine the identity of the user. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationHdfCmdlet.BlockSize"> <summary> <para> <para>The size of the data blocks to write into the HDFS cluster. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationHdfCmdlet.QopConfiguration_DataTransferProtection"> <summary> <para> <para>The data transfer protection setting configured on the HDFS cluster. This setting corresponds to your <code>dfs.data.transfer.protection</code> setting in the <code>hdfs-site.xml</code> file on your Hadoop cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationHdfCmdlet.KerberosKeytab"> <summary> <para> <para>The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. You can load the keytab from a file by providing the file's address. If you use the CLI, it performs base64 encoding for you. Otherwise, provide the base64-encoded text.</para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationHdfCmdlet.KerberosKrb5Conf"> <summary> <para> <para>The <code>krb5.conf</code> file that contains the Kerberos configuration information. You can load the <code>krb5.conf</code> file by providing the file's address. If you're using the CLI, it performs the base64 encoding for you. Otherwise, provide the base64-encoded text.</para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationHdfCmdlet.KerberosPrincipal"> <summary> <para> <para>The Kerberos principal with access to the files and folders on the HDFS cluster. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationHdfCmdlet.KmsKeyProviderUri"> <summary> <para> <para>The URI of the HDFS cluster's Key Management Server (KMS). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationHdfCmdlet.LocationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the source HDFS cluster location.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationHdfCmdlet.NameNode"> <summary> <para> <para>The NameNode that manages the HDFS namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes. You can use only one NameNode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationHdfCmdlet.ReplicationFactor"> <summary> <para> <para>The number of DataNodes to replicate the data to when writing to the HDFS cluster. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationHdfCmdlet.QopConfiguration_RpcProtection"> <summary> <para> <para>The RPC protection setting configured on the HDFS cluster. This setting corresponds to your <code>hadoop.rpc.protection</code> setting in your <code>core-site.xml</code> file on your Hadoop cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationHdfCmdlet.SimpleUser"> <summary> <para> <para>The user name used to identify the client on the host operating system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationHdfCmdlet.Subdirectory"> <summary> <para> <para>A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationHdfCmdlet.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.DataSync.Model.UpdateLocationHdfsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationHdfCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LocationArn parameter. The -PassThru parameter is deprecated, use -Select '^LocationArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationHdfCmdlet.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.DSYN.UpdateDSYNLocationNfsCmdlet"> <summary> Updates some of the parameters of a previously created location for Network File System (NFS) access. For information about creating an NFS location, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html">Creating a location for NFS</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationNfsCmdlet.OnPremConfig_AgentArn"> <summary> <para> <para>ARNs of the agents to use for an NFS location.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationNfsCmdlet.LocationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the NFS location to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationNfsCmdlet.Subdirectory"> <summary> <para> <para>The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network.</para><para>To see all the paths exported by your NFS server, run "<code>showmount -e nfs-server-name</code>" from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication. </para><para>To transfer all the data in the folder that you specified, DataSync must have permissions to read all the data. To ensure this, either configure the NFS export with <code>no_root_squash</code>, or ensure that the files you want DataSync to access have permissions that allow read access for all users. Doing either option enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access.</para><para>If you are copying data to or from your Snowcone device, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone">NFS Server on Snowcone</a> for more information.</para><para>For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat Enterprise Linux documentation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationNfsCmdlet.MountOptions_Version"> <summary> <para> <para>Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails.</para><para>You can specify the following options:</para><ul><li><para><code>AUTOMATIC</code> (default): DataSync chooses NFS version 4.1.</para></li><li><para><code>NFS3</code>: Stateless protocol version that allows for asynchronous writes on the server.</para></li><li><para><code>NFSv4_0</code>: Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.</para></li><li><para><code>NFSv4_1</code>: Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0.</para></li></ul><note><para>DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationNfsCmdlet.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.DataSync.Model.UpdateLocationNfsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationNfsCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LocationArn parameter. The -PassThru parameter is deprecated, use -Select '^LocationArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationNfsCmdlet.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.DSYN.UpdateDSYNLocationObjectStorageCmdlet"> <summary> Updates some parameters of an existing object storage location that DataSync accesses for a transfer. For information about creating a self-managed object storage location, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html">Creating a location for object storage</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationObjectStorageCmdlet.BucketAccessKey"> <summary> <para> <para>Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationObjectStorageCmdlet.AgentArn"> <summary> <para> <para>Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationObjectStorageCmdlet.LocationArn"> <summary> <para> <para>Specifies the ARN of the object storage system location that you're updating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationObjectStorageCmdlet.BucketSecretKey"> <summary> <para> <para>Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationObjectStorageCmdlet.ServerCertificate"> <summary> <para> <para>Specifies a certificate to authenticate with an object storage system that uses a private or self-signed certificate authority (CA). You must specify a Base64-encoded <code>.pem</code> file (for example, <code>file:///home/user/.ssh/storage_sys_certificate.pem</code>). The certificate can be up to 32768 bytes (before Base64 encoding).</para><para>To use this parameter, configure <code>ServerProtocol</code> to <code>HTTPS</code>.</para><para>Updating the certificate doesn't interfere with tasks that you have in progress.</para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationObjectStorageCmdlet.ServerPort"> <summary> <para> <para>Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationObjectStorageCmdlet.ServerProtocol"> <summary> <para> <para>Specifies the protocol that your object storage server uses to communicate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationObjectStorageCmdlet.Subdirectory"> <summary> <para> <para>Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationObjectStorageCmdlet.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.DataSync.Model.UpdateLocationObjectStorageResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationObjectStorageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LocationArn parameter. The -PassThru parameter is deprecated, use -Select '^LocationArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationObjectStorageCmdlet.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.DSYN.UpdateDSYNLocationSmbCmdlet"> <summary> Updates some of the parameters of a previously created location for Server Message Block (SMB) file system access. For information about creating an SMB location, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html">Creating a location for SMB</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationSmbCmdlet.AgentArn"> <summary> <para> <para>The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationSmbCmdlet.Domain"> <summary> <para> <para>The name of the Windows domain that the SMB server belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationSmbCmdlet.LocationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the SMB location to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationSmbCmdlet.Password"> <summary> <para> <para>The password of the user who can mount the share has the permissions to access files and folders in the SMB share.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationSmbCmdlet.Subdirectory"> <summary> <para> <para>The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.</para><note><para><code>Subdirectory</code> must be specified with forward slashes. For example, <code>/path/to/folder</code>.</para></note><para>To transfer all the data in the folder that you specified, DataSync must have permissions to mount the SMB share and to access all the data in that share. To ensure this, do either of the following:</para><ul><li><para>Ensure that the user/password specified belongs to the user who can mount the share and who has the appropriate permissions for all of the files and directories that you want DataSync to access.</para></li><li><para>Use credentials of a member of the Backup Operators group to mount the share. </para></li></ul><para>Doing either of these options enables the agent to access the data. For the agent to access directories, you must also enable all execute access.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationSmbCmdlet.User"> <summary> <para> <para>The user who can mount the share has the permissions to access files and folders in the SMB share.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationSmbCmdlet.MountOptions_Version"> <summary> <para> <para>By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically.</para><para>These are the following options for configuring the SMB version:</para><ul><li><para><code>AUTOMATIC</code> (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1.</para><para>This is the recommended option. If you instead choose a specific version that your file server doesn't support, you may get an <code>Operation Not Supported</code> error.</para></li><li><para><code>SMB3</code>: Restricts the protocol negotiation to only SMB version 3.0.2.</para></li><li><para><code>SMB2</code>: Restricts the protocol negotiation to only SMB version 2.1.</para></li><li><para><code>SMB2_0</code>: Restricts the protocol negotiation to only SMB version 2.0.</para></li><li><para><code>SMB1</code>: Restricts the protocol negotiation to only SMB version 1.0.</para><note><para>The <code>SMB1</code> option isn't available when <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateLocationFsxOntap.html">creating an Amazon FSx for NetApp ONTAP location</a>.</para></note></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationSmbCmdlet.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.DataSync.Model.UpdateLocationSmbResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationSmbCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LocationArn parameter. The -PassThru parameter is deprecated, use -Select '^LocationArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNLocationSmbCmdlet.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.DSYN.UpdateDSYNStorageSystemCmdlet"> <summary> Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNStorageSystemCmdlet.AgentArn"> <summary> <para> <para>Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads your on-premises storage system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNStorageSystemCmdlet.CloudWatchLogGroupArn"> <summary> <para> <para>Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging discovery job events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNStorageSystemCmdlet.Name"> <summary> <para> <para>Specifies a familiar name for your on-premises storage system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNStorageSystemCmdlet.Credentials_Password"> <summary> <para> <para>Specifies the password for your storage system's management interface.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNStorageSystemCmdlet.ServerConfiguration_ServerHostname"> <summary> <para> <para>The domain name or IP address of your storage system's management interface.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNStorageSystemCmdlet.ServerConfiguration_ServerPort"> <summary> <para> <para>The network port for accessing the storage system's management interface.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNStorageSystemCmdlet.StorageSystemArn"> <summary> <para> <para>Specifies the ARN of the on-premises storage system that you want reconfigure.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNStorageSystemCmdlet.Credentials_Username"> <summary> <para> <para>Specifies the user name for your storage system's management interface.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNStorageSystemCmdlet.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.DataSync.Model.UpdateStorageSystemResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNStorageSystemCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StorageSystemArn parameter. The -PassThru parameter is deprecated, use -Select '^StorageSystemArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNStorageSystemCmdlet.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.DSYN.UpdateDSYNTaskCmdlet"> <summary> Updates the metadata associated with a task. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNTaskCmdlet.CloudWatchLogGroupArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource name of the Amazon CloudWatch log group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNTaskCmdlet.Exclude"> <summary> <para> <para>Specifies a list of filter rules that exclude specific data during your transfer. For more information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNTaskCmdlet.Include"> <summary> <para> <para>Specifies a list of filter rules that include specific data during your transfer. For more information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNTaskCmdlet.Name"> <summary> <para> <para>The name of the task to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNTaskCmdlet.Option"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNTaskCmdlet.Schedule_ScheduleExpression"> <summary> <para> <para>A cron expression that specifies when DataSync initiates a scheduled transfer from a source to a destination location. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNTaskCmdlet.TaskArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource name of the task to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNTaskCmdlet.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.DataSync.Model.UpdateTaskResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNTaskCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TaskArn parameter. The -PassThru parameter is deprecated, use -Select '^TaskArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNTaskCmdlet.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.DSYN.UpdateDSYNTaskExecutionCmdlet"> <summary> Modifies a running DataSync task. <note><para> Currently, the only <code>Option</code> that you can modify with <code>UpdateTaskExecution</code> is <code><a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-BytesPerSecond">BytesPerSecond</a></code>, which throttles bandwidth for a running or queued task. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNTaskExecutionCmdlet.Option"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNTaskExecutionCmdlet.TaskExecutionArn"> <summary> <para> <para>Specifies the Amazon Resource Name (ARN) of the task execution that you're updating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNTaskExecutionCmdlet.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.DataSync.Model.UpdateTaskExecutionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNTaskExecutionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TaskExecutionArn parameter. The -PassThru parameter is deprecated, use -Select '^TaskExecutionArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSYN.UpdateDSYNTaskExecutionCmdlet.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> |