Twoorb Plugins  1.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Amazon.S3.Model.GetPreSignedUrlRequest Class Reference

The parameters to create a pre-signed URL to a bucket or object. More...

Inheritance diagram for Amazon.S3.Model.GetPreSignedUrlRequest:

Public Member Functions

bool IsSetExpires ()
 Checks if Expires property is set. More...
 

Properties

string BucketName [get, set]
 The name of the bucket to create a pre-signed url to, or containing the object. More...
 
string Key [get, set]
 The key to the object for which a pre-signed url should be created. More...
 
string ContentType [get, set]
 A standard MIME type describing the format of the object data. More...
 
DateTime Expires [get, set]
 The expiry date and time for the pre-signed url. More...
 
Protocol Protocol [get, set]
 The requested protocol (http/https) for the pre-signed url. More...
 
HttpVerb Verb [get, set]
 The verb for the pre-signed url. More...
 
string VersionId [get, set]
 Version id for the object that the pre-signed url will reference. If not set, the url will reference the latest version of the object. More...
 
ServerSideEncryptionMethod ServerSideEncryptionMethod [get, set]
 Specifies the encryption used on the server to store the content. More...
 
ResponseHeaderOverrides ResponseHeaderOverrides [get, set]
 A set of response headers that should be returned with the pre-signed url creation response. More...
 

Detailed Description

The parameters to create a pre-signed URL to a bucket or object.

For more information, refer to: .
Required Parameters: BucketName, Expires
Optional Parameters: Key, VersionId, Verb: default is GET

Member Function Documentation

bool Amazon.S3.Model.GetPreSignedUrlRequest.IsSetExpires ( )

Checks if Expires property is set.

Returns
true if Expires property is set.

Property Documentation

string Amazon.S3.Model.GetPreSignedUrlRequest.BucketName
getset

The name of the bucket to create a pre-signed url to, or containing the object.

string Amazon.S3.Model.GetPreSignedUrlRequest.ContentType
getset

A standard MIME type describing the format of the object data.

The content type for the content being uploaded. This property defaults to "binary/octet-stream". For more information, refer to:

DateTime Amazon.S3.Model.GetPreSignedUrlRequest.Expires
getset

The expiry date and time for the pre-signed url.

string Amazon.S3.Model.GetPreSignedUrlRequest.Key
getset

The key to the object for which a pre-signed url should be created.

Protocol Amazon.S3.Model.GetPreSignedUrlRequest.Protocol
getset

The requested protocol (http/https) for the pre-signed url.

Defaults to https.

ResponseHeaderOverrides Amazon.S3.Model.GetPreSignedUrlRequest.ResponseHeaderOverrides
getset

A set of response headers that should be returned with the pre-signed url creation response.

ServerSideEncryptionMethod Amazon.S3.Model.GetPreSignedUrlRequest.ServerSideEncryptionMethod
getset

Specifies the encryption used on the server to store the content.

Default is None.

If specifying encryption (not None), the corresponding request must include header "x-amz-server-side-encryption" with the value of the encryption.

HttpVerb Amazon.S3.Model.GetPreSignedUrlRequest.Verb
getset

The verb for the pre-signed url.

Accepted verbs are GET, PUT, DELETE and HEAD. Default is GET.

string Amazon.S3.Model.GetPreSignedUrlRequest.VersionId
getset

Version id for the object that the pre-signed url will reference. If not set, the url will reference the latest version of the object.

This is the VersionId for the S3 Object you want to get a PreSigned URL for. The VersionId property will be ignored for PreSigned "PUT" requests and for requests that don't specify the Key property.


The documentation for this class was generated from the following file: