AWS.Tools.EC2InstanceConnect.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.EC2InstanceConnect</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.EC2IC.SendEC2ICSerialConsoleSSHPublicKeyCmdlet"> <summary> Pushes an SSH public key to the specified EC2 instance. The key remains for 60 seconds, which gives you 60 seconds to establish a serial console connection to the instance using SSH. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-serial-console.html">EC2 Serial Console</a> in the <i>Amazon EC2 User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IC.SendEC2ICSerialConsoleSSHPublicKeyCmdlet.InstanceId"> <summary> <para> <para>The ID of the EC2 instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IC.SendEC2ICSerialConsoleSSHPublicKeyCmdlet.SerialPort"> <summary> <para> <para>The serial port of the EC2 instance. Currently only port 0 is supported.</para><para>Default: 0</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IC.SendEC2ICSerialConsoleSSHPublicKeyCmdlet.SSHPublicKey"> <summary> <para> <para>The public key material. To use the public key, you must have the matching private key. For information about the supported key formats and lengths, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html#how-to-generate-your-own-key-and-import-it-to-aws">Requirements for key pairs</a> in the <i>Amazon EC2 User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IC.SendEC2ICSerialConsoleSSHPublicKeyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Success'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2InstanceConnect.Model.SendSerialConsoleSSHPublicKeyResponse). Specifying the name of a property of type Amazon.EC2InstanceConnect.Model.SendSerialConsoleSSHPublicKeyResponse 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.EC2IC.SendEC2ICSerialConsoleSSHPublicKeyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InstanceId parameter. The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IC.SendEC2ICSerialConsoleSSHPublicKeyCmdlet.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.EC2IC.SendEC2ICSSHPublicKeyCmdlet"> <summary> Pushes an SSH public key to the specified EC2 instance for use by the specified user. The key remains for 60 seconds. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Connect-using-EC2-Instance-Connect.html">Connect to your Linux instance using EC2 Instance Connect</a> in the <i>Amazon EC2 User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IC.SendEC2ICSSHPublicKeyCmdlet.AvailabilityZone"> <summary> <para> <para>The Availability Zone in which the EC2 instance was launched.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IC.SendEC2ICSSHPublicKeyCmdlet.InstanceId"> <summary> <para> <para>The ID of the EC2 instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IC.SendEC2ICSSHPublicKeyCmdlet.InstanceOSUser"> <summary> <para> <para>The OS user on the EC2 instance for whom the key can be used to authenticate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IC.SendEC2ICSSHPublicKeyCmdlet.SSHPublicKey"> <summary> <para> <para>The public key material. To use the public key, you must have the matching private key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IC.SendEC2ICSSHPublicKeyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Success'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2InstanceConnect.Model.SendSSHPublicKeyResponse). Specifying the name of a property of type Amazon.EC2InstanceConnect.Model.SendSSHPublicKeyResponse 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.EC2IC.SendEC2ICSSHPublicKeyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InstanceId parameter. The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2IC.SendEC2ICSSHPublicKeyCmdlet.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> |