Public/Serverless/Resource Types/New-SAMFunction.ps1
|
function New-SAMFunction { <# .SYNOPSIS Adds an AWS::Serverless::Function resource to the template .DESCRIPTION Creates a Lambda function, IAM execution role, and event source mappings which trigger the function. .LINK https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction .PARAMETER LogicalId The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER Handler Required. Function within your code that is called to begin execution. .PARAMETER Runtime Required. The runtime environment. .PARAMETER CodeUri Required. S3 Uri or location to the function code. The S3 object this Uri references MUST be a Lambda deployment package. .PARAMETER FunctionName A name for the function. If you don't specify a name, a unique name will be generated for you. .PARAMETER Description Description of the function. .PARAMETER MemorySize Size of the memory allocated per invocation of the function in MB. Defaults to 128. .PARAMETER Timeout Maximum time that the function can run before it is killed in seconds. Defaults to 3. .PARAMETER Role ARN of an IAM role to use as this function's execution role. If omitted, a default role is created for this function. .PARAMETER Policies Names of AWS managed IAM policies or IAM policy documents that this function needs, which should be appended to the default role for this function. If the Role property is set, this property has no meaning. .PARAMETER Environment Configuration for the runtime environment. .PARAMETER VpcConfig Configuration to enable this function to access private resources within your VPC. .PARAMETER Events A map (string to Event source object) that defines the events that trigger this function. Keys are limited to alphanumeric characters. .PARAMETER Tags A map (string to string) that specifies the tags to be added to this function. Keys and values are limited to alphanumeric characters. Keys can be 1 to 127 Unicode characters in length and cannot be prefixed with aws:. Values can be 1 to 255 Unicode characters in length. When the stack is created, SAM will automatically add a lambda:createdBy:SAM tag to this Lambda function. .PARAMETER Tracing String that specifies the function's X-Ray tracing mode. Accepted values are Active and PassThrough .NOTES Return values Ref When the logical ID of this resource is provided to the Ref intrinsic function, it returns the resource name of the underlying Lambda function. Fn::GetAtt When the logical ID of this resource is provided to the Fn::GetAtt intrinsic function, it returns a value for a specified attribute of this type. This section lists the available attributes. .FUNCTIONALITY Serverless #> [OutputType('Vaporshell.Serverless.Function')] [cmdletbinding()] Param ( [parameter(Mandatory = $true,Position = 0)] [ValidateScript( { if ($_ -match "^[a-zA-Z0-9]*$") { $true } else { throw 'The logical ID must be alphanumeric (a-z, A-Z, 0-9) and unique within the template.' } })] [System.String] $LogicalId, [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { $true } else { throw "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ")." } })] $Handler, [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { $true } else { throw "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ")." } })] $Runtime, [parameter(Mandatory = $true)] [ValidateScript( { $allowedTypes = "Vaporshell.Serverless.S3LocationObject","System.String" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { $true } else { throw "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ")." } })] $CodeUri, [parameter(Mandatory = $false)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { $true } else { throw "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ")." } })] $FunctionName, [parameter(Mandatory = $false)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { $true } else { throw "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ")." } })] $Description, [parameter(Mandatory = $false)] [Int] $MemorySize, [parameter(Mandatory = $false)] [Int] $Timeout, [parameter(Mandatory = $false)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { $true } else { throw "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ")." } })] $Role, [parameter(Mandatory = $false)] [ValidateScript( { $allowedTypes = "System.String","Vaporshell.Function" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { $true } else { throw "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ")." } })] $Policies, [parameter(Mandatory = $false)] [ValidateScript( { $allowedTypes = "Vaporshell.Serverless.EnvironmentVariable","System.Collections.Hashtable" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { $true } else { throw "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ")." } })] $Environment, [parameter(Mandatory = $false)] [ValidateScript( { $allowedTypes = "Vaporshell.Resource.Lambda.Function.VpcConfig","System.Collections.Hashtable" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { $true } else { throw "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ")." } })] $VpcConfig, [parameter(Mandatory = $false)] [ValidateScript( { $allowedTypes = "System.Collections.Hashtable","System.Management.Automation.PSCustomObject","Vaporshell.Serverless.EventSource" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { $true } else { throw "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ")." } })] $Events, [parameter(Mandatory = $false)] [ValidateScript( { $allowedTypes = "Vaporshell.Resource.Tag" if ([string]$($_.PSTypeNames) -match "($(($allowedTypes|ForEach-Object{[RegEx]::Escape($_)}) -join '|'))") { $true } else { throw "This parameter only accepts the following types: $($allowedTypes -join ", "). The current types of the value are: $($_.PSTypeNames -join ", ")." } })] $Tags, [ValidateSet("Active","PassThrough")] [System.String] $Tracing ) Begin { $ResourceParams = @{ LogicalId = $LogicalId Type = "AWS::Serverless::Function" } } Process { foreach ($key in $PSBoundParameters.Keys) { switch ($key) { 'LogicalId' {} 'Environment' { if (!($ResourceParams["Properties"])) { $ResourceParams.Add("Properties",([PSCustomObject]@{})) } if ($Environment.Keys -notcontains "Variables") { $Envi = @{ Variables = $Environment } $ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name Environment -Value $Envi } else { $ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name Environment -Value $Environment } } Default { if (!($ResourceParams["Properties"])) { $ResourceParams.Add("Properties",([PSCustomObject]@{})) } $val = $((Get-Variable $key).Value) $ResourceParams["Properties"] | Add-Member -MemberType NoteProperty -Name $key -Value $val } } } } End { $obj = New-VaporResource @ResourceParams $obj | Add-ObjectDetail -TypeName 'Vaporshell.Serverless.Function' Write-Verbose "Resulting JSON from $($MyInvocation.MyCommand): `n`n$(@{$obj.LogicalId = $obj.Props} | ConvertTo-Json -Depth 5)`n" } } |