Skip to content

Commit ddc4b25

Browse files
authored
Merge pull request #3 from vNugglets/feat_RenameModule
📛 Rename module for consistency
2 parents eb86742 + 7b4814f commit ddc4b25

File tree

6 files changed

+19
-18
lines changed

6 files changed

+19
-18
lines changed

.github/workflows/PublishPSModuleToGallery.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Publish PowerShell Module
33
on:
44
push:
55
paths:
6-
- 'vN.AWSSSO/**'
6+
- 'vNugglets.AWSSSO/**'
77
release:
88
types: [released]
99
workflow_dispatch:

ReadMe.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
# AWS SSO Programmatic Credentials, Programmatically
2+
[![Latest version, PSGallery](https://img.shields.io/powershellgallery/v/vNugglets.AWSSSO.svg?style=flat&logo=powershell&label=Latest%20Version,%20PSGallery)](https://www.powershellgallery.com/packages/vNugglets.AWSSSO) [![PSGallery Downloads](https://img.shields.io/powershellgallery/dt/vNugglets.AWSSSO.svg?style=flat&logo=powershell&label=PSGallery%20Downloads)](https://www.powershellgallery.com/packages/vNugglets.AWSSSO)
3+
24
When credentials are available via the AWS SSO Identity Center ("IDC"), we can [reasonably] easily get AWS credentials for use with the AWS tools that we know and love (SDKs, CLIs, PowerShell modules, etc.).
35

46
Herein is a PowerShell module that simplifies getting accounts, roles, and credentials for some identity (the user).
@@ -10,6 +12,7 @@ Simplify the creation of AWS credentials to SSO accounts/roles that an identity
1012
### Prerequisite Modules
1113
If you don't already have available the two AWS SSO* modules, install them right quick:
1214
```powershell
15+
## pre-req modules
1316
Install-PSResource AWS.Tools.SSO, AWS.Tools.SSOOIDC
1417
```
1518

@@ -18,14 +21,14 @@ To install this module:
1821
1. Save or install the module from the PowerShell Gallery:
1922
```powershell
2023
## save it locally for initial inspection -- safety first!
21-
Find-PSResource vN.AWSSSO | Save-PSResource -Path C:\Temp
24+
Find-PSResource vNugglets.AWSSSO | Save-PSResource -Path C:\Temp
2225
## ..then inspect code to confirm trustworthiness, then import it from said saved path
2326
2427
## orrr, YOLO! Install straight away, as vNugglets is a reputable publisher
25-
Find-PSResource vN.AWSSSO | Install-PSResource
28+
Find-PSResource vNugglets.AWSSSO | Install-PSResource
2629
2730
## see the commands in the now-imported/installed module:
28-
Get-Command -Module vN.AWSSSO
31+
Get-Command -Module vNugglets.AWSSSO
2932
```
3033
1. Profit (see Default Parameter setting below, or examples in [How](#how) section)
3134
@@ -54,7 +57,7 @@ new ssooidc token
5457
get sso account list | Foreach-Object
5558
## get the SSO-related roles to which we are entitled in the given AWS account
5659
get sso account role list |
57-
## filter on <whatveer we like> to get just the account/role info for which to get temp creds
60+
## if not filtering on initial "get sso account list" call via Name param, then filter here on <whatveer we like> to get just the account/role info for which to get temp creds
5861
Where-Object rolename matches something | Foreach-Object
5962
## get the temp creds for the given account and role combos
6063
Get-SSORoleCredential
@@ -72,8 +75,7 @@ A mostly realistic example of getting some credentials.
7275
## make a new SSO OIDC token
7376
New-VNAWSSSOOIDCTokenViaDeviceCode -StartUrl https://mycoolstart.awsapps.com/start/ -Verbose
7477
## get account/role info, filter, get cred for role, get AWS temp cred
75-
Get-VNAWSSSOAccountAndRoleInfo |
76-
Where-Object accountname -like my-cool-account-* |
78+
Get-VNAWSSSOAccountAndRoleInfo -Name my-cool-account-* |
7779
Where-Object RoleName -match _myadminrole_ |
7880
New-VNAWSSSORoleTempCredential -Verbose |
7981
## save to the AWS creds file the temp creds for each account/role
@@ -83,7 +85,7 @@ A mostly realistic example of getting some credentials.
8385
And, to see that example as a likely candidate to paste straight into a PowerShell session (one-line format):
8486
```PowerShell
8587
## make a new SSO OIDC token, get account/role info, filter, get cred for role, get AWS temp cred, save to the AWS creds file the temp creds for each account/role
86-
New-VNAWSSSOOIDCTokenViaDeviceCode -StartUrl https://mycoolstart.awsapps.com/start/; Get-VNAWSSSOAccountAndRoleInfo | Where-Object accountname -like my-cool-account-* | Where-Object RoleName -match _myadminrole_ | New-VNAWSSSORoleTempCredential -Verbose | Set-AWSCredential -ProfileLocation (Resolve-Path ~\.aws\credentials)
88+
New-VNAWSSSOOIDCTokenViaDeviceCode -StartUrl https://mycoolstart.awsapps.com/start/; Get-VNAWSSSOAccountAndRoleInfo -Name my-cool-account-* | Where-Object RoleName -match _myadminrole_ | New-VNAWSSSORoleTempCredential -Verbose | Set-AWSCredential -ProfileLocation (Resolve-Path ~\.aws\credentials)
8789
```
8890

8991
## More Coolness 😎
@@ -96,8 +98,7 @@ Get-VNAWSSSOAccountAndRoleInfo
9698
## *poof*!
9799
98100
## get account/role info, filter like all the other PowerShell filtering we already know and love ❣!
99-
Get-VNAWSSSOAccountAndRoleInfo |
100-
Where-Object accountname -like my-cool-account-* |
101+
Get-VNAWSSSOAccountAndRoleInfo -Name my-cool-account-* |
101102
Where-Object RoleName -match _myadminrole_
102103
```
103104

Update-ThisModuleManifest.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ param(
1010
[Switch]$Recreate
1111
)
1212
begin {
13-
$strModuleName = "vN.AWSSSO"
13+
$strModuleName = "vNugglets.AWSSSO"
1414
$strFilespecForPsd1 = Join-Path ($strModuleFolderFilespec = "$PSScriptRoot\$strModuleName") "${strModuleName}.psd1"
1515

1616
$hshManifestParams = @{

vN.AWSSSO/en-US/about_vN.AWSSSO.help.txt renamed to vNugglets.AWSSSO/en-US/about_vNugglets.AWSSSO.help.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
TOPIC
2-
about_vN.AWSSSO
2+
about_vNugglets.AWSSSO
33

44
SHORT DESCRIPTION
55
Module encapsulating functions for simplified AWS SSO IDC interactions
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
#
2-
# Module manifest for module 'vN.AWSSSO'
2+
# Module manifest for module 'vNugglets.AWSSSO'
33
#
44
# Generated by: Matt Boren, vNugglets
55
#
6-
# Generated on: 10/2/2025
6+
# Generated on: 10/22/2025
77
#
88

99
@{
1010

1111
# Script module or binary module file associated with this manifest.
12-
RootModule = 'vN.AWSSSO_functions.psm1'
12+
RootModule = 'vNugglets.AWSSSO_functions.psm1'
1313

1414
# Version number of this module.
15-
ModuleVersion = '1.4.0'
15+
ModuleVersion = '2.0.0'
1616

1717
# Supported PSEditions
1818
# CompatiblePSEditions = @()
@@ -89,8 +89,8 @@ AliasesToExport = '*'
8989
# ModuleList = @()
9090

9191
# List of all files packaged with this module
92-
FileList = 'vN.AWSSSO.psd1', 'vN.AWSSSO_functions.psm1',
93-
'en-US\about_vN.AWSSSO.help.txt'
92+
FileList = 'vNugglets.AWSSSO.psd1', 'vNugglets.AWSSSO_functions.psm1',
93+
'en-US\about_vNugglets.AWSSSO.help.txt'
9494

9595
# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
9696
PrivateData = @{
File renamed without changes.

0 commit comments

Comments
 (0)