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>
-Description <String>
-Handler <String>
-KMSKeyArn <String>
-MemorySize <Int32>
-TracingConfig_Mode <TracingMode>
-RevisionId <String>
-Role <String>
-Runtime <Runtime>
-VpcConfig_SecurityGroupId <String[]>
-VpcConfig_SubnetId <String[]>
-DeadLetterConfig_TargetArn <String>
-Timeout <Int32>
-Environment_Variable <Hashtable>
-Force <SwitchParameter>

Description

Updates the configuration parameters for the specified Lambda function by using the values provided in the request. You provide only the parameters you want to change. This operation must only be used on an existing Lambda function and cannot be used to update the function's code. If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases. This operation requires permission for the lambda:UpdateFunctionConfiguration action.

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?False
-Description <String>
A short user-defined function description. AWS Lambda does not use this value. Assign a meaningful description as you see fit.
Required?False
Position?Named
Accept pipeline input?False
-Environment_Variable <Hashtable>
Environment variable key-value pairs.
Required?False
Position?Named
Accept pipeline input?False
-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?False
-FunctionName <String>
Amazon.Lambda.Model.UpdateFunctionConfigurationRequest.FunctionName
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Handler <String>
The function that Lambda calls to begin executing your function. For Node.js, it is the module-name.export value in your function.
Required?False
Position?Named
Accept pipeline input?False
-KMSKeyArn <String>
The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If you elect to use the AWS Lambda default service key, pass in an empty string ("") for this parameter.
Required?False
Position?Named
Accept pipeline input?False
-MemorySize <Int32>
The amount of memory, in MB, your Lambda function is given. AWS Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.
Required?False
Position?Named
Accept pipeline input?False
-RevisionId <String>
An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID you pass doesn't match the latest RevisionId of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias RevisionID using either GetFunction or GetAlias.
Required?False
Position?Named
Accept pipeline input?False
-Role <String>
The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.
Required?False
Position?Named
Accept pipeline input?False
-Runtime <Runtime>
The runtime version for the function.
Required?False
Position?Named
Accept pipeline input?False
-Timeout <Int32>
The amount of time that Lambda allows a function to run before terminating it. The default is 3 seconds. The maximum allowed value is 900 seconds.
Required?False
Position?Named
Accept pipeline input?False
-TracingConfig_Mode <TracingMode>
The tracing mode.
Required?False
Position?Named
Accept pipeline input?False
-VpcConfig_SecurityGroupId <String[]>
A list of VPC security groups IDs.
Required?False
Position?Named
Accept pipeline input?False
-VpcConfig_SubnetId <String[]>
A list of VPC subnet IDs.
Required?False
Position?Named
Accept pipeline input?False

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? False
-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? False
-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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

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? False
-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? False
-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? False
-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? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-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? False

Inputs

You can pipe a String object to this cmdlet for the FunctionName parameter.

Outputs

This cmdlet returns a 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.

Supported Version

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