Method: Aws::S3::Object#presigned_url

Defined in:

lib/aws-sdk-resources/services/s3/object.rb

#presigned_url(http_method, params = {}) ⇒ String

Generates a pre-signed URL for this object.

Examples:

Pre-signed GET URL, valid for one hour

obj.presigned_url(:get, expires_in: 3600)
#=> "https://bucket-name.s3.amazonaws.com/object-key?..."

Pre-signed PUT with a canned ACL

# the object uploaded using this URL will be publicly accessible
obj.presigned_url(:put, acl: 'public-read')
#=> "https://bucket-name.s3.amazonaws.com/object-key?..."

Parameters:

• http_method (Symbol) —

  The HTTP method to generate a presigned URL for. Valid values are ‘:get`, `:put`, `:head`, and `:delete`.

• params (Hash) (defaults to: {}) —

  Additional request parameters to use when generating the pre-signed URL. See the related documentation in Client for accepted params.

  | HTTP Method | Client Method | |—————|————————| | ‘:get` | Client#get_object | | `:put` | Client#put_object | | `:head` | Client#head_object | | `:delete` | Client#delete_object |

Options Hash (params):

• :virtual_host (Boolean) — default: false —

  When ‘true` the presigned URL will use the bucket name as a virtual host.

  bucket = Aws::S3::Bucket.new('my.bucket.com')
  bucket.object('key').presigned_url(virtual_host: true)
  #=> "http://my.bucket.com/key?..."
  

• :expires_in (Integer) — default: 900 —

  Number of seconds before the pre-signed URL expires. This may not exceed one week (604800 seconds).

Returns:

• (String)

Raises:

• (ArgumentError) —

  Raised if ‘:expires_in` exceeds one week (604800 seconds).

# File 'lib/aws-sdk-resources/services/s3/object.rb', line 167

def presigned_url(http_method, params = {})
  presigner = Presigner.new(client: client)
  presigner.presigned_url("#{http_method.downcase}_object", params.merge(
    bucket: bucket_name,
    key: key,
  ))
end