Package software.amazon.awscdk.services.lambda

Class CfnMicrovmImage

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.lambda.CfnMicrovmImage
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IMicrovmImageRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.133.0 (build 0f43e37)", date="2026-07-02T13:32:41.774Z") @Stability(Stable) public class CfnMicrovmImage extends CfnResource implements IInspectable, IMicrovmImageRef, ITaggableV2
Resource Type definition for AWS::Lambda::MicrovmImage.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lambda.*;
 CfnMicrovmImage cfnMicrovmImage = CfnMicrovmImage.Builder.create(this, "MyCfnMicrovmImage")
         .additionalOsCapabilities(List.of("additionalOsCapabilities"))
         .baseImageArn("baseImageArn")
         .baseImageVersion("baseImageVersion")
         .buildRoleArn("buildRoleArn")
         .codeArtifact(CodeArtifactProperty.builder()
                 .uri("uri")
                 .build())
         .cpuConfigurations(List.of(CpuConfigurationProperty.builder()
                 .architecture("architecture")
                 .build()))
         .description("description")
         .egressNetworkConnectors(List.of("egressNetworkConnectors"))
         .environmentVariables(List.of(EnvironmentVariableProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .hooks(HooksProperty.builder()
                 .microvmHooks(MicrovmHooksProperty.builder()
                         .resume("resume")
                         .resumeTimeoutInSeconds(123)
                         .run("run")
                         .runTimeoutInSeconds(123)
                         .suspend("suspend")
                         .suspendTimeoutInSeconds(123)
                         .terminate("terminate")
                         .terminateTimeoutInSeconds(123)
                         .build())
                 .microvmImageHooks(MicrovmImageHooksProperty.builder()
                         .ready("ready")
                         .readyTimeoutInSeconds(123)
                         .validate("validate")
                         .validateTimeoutInSeconds(123)
                         .build())
                 .port(123)
                 .build())
         .logging(LoggingProperty.builder()
                 .cloudWatch(CloudWatchLoggingProperty.builder()
                         .logGroup("logGroup")
                         .logStream("logStream")
                         .build())
                 .disabled(false)
                 .build())
         .name("name")
         .resources(List.of(ResourcesProperty.builder()
                 .minimumMemoryInMiB(123)
                 .build()))
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnMicrovmImage

      protected CfnMicrovmImage(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnMicrovmImage

      protected CfnMicrovmImage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnMicrovmImage

      @Stability(Stable) public CfnMicrovmImage(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnMicrovmImageProps props)
      Create a new AWS::Lambda::MicrovmImage.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • isCfnMicrovmImage

      @Stability(Stable) @NotNull public static Boolean isCfnMicrovmImage(@NotNull Object x)
      Checks whether the given object is a CfnMicrovmImage.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      Timestamp when the MicroVM image was created.

    • getAttrImageArn

      @Stability(Stable) @NotNull public String getAttrImageArn()
      ARN of the MicroVM image.

    • getAttrLatestActiveImageVersion

      @Stability(Stable) @NotNull public String getAttrLatestActiveImageVersion()
      The latest active version of the MicroVM image.

    • getAttrLatestFailedImageVersion

      @Stability(Stable) @NotNull public String getAttrLatestFailedImageVersion()
      The latest failed version of the MicroVM image.

    • getAttrState

      @Stability(Stable) @NotNull public String getAttrState()

    • getAttrUpdatedAt

      @Stability(Stable) @NotNull public String getAttrUpdatedAt()
      Timestamp when the MicroVM image was updated.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getMicrovmImageRef

      @Stability(Stable) @NotNull public MicrovmImageReference getMicrovmImageRef()
      A reference to a MicrovmImage resource.
      Specified by:
      getMicrovmImageRef in interface IMicrovmImageRef

    • getAdditionalOsCapabilities

      @Stability(Stable) @NotNull public List<String> getAdditionalOsCapabilities()

    • setAdditionalOsCapabilities

      @Stability(Stable) public void setAdditionalOsCapabilities(@NotNull List<String> value)

    • getBaseImageArn

      @Stability(Stable) @NotNull public String getBaseImageArn()
      ARN of the base MicroVM image.

    • setBaseImageArn

      @Stability(Stable) public void setBaseImageArn(@NotNull String value)
      ARN of the base MicroVM image.

    • getBaseImageVersion

      @Stability(Stable) @NotNull public String getBaseImageVersion()
      Specific version of the base MicroVM image to use.

    • setBaseImageVersion

      @Stability(Stable) public void setBaseImageVersion(@NotNull String value)
      Specific version of the base MicroVM image to use.

    • getBuildRoleArn

      @Stability(Stable) @NotNull public String getBuildRoleArn()
      ARN of the IAM build role.

    • setBuildRoleArn

      @Stability(Stable) public void setBuildRoleArn(@NotNull String value)
      ARN of the IAM build role.

    • getCodeArtifact

      @Stability(Stable) @NotNull public Object getCodeArtifact()
      Returns union: either IResolvable or CfnMicrovmImage.CodeArtifactProperty

    • setCodeArtifact

      @Stability(Stable) public void setCodeArtifact(@NotNull IResolvable value)

    • setCodeArtifact

      @Stability(Stable) public void setCodeArtifact(@NotNull CfnMicrovmImage.CodeArtifactProperty value)

    • getCpuConfigurations

      @Stability(Stable) @NotNull public Object getCpuConfigurations()
      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnMicrovmImage.CpuConfigurationProperty>

    • setCpuConfigurations

      @Stability(Stable) public void setCpuConfigurations(@NotNull IResolvable value)

    • setCpuConfigurations

      @Stability(Stable) public void setCpuConfigurations(@NotNull List<Object> value)

    • getDescription

      @Stability(Stable) @NotNull public String getDescription()
      Human-readable description of the MicroVM image and its purpose.

    • setDescription

      @Stability(Stable) public void setDescription(@NotNull String value)
      Human-readable description of the MicroVM image and its purpose.

    • getEgressNetworkConnectors

      @Stability(Stable) @NotNull public List<String> getEgressNetworkConnectors()

    • setEgressNetworkConnectors

      @Stability(Stable) public void setEgressNetworkConnectors(@NotNull List<String> value)

    • getEnvironmentVariables

      @Stability(Stable) @NotNull public Object getEnvironmentVariables()
      Environment variables to set in the container during the snapshot build.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnMicrovmImage.EnvironmentVariableProperty>

    • setEnvironmentVariables

      @Stability(Stable) public void setEnvironmentVariables(@NotNull IResolvable value)
      Environment variables to set in the container during the snapshot build.

    • setEnvironmentVariables

      @Stability(Stable) public void setEnvironmentVariables(@NotNull List<Object> value)
      Environment variables to set in the container during the snapshot build.

    • getHooks

      @Stability(Stable) @NotNull public Object getHooks()
      Returns union: either IResolvable or CfnMicrovmImage.HooksProperty

    • setHooks

      @Stability(Stable) public void setHooks(@NotNull IResolvable value)

    • setHooks

      @Stability(Stable) public void setHooks(@NotNull CfnMicrovmImage.HooksProperty value)

    • getLogging

      @Stability(Stable) @NotNull public Object getLogging()
      Returns union: either IResolvable or CfnMicrovmImage.LoggingProperty

    • setLogging

      @Stability(Stable) public void setLogging(@NotNull IResolvable value)

    • setLogging

      @Stability(Stable) public void setLogging(@NotNull CfnMicrovmImage.LoggingProperty value)

    • getName

      @Stability(Stable) @NotNull public String getName()
      Unique name for the MicroVM image within the account.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      Unique name for the MicroVM image within the account.

    • getResources

      @Stability(Stable) @NotNull public Object getResources()
      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnMicrovmImage.ResourcesProperty>

    • setResources

      @Stability(Stable) public void setResources(@NotNull IResolvable value)

    • setResources

      @Stability(Stable) public void setResources(@NotNull List<Object> value)

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Key-value pairs to associate with the MicroVM image for organization and management.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Key-value pairs to associate with the MicroVM image for organization and management.