Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mpostument committed Jul 20, 2020
1 parent 07d2ef7 commit 55a966f
Showing 1 changed file with 43 additions and 24 deletions.
67 changes: 43 additions & 24 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -22,57 +22,76 @@

#### Get ec2 tags

Get list of ec2 with required tags - `awstaghelper ec2 get-ec2-tags`
By default result will be stored in file `ec2Tags.csv` . To change filename add `--filename newName.csv`
Tag `Name,Environment` will be added to csv. To use custom tags specify `--tags Name,Owner,CostCenter`
Get list of ec2 with required tags - `awstaghelper ec2 get-ec2-tags`
Default filename `ec2Tags.csv`
Default tags list `Name,Environment`
Example:
`awstaghelper ec2 get-ec2-tags --filename ec2Tag.csv --tags Name,Owner --profile main`

#### Tag ec2

Edit csv by adding new tags or changin value to existing one
Run `awstaghelper ec2 tag-ec2` . All tags from csv will be applied to corresponding instances
Custom filename can be specified with `--filename newName.csv`
Read csv and tag ec2 - `awstaghelper ec2 tag-ec2`
Default filename `ec2Tags.csv`
Example:
`awstaghelper ec2 tag-ec2 --filename ec2Tag.csv --profile main`

### Rds

#### Get rds tags

Get list of rds with required tags - `awstaghelper rds get-rds-tags`
By default result will be stored in file `rdsTags.csv` . To change filename add `--filename newName.csv`
Tag `Name,Environment` will be added to csv. To use custom tags specify `--tags Name,Owner,CostCenter`
Get list of rds with required tags - `awstaghelper rds get-rds-tags`
Default filename `rdsTags.csv`
Default tags list `Name,Environment`
Example:
`awstaghelper rds get-rds-tags --filename rdsTag.csv --tags Name,Owner --profile main`

#### Tag rds

Edit csv by adding new tags or changin value to existing one
Run `awstaghelper rds tag-rds` . All tags from csv will be applied to corresponding instances
Custom filename can be specified with `--filename newName.csv`
Read csv and tag rds - `awstaghelper rds tag-rds`
Default filename `rdsTags.csv`
Example:
`awstaghelper rds tag-rds --filename rdsTag.csv --profile main`

### Lambda

#### Get lambda tags

Get list of lambda with required tags - `awstaghelper lambda get-lambda-tags`
By default result will be stored in file `lambdaTags.csv` . To change filename add `--filename newName.csv`
Tag `Name,Environment` will be added to csv. To use custom tags specify `--tags Name,Owner,CostCenter`
Get list of lambda with required tags - `awstaghelper lambda get-lambda-tags`
Default filename `lambdaTags.csv`
Default tags list `Name,Environment`
Example:
`awstaghelper lambda get-lambda-tags --filename lambdaTag.csv --tags Name,Owner --profile main`

#### Tag lambda

Edit csv by adding new tags or changin value to existing one
Run `awstaghelper lambda tag-lambda` . All tags from csv will be applied to corresponding instances
Custom filename can be specified with `--filename newName.csv`
Read csv and tag lambda - `awstaghelper lambda tag-lambda`
Default filename `lambdaTags.csv`
Example:
`awstaghelper lambda tag-lambda --filename lambdaTag.csv --profile main`

### S3

#### Get s3 tags

Get list of ec2 with required tags - `awstaghelper s3 get-s3-tags`
By default result will be stored in file `s3Tags.csv` . To change filename add `--filename newName.csv`
Tag `Name,Environment` will be added to csv. To use custom tags specify `--tags Name,Owner,CostCenter`
Get list of s3 with required tags - `awstaghelper s3 get-s3-tags`
Default filename `s3Tags.csv`
Default tags list `Environment,Project`
Example:
`awstaghelper s3 get-s3-tags --filename s3Tag.csv --tags Name,Owner --profile main`

#### Tag s3

Edit csv by adding new tags or changin value to existing one
Run `awstaghelper s3 tag-lambda` . All tags from csv will be applied to corresponding instances
Custom filename can be specified with `--filename newName.csv`
Read csv and tag s3 - `awstaghelper s3 tag-s3`
Default filename `ec2Tags.csv`
Example:
`awstaghelper s3 tag-s3 --filename ec2Tag.csv --profile main`

### General parameters

`filename` - path where to write or read data. Supported by every option
`tags` - list of tags to read. Supported only with `get-tags` option
`region` - aws region to use. Supported by every option
`profile` - aws profile to use. Supported by every option

## Contributing

Expand Down

0 comments on commit 55a966f

Please sign in to comment.