AWS.Tools.IoTSecureTunneling.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.IoTSecureTunneling</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.IOTST.AddIOTSTResourceTagCmdlet"> <summary> A resource tag. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.AddIOTSTResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.AddIOTSTResourceTagCmdlet.Tag"> <summary> <para> <para>The tags for the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.AddIOTSTResourceTagCmdlet.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.IoTSecureTunneling.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.AddIOTSTResourceTagCmdlet.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.IOTST.AddIOTSTResourceTagCmdlet.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.IOTST.CloseIOTSTTunnelCmdlet"> <summary> Closes a tunnel identified by the unique tunnel id. When a <code>CloseTunnel</code> request is received, we close the WebSocket connections between the client and proxy server so no data can be transmitted. <para> Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CloseTunnel</a> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.CloseIOTSTTunnelCmdlet.Delete"> <summary> <para> <para>When set to true, IoT Secure Tunneling deletes the tunnel data immediately.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.CloseIOTSTTunnelCmdlet.TunnelId"> <summary> <para> <para>The ID of the tunnel to close.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.CloseIOTSTTunnelCmdlet.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.IoTSecureTunneling.Model.CloseTunnelResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.CloseIOTSTTunnelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TunnelId parameter. The -PassThru parameter is deprecated, use -Select '^TunnelId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.CloseIOTSTTunnelCmdlet.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.IOTST.GetIOTSTResourceTagCmdlet"> <summary> Lists the tags for the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.GetIOTSTResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The resource ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.GetIOTSTResourceTagCmdlet.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.IoTSecureTunneling.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.IoTSecureTunneling.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.IOTST.GetIOTSTResourceTagCmdlet.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="T:Amazon.PowerShell.Cmdlets.IOTST.GetIOTSTTunnelCmdlet"> <summary> Gets information about a tunnel identified by the unique tunnel id. <para> Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeTunnel</a> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.GetIOTSTTunnelCmdlet.TunnelId"> <summary> <para> <para>The tunnel to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.GetIOTSTTunnelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tunnel'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSecureTunneling.Model.DescribeTunnelResponse). Specifying the name of a property of type Amazon.IoTSecureTunneling.Model.DescribeTunnelResponse 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.IOTST.GetIOTSTTunnelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TunnelId parameter. The -PassThru parameter is deprecated, use -Select '^TunnelId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOTST.GetIOTSTTunnelListCmdlet"> <summary> List all tunnels for an Amazon Web Services account. Tunnels are listed by creation time in descending order, newer tunnels will be listed before older tunnels. <para> Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListTunnels</a> action. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.GetIOTSTTunnelListCmdlet.ThingName"> <summary> <para> <para>The name of the IoT thing associated with the destination device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.GetIOTSTTunnelListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return at once.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.GetIOTSTTunnelListCmdlet.NextToken"> <summary> <para> <para>To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.</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.IOTST.GetIOTSTTunnelListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TunnelSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSecureTunneling.Model.ListTunnelsResponse). Specifying the name of a property of type Amazon.IoTSecureTunneling.Model.ListTunnelsResponse 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.IOTST.GetIOTSTTunnelListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ThingName parameter. The -PassThru parameter is deprecated, use -Select '^ThingName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.GetIOTSTTunnelListCmdlet.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.IOTST.InvokeIOTSTTunnelAccessTokenRotationCmdlet"> <summary> Revokes the current client access token (CAT) and returns new CAT for clients to use when reconnecting to secure tunneling to access the same tunnel. <para> Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">RotateTunnelAccessToken</a> action. </para><note><para> Rotating the CAT doesn't extend the tunnel duration. For example, say the tunnel duration is 12 hours and the tunnel has already been open for 4 hours. When you rotate the access tokens, the new tokens that are generated can only be used for the remaining 8 hours. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.InvokeIOTSTTunnelAccessTokenRotationCmdlet.ClientMode"> <summary> <para> <para>The mode of the client that will use the client token, which can be either the source or destination, or both source and destination.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.InvokeIOTSTTunnelAccessTokenRotationCmdlet.DestinationConfig_Service"> <summary> <para> <para>A list of service names that identify the target application. The IoT client running on the destination device reads this value and uses it to look up a port or an IP address and a port. The IoT client instantiates the local proxy, which uses this information to connect to the destination application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.InvokeIOTSTTunnelAccessTokenRotationCmdlet.DestinationConfig_ThingName"> <summary> <para> <para>The name of the IoT thing to which you want to connect.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.InvokeIOTSTTunnelAccessTokenRotationCmdlet.TunnelId"> <summary> <para> <para>The tunnel for which you want to rotate the access tokens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.InvokeIOTSTTunnelAccessTokenRotationCmdlet.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.IoTSecureTunneling.Model.RotateTunnelAccessTokenResponse). Specifying the name of a property of type Amazon.IoTSecureTunneling.Model.RotateTunnelAccessTokenResponse 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.IOTST.InvokeIOTSTTunnelAccessTokenRotationCmdlet.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.IOTST.OpenIOTSTTunnelCmdlet"> <summary> Creates a new tunnel, and returns two client access tokens for clients to use to connect to the IoT Secure Tunneling proxy server. <para> Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">OpenTunnel</a> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.OpenIOTSTTunnelCmdlet.Description"> <summary> <para> <para>A short text description of the tunnel. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.OpenIOTSTTunnelCmdlet.TimeoutConfig_MaxLifetimeTimeoutMinute"> <summary> <para> <para>The maximum amount of time (in minutes) a tunnel can remain open. If not specified, maxLifetimeTimeoutMinutes defaults to 720 minutes. Valid values are from 1 minute to 12 hours (720 minutes) </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.OpenIOTSTTunnelCmdlet.DestinationConfig_Service"> <summary> <para> <para>A list of service names that identify the target application. The IoT client running on the destination device reads this value and uses it to look up a port or an IP address and a port. The IoT client instantiates the local proxy, which uses this information to connect to the destination application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.OpenIOTSTTunnelCmdlet.Tag"> <summary> <para> <para>A collection of tag metadata.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.OpenIOTSTTunnelCmdlet.DestinationConfig_ThingName"> <summary> <para> <para>The name of the IoT thing to which you want to connect.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.OpenIOTSTTunnelCmdlet.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.IoTSecureTunneling.Model.OpenTunnelResponse). Specifying the name of a property of type Amazon.IoTSecureTunneling.Model.OpenTunnelResponse 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.IOTST.OpenIOTSTTunnelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DestinationConfig_ThingName parameter. The -PassThru parameter is deprecated, use -Select '^DestinationConfig_ThingName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.OpenIOTSTTunnelCmdlet.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.IOTST.RemoveIOTSTResourceTagCmdlet"> <summary> Removes a tag from a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.RemoveIOTSTResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The resource ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.RemoveIOTSTResourceTagCmdlet.TagKey"> <summary> <para> <para>The keys of the tags to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.RemoveIOTSTResourceTagCmdlet.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.IoTSecureTunneling.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOTST.RemoveIOTSTResourceTagCmdlet.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.IOTST.RemoveIOTSTResourceTagCmdlet.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> |