Public Member Functions | Private Attributes | List of all members
Aws::S3::S3Facade Class Reference

#include <s3_facade.h>

Inheritance diagram for Aws::S3::S3Facade:
Inheritance graph
[legend]

Public Member Functions

S3Facadeoperator= (const S3Facade &other)=delete
 
virtual Model::PutObjectOutcome PutObject (const std::string &file_path, const std::string &bucket, const std::string &key)
 Call s3 PutObject api to upload file to s3. More...
 
 S3Facade (const bool enable_encryption)
 
 S3Facade (const bool enable_encryption, const Aws::Client::ClientConfiguration &config)
 
 S3Facade (const bool enable_encryption, std::unique_ptr< Aws::S3::S3Client > s3_client)
 
 S3Facade (const S3Facade &other)=delete
 
virtual ~S3Facade ()=default
 

Private Attributes

Aws::Client::ClientConfiguration config_
 
const bool enable_encryption_
 
std::unique_ptr< Aws::S3::S3Client > s3_client_
 

Detailed Description

Definition at line 25 of file s3_facade.h.

Constructor & Destructor Documentation

Aws::S3::S3Facade::S3Facade ( const bool  enable_encryption)
explicit

Creates a facade and an S3Client with a default ClientConfig

Parameters
enable_encryptionwhether or not to enable AES256 server-side encryption

Definition at line 32 of file s3_facade.cpp.

Aws::S3::S3Facade::S3Facade ( const bool  enable_encryption,
const Aws::Client::ClientConfiguration &  config 
)
explicit

Creates a facade and an S3Client with the provided ClientConfiguration

Parameters
enable_encryptionwhether or not to enable AES256 server-side encryption
configthe ClientConfiguration to be used

Definition at line 37 of file s3_facade.cpp.

Aws::S3::S3Facade::S3Facade ( const bool  enable_encryption,
std::unique_ptr< Aws::S3::S3Client >  s3_client 
)
explicit

Creates a facade with an existing S3Client

Parameters
enable_encryptionwhether or not to enable AES256 server-side encryption
s3_clientthe existing S3Client to be used
virtual Aws::S3::S3Facade::~S3Facade ( )
virtualdefault
Aws::S3::S3Facade::S3Facade ( const S3Facade other)
delete

Member Function Documentation

S3Facade& Aws::S3::S3Facade::operator= ( const S3Facade other)
delete
Model::PutObjectOutcome Aws::S3::S3Facade::PutObject ( const std::string &  file_path,
const std::string &  bucket,
const std::string &  key 
)
virtual

Call s3 PutObject api to upload file to s3.

Synchronous call to S3. Uploads file at file_path to s3.

Parameters
file_pathpath to the file to upload
bucketthe s3 bucket for upload
keyobject key for upload
Returns
S3 PutObjectOutcome describing result of upload,

Definition at line 47 of file s3_facade.cpp.

Member Data Documentation

Aws::Client::ClientConfiguration Aws::S3::S3Facade::config_
private

Definition at line 69 of file s3_facade.h.

const bool Aws::S3::S3Facade::enable_encryption_
private

Definition at line 71 of file s3_facade.h.

std::unique_ptr<Aws::S3::S3Client> Aws::S3::S3Facade::s3_client_
private

Definition at line 70 of file s3_facade.h.


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


s3_common
Author(s): AWS RoboMaker
autogenerated on Tue Jun 1 2021 02:51:29