Skip to content
v2.273.0

CfnMicrovmImageProps Struct ​

Properties for defining a CfnMicrovmImage.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lambda as lambda } from 'aws-cdk-lib';
const cfnMicrovmImageProps: lambda.CfnMicrovmImageProps = {
  additionalOsCapabilities: ['additionalOsCapabilities'],
  baseImageArn: 'baseImageArn',
  baseImageVersion: 'baseImageVersion',
  buildRoleArn: 'buildRoleArn',
  codeArtifact: {
    uri: 'uri',
  },
  cpuConfigurations: [{
    architecture: 'architecture',
  }],
  description: 'description',
  egressNetworkConnectors: ['egressNetworkConnectors'],
  environmentVariables: [{
    key: 'key',
    value: 'value',
  }],
  hooks: {
    microvmHooks: {
      resume: 'resume',
      resumeTimeoutInSeconds: 123,
      run: 'run',
      runTimeoutInSeconds: 123,
      suspend: 'suspend',
      suspendTimeoutInSeconds: 123,
      terminate: 'terminate',
      terminateTimeoutInSeconds: 123,
    },
    microvmImageHooks: {
      ready: 'ready',
      readyTimeoutInSeconds: 123,
      validate: 'validate',
      validateTimeoutInSeconds: 123,
    },
    port: 123,
  },
  logging: {
    cloudWatch: {
      logGroup: 'logGroup',
      logStream: 'logStream',
    },
    disabled: false,
  },
  name: 'name',
  resources: [{
    minimumMemoryInMiB: 123,
  }],

  // the properties below are optional
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

additionalOsCapabilitiesstring[]additional_os_capabilitiestyping.List[str]additionalOsCapabilitiesList<String>AdditionalOsCapabilitiesstring[]AdditionalOsCapabilities*[]*stringrequired#
baseImageArnstringbase_image_arnstrbaseImageArnStringBaseImageArnstringBaseImageArn*stringrequired#
ARN of the base MicroVM image.
baseImageVersionstringbase_image_versionstrbaseImageVersionStringBaseImageVersionstringBaseImageVersion*stringrequired#
Specific version of the base MicroVM image to use.
buildRoleArnstringbuild_role_arnstrbuildRoleArnStringBuildRoleArnstringBuildRoleArn*stringrequired#
ARN of the IAM build role.
codeArtifactIResolvable | CfnMicrovmImage.CodeArtifactPropertycode_artifacttyping.Union[IResolvable, CodeArtifactProperty]codeArtifactIResolvableCodeArtifactIResolvableCodeArtifactinterface{}required#
cpuConfigurationsIResolvable | IResolvable | CfnMicrovmImage.CpuConfigurationProperty[]cpu_configurationstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, CpuConfigurationProperty]]]cpuConfigurationsIResolvableCpuConfigurationsIResolvableCpuConfigurationsinterface{}required#
descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*stringrequired#
Human-readable description of the MicroVM image and its purpose.
egressNetworkConnectorsstring[]egress_network_connectorstyping.List[str]egressNetworkConnectorsList<String>EgressNetworkConnectorsstring[]EgressNetworkConnectors*[]*stringrequired#
environmentVariablesIResolvable | IResolvable | CfnMicrovmImage.EnvironmentVariableProperty[]environment_variablestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, EnvironmentVariableProperty]]]environmentVariablesIResolvableEnvironmentVariablesIResolvableEnvironmentVariablesinterface{}required#
Environment variables to set in the container during the snapshot build.
hooksIResolvable | CfnMicrovmImage.HooksPropertyhookstyping.Union[IResolvable, HooksProperty]hooksIResolvableHooksIResolvableHooksinterface{}required#
loggingIResolvable | CfnMicrovmImage.LoggingPropertyloggingtyping.Union[IResolvable, LoggingProperty]loggingIResolvableLoggingIResolvableLogginginterface{}required#
namestringnamestrnameStringNamestringName*stringrequired#
Unique name for the MicroVM image within the account.
resourcesIResolvable | IResolvable | CfnMicrovmImage.ResourcesProperty[]resourcestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ResourcesProperty]]]resourcesIResolvableResourcesIResolvableResourcesinterface{}required#
tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#
Key-value pairs to associate with the MicroVM image for organization and management.

Used as props by ​