View a markdown version of this page

AWS::Lambda::MicrovmImage - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Lambda::MicrovmImage

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.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Lambda::MicrovmImage",
  "Properties" : {
      "AdditionalOsCapabilities" : [ String, ... ],
      "BaseImageArn" : String,
      "BaseImageVersion" : String,
      "BuildRoleArn" : String,
      "CodeArtifact" : CodeArtifact,
      "CpuConfigurations" : [ CpuConfiguration, ... ],
      "Description" : String,
      "EgressNetworkConnectors" : [ String, ... ],
      "EnvironmentVariables" : [ EnvironmentVariable, ... ],
      "Hooks" : Hooks,
      "Logging" : Logging,
      "Name" : String,
      "Resources" : [ Resources, ... ],
      "Tags" : [ Tag, ... ]
    }
}

Properties

AdditionalOsCapabilities

Additional OS capabilities granted to the MicroVM runtime environment.

Required: Yes

Type: Array of String

Allowed values: ALL

Update requires: No interruption

BaseImageArn

The ARN of the base MicroVM image used.

Required: Yes

Type: String

Pattern: ^[^\s]+$

Minimum: 1

Maximum: 2048

Update requires: No interruption

BaseImageVersion

The specific version of the base MicroVM image.

Required: Yes

Type: String

Pattern: ^[^\s]+$

Minimum: 1

Maximum: 2048

Update requires: No interruption

BuildRoleArn

The ARN of the IAM build role.

Required: Yes

Type: String

Pattern: ^arn:aws[a-zA-Z-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

Update requires: No interruption

CodeArtifact

The code artifact for this version.

Required: Yes

Type: CodeArtifact

Update requires: No interruption

CpuConfigurations

The list of supported CPU configurations for the MicroVM.

Required: Yes

Type: Array of CpuConfiguration

Update requires: No interruption

Description

The description of the version.

Required: Yes

Type: String

Update requires: No interruption

EgressNetworkConnectors

The list of egress network connectors available to the MicroVM at runtime.

Required: Yes

Type: Array of String

Maximum: 10

Update requires: No interruption

EnvironmentVariables

Environment variables set in the MicroVM runtime environment.

Required: Yes

Type: Array of EnvironmentVariable

Maximum: 50

Update requires: No interruption

Hooks

Lifecycle hook configuration for MicroVMs and MicroVM images.

Required: Yes

Type: Hooks

Update requires: No interruption

Logging

Configuration for MicroVM logging output. Specify exactly one: cloudWatch to enable CloudWatch logging, or disabled to turn off logging.

Required: Yes

Type: Logging

Update requires: No interruption

Name

The name of the MicroVM image.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9-_]+$

Minimum: 1

Maximum: 64

Update requires: Replacement

Resources

The resource requirements for the MicroVM.

Required: Yes

Type: Array of Resources

Maximum: 1

Update requires: No interruption

Tags

Key-value pairs associated with the version.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the resource name.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CreatedAt

The timestamp when the version was created.

ImageArn

The ARN of the MicroVM image.

LatestActiveImageVersion

The latest active version of the MicroVM image.

LatestFailedImageVersion

The latest failed version of the MicroVM image, if any.

State

The current state of the version.

UpdatedAt

The timestamp when the version was last updated.