AWS CLI: Difference between revisions
| (12 intermediate revisions by the same user not shown) | |||
| Line 14: | Line 14: | ||
AWS CLI is a package that provides commands for interacting with the AWS services. All functionality available on the web Amazon Management Console is made available from command line. | AWS CLI is a package that provides commands for interacting with the AWS services. All functionality available on the web Amazon Management Console is made available from command line. | ||
=Version= | |||
<syntaxhighlight lang='bash'> | |||
aws --version | |||
</syntaxhighlight> | |||
=Installation= | =Installation= | ||
| Line 29: | Line 33: | ||
Even it looks odd, "-target /" will install AWS CLI in /usr/local/aws-cli. | Even it looks odd, "-target /" will install AWS CLI in /usr/local/aws-cli. | ||
===Upgrade=== | |||
Download the latest package as shown in the AWS documentation, then: | |||
<syntaxhighlight lang='bash'> | |||
sudo installer -pkg AWSCLIV2.pkg -target / | |||
</syntaxhighlight> | |||
==Linux== | ==Linux== | ||
| Line 66: | Line 75: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===Named Profile=== | ===Named Profile=== | ||
A '''named profile''' is a collection of settings and credentials that apply to an AWS CLI command. The named profile elements are specified in both <code>[[#.7E.2F.aws.2Fconfig|.aws/config]]</code> and <code>[[#.7E.2F.aws.2Fcredentials|.aws/credentials]]</code>: | A '''[[Amazon_AWS_Concepts#Profile|named profile]]''' is a collection of settings and credentials that apply to an AWS CLI command. The named profile elements are specified in both <code>[[#.7E.2F.aws.2Fconfig|.aws/config]]</code> and <code>[[#.7E.2F.aws.2Fcredentials|.aws/credentials]]</code>: | ||
<code>.aws/config</code>: | <code>.aws/config</code>: | ||
| Line 82: | Line 91: | ||
AWS CLI commands accept a named profiles as a command line parameter. When no named profile is explicitly specified, the [[#Default_Profile|default profile]] settings and credentials are used. | AWS CLI commands accept a named profiles as a command line parameter. When no named profile is explicitly specified, the [[#Default_Profile|default profile]] settings and credentials are used. | ||
===Relationship between Account ID and Profile=== | |||
<font color=darkkhaki>What is the relationship between the account ID and a profile? | |||
The profile includes credentials that establish identity, and the identity implies the profile? | |||
</font> | |||
===Default Profile=== | ===Default Profile=== | ||
| Line 99: | Line 114: | ||
</font> | </font> | ||
To configure the default profile name with CLI, execute the procedure to [[#Add_a_New_Profile|add a new profile]] without specifying <code>--profile <profile-name></code> when executing <code>aws configure </code>. | |||
If the <tt>[[#AWS_PROFILE|AWS_PROFILE]]</tt> environment variable is present, its value overrides the default profile. | If the <tt>[[#AWS_PROFILE|AWS_PROFILE]]</tt> environment variable is present, its value overrides the default profile. | ||
| Line 138: | Line 153: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
If <code>--profile <profile-name></code> is omitted, the default profile will be configured. | If <code>--profile <profile-name></code> is omitted, the [[#Default_Profile|default profile]] will be configured. | ||
====Change a Specific Configuration Element for a Profile==== | ====Change a Specific Configuration Element for a Profile==== | ||
| Line 158: | Line 173: | ||
===~/.aws/config=== | ===~/.aws/config=== | ||
AWS CLI configuration file is maintained by default in ~/.aws/config: | AWS CLI configuration file is maintained by default in <code>~/.aws/config</code>: | ||
<syntaxhighlight lang='text'> | <syntaxhighlight lang='text'> | ||
| Line 166: | Line 181: | ||
output=json | output=json | ||
[profile | [profile green] | ||
region = us-west-1 | region = us-west-1 | ||
| Line 182: | Line 197: | ||
<syntaxhighlight lang='text'> | <syntaxhighlight lang='text'> | ||
[default] | [default] | ||
aws_access_key_id= | aws_access_key_id = AKIA9999999999999999 | ||
aws_secret_access_key= | aws_secret_access_key = Bsomething+something+something+something | ||
[green] | |||
aws_access_key_id = AKIA8888888888888888 | |||
aws_secret_access_key = Bsomethin9+somethin9+somethin9+somethin9 | |||
</syntaxhighlight> | </syntaxhighlight> | ||
=Credential Providers= | =Credential Providers= | ||
{{Internal|Amazon_AWS_Security_Concepts#Credential_Providers|Credential Providers}} | {{Internal|Amazon_AWS_Security_Concepts#Credential_Providers|Credential Providers}} | ||
Latest revision as of 23:41, 19 April 2023
External
- https://aws.amazon.com/cli/
- https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html
- https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2-mac.html
Internal
Overview
AWS CLI is a package that provides commands for interacting with the AWS services. All functionality available on the web Amazon Management Console is made available from command line.
Version
aws --version
Installation
Mac
This section documents installation of AWS CLI v2.
curl "https://awscli.amazonaws.com/AWSCLIV2.pkg" -o "AWSCLIV2.pkg"
sudo installer -pkg AWSCLIV2.pkg -target /
Even it looks odd, "-target /" will install AWS CLI in /usr/local/aws-cli.
Upgrade
Download the latest package as shown in the AWS documentation, then:
sudo installer -pkg AWSCLIV2.pkg -target /
Linux
curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
unzip awscliv2.zip
sudo ./aws/install
rm -f awscliv2.zip
Test Installation
Verify the installation executing:
aws --version
aws-cli/2.0.35 Python/3.7.4 Darwin/18.7.0 botocore/2.0.0dev39
aws ec2 describe-regions
aws ec2 describe-hosts
Uninstall AWS CLI Version 1
sudo rm -rf /usr/local/aws
sudo rm /usr/local/bin/aws
Configuration
Configuration Profile
A collection of settings related to a certain account (access key, secret key, the default region and the default output format) are called a profile. The initial configuration procedure creates a profile named "default", and this is what AWS CLI uses by default. Additional named profiles can be created and stored, and then referred from command line with --profile, or configured in the environment to be used instead "default". The configuration information associated with profiles is stores in a series of local files. More details in the Configuration Files section.
Individual AWS CLI commands can be executed within the context of a specific profile using the --profile option:
aws s3 ls --profile blue
Named Profile
A named profile is a collection of settings and credentials that apply to an AWS CLI command. The named profile elements are specified in both .aws/config and .aws/credentials:
.aws/config:
[profile green] region = us-west-2
.aws/credentials:
[profile green] aws_access_key_id = AKIA9999999999999999 aws_secret_access_key = Bsomething+something+something+something
AWS CLI commands accept a named profiles as a command line parameter. When no named profile is explicitly specified, the default profile settings and credentials are used.
Relationship between Account ID and Profile
What is the relationship between the account ID and a profile?
The profile includes credentials that establish identity, and the identity implies the profile?
Default Profile
The default profile is specified in AWS CLI configuration files under the [default] label:
.aws/config:
[default] region = us-west-2
.aws/credentials:
[default] aws_access_key_id = AKIA9999999999999999 aws_secret_access_key = Bsomething+something+something+something
To configure the default profile name with CLI, execute the procedure to add a new profile without specifying --profile <profile-name> when executing aws configure .
If the AWS_PROFILE environment variable is present, its value overrides the default profile.
AWS_PROFILE Environment Variable
The AWS_PROFILE environment variable value overrides the default profile specified in the configuration files.
Configuration Profile Operations
List Available Profiles
aws configure list-profiles
List the Configuration for a Specific Profiles
Default profile:
aws configure list
Specific named profile:
aws configure list --profile blue
Permanently Select a Profile
A previously-configured profile can be selected by setting the AWS_PROFILE environment variable:
export AWS_PROFILE=jenkins
Add a New Profile
aws configure --profile green
AWS Access Key ID [None]: AKIAXXXXXXXXXXXXXXXX
AWS Secret Access Key [None]: yxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Default region name [None]: us-west-2
Default output format [None]:
If --profile <profile-name> is omitted, the default profile will be configured.
Change a Specific Configuration Element for a Profile
aws configure set region us-west-2 --profile <some-profile>
Alternative syntax:
aws configure set <some-profile>.region us-west-2
Change the Name of an Existing Profile
Manually change the name of the profile in .aws/config and .aws/credentials.
Configuration Files
AWS CLI organizes configuration and credentials in two separate files placed in $USER/.aws. They are separated to isolate credentials for less sensitive options of region and output.
~/.aws/config
AWS CLI configuration file is maintained by default in ~/.aws/config:
[default]
region = us-west-2
ca_bundle = /path/to/ca-bundle.pem
output=json
[profile green]
region = us-west-1
[profile testing2]
region = eu-west-1
[preview]
cloudsearch = true
~/.aws/credentials
AWS CLI credentials are maintained by default in ~/.aws/credentials:
[default]
aws_access_key_id = AKIA9999999999999999
aws_secret_access_key = Bsomething+something+something+something
[green]
aws_access_key_id = AKIA8888888888888888
aws_secret_access_key = Bsomethin9+somethin9+somethin9+somethin9