Public/Primary Functions/New-VaporMapping.ps1
|
function New-VaporMapping { <# .SYNOPSIS Adds a Mapping object to the template .DESCRIPTION The optional Mappings section matches a key to a corresponding set of named values. For example, if you want to set values based on a region, you can create a mapping that uses the region name as a key and contains the values you want to specify for each specific region. You use the Fn::FindInMap intrinsic function to retrieve values in a map. You cannot include parameters, pseudo parameters, or intrinsic functions in the Mappings section. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html .PARAMETER LogicalId An identifier for the current condition. The logical ID must be alphanumeric (a-z, A-Z, 0-9) and unique within the template. .PARAMETER Map A 2 level collection of key/value pairs. If you would like your collection to remain ordered the same as called, use an ordered PSCustomObject, otherwise a hashtable is fine. You can use any of these 3 types for this parameter; "System.Collections.Hashtable","System.Management.Automation.PSCustomObject","Vaporshell.Mapping.Map" .EXAMPLE $template = Initialize-Vaporshell -Description "Testing Mapping addition" $template.AddMapping(( New-VaporMapping -LogicalId "RegionMap" -Map ([PSCustomObject][Ordered]@{ "us-east-1" = [PSCustomObject][Ordered]@{ "32" = "ami-6411e20d" "64" = "ami-7a11e213" } "us-west-1" = [PSCustomObject][Ordered]@{ "32" = "ami-c9c7978c" "64" = "ami-cfc7978a" } "eu-west-1" = [PSCustomObject][Ordered]@{ "32" = "ami-37c2f643" "64" = "ami-31c2f645" } "ap-southeast-1" = [PSCustomObject][Ordered]@{ "32" = "ami-66f28c34" "64" = "ami-60f28c32" } "ap-northeast-1" = [PSCustomObject][Ordered]@{ "32" = "ami-9c03a89d" "64" = "ami-a003a8a1" } }) )) When the template is exported, this will convert to: { "AWSTemplateFormatVersion": "2010-09-09", "Description": "Testing Mapping addition", "Mappings": { "RegionMap": { "us-east-1": { "32": "ami-6411e20d", "64": "ami-7a11e213" }, "us-west-1": { "32": "ami-c9c7978c", "64": "ami-cfc7978a" }, "eu-west-1": { "32": "ami-37c2f643", "64": "ami-31c2f645" }, "ap-southeast-1": { "32": "ami-66f28c34", "64": "ami-60f28c32" }, "ap-northeast-1": { "32": "ami-9c03a89d", "64": "ami-a003a8a1" } } } } .FUNCTIONALITY Vaporshell #> [OutputType('Vaporshell.Mapping')] [cmdletbinding()] Param ( [parameter(Mandatory = $true,Position = 0)] [ValidateScript( { if ($_ -match "^[a-zA-Z0-9]*$") { $true } else { $PSCmdlet.ThrowTerminatingError((New-VSError -String 'The LogicalID must be alphanumeric (a-z, A-Z, 0-9) and unique within the template.')) } })] [System.String] $LogicalId, [parameter(Mandatory = $true,Position = 1)] [ValidateScript( { $allowedTypes = "System.Collections.Hashtable","System.Management.Automation.PSCustomObject","Vaporshell.Mapping.Map" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { $true } else { $PSCmdlet.ThrowTerminatingError((New-VSError -String "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ").")) } })] $Map ) if ($Map -is [System.Collections.Hashtable]) { $Map = [PSCustomObject]$Map } $obj = [PSCustomObject][Ordered]@{ "LogicalId" = $LogicalId "Props" = $Map } $obj | Add-ObjectDetail -TypeName 'Vaporshell.Mapping' Write-Verbose "Resulting JSON from $($MyInvocation.MyCommand): `n`n`t$(@{$obj.LogicalId = $obj.Props} | ConvertTo-Json -Depth 5 -Compress)`n" } |