MicrovmImageVersionSummary
Contains summary information about a version of a MicroVM image.
Contents
- baseImageArn
-
The ARN of the base MicroVM image used.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
[^\s]+Required: Yes
- buildRoleArn
-
The ARN of the IAM build role.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:aws[a-z\-]*:iam::[0-9]{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+Required: Yes
- codeArtifact
-
The code artifact for this version.
Type: CodeArtifact object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
- createdAt
-
The timestamp when the version was created.
Type: Timestamp
Required: Yes
- imageArn
-
The ARN of the MicroVM image.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
[^\s]+Required: Yes
- imageVersion
-
The version of the MicroVM image.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
[^\s]+Required: Yes
- state
-
The current state of the version.
Type: String
Valid Values:
PENDING | IN_PROGRESS | SUCCESSFUL | FAILED | DELETING | DELETED | DELETE_FAILEDRequired: Yes
- status
-
The availability status of the version: ACTIVE (can be used by RunMicrovm) or INACTIVE (blocked from launching new MicroVMs).
Type: String
Valid Values:
ACTIVE | INACTIVERequired: Yes
- additionalOsCapabilities
-
Additional OS capabilities granted to the MicroVM runtime environment.
Type: Array of strings
Valid Values:
ALLRequired: No
- baseImageVersion
-
The specific version of the base MicroVM image.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
[^\s]+Required: No
- cpuConfigurations
-
The list of supported CPU configurations for the MicroVM.
Type: Array of CpuConfiguration objects
Required: No
- description
-
The description of the version.
Type: String
Required: No
- egressNetworkConnectors
-
The list of egress network connectors available to the MicroVM at runtime.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
- environmentVariables
-
Environment variables set in the MicroVM runtime environment.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 256.
Key Pattern:
[^\s]+Value Length Constraints: Minimum length of 0. Maximum length of 4096.
Required: No
- hooks
-
Lifecycle hook configuration for MicroVMs and MicroVM images.
Type: Hooks object
Required: No
- logging
-
The logging configuration for this version.
Type: Logging object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- resources
-
The resource requirements for the MicroVM.
Type: Array of Resources objects
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Required: No
- stateReason
-
The reason for the current state. For example, one or more builds failed.
Type: String
Required: No
-
Key-value pairs associated with the version.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
([\p{L}\p{Z}\p{N}_.:/=+\-@]*)Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern:
([\p{L}\p{Z}\p{N}_.:/=+\-@]*)Required: No
- updatedAt
-
The timestamp when the version was last updated.
Type: Timestamp
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: