v0.0.1 Release #1
Conversation
Added the following key functions: * New-AwsAccount * Edit-AwsAccount * New-AwsRole * Set-AwsProfile * New-AwsSession
|
I should update the README as well |
| ) | ||
|
|
||
| # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export. | ||
| CmdletsToExport = @() |
There was a problem hiding this comment.
What's the difference between CmdletsToExport and FunctionsToExport?
There was a problem hiding this comment.
I... don't know. Honestly I barely know the difference between a function and a cmdlet.
There was a problem hiding this comment.
My understanding is that a CmdLet is a Function with special powers... when you add the attribute [CmdletBinding()] This turns an ordinary function into a commandlet that can support things like -Verbose -WhatIf etc... without the attribute, it's just a plain old Function.
There was a problem hiding this comment.
in the module manifest the CmdletsToExport refers to binary CMDlets that have been compiled from C# and available in a linked dll.
The FunctionsToExport is for script functions regardless of whether they do or do not have the [CMDletBinding()]or not
| # Tags = @() | ||
|
|
||
| # A URL to the license for this module. | ||
| # LicenseUri = '' |
There was a problem hiding this comment.
Have you considered which open source license to use? Is this something that TP will dictate, or can you choose?
There was a problem hiding this comment.
Good question, I'll ping some peeps and see what we should use. MIT would be nice.
There was a problem hiding this comment.
We use MIT for our existing powershell modules and is the preferred license in general
| A collection of functions for managing AWS CLI config and credentials. | ||
|
|
||
| .DESCRIPTION | ||
| A collection of functions for managing AWS CLI config and credentials. |
There was a problem hiding this comment.
Might want to dive a bit deeper in the description.
There was a problem hiding this comment.
Yep good idea. I'll be filling out the README too so likely to be a lot of overlap in content here.
| or CSV file. This will silently ignore if the account already exists. To edit | ||
| an existing account, use Edit-AwsAccount. | ||
|
|
||
| .PARAMETER AccountName |
There was a problem hiding this comment.
The naming might need some work. From an AWS perspective the concept of an Account is very well defined, but this does not map one-to-one to an "AWS Account". Not sure what other naming you could use, maybe Organisation, or Realm or Identity???? I guess this comment also applies to the Function name too. It may just be a case of it' too hard to name it anything other than Account.
There was a problem hiding this comment.
Yeah I reckon Identity or User would do the trick.
| Function New-AwsAccount | ||
| { | ||
| Param( | ||
| [Parameter(Mandatory)] [string] $AccountName, |
There was a problem hiding this comment.
One thing I like to do in scripts that will be used a lot is to make them positional parameters where possible (e.g. [Parameter(Mandatory=$true, Position=0)] etc...), that way a power user could just go New-AwsAccount vicroads accesskeys.csv rather than having to type in out the parameter names in full to disambiguate.
There was a problem hiding this comment.
Happy to add this explicitly, although I think this Just Works™ naturally by defaulting to the order listed.
| Param( | ||
| [string] $Profile = $env:AWS_PROFILE, | ||
| [string] $Code, | ||
| [string] $Arn |
There was a problem hiding this comment.
Same comment about positional parameters as above
|
|
||
| # Modules to import as nested modules of the module specified in RootModule/ModuleToProcess | ||
| NestedModules = @( | ||
| 'PwshAwsConfig.psm1' |
There was a problem hiding this comment.
Typically the psm1 module file is added under RootModule and NestedModules is used for libraries that you bundle together with your module.
| NewOrEdit-AwsAccount -AccountName $AccountName -AccessKeyCsvPath $AccessKeyCsvPath | ||
| } | ||
|
|
||
| <# |
There was a problem hiding this comment.
I think comment based help needs to be within the function block before the Param(bit in order to surface properly. You can check by loading the module and calling Get-Help Edit-AwsAccount
There was a problem hiding this comment.
Wow interesting, I had only ever seen it like this, before the Function keyword. It turns out it can go in 3 places!
|
|
||
| If (Test-AwsProfile -Profile $credentialName) | ||
| { | ||
| Write-Information "Account already exists" |
There was a problem hiding this comment.
Maybe reword to Profile Already Exists
Added the following key functions: