- 16 Jul 2024
- 3 Minutes to read
- Print
- PDF
AWS CLI With Wasabi
- Updated on 16 Jul 2024
- 3 Minutes to read
- Print
- PDF
How do I use AWS CLI with Wasabi?
The AWS CLI (Command Line Interface) tool is certified for use with Wasabi. To use AWS CLI with Wasabi, follow the configuration tips below. Note that this article assumes that you have the awscli tool already installed. For more information on how to install it, refer to https://aws.amazon.com/cli/.
This example discusses the use of Wasabi's us-east-1 storage region. To use other Wasabi storage regions, use the appropriate Wasabi service URL, as described in Service URLs for Wasabi's Storage Regions.
Configuring awscli Using the configure
Command
To access your wasabi buckets with the CLI, utilize the configure
command.
Typing$ aws configure
will bring up a series of prompts, calling for an access key and secret access key. Enter your Wasabi access key and your Wasabi secret key. For the region, type "us-east-1". Leave the last setting blank.
If you follow options 2 or 3 below, you will have to configure the [wasabi] profile after you create it. To do so, simply type
$ aws configure --profile wasabi
.
Using Wasabi With AWS CLI
There are three methods for utilizing Wasabi with the CLI, ranking from requiring the least amount of configuration to the most.
Add the --endpoint-url
Subcommand After Every Command
Add the following after every command you make in the CLI. Be sure to use the appropriate service URL as noted in Service URLs for Wasabi's Storage Regions. The URL may be different from s3.wasabisys.com.
$ --endpoint-url=https://s3.wasabisys.com
Example:
To list buckets in the cli, type:
$ aws s3 ls --endpoint-url=https://s3.wasabisys.com
To make a new bucket in the eu-central-1 region, type:
$ aws s3 mb s3://newbucketnamehere --endpoint-url=https://s3.eu-central-1.wasabisys.com
To make a new bucket with object lock enabled in the us-central-1 region, type:
$ aws s3api create-bucket --bucket yournewbucketnamehere --object-lock-enabled-for-bucket --endpoint-url=https://s3.us-central-1.wasabisys.com
Example:
aws s3api create-bucket --bucket yournewbucketnamehere --object-lock-enabled-for-bucket --endpoint-url=https://s3.us-central-1.wasabisys.com
{
"Location": "/yournewbucketnamehere"
}
Using the awscli-plugin-endpoint
Plugin
awscli-plugin-endpoint is a plugin used to easily access third-party S3 providers, such as Wasabi. Using this plugin requires creating a profile in addition to the default one.
Open the
config
file in the.aws
. Add a profile line at the end of the configuration file, as shown below.[profile wasabi]
Save the file.
Once you have a profile created, follow the instructions detailed on the plugin's git page.
You should then be able to use --profile wasabi
after every command instead of typing out the entire URL.
Example:
To list buckets in the cli, type:
$ aws s3 ls --profile wasabi
Using export AWS_PROFILE
with awscli-plugin-endpoint
Once you have set up Option 2, you can default the aws cli to point to the new profile at the beginning of your session. To do so, follow the instructions below provided by AWS.
For Linux, macOS, or Unix:
$ export AWS_PROFILE=wasabi
For Windows:
> set AWS_PROFILE=wasabi
Setting the environment variable either changes the default profile until the end of your shell session or until you set the variable to a different value.
Example:
To list buckets in the cli, type:
$ aws s3 ls
Using AWS CLI for Cloud-to-Cloud Migration Scenarios
Install and configure AWS CLI using your AWS Access Key and Secret Key. For more information, refer to Get started with the AWS CLI.
Configure an additional AWS CLI profile for the Wasabi account using the Wasabi keys.
Transfer all files from the AWS bucket to a local directory by running the following command.
aws s3 cp s3:/// --recursive
Transfer all files from the local directory to the destination bucket at Wasabi.
aws s3 cp / s3:/// --recursive --profile wasabi
For additional information regarding AWS CLI, refer to the following resources.