AWSS3GetPreSignedURLRequest Class Reference

Inherits from NSObject
Declared in AWSS3PreSignedURL.h
AWSS3PreSignedURL.m

Overview

The GetPreSignedURLRequest contains the parameters used to create a pre signed URL.

  accelerateModeEnabled

Returns whether the client has enabled accelerate mode for getting and putting objects. The default is NO.

@property (nonatomic, assign, getter=isAccelerateModeEnabled) BOOL accelerateModeEnabled

Declared In

AWSS3PreSignedURL.h

  bucket

The name of the bucket

@property (nonatomic, strong) NSString *bucket

Declared In

AWSS3PreSignedURL.h

  key

The name of the S3 object

@property (nonatomic, strong) NSString *key

Declared In

AWSS3PreSignedURL.h

  HTTPMethod

Specifies the verb used in the pre-signed URL. accepted AWSHTTPMethodGET, AWSHTTPMethodPUT, AWSHTTPMethodHEAD.

@property (nonatomic, assign) AWSHTTPMethod HTTPMethod

Declared In

AWSS3PreSignedURL.h

  expires

The time when the signature expires, specified as an NSDate object.

@property (nonatomic, strong) NSDate *expires

Declared In

AWSS3PreSignedURL.h

  minimumCredentialsExpirationInterval

AWSS3GetPreSignedURLRequest will automatically refresh temporary credential if expiration duration in less than minimumCredentialsExpirationInterval. Only applied for credential provider using temporary token (e.g. CognitoIdentityProvider). Default value is 3000 seconds.

@property (nonatomic, assign) NSTimeInterval minimumCredentialsExpirationInterval

Declared In

AWSS3PreSignedURL.h

  contentType

Expected content-type of the request. If set, the content-type will be included in the signature and future requests must include the same content-type header value to access the presigned URL. This parameter is ignored unless AWSHTTPMethod is equal to AWSHTTPMethodPUT. Default is nil.

@property (nonatomic) NSString *contentType

Declared In

AWSS3PreSignedURL.h

  contentMD5

Expected content-md5 header of the request. If set, this header value will be included when calculating the signature and future requests must include the same content-md5 header value to access the presigned URL. This parameter is ignored unless HTTPMethod is equal to AWSHTTPMethodPUT. Default is nil.

@property (nonatomic) NSString *contentMD5

Declared In

AWSS3PreSignedURL.h

  requestHeaders

This NSDictionary can contains additional request headers to be included in the pre-signed URL. Default is emtpy.

@property (nonatomic, readonly) NSDictionary<NSString*NSString*> *requestHeaders

Declared In

AWSS3PreSignedURL.h

  requestParameters

This NSDictionary can contains additional request parameters to be included in the pre-signed URL. Adding additional request parameters enables more advanced pre-signed URLs, such as accessing Amazon S3’s torrent resource for an object, or for specifying a version ID when accessing an object. Default is emtpy.

@property (nonatomic, readonly) NSDictionary<NSString*NSString*> *requestParameters

Declared In

AWSS3PreSignedURL.h

– setValue:forRequestHeader:

Set an additional request header to be included in the pre-signed URL.

- (void)setValue:(NSString *_Nullable)value forRequestHeader:(NSString *)requestHeader

Parameters

value

The value of the request parameter being added. Set to nil if parameter doesn’t contains value.

requestHeader

The name of the request header.

Declared In

AWSS3PreSignedURL.h

– setValue:forRequestParameter:

Set an additional request parameter to be included in the pre-signed URL. Adding additional request parameters enables more advanced pre-signed URLs, such as accessing Amazon S3’s torrent resource for an object, or for specifying a version ID when accessing an object.

- (void)setValue:(NSString *_Nullable)value forRequestParameter:(NSString *)requestParameter

Parameters

value

The value of the request parameter being added. Set to nil if parameter doesn’t contains value.

requestParameter

The name of the request parameter, as it appears in the URL’s query string (e.g. AWSS3PresignedURLVersionID).

Declared In

AWSS3PreSignedURL.h