Rename-S3 Cmdlet
Parameters Output Objects Configuration Settings
The Rename-S3 component is used to rename objects on Amazon S3 servers.
Syntax
Rename-S3 [parameters]
Remarks
The appropriate Amazon S3 credentials should be passed to the AccessKey, and SecretKey parameters. The Bucket parameter should be set to the bucket where the object resides. The object to rename is given by RemoteObject and the new name is given by NewName.
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.
# rename a file Rename-S3 -AccessKey $s3access -SecretKey $s3secret -Bucket myBucket -RemoteObject oldname.txt -NewName newname.txt
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. |
| Bucket | The name of the current 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 | The local file to save the object data to. |
| LocalIP | The IP address of the local interface to use. |
| LogFile | The location of a file to which debug information is written. |
| NewName | Rename the file specified by RemoteFile . |
| 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 | The name of the remote object to rename. |
| 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.
| Bucket | Returned for each bucket during a list bucket operation. |
Configuration Settings
The following is a list of configuration settings for the cmdlet with short descriptions. Click on the links for further details.