AWSS3GetPreSignedURLRequest

Objective-C

@interface AWSS3GetPreSignedURLRequest : NSObject

Swift

class AWSS3GetPreSignedURLRequest : NSObject

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

See

AWSS3PreSignedURLBuilder

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

    Declaration

    Objective-C

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

    Swift

    var isAccelerateModeEnabled: Bool { get set }

  • The name of the bucket

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull bucket;

    Swift

    var bucket: String { get set }

  • The preferred access style for the bucket. The default is AWSS3BucketAccessStyleVirtualHosted.

    Virtual-hosted-style requests require that the bucket name must be DNS-compliant and must not contain periods (".").

    If virtual-hosted-style access is set as preferred but the bucket name does not meet these conditions, path-style access will be used instead.

    Declaration

    Objective-C

    @property (nonatomic) AWSS3BucketAccessStyle preferredAccessStyle;

    Swift

    var preferredAccessStyle: AWSS3BucketAccessStyle { get set }
  • key

    The name of the S3 object

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull key;

    Swift

    var key: String { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) int HTTPMethod;

    Swift

    var httpMethod: Int32 { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nonnull expires;

    Swift

    var expires: Date { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic) NSTimeInterval minimumCredentialsExpirationInterval;

    Swift

    var minimumCredentialsExpirationInterval: TimeInterval { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic) NSString *_Nullable contentType;

    Swift

    var contentType: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic) NSString *_Nullable contentMD5;

    Swift

    var contentMD5: String? { get set }

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

    Declaration

    Objective-C

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

    Swift

    var requestHeaders: [String : String] { get }

  • 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.

    Declaration

    Objective-C

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

    Swift

    var requestParameters: [String : String] { get }

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

    Declaration

    Objective-C

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

    Swift

    func setValue(_ value: String?, forRequestHeader requestHeader: String)

    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.

  • 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.

    Declaration

    Objective-C

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

    Swift

    func setValue(_ value: String?, forRequestParameter requestParameter: String)

    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).