[[TOC()]]

= [wiki:help/en Cyberduck Help] / [wiki:help/en/howto Howto] / Amazon S3 =

Transfer files to your [http://aws.amazon.com/s3 S3] account and browse the S3 buckets and files in a hierarchical way. For a short overview of Amazon S3, refer to the Wikipedia [http://en.wikipedia.org/wiki/Amazon_S3 article].

== Connecting to Amazon S3 ==

You must obtain the login credentials (''Access Key ID'' and ''Secret Access Key'') of your Amazon Web Services [http://aws.amazon.com/account/ Account] from the ''AWS Access Identifiers'' [http://aws-portal.amazon.com/gp/aws/developer/account/index.html?action=access-key page]. In the login prompt of Cyberduck upon connecting to S3 you enter the ''Access Key ID'' for the username and ''Secret Access Key'' for the password.

You can also connect using [wiki:help/en/howto/iam IAM] credentials.

=== Creating a bucket ===

When connecting the first time, you must first create a new bucket with ''File → New Folder... (⌘-N)''. Note that the namespace for bucket names is global in S3 and common names are most possibly already taken by a third party.

=== External buckets ===

Connecting to a bucket you are not the owner (and therefore not listed when logging in as above) is possible. You can access buckets owned by someone else if the ACL allows you to access it. Specify the bucket you want to access in the hostname to connect to like `<bucketname>.s3.amazonaws.com`. Your own buckets will not be displayed but only the third party bucket.

=== Storage Class ===

You have the option to store files using the ''Reduced Redundancy Storage (RRS)'' to reduce costs by storing non-critical, reproducible data at lower levels of redundancy. Set the default storage class in ''Preferences (⌘-,)→ S3'' and [wiki:help/en/howto/info#CloudProviderS3CloudFilesPanel edit the storage class] for already uploaded files using ''File → Info (⌘-I) → S3''.

== Third-Party S3 providers ==

There are a growing number of third parties beside Amazon offering S3 compatible cloud storage software or solutions. 
 * [wiki:help/en/howto/googlestorage Google Storage]
 * [wiki:help/en/howto/eucalyptus Eucalyptus Walrus]
 * [https://www.cloud.it Aruba Cloud]
 * [wiki:help/en/howto/dunkel Dunkel Cloud Storage]
 * [http://www.hosteurope.de/produkte/Cloud-Storage Host Europe Cloud Storage]
 * Tiscali
 * Seeweb
 * [wiki:help/en/howto/greenqloud GreenQloud Storage Qloud]
 * ScaleUp Technologies
 * Intergenia
 * [https://www.mh.connectria.com/rp/order/cloud_storage_index Connectria Cloud Storage]
 * [wiki:help/en/howto/lunacloud Lunacloud]
 * [wiki:help/en/howto/dreamobjects DreamObjects Cloud Storage]

== Distribution (CloudFront CDN) ==

Amazon CloudFront delivers your static and streaming content using a global network of edge locations. Requests for your objects are automatically routed to the nearest edge location, so content is delivered with the best possible performance. Refer to [wiki:help/en/howto/cloudfront Amazon CloudFront distribution] for help about setting up distributions.

== Buckets ==

To create a new [http://docs.amazonwebservices.com/AmazonS3/2006-03-01/index.html?UsingBucket.html bucket] for your account, browse to the root and choose ''File → New Folder... (⌘-N)''.  You can choose the bucket location in ''Preferences (⌘-,) → S3''. Note that Amazon has a different pricing scheme for different locations. Supported locations are:
 * EU (Ireland)
 * US Standard
 * US-West (Northern California)
 * Asia Pacific (Singapore)
 * Asia Pacific (Tokyo)

'''Important''': Because the bucket name must be globally unique the operation might fail if the name is already taken by someone else (E.g. don't assume any common name like ''media'' or ''images'' will be available).

'''Important''': You cannot change the location of an existing bucket.

You can change the default bucket ACL `public-read` with a [wiki:help/en/howto/preferences#Hiddenconfigurationoptions hidden option] to `private`.

{{{
defaults write ch.sudo.cyberduck s3.bucket.acl.default private
}}}

=== Bucket Access Logging ===

When this option is enabled in the ''S3'' panel of the Info (''File →  Info (⌘-I)'') window for a bucket or any file within, available log records for this bucket are periodically aggregated into log files and delivered to `/logs` in the target logging bucket specified. It is considered best practice to [http://blog.qloudstat.com/2012/04/24/choose-a-logging-target/ choose a logging target] that is different from the origin bucket.

[[Image(AWS Logging Configuration.png)]]

To toggle ''CloudFront'' access logging, select the the [wiki:help/en/howto/cloudfront#CloudFrontAccessLogging Distribution] panel in the ''File → Info (⌘-N)'' window.

=== Qloudstat Analytics ===
The ''Read Access for Qloudstat'' checkbox in the ''Info'' panel tab creates a dedicated IAM user with a read only IAM policy for Qloudstat to fetch log files. Unchecking the Read Access for Qloudstat checkbox will remove the IAM user again revoking all access for Qloudstat. When enabled, a clickable link is displayed that redirects to [https://qloudstat.com Qloudstat] to confirm the new setup.

== Folders ==

Creating a folder inside a bucket will create a placeholder object named after the directory, has no data content and the mimetype `application/x-directory`. 

=== Supported thirdparty folder placeholder formats ===

 * Folders created with [http://aws.amazon.com/console/ AWS Management Console].  

== Access Control (ACL) ==
Amazon S3 uses Access Control List (ACL) settings to control who may access or modify items stored in S3. You can edit ACLs in ''File → Info (⌘-I) → Permissions''.

[[Image(ACLs.png)]]

=== Canonical User ID Grantee ===
If you enter a user ID unknown to AWS, the error message `S3 Error Message. Bad Request. Invalid id.` will be displayed.
=== Email Address Grantee ===
If you enter an email address unknown to AWS, the error message `S3 Error Message. Bad Request. Invalid id.` will be displayed. If multiple accounts are registered with AWS for the given email address, the error message `Bad Request. The e-mail address you provided is associated with more than one account. Please retry your request using a different identification method or after resolving the ambiguity.` is returned.
=== All Users Group Grantee ===
You must give the group grantee `http://acs.amazonaws.com/groups/global/AllUsers` read permissions for your objects to make them accessible using a regular web browser for everyone.

If [wiki:help/en/howto/s3#BucketAccessLogging bucket logging] is enabled, the bucket ACL will have `READ_ACP` and `WRITE` permissions for the group grantee `http://acs.amazonaws.com/groups/s3/LogDelivery`.

=== Default ACLs ===

 * '''Buckets'''. New buckets created have a default pre-defined canned ACL set to `public-read`. You get `FULL_CONTROL`. All other users have `READ` access.
 * '''Files'''. For new files uploaded, the ACL applied depends on the setting in ''Preferences → Transfers (⌘-T)→ Permissions → Uploads''. If you want files uploaded accessible to anyone, make sure to set the following:
   * If you have selected to apply ''the permissions of the local file or folder'' for uploads, then check the access permissions of the file in ''Finder.app''. If ''everyone'' is allowed read access in the ''Sharing & Permissions'' section of the Finder.app ''Info'' window, the file should have a `READ` ACL in S3 for `http://acs.amazonaws.com/groups/global/AllUsers`.
   * If you have choosen to set default permissions for uploads, make sure ''Read'' access for ''Others'' is selected in the Upload Permissions Transfer Preferences.

=== Permissions ===
The following permissions can be given to grantees:
 

||                   ||=''Bucket''=||=''Files''=||
||=`READ`=|| Allows grantee to list the files in the bucket || Allows grantee to download the file and its metadata ||
||=`WRITE`=|| Allows grantee to create, overwrite, and delete any file in the bucket || Not applicable ||
||=`FULL_CONTROL`=|| Allows grantee all permissions on the bucket || Allows grantee all permissions on the object ||
||=`READ_ACP`=|| Allows grantee to read the bucket ACL || Allows grantee to read the file ACL ||
||=`WRITE_ACP`=|| Allows grantee to write the ACL for the applicable bucket || Allows grantee to write the ACL for the applicable file ||


== Versions ==
[http://aws.amazon.com/s3/faqs/#What_is_Versioning Versioning] can be enabled per bucket in ''File → Info (⌘-I)→ S3''. You can view all revisions of a file in the browser by choosing ''View → Show Hidden Files''. 

=== Revert ===
To revert to a previous version and make it the current, choose ''File → Revert''.

=== Multi-Factor Authentication (MFA) Delete ===
To enable ''Multi-Factor Authentication (MFA) Delete'', you need to purchase a compatible [http://aws.amazon.com/mfa/ authentication device]. Toggle MFA in ''File → Info (⌘-I) → S3''. When enabled, you are prompted for the device number and one-time token in a login prompt. Never reenter a token in the prompt already used before. A token is only valid for a single request. Wait for the previous token to disapear from the device screen and request a new token from the device.

[[Image(MFA Credentials.png)]]

== Public URLs ==
You can access all URLs (including from [wiki:help/en/howto/cloudfront CDN] configurations) from the menu ''Edit → Copy URL'' and ''File → Open URL''.
[[Image(Copy URLs.png)]]


=== Signed temporary URLs ===
A private object stored in S3 can be made publicly available for a limited time using a signed URL. The signed URL can be used by anyone to download the object, yet it includes a date and time after which the URL will no longer work. Copy the signed URL from ''File → Info (⌘-I) → S3''. Public access to the URL is granted for 24 hours by default.

 * Choose the lifetime for publicly available auto-expiring signed URL using the [wiki:help/en/howto/preferences#Hiddenconfigurationoptions hidden option] {{{s3.url.expire.seconds}}}.

{{{
defaults write ch.sudo.cyberduck s3.url.expire.seconds 86400
}}}

=== BitTorrent URLs ===

Use ''File →  Info (⌘-I) → S3'' to copy the BitTorrent URL of a selected file. The ACL of the object must allow aonymous read. One important thing to note is that the .torrent file describing an Amazon S3 object is generated on-demand, the first time the Torrent URL is requested. Generating the .torrent for an object takes time proportional to the size of that object. For large objects, this time can be significant. Therefore, before publishing a ?torrent link, we suggest making the first request for it yourself. Amazon S3 might take several minutes to respond to this first request, as it generates the .torrent file. Unless you update the object in question, subsequent requests for the .torrent will be fast.

== Metadata ==

You can edit standard HTTP headers and add [wiki:help/en/howto/info#MetadataHTTPheaders custom HTTP headers] to files to store [http://docs.amazonwebservices.com/AmazonS3/latest/index.html?UsingMetadata.html metadata]. Choose ''File → Info (⌘-I) → Metadata'' to edit headers.

Refer to the [wiki:help/en/howto/info#MetadataHTTPheaders Info panel] wiki page.

=== Default metadata ===

Currently only possible using a [wiki:help/en/howto/preferences#Hiddenconfigurationoptions hidden configuration option] you can define default headers to be added for uploads. Multiple headers must be separated using a whitespace delimiter. Key and value of a header are seperated with `=`. For example if you want to add a HTTP header for Cache-Control and one named `Creator` you would set

{{{
defaults write ch.sudo.cyberduck s3.metadata.default "Cache-Control=public,max-age=86400 Creator=Cyberduck"
}}}

=== Cache Control Setting ===

This option lets you control how long a client accessing objects from your S3 bucket will cache the content and thus lowering the number of access to your S3 storage. In conjunction with Amazon CloudFront, it controls the time an object stays in an edge location until it expires. After the object expires, CloudFront must go back to the origin server the next time that edge location needs to serve that object. By default, all objects automatically expire after 24 hours when no custom `Cache-Control` header is set. 

The default setting is `Cache-Control: public,max-age=2052000` when choosing to add a custom `Cache-Control` header in the [wiki:help/en/howto/info Info] panel which translates to a cache expiration of one month (one month in seconds equals more or less `60*60*24*30`).

 * Use the [wiki:help/en/howto/preferences#Hiddenconfigurationoptions hidden configuration option] `s3.cache.seconds` to set a custom default value

{{{
defaults write ch.sudo.cyberduck s3.cache.seconds 2052000
}}}

 * [http://docs.amazonwebservices.com/AmazonCloudFront/latest/GettingStartedGuide/index.html?NextSteps.html Amazon CloudFront and Your Live System].
 * Read more about [http://docs.amazonwebservices.com/AmazonCloudFront/latest/DeveloperGuide/index.html?Expiration.html Amazon CloudFront Object Expiration].

'''Tip:''' Use `curl -I <http://<bucketname>.s3.amazonaws.com/<key>` to debug HTTP headers.

== Encryption ==

Server side [http://aws.amazon.com/s3/faqs/#What_options_do_I_have_for_encrypting_data_stored_on_Amazon_S3 encryption] for stored files is supported and can be enabled by default for all uploads in the S3 preferences or for individual files in the ''File → Info (⌘-I) → S3''. AWS handles key management and key protection for you.

== Website Configuration ==
To host a static website on S3, It is possible to define a Amazon S3 bucket as a ''Website Endpoint''. The configuration in ''File → Info (⌘-I) → Distribution'' allows you to enable website configuration. Choose ''Website Configuration (HTTP)'' from ''Delivery Method'' and define an index document name that is searched for and returned when requests are made to the root or the subfolder of your website. 

To access this website functionality, Amazon S3 exposes a new website endpoint for each region (US Standard, US West, EU, or Asia Pacific). For example, `s3-website-ap-southeast-1.amazonaws.com` is the endpoint for the Asia Pacific Region. The location is displayed in the ''Where'' field following the ''Origin''.

[[Image(S3 Website Configuration.png)]]

To configure Amazon CloudFront for your website endpoints, refer to [http://trac.cyberduck.ch/wiki/help/en/howto/cloudfront#WebsiteConfigurationEndpointDistributionswithCloudFrontCDN Website Configuration Endpoint Distributions with CloudFront CDN].

=== Reference ===
 * [http://aws.typepad.com/aws/2011/02/host-your-static-website-on-amazon-s3.html Host Your Static Website on Amazon S3]
 * [http://aws.amazon.com/about-aws/whats-new/2011/02/17/Amazon-S3-Website-Features/ Amazon S3 adds new features for hosting static websites]


== Uploads ==
=== Multiparts ===
Files larger than 5MB are uploaded in parts with up to 10 parallel requests making use of the [http://aws.amazon.com/about-aws/whats-new/2010/11/10/Amazon-S3-Introducing-Multipart-Upload/ multipart upload] feature. The file size limit is 5TB.

Multipart uploads can be disabled by setting the [wiki:help/en/howto/preferences#Hiddenconfigurationoptions hidden option] `s3.upload.multipart` to `false`.

== Problems ==
=== Use S3 without SSL ===
'''It is discouraged to enable this option to connect plaintext to Amazon S3.'''

If you have a S* installation without SSL configured, you need an optional connection profile to connect using HTTP only without transport layer security. You will then have the added option ''S3 (HTTP)'' in the protocol dropdown selection in the [wiki:help/en/howto/connection Connection] and [wiki:help/en/howto/bookmarks Bookmark] panels.

 * [https://svn.cyberduck.ch/trunk/profiles/S3%20(HTTP).cyberduckprofile Download] the ''S3 (HTTP)'' for preconfigured settings.

=== SSL certificate trust verification ===

When listing a bucket that has a `.` in its name, connecting will give a trust verification failure ''The certificate is not valid (host name mismatch)'' for the wildcard certificate `*.s3.amazonaws.com`. Because the wildcard only applies to one level in the domain name, you must manually trust this certificate. 

== References ==
 * [http://aws.amazon.com/s3/faqs/ Amazon Simple Storage Service FAQs]
 * [http://docs.amazonwebservices.com/AmazonS3/latest Amazon Simple Storage Service Developer Guide]