Class AmazonS3EncryptionClientBase

Namespace

Amazon.Extensions.S3.Encryption

Assembly

Amazon.Extensions.S3.Encryption.dll

Base class for AmazonS3Encryption clients Encapsulates common properties and methods of the encryption clients

public abstract class AmazonS3EncryptionClientBase : AmazonS3Client, IAmazonS3, IDisposable, ICoreAmazonS3, IAmazonService, IAmazonS3Encryption

Inheritance

object

AmazonServiceClient

AmazonS3Client

AmazonS3EncryptionClientBase

Implements

IAmazonS3

IDisposable

ICoreAmazonS3

IAmazonService

IAmazonS3Encryption

Derived

AmazonS3EncryptionClient

AmazonS3EncryptionClientV2

Constructors

AmazonS3EncryptionClientBase(AmazonS3CryptoConfigurationBase, EncryptionMaterialsBase)

Constructs AmazonS3EncryptionClient with the Encryption materials, AmazonS3 CryptoConfiguration object and credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.

Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

public AmazonS3EncryptionClientBase(AmazonS3CryptoConfigurationBase config, EncryptionMaterialsBase materials)

Parameters

config AmazonS3CryptoConfigurationBase

The AmazonS3EncryptionClient CryptoConfiguration Object

materials EncryptionMaterialsBase

The encryption materials to be used to encrypt and decrypt envelope key.

AmazonS3EncryptionClientBase(EncryptionMaterialsBase)

Constructs AmazonS3EncryptionClient with the Encryption materials and credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.

Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

public AmazonS3EncryptionClientBase(EncryptionMaterialsBase materials)

Parameters

materials EncryptionMaterialsBase

The encryption materials to be used to encrypt and decrypt envelope key.

AmazonS3EncryptionClientBase(RegionEndpoint, EncryptionMaterialsBase)

Constructs AmazonS3EncryptionClient with the Encryption materials and credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.

Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

public AmazonS3EncryptionClientBase(RegionEndpoint region, EncryptionMaterialsBase materials)

Parameters

region RegionEndpoint

The region to connect.

materials EncryptionMaterialsBase

The encryption materials to be used to encrypt and decrypt envelope key.

AmazonS3EncryptionClientBase(AWSCredentials, AmazonS3CryptoConfigurationBase, EncryptionMaterialsBase)

Constructs AmazonS3EncryptionClient with AWS Credentials, AmazonS3CryptoConfigurationBase Configuration object and Encryption materials

public AmazonS3EncryptionClientBase(AWSCredentials credentials, AmazonS3CryptoConfigurationBase config, EncryptionMaterialsBase materials)

Parameters

credentials AWSCredentials

AWS Credentials

config AmazonS3CryptoConfigurationBase

The AmazonS3EncryptionClient CryptoConfiguration Object

materials EncryptionMaterialsBase

The encryption materials to be used to encrypt and decrypt envelope key.

AmazonS3EncryptionClientBase(AWSCredentials, EncryptionMaterialsBase)

Constructs AmazonS3EncryptionClient with AWS Credentials and Encryption materials.

public AmazonS3EncryptionClientBase(AWSCredentials credentials, EncryptionMaterialsBase materials)

Parameters

credentials AWSCredentials

AWS Credentials

materials EncryptionMaterialsBase

The encryption materials to be used to encrypt and decrypt envelope key.

AmazonS3EncryptionClientBase(AWSCredentials, RegionEndpoint, EncryptionMaterialsBase)

Constructs AmazonS3EncryptionClient with AWS Credentials, Region and Encryption materials

public AmazonS3EncryptionClientBase(AWSCredentials credentials, RegionEndpoint region, EncryptionMaterialsBase materials)

Parameters

credentials AWSCredentials

AWS Credentials

region RegionEndpoint

The region to connect.

materials EncryptionMaterialsBase

The encryption materials to be used to encrypt and decrypt envelope key.

AmazonS3EncryptionClientBase(string, string, AmazonS3CryptoConfigurationBase, EncryptionMaterialsBase)

Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, AmazonS3 CryptoConfiguration object and Encryption materials.

public AmazonS3EncryptionClientBase(string awsAccessKeyId, string awsSecretAccessKey, AmazonS3CryptoConfigurationBase config, EncryptionMaterialsBase materials)

Parameters

awsAccessKeyId string

AWS Access Key ID

awsSecretAccessKey string

AWS Secret Access Key

config AmazonS3CryptoConfigurationBase

The AmazonS3EncryptionClient CryptoConfiguration Object

materials EncryptionMaterialsBase

The encryption materials to be used to encrypt and decrypt envelope key.

AmazonS3EncryptionClientBase(string, string, EncryptionMaterialsBase)

Constructs AmazonS3EncryptionClient with AWS Access Key ID, AWS Secret Key and Encryption materials

public AmazonS3EncryptionClientBase(string awsAccessKeyId, string awsSecretAccessKey, EncryptionMaterialsBase materials)

Parameters

awsAccessKeyId string

AWS Access Key ID

awsSecretAccessKey string

AWS Secret Access Key

materials EncryptionMaterialsBase

The encryption materials to be used to encrypt and decrypt envelope key.

AmazonS3EncryptionClientBase(string, string, RegionEndpoint, EncryptionMaterialsBase)

Constructs AmazonS3EncryptionClient with AWS Access Key ID, AWS Secret Key, Region and Encryption materials

public AmazonS3EncryptionClientBase(string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region, EncryptionMaterialsBase materials)

Parameters

awsAccessKeyId string

AWS Access Key ID

awsSecretAccessKey string

AWS Secret Access Key

region RegionEndpoint

The region to connect.

materials EncryptionMaterialsBase

The encryption materials to be used to encrypt and decrypt envelope key.

AmazonS3EncryptionClientBase(string, string, string, AmazonS3CryptoConfigurationBase, EncryptionMaterialsBase)

Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, SessionToken AmazonS3EncryptionClient CryptoConfiguration object and Encryption materials.

public AmazonS3EncryptionClientBase(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonS3CryptoConfigurationBase config, EncryptionMaterialsBase materials)

Parameters

awsAccessKeyId string

AWS Access Key ID

awsSecretAccessKey string

AWS Secret Access Key

awsSessionToken string

AWS Session Token

config AmazonS3CryptoConfigurationBase

The AmazonS3EncryptionClient CryptoConfiguration Object

materials EncryptionMaterialsBase

The encryption materials to be used to encrypt and decrypt envelope key.

AmazonS3EncryptionClientBase(string, string, string, EncryptionMaterialsBase)

Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, SessionToken and Encryption materials.

public AmazonS3EncryptionClientBase(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, EncryptionMaterialsBase materials)

Parameters

awsAccessKeyId string

AWS Access Key ID

awsSecretAccessKey string

AWS Secret Access Key

awsSessionToken string

AWS Session Token

materials EncryptionMaterialsBase

The encryption materials to be used to encrypt and decrypt envelope key.

AmazonS3EncryptionClientBase(string, string, string, RegionEndpoint, EncryptionMaterialsBase)

Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, SessionToken, Region and Encryption materials.

public AmazonS3EncryptionClientBase(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region, EncryptionMaterialsBase materials)

Parameters

awsAccessKeyId string

AWS Access Key ID

awsSecretAccessKey string

AWS Secret Access Key

awsSessionToken string

AWS Session Token

region RegionEndpoint

The region to connect.

materials EncryptionMaterialsBase

The encryption materials to be used to encrypt and decrypt envelope key.

Properties

SupportResponseLogging

Turn off response logging because it will interfere with decrypt of the data coming back from S3.

protected override bool SupportResponseLogging { get; }

Property Value

bool

Methods

Dispose(bool)

Dispose this instance

protected override void Dispose(bool disposing)

Parameters

disposing bool