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 MicroVMs CreateMicrovmImage API operation.

Syntax

New-LMVM2MicrovmImage
-AdditionalOsCapability <String[]>
-BaseImageArn <String>
-BaseImageVersion <String>
-BuildRoleArn <String>
-CpuConfiguration <CpuConfiguration[]>
-Description <String>
-Logging_Disabled <LoggingDisabled>
-EgressNetworkConnector <String[]>
-EnvironmentVariable <Hashtable>
-Logging_CloudWatch_LogGroup <String>
-Logging_CloudWatch_LogStream <String>
-Name <String>
-Hooks_Port <Int32>
-Hooks_MicrovmImageHooks_Ready <HookState>
-Hooks_MicrovmImageHooks_ReadyTimeoutInSecond <Int32>
-Resource <Resources[]>
-Hooks_MicrovmHooks_Resume <HookState>
-Hooks_MicrovmHooks_ResumeTimeoutInSecond <Int32>
-Hooks_MicrovmHooks_Run <HookState>
-Hooks_MicrovmHooks_RunTimeoutInSecond <Int32>
-Hooks_MicrovmHooks_Suspend <HookState>
-Hooks_MicrovmHooks_SuspendTimeoutInSecond <Int32>
-Tag <Hashtable>
-Hooks_MicrovmHooks_Terminate <HookState>
-Hooks_MicrovmHooks_TerminateTimeoutInSecond <Int32>
-CodeArtifact_Uri <String>
-Hooks_MicrovmImageHooks_Validate <HookState>
-Hooks_MicrovmImageHooks_ValidateTimeoutInSecond <Int32>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonLambdaMicrovmsConfig>

Description

Creates a MicroVM image from the specified code artifact and base image. The build is asynchronous — the image transitions from CREATING to CREATED on success, or CREATE_FAILED on failure. Use GetMicrovmImage to poll for completion.

Parameters

-AdditionalOsCapability <String[]>
Additional OS capabilities granted to the MicroVM runtime environment. 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)
AliasesAdditionalOsCapabilities
-BaseImageArn <String>
The ARN of the Lambda-managed base MicroVM image to build upon. Use ListManagedMicrovmImages to discover available base images.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-BaseImageVersion <String>
The specific version of the base MicroVM image to use.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-BuildRoleArn <String>
The ARN of the IAM role assumed during the image build process. This role must have permissions to access the code artifact and any required resources.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonLambdaMicrovmsConfig>
Amazon.PowerShell.Cmdlets.LMVM2.AmazonLambdaMicrovmsClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token, the operation returns the successful response without performing any further actions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CodeArtifact_Uri <String>
The URI of the code artifact, such as an Amazon S3 path or Amazon ECR image URI.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CpuConfiguration <CpuConfiguration[]>
The list of supported CPU configurations for the MicroVM. 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)
AliasesCpuConfigurations
-Description <String>
A description of the MicroVM image.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EgressNetworkConnector <String[]>
The list of egress network connectors available to the MicroVM at runtime. 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)
AliasesEgressNetworkConnectors
-EnvironmentVariable <Hashtable>
Environment variables set in the MicroVM runtime environment. 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)
AliasesEnvironmentVariables
-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)
-Hooks_MicrovmHooks_Resume <HookState>
The path of the hook invoked when the MicroVM resumes from a suspended state.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Hooks_MicrovmHooks_ResumeTimeoutInSecond <Int32>
The maximum time in seconds for the resume hook to complete.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHooks_MicrovmHooks_ResumeTimeoutInSeconds
-Hooks_MicrovmHooks_Run <HookState>
The path of the hook invoked when the MicroVM starts running.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Hooks_MicrovmHooks_RunTimeoutInSecond <Int32>
The maximum time in seconds for the run hook to complete.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHooks_MicrovmHooks_RunTimeoutInSeconds
-Hooks_MicrovmHooks_Suspend <HookState>
The path of the hook invoked when the MicroVM is suspended.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Hooks_MicrovmHooks_SuspendTimeoutInSecond <Int32>
The maximum time in seconds for the suspend hook to complete.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHooks_MicrovmHooks_SuspendTimeoutInSeconds
-Hooks_MicrovmHooks_Terminate <HookState>
The path of the hook invoked when the MicroVM is terminated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Hooks_MicrovmHooks_TerminateTimeoutInSecond <Int32>
The maximum time in seconds for the terminate hook to complete.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHooks_MicrovmHooks_TerminateTimeoutInSeconds
-Hooks_MicrovmImageHooks_Ready <HookState>
The path of the hook invoked when the MicroVM image build is ready.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Hooks_MicrovmImageHooks_ReadyTimeoutInSecond <Int32>
The maximum time in seconds for the ready hook to complete.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHooks_MicrovmImageHooks_ReadyTimeoutInSeconds
-Hooks_MicrovmImageHooks_Validate <HookState>
The path of the hook invoked to validate the MicroVM image build.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Hooks_MicrovmImageHooks_ValidateTimeoutInSecond <Int32>
The maximum time in seconds for the validate hook to complete.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHooks_MicrovmImageHooks_ValidateTimeoutInSeconds
-Hooks_Port <Int32>
The port number on which the hooks listener runs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Logging_CloudWatch_LogGroup <String>
The name of the CloudWatch Logs log group to send logs to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Logging_CloudWatch_LogStream <String>
The name of the CloudWatch Logs log stream within the log group.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Logging_Disabled <LoggingDisabled>
Specifies that logging is disabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
The name of the MicroVM image. Must be unique within the AWS account.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Resource <Resources[]>
The resource requirements for the MicroVM. 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)
AliasesResources
-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.LambdaMicrovms.Model.CreateMicrovmImageResponse). Specifying the name of a property of type Amazon.LambdaMicrovms.Model.CreateMicrovmImageResponse 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 set of key-value pairs that you can attach to the resource. Use tags to categorize resources for cost allocation, access control (ABAC), and organization. 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.LambdaMicrovms.Model.CreateMicrovmImageResponse
This cmdlet returns an Amazon.LambdaMicrovms.Model.CreateMicrovmImageResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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