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 Lambda Web CreateWebFunction API operation.

Syntax

New-LWEBWebFunction
-FunctionName <String>
-RevisionConfig_ServiceConfig_TelemetryConfig_LoggingConfig_ApplicationLogLevel <ApplicationLogLevel>
-EndpointConfig_AuthType <AuthType>
-EndpointConfig_AutoDeploymentMode <AutoDeploymentMode>
-RevisionConfig_BuildConfig_CodeConfig_S3Object_Bucket <String>
-EndpointConfig_Description <String>
-RevisionConfig_Description <String>
-RevisionConfig_ServiceConfig_EgressNetworkConnectorArn <String>
-EndpointConfig_EndpointName <String>
-EndpointConfig_EndpointType <EndpointType>
-RevisionConfig_ServiceConfig_EnvironmentVariable <Hashtable>
-RevisionConfig_ServiceConfig_ExecutionRoleArn <String>
-RevisionConfig_BuildConfig_CodeConfig_S3Object_Key <String>
-RevisionConfig_KmsKeyArn <String>
-RevisionConfig_ServiceConfig_TelemetryConfig_LoggingConfig_LogGroup <String>
-RevisionConfig_ServiceConfig_MaxConcurrencyPerEnvironment <Int32>
-EndpointConfig_ScalingConfig_MaxEnvironment <Int32>
-EndpointConfig_ThrottleConfig_RateLimit <Int32>
-EndpointConfig_Region <String[]>
-RevisionConfig_BuildConfig_RuntimeConfig_Runtime <String>
-RevisionConfig_ServiceConfig_TelemetryConfig_LoggingConfig_SystemLogLevel <SystemLogLevel>
-Tag <Hashtable>
-RevisionConfig_ServiceConfig_TimeoutSecond <Int32>
-RevisionConfig_BuildConfig_CodeConfig_S3Object_VersionId <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonLambdaWebConfig>

Description

Creates a web function with an initial revision and endpoint. To create a web function, you provide the function name, revision configuration (code and service settings), and endpoint configuration. To use this operation, you must have the CreateWebFunction permission on the web function. You don't need separate permissions for the initial revision or endpoint.

Parameters

-ClientConfig <AmazonLambdaWebConfig>
Amazon.PowerShell.Cmdlets.LWEB.AmazonLambdaWebClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EndpointConfig_AuthType <AuthType>
The authorization type for the endpoint.Valid values:
  • ApplicationManaged – Your application handles authorization.
  • IamAuth – Lambda uses IAM to authorize requests, which must be signed with Signature Version 4 (SigV4).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EndpointConfig_AutoDeploymentMode <AutoDeploymentMode>
The auto-deployment mode for the endpoint. If you don't specify a value, the default is Disabled, and this default is returned in the response.Valid values:
  • LatestRevision – The endpoint automatically serves the newest revision.
  • Disabled – Revision routing stays fixed until you change it.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EndpointConfig_Description <String>
A description of the endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EndpointConfig_EndpointName <String>
The name of the endpoint. The name can contain letters, numbers, hyphens (-), and underscores (_), and can't begin or end with a hyphen or an underscore. The name is limited to 64 characters in length.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EndpointConfig_EndpointType <EndpointType>
The type of endpoint. Determines how traffic is served and routed across Regions.Valid values:
  • HomeRegion – Serves traffic from the Region where you created the web function.
  • MultiRegion – Replicates across the Regions that you choose and routes each request to the nearest one.
  • PerRegion – Creates a separate endpoint in each Region that you choose.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EndpointConfig_Region <String[]>
The list of Regions for the endpoint. Required when the endpoint type is MultiRegion or PerRegion: specify at least one Region other than the Region where you create the endpoint (the home Region). The home Region is added automatically if you don't include it; specifying only the home Region isn't allowed. When the endpoint type is HomeRegion, omit this field or specify only the home Region. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEndpointConfig_Regions
-EndpointConfig_ScalingConfig_MaxEnvironment <Int32>
The maximum number of concurrent execution environments for the endpoint. Minimum value of 2, maximum value of 10000. There is no default value. If you don't specify a value, the scaling configuration is absent from the response. On an update, omit scalingConfig to keep the current value, or specify an empty object to clear a previously set value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEndpointConfig_ScalingConfig_MaxEnvironments
-EndpointConfig_ThrottleConfig_RateLimit <Int32>
The maximum request rate per second for the endpoint. The value must be one of the following supported values: 0, 100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 2000, 3000, 4000, 5000, 6000, 7000, 8000, 9000, or 10000. The maximum effective value is also bounded by your account-level maximum total rate limit. There is no default value. If you don't specify a value, the throttling configuration is absent from the response. On an update, omit throttleConfig to keep the current value, or specify an empty object to clear a previously set value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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>
The name of the web function. The name can contain letters, numbers, hyphens (-), and underscores (_), and can't begin or end with a hyphen or an underscore. The name is limited to 64 characters in length.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-RevisionConfig_BuildConfig_CodeConfig_S3Object_Bucket <String>
The name of the Amazon S3 bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RevisionConfig_BuildConfig_CodeConfig_S3Object_Key <String>
The Amazon S3 object key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RevisionConfig_BuildConfig_CodeConfig_S3Object_VersionId <String>
The version ID of the Amazon S3 object.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RevisionConfig_BuildConfig_RuntimeConfig_Runtime <String>
The runtime identifier for the web function (for example, a Node.js runtime identifier).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RevisionConfig_Description <String>
A description of the revision.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RevisionConfig_KmsKeyArn <String>
The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) key used to encrypt the revision's code and environment variables.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RevisionConfig_ServiceConfig_EgressNetworkConnectorArn <String>
The Amazon Resource Name (ARN) of the Lambda network connector that gives the web function access to resources in your VPC. You must specify the fully qualified ARN, including the connector version, which pins the revision to that version. If the network connector is deleted, invocations of revisions that reference it fail. Revisions that specify a network connector support only HomeRegion endpoints, not MultiRegion or PerRegion.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RevisionConfig_ServiceConfig_EnvironmentVariable <Hashtable>
A map of environment variable key-value pairs available to the web function at runtime. Environment variable values are sensitive. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRevisionConfig_ServiceConfig_EnvironmentVariables
-RevisionConfig_ServiceConfig_ExecutionRoleArn <String>
The ARN of the IAM role that the web function assumes when it runs. This role provides permissions to access AWS services and resources.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RevisionConfig_ServiceConfig_MaxConcurrencyPerEnvironment <Int32>
The maximum number of concurrent requests handled per execution environment. Minimum value of 1, maximum value of 128. If you don't specify a value, the default is 64, and this default is returned in the response.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RevisionConfig_ServiceConfig_TelemetryConfig_LoggingConfig_ApplicationLogLevel <ApplicationLogLevel>
The log level for application logs emitted by the web function. If you don't specify a value, the default is INFO, and this default is returned in the response.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RevisionConfig_ServiceConfig_TelemetryConfig_LoggingConfig_LogGroup <String>
The name of the Amazon CloudWatch Logs log group the web function sends logs to. If you don't specify a value, the default is /aws/lambda/web/{functionName}, and this default is returned in the response.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RevisionConfig_ServiceConfig_TelemetryConfig_LoggingConfig_SystemLogLevel <SystemLogLevel>
The log level for system logs emitted by the Lambda runtime. If you don't specify a value, the default is INFO, and this default is returned in the response.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RevisionConfig_ServiceConfig_TimeoutSecond <Int32>
The amount of time (in seconds) that Lambda allows the web function to run before stopping it. Minimum value of 3, maximum value of 900. If you don't specify a value, the default is 30, and this default is returned in the response.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRevisionConfig_ServiceConfig_TimeoutSeconds
-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.LambdaWeb.Model.CreateWebFunctionResponse). Specifying the name of a property of type Amazon.LambdaWeb.Model.CreateWebFunctionResponse 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)
-Tag <Hashtable>
A map of tag keys and values to apply to the web function. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

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.LambdaWeb.Model.CreateWebFunctionResponse
This cmdlet returns an Amazon.LambdaWeb.Model.CreateWebFunctionResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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