Class AmazonS3EncryptionClient

Namespace

Amazon.S3.Encryption

Assembly

AWSSDK.S3.dll

This class extends the AmazonS3Client and provides client side encryption when reading or writing S3 objects.

[Obsolete("This feature is in maintenance mode, no new updates will be released. Please transition to https://www.nuget.org/packages/Amazon.Extensions.S3.Encryption and see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.")]
public class AmazonS3EncryptionClient : AmazonS3Client, IAmazonS3, IDisposable, ICoreAmazonS3, IAmazonService, IAmazonS3Encryption

Inheritance

object

AmazonS3Client

AmazonS3EncryptionClient

Implements

IAmazonS3

IDisposable

ICoreAmazonS3

IAmazonService

IAmazonS3Encryption

Inherited Members

AmazonS3Client.Initialize()

AmazonS3Client.GetPreSignedURL(GetPreSignedUrlRequest)

AmazonS3Client.CreateSigner()

AmazonS3Client.AbortMultipartUploadAsync(string, string, string, CancellationToken)

AmazonS3Client.AbortMultipartUploadAsync(AbortMultipartUploadRequest, CancellationToken)

AmazonS3Client.CompleteMultipartUploadAsync(CompleteMultipartUploadRequest, CancellationToken)

AmazonS3Client.CopyObjectAsync(string, string, string, string, CancellationToken)

AmazonS3Client.CopyObjectAsync(string, string, string, string, string, CancellationToken)

AmazonS3Client.CopyObjectAsync(CopyObjectRequest, CancellationToken)

AmazonS3Client.CopyPartAsync(string, string, string, string, string, CancellationToken)

AmazonS3Client.CopyPartAsync(string, string, string, string, string, string, CancellationToken)

AmazonS3Client.CopyPartAsync(CopyPartRequest, CancellationToken)

AmazonS3Client.DeleteBucketAsync(string, CancellationToken)

AmazonS3Client.DeleteBucketAsync(DeleteBucketRequest, CancellationToken)

AmazonS3Client.DeleteBucketAnalyticsConfigurationAsync(DeleteBucketAnalyticsConfigurationRequest, CancellationToken)

AmazonS3Client.DeleteBucketEncryptionAsync(DeleteBucketEncryptionRequest, CancellationToken)

AmazonS3Client.DeleteBucketInventoryConfigurationAsync(DeleteBucketInventoryConfigurationRequest, CancellationToken)

AmazonS3Client.DeleteBucketMetricsConfigurationAsync(DeleteBucketMetricsConfigurationRequest, CancellationToken)

AmazonS3Client.DeleteBucketOwnershipControlsAsync(DeleteBucketOwnershipControlsRequest, CancellationToken)

AmazonS3Client.DeleteBucketPolicyAsync(string, CancellationToken)

AmazonS3Client.DeleteBucketPolicyAsync(DeleteBucketPolicyRequest, CancellationToken)

AmazonS3Client.DeleteBucketReplicationAsync(DeleteBucketReplicationRequest, CancellationToken)

AmazonS3Client.DeleteBucketTaggingAsync(string, CancellationToken)

AmazonS3Client.DeleteBucketTaggingAsync(DeleteBucketTaggingRequest, CancellationToken)

AmazonS3Client.DeleteBucketWebsiteAsync(string, CancellationToken)

AmazonS3Client.DeleteBucketWebsiteAsync(DeleteBucketWebsiteRequest, CancellationToken)

AmazonS3Client.DeleteCORSConfigurationAsync(string, CancellationToken)

AmazonS3Client.DeleteCORSConfigurationAsync(DeleteCORSConfigurationRequest, CancellationToken)

AmazonS3Client.DeleteLifecycleConfigurationAsync(string, CancellationToken)

AmazonS3Client.DeleteLifecycleConfigurationAsync(DeleteLifecycleConfigurationRequest, CancellationToken)

AmazonS3Client.DeleteObjectAsync(string, string, CancellationToken)

AmazonS3Client.DeleteObjectAsync(string, string, string, CancellationToken)

AmazonS3Client.DeleteObjectAsync(DeleteObjectRequest, CancellationToken)

AmazonS3Client.DeleteObjectsAsync(DeleteObjectsRequest, CancellationToken)

AmazonS3Client.DeleteObjectTaggingAsync(DeleteObjectTaggingRequest, CancellationToken)

AmazonS3Client.DeletePublicAccessBlockAsync(DeletePublicAccessBlockRequest, CancellationToken)

AmazonS3Client.GetACLAsync(string, CancellationToken)

AmazonS3Client.GetACLAsync(GetACLRequest, CancellationToken)

AmazonS3Client.GetBucketAccelerateConfigurationAsync(string, CancellationToken)

AmazonS3Client.GetBucketAccelerateConfigurationAsync(GetBucketAccelerateConfigurationRequest, CancellationToken)

AmazonS3Client.GetBucketAnalyticsConfigurationAsync(GetBucketAnalyticsConfigurationRequest, CancellationToken)

AmazonS3Client.GetBucketEncryptionAsync(GetBucketEncryptionRequest, CancellationToken)

AmazonS3Client.GetBucketInventoryConfigurationAsync(GetBucketInventoryConfigurationRequest, CancellationToken)

AmazonS3Client.GetBucketLocationAsync(string, CancellationToken)

AmazonS3Client.GetBucketLocationAsync(GetBucketLocationRequest, CancellationToken)

AmazonS3Client.GetBucketLoggingAsync(string, CancellationToken)

AmazonS3Client.GetBucketLoggingAsync(GetBucketLoggingRequest, CancellationToken)

AmazonS3Client.GetBucketMetricsConfigurationAsync(GetBucketMetricsConfigurationRequest, CancellationToken)

AmazonS3Client.GetBucketNotificationAsync(string, CancellationToken)

AmazonS3Client.GetBucketNotificationAsync(GetBucketNotificationRequest, CancellationToken)

AmazonS3Client.GetBucketOwnershipControlsAsync(GetBucketOwnershipControlsRequest, CancellationToken)

AmazonS3Client.GetBucketPolicyAsync(string, CancellationToken)

AmazonS3Client.GetBucketPolicyAsync(GetBucketPolicyRequest, CancellationToken)

AmazonS3Client.GetBucketPolicyStatusAsync(GetBucketPolicyStatusRequest, CancellationToken)

AmazonS3Client.GetBucketReplicationAsync(GetBucketReplicationRequest, CancellationToken)

AmazonS3Client.GetBucketRequestPaymentAsync(string, CancellationToken)

AmazonS3Client.GetBucketRequestPaymentAsync(GetBucketRequestPaymentRequest, CancellationToken)

AmazonS3Client.GetBucketTaggingAsync(GetBucketTaggingRequest, CancellationToken)

AmazonS3Client.GetBucketVersioningAsync(string, CancellationToken)

AmazonS3Client.GetBucketVersioningAsync(GetBucketVersioningRequest, CancellationToken)

AmazonS3Client.GetBucketWebsiteAsync(string, CancellationToken)

AmazonS3Client.GetBucketWebsiteAsync(GetBucketWebsiteRequest, CancellationToken)

AmazonS3Client.GetCORSConfigurationAsync(string, CancellationToken)

AmazonS3Client.GetCORSConfigurationAsync(GetCORSConfigurationRequest, CancellationToken)

AmazonS3Client.GetLifecycleConfigurationAsync(string, CancellationToken)

AmazonS3Client.GetLifecycleConfigurationAsync(GetLifecycleConfigurationRequest, CancellationToken)

AmazonS3Client.GetObjectAsync(string, string, CancellationToken)

AmazonS3Client.GetObjectAsync(string, string, string, CancellationToken)

AmazonS3Client.GetObjectAsync(GetObjectRequest, CancellationToken)

AmazonS3Client.GetObjectLegalHoldAsync(GetObjectLegalHoldRequest, CancellationToken)

AmazonS3Client.GetObjectLockConfigurationAsync(GetObjectLockConfigurationRequest, CancellationToken)

AmazonS3Client.GetObjectMetadataAsync(string, string, CancellationToken)

AmazonS3Client.GetObjectMetadataAsync(string, string, string, CancellationToken)

AmazonS3Client.GetObjectMetadataAsync(GetObjectMetadataRequest, CancellationToken)

AmazonS3Client.GetObjectRetentionAsync(GetObjectRetentionRequest, CancellationToken)

AmazonS3Client.GetObjectTaggingAsync(GetObjectTaggingRequest, CancellationToken)

AmazonS3Client.GetObjectTorrentAsync(string, string, CancellationToken)

AmazonS3Client.GetObjectTorrentAsync(GetObjectTorrentRequest, CancellationToken)

AmazonS3Client.GetPublicAccessBlockAsync(GetPublicAccessBlockRequest, CancellationToken)

AmazonS3Client.InitiateMultipartUploadAsync(string, string, CancellationToken)

AmazonS3Client.InitiateMultipartUploadAsync(InitiateMultipartUploadRequest, CancellationToken)

AmazonS3Client.ListBucketAnalyticsConfigurationsAsync(ListBucketAnalyticsConfigurationsRequest, CancellationToken)

AmazonS3Client.ListBucketInventoryConfigurationsAsync(ListBucketInventoryConfigurationsRequest, CancellationToken)

AmazonS3Client.ListBucketMetricsConfigurationsAsync(ListBucketMetricsConfigurationsRequest, CancellationToken)

AmazonS3Client.ListBucketsAsync(CancellationToken)

AmazonS3Client.ListBucketsAsync(ListBucketsRequest, CancellationToken)

AmazonS3Client.ListMultipartUploadsAsync(string, CancellationToken)

AmazonS3Client.ListMultipartUploadsAsync(string, string, CancellationToken)

AmazonS3Client.ListMultipartUploadsAsync(ListMultipartUploadsRequest, CancellationToken)

AmazonS3Client.ListObjectsAsync(string, CancellationToken)

AmazonS3Client.ListObjectsAsync(string, string, CancellationToken)

AmazonS3Client.ListObjectsAsync(ListObjectsRequest, CancellationToken)

AmazonS3Client.ListObjectsV2Async(ListObjectsV2Request, CancellationToken)

AmazonS3Client.ListPartsAsync(string, string, string, CancellationToken)

AmazonS3Client.ListPartsAsync(ListPartsRequest, CancellationToken)

AmazonS3Client.ListVersionsAsync(string, CancellationToken)

AmazonS3Client.ListVersionsAsync(string, string, CancellationToken)

AmazonS3Client.ListVersionsAsync(ListVersionsRequest, CancellationToken)

AmazonS3Client.PutACLAsync(PutACLRequest, CancellationToken)

AmazonS3Client.PutBucketAsync(string, CancellationToken)

AmazonS3Client.PutBucketAsync(PutBucketRequest, CancellationToken)

AmazonS3Client.PutBucketAccelerateConfigurationAsync(PutBucketAccelerateConfigurationRequest, CancellationToken)

AmazonS3Client.PutBucketAnalyticsConfigurationAsync(PutBucketAnalyticsConfigurationRequest, CancellationToken)

AmazonS3Client.PutBucketEncryptionAsync(PutBucketEncryptionRequest, CancellationToken)

AmazonS3Client.PutBucketInventoryConfigurationAsync(PutBucketInventoryConfigurationRequest, CancellationToken)

AmazonS3Client.PutBucketLoggingAsync(PutBucketLoggingRequest, CancellationToken)

AmazonS3Client.PutBucketMetricsConfigurationAsync(PutBucketMetricsConfigurationRequest, CancellationToken)

AmazonS3Client.PutBucketNotificationAsync(PutBucketNotificationRequest, CancellationToken)

AmazonS3Client.PutBucketOwnershipControlsAsync(PutBucketOwnershipControlsRequest, CancellationToken)

AmazonS3Client.PutBucketPolicyAsync(string, string, CancellationToken)

AmazonS3Client.PutBucketPolicyAsync(string, string, string, CancellationToken)

AmazonS3Client.PutBucketPolicyAsync(PutBucketPolicyRequest, CancellationToken)

AmazonS3Client.PutBucketReplicationAsync(PutBucketReplicationRequest, CancellationToken)

AmazonS3Client.PutBucketRequestPaymentAsync(string, RequestPaymentConfiguration, CancellationToken)

AmazonS3Client.PutBucketRequestPaymentAsync(PutBucketRequestPaymentRequest, CancellationToken)

AmazonS3Client.PutBucketTaggingAsync(string, List<Tag>, CancellationToken)

AmazonS3Client.PutBucketTaggingAsync(PutBucketTaggingRequest, CancellationToken)

AmazonS3Client.PutBucketVersioningAsync(PutBucketVersioningRequest, CancellationToken)

AmazonS3Client.PutBucketWebsiteAsync(string, WebsiteConfiguration, CancellationToken)

AmazonS3Client.PutBucketWebsiteAsync(PutBucketWebsiteRequest, CancellationToken)

AmazonS3Client.PutCORSConfigurationAsync(string, CORSConfiguration, CancellationToken)

AmazonS3Client.PutCORSConfigurationAsync(PutCORSConfigurationRequest, CancellationToken)

AmazonS3Client.PutLifecycleConfigurationAsync(string, LifecycleConfiguration, CancellationToken)

AmazonS3Client.PutLifecycleConfigurationAsync(PutLifecycleConfigurationRequest, CancellationToken)

AmazonS3Client.PutObjectAsync(PutObjectRequest, CancellationToken)

AmazonS3Client.PutObjectLegalHoldAsync(PutObjectLegalHoldRequest, CancellationToken)

AmazonS3Client.PutObjectLockConfigurationAsync(PutObjectLockConfigurationRequest, CancellationToken)

AmazonS3Client.PutObjectRetentionAsync(PutObjectRetentionRequest, CancellationToken)

AmazonS3Client.PutObjectTaggingAsync(PutObjectTaggingRequest, CancellationToken)

AmazonS3Client.PutPublicAccessBlockAsync(PutPublicAccessBlockRequest, CancellationToken)

AmazonS3Client.RestoreObjectAsync(string, string, CancellationToken)

AmazonS3Client.RestoreObjectAsync(string, string, int, CancellationToken)

AmazonS3Client.RestoreObjectAsync(string, string, string, CancellationToken)

AmazonS3Client.RestoreObjectAsync(string, string, string, int, CancellationToken)

AmazonS3Client.RestoreObjectAsync(RestoreObjectRequest, CancellationToken)

AmazonS3Client.SelectObjectContentAsync(SelectObjectContentRequest, CancellationToken)

AmazonS3Client.UploadPartAsync(UploadPartRequest, CancellationToken)

AmazonS3Client.Paginators

AmazonS3Client.ServiceMetadata

Constructors

AmazonS3EncryptionClient(RegionEndpoint, EncryptionMaterials)

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 AmazonS3EncryptionClient(RegionEndpoint region, EncryptionMaterials materials)

Parameters

region RegionEndpoint

The region to connect.

materials EncryptionMaterials

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

AmazonS3EncryptionClient(AWSCredentials, RegionEndpoint, EncryptionMaterials)

Constructs AmazonS3EncryptionClient with AWS Credentials, Region and Encryption materials

public AmazonS3EncryptionClient(AWSCredentials credentials, RegionEndpoint region, EncryptionMaterials materials)

Parameters

credentials AWSCredentials

AWS Credentials

region RegionEndpoint

The region to connect.

materials EncryptionMaterials

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

AmazonS3EncryptionClient(AWSCredentials, AmazonS3CryptoConfiguration, EncryptionMaterials)

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

public AmazonS3EncryptionClient(AWSCredentials credentials, AmazonS3CryptoConfiguration config, EncryptionMaterials materials)

Parameters

credentials AWSCredentials

AWS Credentials

config AmazonS3CryptoConfiguration

The AmazonS3EncryptionClient CryptoConfiguration Object

materials EncryptionMaterials

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

AmazonS3EncryptionClient(AWSCredentials, EncryptionMaterials)

Constructs AmazonS3EncryptionClient with AWS Credentials and Encryption materials.

public AmazonS3EncryptionClient(AWSCredentials credentials, EncryptionMaterials materials)

Parameters

credentials AWSCredentials

AWS Credentials

materials EncryptionMaterials

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

AmazonS3EncryptionClient(AmazonS3CryptoConfiguration, EncryptionMaterials)

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 AmazonS3EncryptionClient(AmazonS3CryptoConfiguration config, EncryptionMaterials materials)

Parameters

config AmazonS3CryptoConfiguration

The AmazonS3EncryptionClient CryptoConfiguration Object

materials EncryptionMaterials

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

AmazonS3EncryptionClient(EncryptionMaterials)

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 AmazonS3EncryptionClient(EncryptionMaterials materials)

Parameters

materials EncryptionMaterials

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

AmazonS3EncryptionClient(string, string, RegionEndpoint, EncryptionMaterials)

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

public AmazonS3EncryptionClient(string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region, EncryptionMaterials materials)

Parameters

awsAccessKeyId string

AWS Access Key ID

awsSecretAccessKey string

AWS Secret Access Key

region RegionEndpoint

The region to connect.

materials EncryptionMaterials

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

AmazonS3EncryptionClient(string, string, AmazonS3CryptoConfiguration, EncryptionMaterials)

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

public AmazonS3EncryptionClient(string awsAccessKeyId, string awsSecretAccessKey, AmazonS3CryptoConfiguration config, EncryptionMaterials materials)

Parameters

awsAccessKeyId string

AWS Access Key ID

awsSecretAccessKey string

AWS Secret Access Key

config AmazonS3CryptoConfiguration

The AmazonS3EncryptionClient CryptoConfiguration Object

materials EncryptionMaterials

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

AmazonS3EncryptionClient(string, string, EncryptionMaterials)

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

public AmazonS3EncryptionClient(string awsAccessKeyId, string awsSecretAccessKey, EncryptionMaterials materials)

Parameters

awsAccessKeyId string

AWS Access Key ID

awsSecretAccessKey string

AWS Secret Access Key

materials EncryptionMaterials

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

AmazonS3EncryptionClient(string, string, string, RegionEndpoint, EncryptionMaterials)

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

public AmazonS3EncryptionClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region, EncryptionMaterials 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 EncryptionMaterials

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

AmazonS3EncryptionClient(string, string, string, AmazonS3CryptoConfiguration, EncryptionMaterials)

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

public AmazonS3EncryptionClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonS3CryptoConfiguration config, EncryptionMaterials materials)

Parameters

awsAccessKeyId string

AWS Access Key ID

awsSecretAccessKey string

AWS Secret Access Key

awsSessionToken string

AWS Session Token

config AmazonS3CryptoConfiguration

The AmazonS3EncryptionClient CryptoConfiguration Object

materials EncryptionMaterials

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

AmazonS3EncryptionClient(string, string, string, EncryptionMaterials)

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

public AmazonS3EncryptionClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, EncryptionMaterials materials)

Parameters

awsAccessKeyId string

AWS Access Key ID

awsSecretAccessKey string

AWS Secret Access Key

awsSessionToken string

AWS Session Token

materials EncryptionMaterials

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

CustomizeRuntimePipeline(RuntimePipeline)

Customize the pipeline to allow encryption.

protected override void CustomizeRuntimePipeline(RuntimePipeline pipeline)

Parameters

pipeline RuntimePipeline

Dispose(bool)

Dispose this instance

protected override void Dispose(bool disposing)

Parameters

disposing bool