Aws::Client::AWSUrlPresigner Class Reference

#include <AWSUrlPresigner.h>

Public Member Functions

 AWSUrlPresigner (const AWSClient &client)

 

virtual ~AWSUrlPresigner ()

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *regionOverride, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *regionOverride, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *regionOverride, const char *serviceNameOverride, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *regionOverride, const char *serviceNameOverride, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *regionOverride, const char *serviceNameOverride, const char *signerName, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *regionOverride, const char *serviceNameOverride, const char *signerName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::Endpoint::AWSEndpoint &endpoint, Aws::Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const Aws::Http::HeaderValueCollection &customizedHeaders={}, uint64_t expirationInSeconds=0, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *regionOverride, const char *serviceNameOverride, const char *signerName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *regionOverride, const char *serviceNameOverride, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *regionOverride, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Protected Member Functions

Aws::Client::AWSAuthSigner * GetSignerByName (const char *name) const

 

Protected Attributes

const AWSClient & m_awsClient

 

Friends

class AWSClient

 

Detailed Description

Helper class to generate pre-signed AWS URLs.

Definition at line 23 of file AWSUrlPresigner.h.

Constructor & Destructor Documentation

AWSUrlPresigner()

Aws::Client::AWSUrlPresigner::AWSUrlPresigner ( const AWSClient &  client)

~AWSUrlPresigner()

virtual Aws::Client::AWSUrlPresigner::~AWSUrlPresigner ( )

inlinevirtual

Definition at line 28 of file AWSUrlPresigner.h.

Member Function Documentation

GeneratePresignedUrl() [1/13]

Aws::String Aws::Client::AWSUrlPresigner::GeneratePresignedUrl ( const Aws::AmazonWebServiceRequest &  request,

const Aws::Http::URI &  uri,

Aws::Http::HttpMethod  method,

const Aws::Http::QueryStringParameterCollection &  extraParams = Aws::Http::QueryStringParameterCollection(),

long long  expirationInSeconds = 0,

const std::shared_ptr< Aws::Http::ServiceSpecificParameters >  serviceSpecificParameter = {} 

) const

Generates a signed Uri for a supplied request and uri.

GeneratePresignedUrl() [2/13]

Aws::String Aws::Client::AWSUrlPresigner::GeneratePresignedUrl ( const Aws::AmazonWebServiceRequest &  request,

const Aws::Http::URI &  uri,

Aws::Http::HttpMethod  method,

const char *  regionOverride,

const Aws::Http::QueryStringParameterCollection &  extraParams = Aws::Http::QueryStringParameterCollection(),

long long  expirationInSeconds = 0,

const std::shared_ptr< Aws::Http::ServiceSpecificParameters >  serviceSpecificParameter = {} 

) const

Generates a signed Uri for a supplied request and uri.

GeneratePresignedUrl() [3/13]

Aws::String Aws::Client::AWSUrlPresigner::GeneratePresignedUrl ( const Aws::AmazonWebServiceRequest &  request,

const Aws::Http::URI &  uri,

Aws::Http::HttpMethod  method,

const char *  regionOverride,

const char *  serviceNameOverride,

const Aws::Http::QueryStringParameterCollection &  extraParams = Aws::Http::QueryStringParameterCollection(),

long long  expirationInSeconds = 0,

const std::shared_ptr< Aws::Http::ServiceSpecificParameters >  serviceSpecificParameter = {} 

) const

Generates a signed Uri for a supplied request and uri.

GeneratePresignedUrl() [4/13]

Aws::String Aws::Client::AWSUrlPresigner::GeneratePresignedUrl ( const Aws::AmazonWebServiceRequest &  request,

const Aws::Http::URI &  uri,

Aws::Http::HttpMethod  method,

const char *  regionOverride,

const char *  serviceNameOverride,

const char *  signerName,

const Aws::Http::QueryStringParameterCollection &  extraParams = Aws::Http::QueryStringParameterCollection(),

long long  expirationInSeconds = 0,

const std::shared_ptr< Aws::Http::ServiceSpecificParameters >  serviceSpecificParameter = {} 

) const

Generates a signed Uri using the injected signer. for the supplied request object, uri, http method, region, service name, signer name, and customized headers. expirationInSeconds defaults to 0 which is the default 7 days.

This is a real method for request+uri pre-signing, the rest are just overloads.

GeneratePresignedUrl() [5/13]

Aws::String Aws::Client::AWSUrlPresigner::GeneratePresignedUrl ( const Aws::Endpoint::AWSEndpoint &  endpoint,

Aws::Http::HttpMethod  method = Http::HttpMethod::HTTP_POST,

const Aws::Http::HeaderValueCollection &  customizedHeaders = {},

uint64_t  expirationInSeconds = 0,

const char *  signerName = Aws::Auth::SIGV4_SIGNER,

const char *  signerRegionOverride = nullptr,

const char *  signerServiceNameOverride = nullptr,

const std::shared_ptr< Aws::Http::ServiceSpecificParameters >  serviceSpecificParameter = {} 

) const

Generates a signed Uri for a supplied AWSEndpoint.

GeneratePresignedUrl() [6/13]

Aws::String Aws::Client::AWSUrlPresigner::GeneratePresignedUrl ( const Aws::Http::URI &  uri,

Aws::Http::HttpMethod  method,

const Aws::Http::HeaderValueCollection &  customizedHeaders,

long long  expirationInSeconds = 0,

const std::shared_ptr< Aws::Http::ServiceSpecificParameters >  serviceSpecificParameter = {} 

) const

Generates a signed Uri using the injected signer, for the supplied uri, http method, and customized headers. expirationInSeconds defaults to 0 which is the default 7 days. The implication of this function is using auth signer v4 to sign it.

GeneratePresignedUrl() [7/13]

Aws::String Aws::Client::AWSUrlPresigner::GeneratePresignedUrl ( const Aws::Http::URI &  uri,

Aws::Http::HttpMethod  method,

const char *  regionOverride,

const Aws::Http::HeaderValueCollection &  customizedHeaders,

long long  expirationInSeconds = 0,

const std::shared_ptr< Aws::Http::ServiceSpecificParameters >  serviceSpecificParameter = {} 

) const

Generates a signed Uri using the injected signer, for the supplied uri, http method, and customized headers. expirationInSeconds defaults to 0 which is the default 7 days.

GeneratePresignedUrl() [8/13]

Aws::String Aws::Client::AWSUrlPresigner::GeneratePresignedUrl ( const Aws::Http::URI &  uri,

Aws::Http::HttpMethod  method,

const char *  regionOverride,

const char *  serviceNameOverride,

const Aws::Http::HeaderValueCollection &  customizedHeaders,

long long  expirationInSeconds = 0,

const std::shared_ptr< Aws::Http::ServiceSpecificParameters >  serviceSpecificParameter = {} 

) const

Generates a signed Uri using the injected signer, for the supplied uri, http method, and customized headers. expirationInSeconds defaults to 0 which is the default 7 days.

GeneratePresignedUrl() [9/13]

Aws::String Aws::Client::AWSUrlPresigner::GeneratePresignedUrl ( const Aws::Http::URI &  uri,

Aws::Http::HttpMethod  method,

const char *  regionOverride,

const char *  serviceNameOverride,

const char *  signerName,

const Aws::Http::HeaderValueCollection &  customizedHeaders,

long long  expirationInSeconds = 0,

const std::shared_ptr< Aws::Http::ServiceSpecificParameters >  serviceSpecificParameter = {} 

) const

Generates a signed Uri using the injected signer, for the supplied uri, http method, region, service name, signer name, and customized headers. expirationInSeconds defaults to 0 which is the default 7 days.

This is a real method for uri pre-signing, the rest are just overloads.

GeneratePresignedUrl() [10/13]

Aws::String Aws::Client::AWSUrlPresigner::GeneratePresignedUrl ( const Aws::Http::URI &  uri,

Aws::Http::HttpMethod  method,

const char *  regionOverride,

const char *  serviceNameOverride,

const char *  signerName,

long long  expirationInSeconds = 0,

const std::shared_ptr< Aws::Http::ServiceSpecificParameters >  serviceSpecificParameter = {} 

) const

Generates a signed Uri using the injected signer, for the supplied uri, http method, region, service name, and signer name. expirationInSeconds defaults to 0 which is the default 7 days.

GeneratePresignedUrl() [11/13]

Aws::String Aws::Client::AWSUrlPresigner::GeneratePresignedUrl ( const Aws::Http::URI &  uri,

Aws::Http::HttpMethod  method,

const char *  regionOverride,

const char *  serviceNameOverride,

long long  expirationInSeconds = 0,

const std::shared_ptr< Aws::Http::ServiceSpecificParameters >  serviceSpecificParameter = {} 

) const

Generates a signed Uri using the injected signer, for the supplied uri, http method, region, and service name. expirationInSeconds defaults to 0 which is the default 7 days.

GeneratePresignedUrl() [12/13]

Aws::String Aws::Client::AWSUrlPresigner::GeneratePresignedUrl ( const Aws::Http::URI &  uri,

Aws::Http::HttpMethod  method,

const char *  regionOverride,

long long  expirationInSeconds = 0,

const std::shared_ptr< Aws::Http::ServiceSpecificParameters >  serviceSpecificParameter = {} 

) const

Generates a signed Uri using the injected signer, for the supplied uri, http method, and region. expirationInSeconds defaults to 0 which is the default 7 days.

GeneratePresignedUrl() [13/13]

Aws::String Aws::Client::AWSUrlPresigner::GeneratePresignedUrl ( const Aws::Http::URI &  uri,

Aws::Http::HttpMethod  method,

long long  expirationInSeconds = 0,

const std::shared_ptr< Aws::Http::ServiceSpecificParameters >  serviceSpecificParameter = {} 

) const

Generates a signed Uri using the injected signer, for the supplied uri and http method. expirationInSeconds defaults to 0 which is the default 7 days. The implication of this function is using auth signer v4 to sign it.

GetSignerByName()

Aws::Client::AWSAuthSigner * Aws::Client::AWSUrlPresigner::GetSignerByName ( const char *  name) const

protected

Friends And Related Symbol Documentation

AWSClient

friend class AWSClient

friend

Definition at line 184 of file AWSUrlPresigner.h.

Member Data Documentation

m_awsClient

const AWSClient& Aws::Client::AWSUrlPresigner::m_awsClient

protected

Definition at line 182 of file AWSUrlPresigner.h.

---

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

• src/aws-cpp-sdk-core/include/aws/core/client/AWSUrlPresigner.h