Skip to content

Commit

Permalink
comments
Browse files Browse the repository at this point in the history
  • Loading branch information
TheRealFalcon committed Oct 17, 2024
1 parent 0838f5e commit 4989985
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
8 changes: 5 additions & 3 deletions docs/clouds/ec2.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ The following page documents the AWS EC2 cloud integration in pycloudlib.

## Credentials

To access EC2 requires users to have an access key id and secret access key. These should be set in pycloudlib.toml.
To access EC2 requires users to have either an access key id and secret access key or a profile using SSO.
These should be set in pycloudlib.toml.

### AWS Dotfile (Deprecated)

Expand All @@ -25,13 +26,14 @@ region = us-west-2

### Passed Directly (Deprecated)

The credential and region information can also be provided directly when initializing the EC2 object:
The credential, region,and profile information can also be provided directly when initializing the EC2 object:

```python
ec2 = pycloudlib.EC2(
access_key_id='KEY_VALUE',
secret_access_key='KEY_VALUE',
region='us-west-2'
region='us-west-2',
profile="work",
)
```

Expand Down
2 changes: 1 addition & 1 deletion pycloudlib.toml.template
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ region = "" # in ~/.aws/config
# If 'aws configure sso' has been run, 'profile' should be the only credentials needed
profile = "" # in ~/.aws/config

# With modern SSO, these should no longer be necessary.
# If profile is given, these are not necessary.
# They can be found in ~/.aws/credentials or ~/.aws/config
# access_key_id = "" # in ~/.aws/credentials
# secret_access_key = "" # in ~/.aws/credentials
Expand Down

0 comments on commit 4989985

Please sign in to comment.