This project seems not useful on 2025. Archived.

Amazon S3 Content Synchronization with .NET.

S3Sync synchronize a directory to a S3 Bucket. It meakes bucket identical to the LocalRoot (source).

Note: Remote files that are not in the LocalRoot are removed.

You can download latest version from Release Page.

You can pass parameter to S3Sync with Arguments or Environment Variable.

You can use dotnet to run as .NETCore.

$ dotnet S3Sync.dll BucketName=your-awesome-bucket LocalRoot=/Home/User/HogeMoge ExcludeFiles=.gitignore,.gitattributes ExcludeDirectories=.git,test

No .NETCore? You can use Full.NET as a ConsoleApp.

S3Sync.exe BucketName=your-fantastic-bucket KeyPrefix=hoge LocalRoot=C:/Users/User/HomeMoge DryRun=false

You can run with docker.

Run with IAM Role is recommended.

docker run --rm -v <YOUR_SYNC_DIR>:/app/sync/ -e S3Sync_BucketName=<YOUR_BUCKET_NAME> S3Sync_DryRun=false guitarrapc/s3sync

Local run without IAM Role, use AWS Credentials.

$ docker run --rm -v <YOUR_SYNC_DIR>:/app/sync/ -e S3Sync_BucketName=<YOUR_BUCKET_NAME> -e AWS_ACCESS_KEY_ID=<YOUR_ACCESS_KEY> -e AWS_SECRET_ACCESS_KEY=<YOUR_SECRET> S3Sync_DryRun=false guitarrapc/s3sync

Build S3Sync with docker-compose. This enable you not to think about .NETCore2.0 sdk installed on your host.

docker-compose -f docker-compose.ci.build.yml up

Build artifacts will be generated in following path.

S3Sync\source\S3Sync\obj\Docker\publish

Clean up build docker container resource with down.

docker-compose -f docker-compose.ci.build.yml down

Create docker image with docker-compose.

docker-compose -f docker-compose.yml build

Synchronization operation requires read, write and delete objects permission.

It is recommended that you use IAM Policy and Profile to handle appropriate access right.

Here's some sample IAM Policy.

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "Stmt1446117060000",
            "Effect": "Allow",
            "Action": [
                "s3:GetObject",
                "s3:ListAllMyBuckets",
                "s3:ListBucket",
                "s3:PutObject"
            ],
            "Resource": [
                "arn:aws:s3:::*"
            ]
        }
    ]
}

If you want to restrict access to certain Bucket, then replace * with desired bucketName.

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "Stmt1446117060000",
            "Effect": "Allow",
            "Action": [
                "s3:GetObject",
                "s3:ListAllMyBuckets",
                "s3:ListBucket",
                "s3:PutObject"
            ],
            "Resource": [
                "arn:aws:s3:::PutYourBucketName"
            ]
        }
    ]
}

There are several way to set profile.

If you run S3Sync on AWS Resource, you should AWS managed profile like IAM Instance Profile. If you run S3Sync on Local Environment, you can configure your machine with "aws cli" or otheres.

You can create AWS Credential Profile with AWS CLI.

aws configure --profile sample

You can create Profile with other tools.

• AWS Toolkit for Visual Studio .
• AWS Tools for Windows PowerShell

Or you can use following method.

public static void RegisterProfile(string profileName, string accessKey, string accessSecret)
{
    var option = new CredentialProfileOptions
    {
        AccessKey = accessKey,
        SecretKey = accessSecret
    };
    new NetSDKCredentialsFile().RegisterProfile(new CredentialProfile(profileName, option));
}

The MIT License (MIT)