AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Lambda UpdateFunctionConfiguration API operation.

Syntax

Update-LMFunctionConfiguration
-FunctionName <String>
-ImageConfig_Command <String[]>
-Description <String>
-ImageConfig_EntryPoint <String[]>
-FileSystemConfig <FileSystemConfig[]>
-Handler <String>
-ImageConfig_IsCommandSet <Boolean>
-ImageConfig_IsEntryPointSet <Boolean>
-IsFileSystemConfigsSet <Boolean>
-IsLayersSet <Boolean>
-VpcConfig_IsSecurityGroupIdsSet <Boolean>
-VpcConfig_IsSubnetIdsSet <Boolean>
-Environment_IsVariablesSet <Boolean>
-KMSKeyArn <String>
-Layer <String[]>
-MemorySize <Int32>
-TracingConfig_Mode <TracingMode>
-RevisionId <String>
-Role <String>
-Runtime <Runtime>
-VpcConfig_SecurityGroupId <String[]>
-EphemeralStorage_Size <Int32>
-VpcConfig_SubnetId <String[]>
-DeadLetterConfig_TargetArn <String>
-Timeout <Int32>
-Environment_Variable <Hashtable>
-ImageConfig_WorkingDirectory <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Modify the version-specific settings of a Lambda function. When you update a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute. During this time, you can't modify the function, but you can still invoke it. The LastUpdateStatus, LastUpdateStatusReason, and LastUpdateStatusReasonCode fields in the response from GetFunctionConfiguration indicate when the update is complete and the function is processing events with the new configuration. For more information, see Function States. These settings can vary between versions of a function and are locked when you publish a version. You can't modify the configuration of a published version, only the unpublished version. To configure function concurrency, use PutFunctionConcurrency. To grant invoke permissions to an account or Amazon Web Services service, use AddPermission.

Parameters

-DeadLetterConfig_TargetArn <String>
The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
A description of the function.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Environment_IsVariablesSet <Boolean>
This property is set to true if the property is set; false otherwise. This property can be used to determine if the related property was returned by a service response or if the related property should be sent to the service during a service call.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Environment_Variable <Hashtable>
Environment variable key-value pairs. For more information, see Using Lambda environment variables.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEnvironment_Variables
-EphemeralStorage_Size <Int32>
The size of the function’s /tmp directory.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FileSystemConfig <FileSystemConfig[]>
Connection settings for an Amazon EFS file system.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFileSystemConfigs
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FunctionName <String>
Amazon.Lambda.Model.UpdateFunctionConfigurationRequest.FunctionName
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Handler <String>
The name of the method within your code that Lambda calls to execute your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ImageConfig_Command <String[]>
Specifies parameters that you want to pass in with ENTRYPOINT.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ImageConfig_EntryPoint <String[]>
Specifies the entry point to their application, which is typically the location of the runtime executable.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ImageConfig_IsCommandSet <Boolean>
This property is set to true if the property is set; false otherwise. This property can be used to determine if the related property was returned by a service response or if the related property should be sent to the service during a service call.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ImageConfig_IsEntryPointSet <Boolean>
This property is set to true if the property is set; false otherwise. This property can be used to determine if the related property was returned by a service response or if the related property should be sent to the service during a service call.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ImageConfig_WorkingDirectory <String>
Specifies the working directory.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IsFileSystemConfigsSet <Boolean>
This property is set to true if the property is set; false otherwise. This property can be used to determine if the related property was returned by a service response or if the related property should be sent to the service during a service call.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IsLayersSet <Boolean>
This property is set to true if the property is set; false otherwise. This property can be used to determine if the related property was returned by a service response or if the related property should be sent to the service during a service call.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KMSKeyArn <String>
The ARN of the Amazon Web Services Key Management Service (KMS) key that's used to encrypt your function's environment variables. If it's not provided, Lambda uses a default service key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Layer <String[]>
A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLayers
-MemorySize <Int32>
The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the FunctionName parameter. The -PassThru parameter is deprecated, use -Select '^FunctionName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RevisionId <String>
Only update the function if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Role <String>
The Amazon Resource Name (ARN) of the function's execution role.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Runtime <Runtime>
The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Lambda.Model.UpdateFunctionConfigurationResponse). Specifying the name of a property of type Amazon.Lambda.Model.UpdateFunctionConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Timeout <Int32>
The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For additional information, see Lambda execution environment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TracingConfig_Mode <TracingMode>
The tracing mode.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VpcConfig_IsSecurityGroupIdsSet <Boolean>
This property is set to true if the property is set; false otherwise. This property can be used to determine if the related property was returned by a service response or if the related property should be sent to the service during a service call.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VpcConfig_IsSubnetIdsSet <Boolean>
This property is set to true if the property is set; false otherwise. This property can be used to determine if the related property was returned by a service response or if the related property should be sent to the service during a service call.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VpcConfig_SecurityGroupId <String[]>
A list of VPC security groups IDs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVpcConfig_SecurityGroupIds
-VpcConfig_SubnetId <String[]>
A list of VPC subnet IDs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVpcConfig_SubnetIds

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.Lambda.Model.UpdateFunctionConfigurationResponse
This cmdlet returns an Amazon.Lambda.Model.UpdateFunctionConfigurationResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Examples

Example 1

Update-LMFunctionConfiguration -FunctionName "MylambdaFunction123" -Handler "lambda_function.launch_instance" -Timeout 600 -Environment_Variable @{ "envvar1"="value";"envvar2"="value" } -Role arn:aws:iam::123456789101:role/service-role/lambda -DeadLetterConfig_TargetArn arn:aws:sns:us-east-1: 123456789101:MyfirstTopic
This example updates the existing Lambda Function Configuration
Developer Guide
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z