AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Sets AWS default proxy for the shell. Subsequent AWS cmdlet invocations will use the configured proxy.

Syntax

Set-AWSProxy
-Hostname <String>
-Port <Int32>
-Username <String>
-Password <String>
-Credential <ICredentials>
-BypassList <String[]>
-BypassOnLocal <SwitchParameter>

Description

Sets AWS default proxy for the shell.

Parameters

-BypassList <String[]>
An array of regular expressions that describe URIs that do not use the proxy server when accessed.
Required?False
Position?Named
Accept pipeline input?False
-BypassOnLocal <SwitchParameter>
If specified, requests to local Internet resources do not use the configured proxy.
Required?False
Position?Named
Accept pipeline input?False
-Credential <ICredentials>
The credentials to submit to the proxy server for authentication
Required?False
Position?5
Accept pipeline input?False
-Hostname <String>
Proxy server host
Required?True
Position?1
Accept pipeline input?False
-Password <String>
Password to submit to the proxy server for authentication
Required?False
Position?4
Accept pipeline input?False
-Port <Int32>
Proxy server port
Required?True
Position?2
Accept pipeline input?False
-Username <String>
Username to submit to the proxy server for authentication
Required?False
Position?3
Accept pipeline input?False

Inputs

This cmdlet does not accept pipeline input.

Outputs

None
This cmdlet does not generate any output.

Examples

Example 1

PS C:\>Set-AWSProxy -Hostname localhost -Port 8888
This command configures a proxy that does not require special credentials.

Example 2

PS C:\>Set-AWSProxy -Hostname localhost -Port 8888 -Username 1 -Password 1
This command configures a proxy that requires a username and a password.

Example 3

PS C:\>Set-AWSProxy -Hostname localhost -Port 8888 -Credential ([System.Net.CredentialCache]::DefaultCredentials)
This command configures a proxy with default credentials. The -Credentials parameter can be used for any credentials object that implements the ICredentials interface.

Supported Version

AWS Tools for PowerShell: 2.x.y.z