Add-S3 Cmdlet

Parameters   Output Objects   Config Settings  

The Add-S3 component can be used to create objects and buckets in the Amazon S3 service.

Syntax

Add-S3 [parameters]

Remarks

The Add-S3 cmdlet allows you to access Amazon's Simple Storage Service (S3) in a secure manner using SSL. Add-S3 allows for the creation of objects and buckets. A brief synopsis follows but please refer to Amazon S3 documentation for details.

You will first need to sign up for the S3 service and obtain an AccessKey and SecretKey from Amazon. Then you can start creating buckets or objects in your account using Add-S3.

The cmdlets support pipeline input for some of their parameters. Prebuilding an object and piping it to the cmdlet is very useful, but should be used with caution to prevent security conflicts. Steps have been taken to decrease the risk of a possibly accidental pipe to the cmdlet, for instance, the Credential parameter cannot be piped to the cmdlet and must be specified manually.

#create bucket Add-S3 -AccessKey $S3AccessKey -SecretKey $S3SecretKey -Bucket TestBucket #create object Add-S3 -AccessKey $S3AccessKey -SecretKey $S3SecretKey -Bucket TestBucket -RemoteObject test_object -ObjectData "test data"

Parameter List

---

The following is the full list of the parameters of the cmdlet with short descriptions. Click on the links for further details.

LogFile	The location of a file to which debug information is written.
AccessKey	The Access Key Id for the Amazon Web Services account.
AccessPolicy	The AccessPolicy are used to set permissions when a Bucket or an object is updated.
Bucket	The name of the S3 bucket.
CertPassword	The password to the certificate store.
CertStore	The name of the certificate store for the client certificate.
CertStoreType	The type of certificate store for the client certificate.
CertSubject	The subject of the certificate used for client authentication.
Config	Specifies one or more configuration settings.
Credential	The PSCredential object to use for authentication.
FirewallHost	Name or IP address of firewall.
FirewallPassword	A password if authentication is to be used when connecting through the firewall.
FirewallPort	The port of the firewall to which to connect.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
Force	Forces the component to accept the default behavior instead of querying the user.
LocalFile	If set, data is imported for the RemoteObject to create.
LocalIP	The IP address of the local interface to use.
LogFile	The location of a file to which debug information is written.
MetaData	Add custom metadata when uploading a file.
ObjectData	Specifies the data of the object to be created in the remote host.
ProxyAutoDetect	Specifies if proxy information is automatically detected.
ProxyPassword	The password to authenticate with.
ProxyPort	The TCP port of the Proxy .
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	The User value to authenticate with.
Region	The region the component will make requests against.
RemoteObject	Sets the remote object for the operation.
SecretKey	The Secret Access Key for the Amazon Web Services account.
SSL	Use SSL to access Amazon S3.
SSLAccept	The encoded public key of the certificate which is to be trusted explicitly.
Timeout	The maximum time allowed for the operation.
UseVirtualHosting	Determines which style request to use.

Output Objects

---

The following is the full list of the output objects returned by the cmdlet with short descriptions. Click on the links for further details.

S3Create	Returned when an object or a bucket is created.

Config Settings

---

The following is a list of config settings for the cmdlet with short descriptions. Click on the links for further details.

BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Tells the component whether or not to use the system security libraries or an internal implementation.

LogFile Parameter (Add-S3 Cmdlet)

The location of a file to which debug information is written.

Syntax

Add-S3 -LogFile string

Remarks

When specified, the cmdlet will log debug information to the file. If the file exists, the information will be appended.

Default Value

null

AccessKey Property (Add-S3 Cmdlet)

The Access Key Id for the Amazon Web Services account.

Syntax

Add-S3 -AccessKey string

Remarks

For more information, please refer to the Amazon documentation.

Default Value

""

AccessPolicy Property (Add-S3 Cmdlet)

The AccessPolicy are used to set permissions when a Bucket or an object is updated.

Syntax

Add-S3 -AccessPolicy string

Remarks

Amazon S3 allows buckets and objects to be publicly accessible, this can be achieved by setting a suitable AccessPolicy.

Possible values:

• Private
• PublicRead
• PublicReadWrite
• AuthenticatedRead

Default Value

0

Bucket Property (Add-S3 Cmdlet)

The name of the S3 bucket.

Syntax

Add-S3 -Bucket string

Remarks

The Bucket parameter determines which bucket to create or the bucket where the RemoteObject should be created.

Default Value

""

This is a required parameter.

CertPassword Property (Add-S3 Cmdlet)

The password to the certificate store.

Syntax

Add-S3 -CertPassword string

Remarks

Specifies a password (if required) to access the specified certificate store.

Default Value

""

Parameter Alias

CertificatePassword

CertStore Property (Add-S3 Cmdlet)

The name of the certificate store for the client certificate.

Syntax

Add-S3 -CertStore string

Remarks

The CertStoreType parameter specifies the type of the certificate store specified by CertStore. If the store is password protected, specify the password in CertPassword.

CertStore is used in conjunction with the CertSubject parameter in order to specify client certificates. If CertStore has a value, and CertSubject has been set, a search for a certificate is initiated during logon. Please refer to the CertSubject parameter for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this parameter must be set to the name of the file.

Default Value

"MY"

Parameter Alias

CertificateStore

CertStoreType Property (Add-S3 Cmdlet)

The type of certificate store for the client certificate.

Syntax

Add-S3 -CertStoreType string

Remarks

This parameter can take one of the following values:

Default Value

0

CertSubject Property (Add-S3 Cmdlet)

The subject of the certificate used for client authentication.

Syntax

Add-S3 -CertSubject string

Remarks

During the user authentication phase of the logon process, the cmdlet will search the store specified in CertStore for a certificate that matches this parameter. If the store contains a private key for that certificate, it is used to verify the user's identity with the secure server.

When this parameter is set, a search is performed in the current certificate store certificate with matching subject.

If an exact match is not found, the store is searched for subjects containing the value of the parameter.

When setting the parameter to a partial subject, CN= should be omitted. For example, the following code would find the certificate with subject CN=Test Certificate, OU=People, C=US

Example (Searching with partial subject)

-certsubject "Test"

If a match is not found, the parameter is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

Default Value

"*"

Config Property (Add-S3 Cmdlet)

Specifies one or more configuration settings.

Syntax

Add-S3 -Config string[]

Remarks

The Config parameter takes one or more name-value pairs that represent the name of the configuration setting and value, i.e.: -config "Name=Value"

Default Value

null

Credential Property (Add-S3 Cmdlet)

The PSCredential object to use for authentication.

Syntax

Add-S3 -Credential PSCredential

Remarks

In the case of S3 cmdlets, the User field contains the AccessKey and Password contains SecretKey.

Default Value

null

Parameter Alias

auth

FirewallHost Property (Add-S3 Cmdlet)

Name or IP address of firewall.

Syntax

Add-S3 -FirewallHost string

Remarks

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost parameter is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost parameter is set to the corresponding address. If the search is not successful, an error is returned.

Default Value

""

FirewallPassword Property (Add-S3 Cmdlet)

A password if authentication is to be used when connecting through the firewall.

Syntax

Add-S3 -FirewallPassword string

Remarks

If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to authenticate against the firewall.

Default Value

""

FirewallPort Property (Add-S3 Cmdlet)

The port of the firewall to which to connect.

Syntax

Add-S3 -FirewallPort int

Remarks

The TCP port for the FirewallHost. See the description of the FirewallHost parameter for details.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value. See the description of the FirewallType parameter for details. Setting this parameter will overwrite the default settings for the firewall port as specified by FirewallType.

Default Value

0

FirewallType Property (Add-S3 Cmdlet)

Determines the type of firewall to connect through.

Syntax

Add-S3 -FirewallType string

Remarks

The applicable values are the following:

Default Value

0

FirewallUser Property (Add-S3 Cmdlet)

A user name if authentication is to be used connecting through a firewall.

Syntax

Add-S3 -FirewallUser string

Remarks

If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to authenticate against the firewall.

Default Value

""

Force Property (Add-S3 Cmdlet)

Forces the component to accept the default behavior instead of querying the user.

Syntax

Add-S3 -Force SwitchParameter

Remarks

The Force parameter is especially useful in a script environment where user interaction is not an option. Certain cmdlets that are SSH and SSL based will query the user if the security credentials of the certificate presented by the server are not met. Setting this parameter will force the cmdlet to accept the certificate of the server unconditionally.

Default Value

false

LocalFile Property (Add-S3 Cmdlet)

If set, data is imported for the RemoteObject to create.

Syntax

Add-S3 -LocalFile string

Remarks

ObjectData takes precedence over LocalFile, so if both parameters are set, the RemoteObject's data will be specified by ObjectData. If RemoteObject is not set, the name of the remote object is the same as the name of LocalFile.

Default Value

""

Parameter Alias

Upload

LocalIP Property (Add-S3 Cmdlet)

The IP address of the local interface to use.

Syntax

Add-S3 -LocalIP string

Remarks

This parameter is useful when the cmdlet is running on a machine that has more than one network interface (each with its own IP address and network access privileges).

Default Value

""

Parameter Alias

LocalAddress

LogFile Property (Add-S3 Cmdlet)

The location of a file to which debug information is written.

Syntax

Add-S3 -LogFile string

Remarks

When specified, the cmdlet will log debug information to the file. If the file exists, the information will be appended.

Default Value

""

MetaData Property (Add-S3 Cmdlet)

Add custom metadata when uploading a file.

Syntax

Add-S3 -MetaData Hashtable

Remarks

This parameter is a hashtable of metadata headers and their associated value. For example, passing @{build="12345"; author="John"} will cause the S3 server to add the following headers to the uploaded file:

x-amz-meta-build: 12345

x-amz-meta-author: John

Default Value

null

ObjectData Property (Add-S3 Cmdlet)

Specifies the data of the object to be created in the remote host.

Syntax

Add-S3 -ObjectData string

Remarks

ObjectData will take precedence over LocalFile.

Default Value

""

ProxyAutoDetect Property (Add-S3 Cmdlet)

Specifies if proxy information is automatically detected.

Syntax

Add-S3 -ProxyAutoDetect SwitchParameter

Remarks

This parameter tells the cmdlet whether or not to automatically detect and use proxy system settings, if available. The default value is False.

Default Value

false

ProxyPassword Property (Add-S3 Cmdlet)

The password to authenticate with.

Syntax

Add-S3 -ProxyPassword string

Remarks

If authentication is required with the proxy server, the ProxyPassword parameter specifies the password.

Default Value

""

ProxyPort Property (Add-S3 Cmdlet)

The TCP port of the Proxy .

Syntax

Add-S3 -ProxyPort int

Remarks

By default this value is set to 80.

Default Value

80

ProxyServer Property (Add-S3 Cmdlet)

Name or IP address of a proxy server (optional).

Syntax

Add-S3 -ProxyServer string

Remarks

If a Proxy is given, then the HTTP request is sent to the proxy instead of the server specified in the URL.

If the Proxy parameter is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the Proxy parameter is set to the corresponding address. If the search is not successful, an error is returned.

Default Value

""

Parameter Alias

Proxy

ProxyUser Property (Add-S3 Cmdlet)

The User value to authenticate with.

Syntax

Add-S3 -ProxyUser string

Remarks

If authentication is required with the proxy server, the ProxyUser parameter specifies the username.

Default Value

""

Region Property (Add-S3 Cmdlet)

The region the component will make requests against.

Syntax

Add-S3 -Region string

Remarks

This property control which region the cmdlet will make requests against. By default the cmdlet uses us-east-1, the US East (N. Virginia) region. This property should be changed to create or access resources in other regions.

Regions:

The cmdlet will always convert this property's value to lowercase. If this property is cleared, the cmdlet will reset it to the default value.

Default Value

"us-east-1"

RemoteObject Property (Add-S3 Cmdlet)

Sets the remote object for the operation.

Syntax

Add-S3 -RemoteObject string

Remarks

Specifies the remote object to create. If not set, the cmdlet will create the Bucket instead.

Default Value

""

Parameter Alias

Object

SecretKey Property (Add-S3 Cmdlet)

The Secret Access Key for the Amazon Web Services account.

Syntax

Add-S3 -SecretKey string

Remarks

For more information, please refer to the Amazon documentation.

Default Value

""

SSL Property (Add-S3 Cmdlet)

Use SSL to access Amazon S3.

Syntax

Add-S3 -SSL SwitchParameter

Remarks

Use this property to determine whether the cmdlet uses SSL to connect with Amazon S3 servers.

Default Value

true

SSLAccept Property (Add-S3 Cmdlet)

The encoded public key of the certificate which is to be trusted explicitly.

Syntax

Add-S3 -SSLAccept string

Remarks

Ordinarily, the certificate presented by the server will be checked against the system certificate stores to see if the Certificate Authority is trusted, and if not, the cmdlet will prompt the user to accept the certificate. Setting this parameter will override the system settings and trust the certificate provided.

After each connection, regardless of whether or not the certificate was trusted, the cmdlet will store the certificate presented by the server in the $SSLServerCertificate session variable. This variable can be inspected to view details of the server's certificate.

If the Force parameter is set, the cmdlet will accept the server's certificate unconditionally.

In cases where the certificate presented by the server is not trusted, a prompt will be shown to the user. This prompt will allow the user to decide whether or not they would like to accept the certificate presented by the server.

There may be cases where you do not want a prompt to be displayed or would like to handle the response supplied directly within your script. This can be done by setting the $SSLAcceptPreference variable prior to running the cmdlet. The available values for this variable are:

Default Value

""

Parameter Alias

Accept

Timeout Property (Add-S3 Cmdlet)

The maximum time allowed for the operation.

Syntax

Add-S3 -Timeout int

Remarks

After the specified interval in seconds, the cmdlet will throw a Timeout error if the operation is not completed.

Default Value

10

UseVirtualHosting Property (Add-S3 Cmdlet)

Determines which style request to use.

Syntax

Add-S3 -UseVirtualHosting SwitchParameter

Remarks

If set to true (default), buckets will be referenced in the request using the hosted-style request: http://yourbucket.s3.amazonaws.com/yourobject If false, the cmdlet will use the path-style request: http://s3.amazonaws.com/yourbucket/yourobject

NOTE: When set to true, there are more limitations when choosing a bucket name due to DNS server naming restrictions. See Amazon's documentation for more detailed naming information.

Default Value

true

S3Create Output Object (Add-S3 Cmdlet)

Returned when an object or a bucket is created.

Syntax

Object S3Create {
   string Name;
   string Value;
   string Type;
}

Remarks

The Name field specifies the name of the created entity. The Value field specifies the value of the object that was created, and Type shows the type of the entity created (i.e., Object or Bucket).

Config Settings (Add-S3 Cmdlet)

The cmdlet accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the cmdlet, access to these internal properties is provided through the Config method.

Base Config Settings