Functions/Get-CmEc2ImageId.ps1

<#
.Synopsis
   Find the latest AWS EC2 AMI based on search critera
.DESCRIPTION
  Outputs only the image ID of the latest AWS EC2 AMI based on option you specficy such as Windows version, SQL verison and SQL Edition or Amazon Linux(2) or Ubuntu
 
  Supports Core and Container based AMIS and Windows version 2003, 2008, 2008R2, 2012, 2012 R2, 2016, 1709, 1803, 1809 and 2019
 
  It does this mostly by querying the SSM public paramter store, so the user that is running this must have the AWS PowerShell Module installed and configured as well permission to the ssm:describeparameter action
   
.EXAMPLE
   PS C:\> (Get-CmEc2ImageId -OsVersion WindowsServer2016 -Region us-east-1).ImageId
   ami-041114ddee4a98333
 
   Above finds the latest Windows Server 2016 Base AMI in us-east-1 region
.EXAMPLE
   PS C:\> Get-CmEc2ImageId -OsVersion WindowsServer2012R2 -SqlVersion 2008R2
   WARNING: SQL Server 2008 R2 and 2012 only supported on Windows Server 2008R2 and 2012, switching to Windows 2012
   ami-0193fd36c14f87865
 
   Here SQL server 2008R2 is not supported on Windows 2012 R2 and it has automatically changed the OS to the latest one that supports this SQL version
.EXAMPLE
    PS C:\> Get-CmEc2ImageId -OsVersion 2019 -Core -Containers -Region us-east-1
    ami-0f3d4a916972fd1ac
 
    Here we specify we want Windows Server 2019 Core edition with Containers in the us-east-1 region
.EXAMPLE
    PS C:\> New-EC2Instance -Region us-east-1 -Subnet subnet-97654567890 -ImageId (Get-CmEc2ImageId -OsVersion WindowsServer2016 -Region us-east-1).ImageId -KeyPair MyKeyPair
 
    This launches an instance in the us-east-1 region getting the latest AMI for Windows Serve 2016 in that region.
.INPUTS
   Inputs to this cmdlet (if any)
.OUTPUTS
   ImageId (String)
.NOTES
   General notes
.COMPONENT
   The component this cmdlet belongs to
.ROLE
   The role this cmdlet belongs to the CMAWS Module
.FUNCTIONALITY
   The functionality that best describes this cmdlet
#>

Function Get-CmEc2ImageId {
    [CmdletBinding(DefaultParameterSetName='Base')]
    Param(
        [Parameter(Position=0)]
        #[ValidatePattern('(WindowsServer)?(180(3|9)|1709|20(03|(08|12)(R2)?|16|19))|Ubuntu1(6|8)\.04|AmazonLinux2?')]
        [ValidateSet( 
            "WindowsServer1903", 
            "WindowsServer1809", 
            "WindowsServer1803",
            "WindowsServer2019",
            "WindowsServer2016",
            "WindowsServer2012R2",
            "WindowsServer2012",
            "WindowsServer2008R2",
            "1903",
            "1809",
            "1803",
            "2019",
            "2016",
            "2012R2",
            "2012",
            "2008R2",
            "Ubuntu16.04",
            "Ubuntu18.04",
            "AmazonLinux",
            "AmazonLinux2",
            "AmazonLinux2NetCore",
            "UbuntuNetCore",
            "EcsAmazonLinux",
            "EcsAmazonLinux2"
        )]
        [string] $OsVersion = "2016",
        [ValidateSet("2019","2017","2016","2014","2012","2008R2","2008")]
        [string] $SqlVersion,

        [ValidateSet("Express", "Web","Standard","Enterprise")]
        [string] $SqlEdition = "Standard",

        [switch] $Core,
        [switch] $Containers,
        [switch] $NoSwitching,
        
        [ValidateScript({@((Get-AWSRegion).Region)})]
        [string] $Region,

        [ValidateSet(
            "Chinese_Traditional",
            "Chinese_Simplified",
            "Czech",
            "Dutch",
            "English",
            "French",
            "German",
            "Hungarian",
            "Korean",
            "Japanese",
            "Polish",
            "Portuguese_Brazil",
            "Russian",
            "Spanish",
            "Swedish",
            "Turkish"
            )]
        [string] $Language = "English",
        [switch] $ImageIdOnly
    )
    $ErrorActionPreference = "Stop"
    # if(!$Region){$Region = (Get-DefaultAWSRegion).Region}
    
    If ($OsVersion -like "WindowsServer*"){
        $OsVersion = $OsVersion.Substring(13)
        $WindowsServer = $True
    }
    $Base = $True 
    If ($OsVersion -match '(180(3|9)|1903|20((08|12)(R2)?|16|19))'){
        if ((Get-Date) -lt $([datetime]"2019/04")) { $LatestStable = "1809","2016" }
        else { $LatestStable = "1903","2019" }
        if ($OsVersion -match '(1709|180(3|9)|1903)'){$Core = $True}
        if ($Core -and $OsVersion -notmatch '1709|180(3|9)|1903|20((08|12)R2|16|19)')      {
            Write-Warning "Core AMIs only available for Windows Server 2008R2 and 2012R2 and later, Switching to Windows Server $($LatestStable[0])"
            $OsVersion = $LatestStable[0]
        }
        if ($Containers) {
            $Base = $False
            if  ($OsVersion -notmatch '1709|180(3|9)|1903|201(6|9)')  {
                Write-Warning "Container AMIs only available for Windows Server 2016 and later, Switching to Windows Server $($LatestStable[1])"
                $OsVersion = $LatestStable[1]
            }
        }
        if ($SqlVersion) {
            $Base = $False
            If ($Core -and $OsVersion -ne 2016 -and $SqlVersion ) { Write-Warning "SQL only avaialable on Core Editions of Windows Server 2016, Switching to Full"; $Core = $False}
            If ($Containers) { Write-Warning "SQL AMI not available with Containers, Switching to Non-Containers"; $Containers = $False}
            If ($SqlVersion -match "20(05|08|12)") {$SqlSp = "_SP4"}
            If ($SqlVersion -eq "2014") {$SqlSp = "_SP3"}
            If ($SqlVersion -eq "2016") {$SqlSp = "_SP2"}
            $SqlVersion = $SqlVersion.ToUpper()
            $SqlEdition = $SqlEdition.Substring(0,1).ToUpper() + $SqlEdition.Substring(1).ToLower()
            if ($SqlVersion.Length -eq 4) { $SqlText = "SQL_"+$SqlVersion+$SqlSp+"_"+$SqlEdition }
            else                          { $SqlText = "SQL_2008_R2_SP3_"+$SqlEdition }
            if ($OsVersion -notmatch '201(6|9)'     -and $SqlVersion -match '201(7|9)')   {
                Write-Warning "SQL Server $SqlVersion only supported on Windows Server 2016 and 2019, switching to Windows $($LatestStable[1])"
                $OSVersion = $($LatestStable[1])
            }
            if ($OsVersion -notmatch '201(2R2|6|9)' -and $SqlVersion -eq "2016")   {
                Write-Warning "SQL Server 2016 only supported on Windows Server 2012 R2, 2016 and 2019, switching to Windows $($LatestStable[1])"
                $OSVersion = $($LatestStable[1])
            }
            if ($OsVersion -notmatch '2012'         -and $SqlVersion -eq "2014")   {
                Write-Warning "SQL Server 2014 only supported on Windows Server 2012 or 2012 R2, switching to Windows 2012 R2"
                $OSVersion = "2012R2"
            }
            if ($OsVersion -notmatch '20(08R2|12)$'  -and $SqlVersion -match '20(08R2|12)')   {
                Write-Warning "SQL Server 2008 R2 and 2012 only supported on Windows Server 2008R2 and 2012, switching to Windows 2012"
                $OSVersion = "2012"
            }
        }
        $OSVersion             = $OSVersion.ToUpper()
        $Language              = $Language.Substring(0,1).ToUpper() + $Language.Substring(1).ToLower()
    
        $BaseText = "/aws/service/ami-windows-latest/Windows_Server-"

        if ($OsVersion -match '(180(3|9)|1903)')     
        {
            $SearchString = $BaseText+$OsVersion+"-"+$Language+"-Core"
            if ($Base) {$SearchString = $SearchString+"-Base"}
            else       {$SearchString = $SearchString+"-ContainersLatest"}
        }
        if ($OsVersion -match '201(6|9)')     
        {
            if ($Core) {$SearchString = $BaseText+$OsVersion+"-"+$Language+"-Core"}
            else       {$SearchString = $BaseText+$OsVersion+"-"+$Language+"-Full"}
            if ($Base) {$SearchString = $SearchString+"-Base"}
            elseif ($Containers) {
                if ($OsVersion -eq '2016'){$SearchString = $SearchString+"-Containers"}
                if ($OsVersion -eq '2019'){$SearchString = $SearchString+"-ContainersLatest"}
            }
            else       {$SearchString = $SearchString+"-"+$SqlText}
        }
        if ($OsVersion -eq "2012R2")   
        {
            if ($Base) 
            {
                if     ($Core) {$SearchString = $BaseText+"2012-R2_RTM-"+$Language+"-64Bit-Core"}
                else           {$SearchString = $BaseText+"2012-R2_RTM-"+$Language+"-64Bit-Base"}
            }
           
            else {$SearchString = $BaseText+"2012-R2_RTM-"+$Language+"-64Bit-"+$SqlText}
        }

        if ($OsVersion -eq "2012")     
        {
            if ($Base) {$SearchString = $BaseText+"2012-RTM-"+$Language+"-64Bit-Base"}
            else       {$SearchString = $BaseText+"2012-RTM-"+$Language+"-64Bit-"+$SqlText}
        }
        if ($OsVersion -eq "2008R2")   
        {
            if     ($Core) {$SearchString = $BaseText+"2008-R2_SP1-"+$Language+"-64Bit-Core"}
            elseif ($Base) {$SearchString = $BaseText+"2008-R2_SP1-"+$Language+"-64Bit-Base"}
            else           {$SearchString = $BaseText+"2008-R2_SP1-"+$Language+"-64Bit-"+$SqlText}
        }
    }
    If ($OsVersion -eq "Ubuntu18.04"){
        $Images = Get-Ec2Image -filter @{Name="name";Values="ubuntu/images/hvm-ssd/ubuntu-bionic-18.04-amd64-server*"} -Region $Region
    }
    If ($OsVersion -eq "Ubuntu16.04"){
        $Images = Get-Ec2Image -filter @{Name="name";Values="ubuntu/images/hvm-ssd/ubuntu-xenial-16.04-amd64-server*"} -Region $Region 
    }
    If ($OsVersion -eq "AmazonLinux2"){
        $SearchString = "/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2"
    }
    If ($OsVersion -eq "AmazonLinux"){
        $SearchString ="/aws/service/ami-amazon-linux-latest/amzn-ami-hvm-x86_64-gp2"
    }
    If ($OsVersion -eq "AmazonLinux2NetCore"){
        $Images = Get-EC2Image -Owner 'amazon' -Filter @{ Name="name"; Values="amzn2-ami-hvm*x86_64-gp2-dotnetcore*" } -Region $Region
    }
    If ($OsVersion -eq "UbuntuNetCore"){
        $Images = Get-EC2Image -Owner 'amazon' -Filter @{ Name="name"; Values="ubuntu*amd64*dotnetcore*" } -Region $Region
    }
    If ($OsVersion -eq "EcsAmazonLinux"){
        $SearchString = "/aws/service/ecs/optimized-ami/amazon-linux/recommended/image_id"
    }
    If ($OsVersion -eq "EcsAmazonLinux2"){
        $SearchString = "/aws/service/ecs/optimized-ami/amazon-linux-2/recommended/image_id"
    }
    If ($SearchString){
        $SSMParameters = @{Name = $SearchString}
        if ($Region) {$SSMParameters.Add('Region', $Region) }
        Try { 
            $ImageId = (Get-SSMParameter @SSMParameters).Value
        } Catch { 
            Write-Error "AMI Not Found" 
        }
    }
    If ($ImageIdOnly){
        If ($Images){
            ($Images | where Name -NotMatch "beanstalk" | Sort Name | Select -Last 1 ).ImageId
        }
        If ($ImageId) { 
            $ImageId
        }
    } else {
        If ($Images){
            $Images | where Name -NotMatch "beanstalk" | Sort Name | Select -Last 1 
        }
        If ($ImageId) {
            $ImageParams = @{ImageId = $ImageId}
            if ($Region) {$ImageParams.Add('Region', $Region) }
            Get-EC2Image @ImageParams
        }
    }
}