Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data Image = Image' {
- blockDeviceMappings :: Maybe [BlockDeviceMapping]
- bootMode :: Maybe BootModeValues
- creationDate :: Maybe Text
- deprecationTime :: Maybe Text
- description :: Maybe Text
- enaSupport :: Maybe Bool
- imageOwnerAlias :: Maybe Text
- imdsSupport :: Maybe ImdsSupportValues
- kernelId :: Maybe Text
- name :: Maybe Text
- platform :: Maybe PlatformValues
- platformDetails :: Maybe Text
- productCodes :: Maybe [ProductCode]
- ramdiskId :: Maybe Text
- rootDeviceName :: Maybe Text
- sriovNetSupport :: Maybe Text
- stateReason :: Maybe StateReason
- tags :: Maybe [Tag]
- tpmSupport :: Maybe TpmSupportValues
- usageOperation :: Maybe Text
- imageId :: Text
- imageLocation :: Text
- state :: ImageState
- ownerId :: Text
- public :: Bool
- architecture :: ArchitectureValues
- imageType :: ImageTypeValues
- rootDeviceType :: DeviceType
- virtualizationType :: VirtualizationType
- hypervisor :: HypervisorType
- newImage :: Text -> Text -> ImageState -> Text -> Bool -> ArchitectureValues -> ImageTypeValues -> DeviceType -> VirtualizationType -> HypervisorType -> Image
- image_blockDeviceMappings :: Lens' Image (Maybe [BlockDeviceMapping])
- image_bootMode :: Lens' Image (Maybe BootModeValues)
- image_creationDate :: Lens' Image (Maybe Text)
- image_deprecationTime :: Lens' Image (Maybe Text)
- image_description :: Lens' Image (Maybe Text)
- image_enaSupport :: Lens' Image (Maybe Bool)
- image_imageOwnerAlias :: Lens' Image (Maybe Text)
- image_imdsSupport :: Lens' Image (Maybe ImdsSupportValues)
- image_kernelId :: Lens' Image (Maybe Text)
- image_name :: Lens' Image (Maybe Text)
- image_platform :: Lens' Image (Maybe PlatformValues)
- image_platformDetails :: Lens' Image (Maybe Text)
- image_productCodes :: Lens' Image (Maybe [ProductCode])
- image_ramdiskId :: Lens' Image (Maybe Text)
- image_rootDeviceName :: Lens' Image (Maybe Text)
- image_sriovNetSupport :: Lens' Image (Maybe Text)
- image_stateReason :: Lens' Image (Maybe StateReason)
- image_tags :: Lens' Image (Maybe [Tag])
- image_tpmSupport :: Lens' Image (Maybe TpmSupportValues)
- image_usageOperation :: Lens' Image (Maybe Text)
- image_imageId :: Lens' Image Text
- image_imageLocation :: Lens' Image Text
- image_state :: Lens' Image ImageState
- image_ownerId :: Lens' Image Text
- image_public :: Lens' Image Bool
- image_architecture :: Lens' Image ArchitectureValues
- image_imageType :: Lens' Image ImageTypeValues
- image_rootDeviceType :: Lens' Image DeviceType
- image_virtualizationType :: Lens' Image VirtualizationType
- image_hypervisor :: Lens' Image HypervisorType
Documentation
Describes an image.
See: newImage
smart constructor.
Image' | |
|
Instances
:: Text | |
-> Text | |
-> ImageState | |
-> Text | |
-> Bool | |
-> ArchitectureValues | |
-> ImageTypeValues | |
-> DeviceType | |
-> VirtualizationType | |
-> HypervisorType | |
-> Image |
Create a value of Image
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:blockDeviceMappings:Image'
, image_blockDeviceMappings
- Any block device mapping entries.
$sel:bootMode:Image'
, image_bootMode
- The boot mode of the image. For more information, see
Boot modes
in the Amazon EC2 User Guide.
$sel:creationDate:Image'
, image_creationDate
- The date and time the image was created.
$sel:deprecationTime:Image'
, image_deprecationTime
- The date and time to deprecate the AMI, in UTC, in the following format:
YYYY-MM-DDTHH:MM:SSZ. If you specified a value for seconds,
Amazon EC2 rounds the seconds to the nearest minute.
$sel:description:Image'
, image_description
- The description of the AMI that was provided during image creation.
$sel:enaSupport:Image'
, image_enaSupport
- Specifies whether enhanced networking with ENA is enabled.
$sel:imageOwnerAlias:Image'
, image_imageOwnerAlias
- The Amazon Web Services account alias (for example, amazon
, self
) or
the Amazon Web Services account ID of the AMI owner.
$sel:imdsSupport:Image'
, image_imdsSupport
- If v2.0
, it indicates that IMDSv2 is specified in the AMI. Instances
launched from this AMI will have HttpTokens
automatically set to
required
so that, by default, the instance requires that IMDSv2 is
used when requesting instance metadata. In addition,
HttpPutResponseHopLimit
is set to 2
. For more information, see
Configure the AMI
in the Amazon EC2 User Guide.
$sel:kernelId:Image'
, image_kernelId
- The kernel associated with the image, if any. Only applicable for
machine images.
$sel:name:Image'
, image_name
- The name of the AMI that was provided during image creation.
$sel:platform:Image'
, image_platform
- This value is set to windows
for Windows AMIs; otherwise, it is blank.
$sel:platformDetails:Image'
, image_platformDetails
- The platform details associated with the billing code of the AMI. For
more information, see
Understand AMI billing information
in the Amazon EC2 User Guide.
$sel:productCodes:Image'
, image_productCodes
- Any product codes associated with the AMI.
$sel:ramdiskId:Image'
, image_ramdiskId
- The RAM disk associated with the image, if any. Only applicable for
machine images.
$sel:rootDeviceName:Image'
, image_rootDeviceName
- The device name of the root device volume (for example, /dev/sda1
).
$sel:sriovNetSupport:Image'
, image_sriovNetSupport
- Specifies whether enhanced networking with the Intel 82599 Virtual
Function interface is enabled.
$sel:stateReason:Image'
, image_stateReason
- The reason for the state change.
$sel:tags:Image'
, image_tags
- Any tags assigned to the image.
$sel:tpmSupport:Image'
, image_tpmSupport
- If the image is configured for NitroTPM support, the value is v2.0
.
For more information, see
NitroTPM
in the Amazon EC2 User Guide.
$sel:usageOperation:Image'
, image_usageOperation
- The operation of the Amazon EC2 instance and the billing code that is
associated with the AMI. usageOperation
corresponds to the
lineitem/Operation
column on your Amazon Web Services Cost and Usage Report and in the
Amazon Web Services Price List API.
You can view these fields on the Instances or AMIs pages in the
Amazon EC2 console, or in the responses that are returned by the
DescribeImages
command in the Amazon EC2 API, or the
describe-images
command in the CLI.
$sel:imageId:Image'
, image_imageId
- The ID of the AMI.
$sel:imageLocation:Image'
, image_imageLocation
- The location of the AMI.
$sel:state:Image'
, image_state
- The current state of the AMI. If the state is available
, the image is
successfully registered and can be used to launch an instance.
$sel:ownerId:Image'
, image_ownerId
- The ID of the Amazon Web Services account that owns the image.
$sel:public:Image'
, image_public
- Indicates whether the image has public launch permissions. The value is
true
if this image has public launch permissions or false
if it has
only implicit and explicit launch permissions.
$sel:architecture:Image'
, image_architecture
- The architecture of the image.
$sel:imageType:Image'
, image_imageType
- The type of image.
$sel:rootDeviceType:Image'
, image_rootDeviceType
- The type of root device used by the AMI. The AMI can use an Amazon EBS
volume or an instance store volume.
$sel:virtualizationType:Image'
, image_virtualizationType
- The type of virtualization of the AMI.
$sel:hypervisor:Image'
, image_hypervisor
- The hypervisor type of the image.
image_blockDeviceMappings :: Lens' Image (Maybe [BlockDeviceMapping]) Source #
Any block device mapping entries.
image_bootMode :: Lens' Image (Maybe BootModeValues) Source #
The boot mode of the image. For more information, see Boot modes in the Amazon EC2 User Guide.
image_deprecationTime :: Lens' Image (Maybe Text) Source #
The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.
image_description :: Lens' Image (Maybe Text) Source #
The description of the AMI that was provided during image creation.
image_enaSupport :: Lens' Image (Maybe Bool) Source #
Specifies whether enhanced networking with ENA is enabled.
image_imageOwnerAlias :: Lens' Image (Maybe Text) Source #
The Amazon Web Services account alias (for example, amazon
, self
) or
the Amazon Web Services account ID of the AMI owner.
image_imdsSupport :: Lens' Image (Maybe ImdsSupportValues) Source #
If v2.0
, it indicates that IMDSv2 is specified in the AMI. Instances
launched from this AMI will have HttpTokens
automatically set to
required
so that, by default, the instance requires that IMDSv2 is
used when requesting instance metadata. In addition,
HttpPutResponseHopLimit
is set to 2
. For more information, see
Configure the AMI
in the Amazon EC2 User Guide.
image_kernelId :: Lens' Image (Maybe Text) Source #
The kernel associated with the image, if any. Only applicable for machine images.
image_name :: Lens' Image (Maybe Text) Source #
The name of the AMI that was provided during image creation.
image_platform :: Lens' Image (Maybe PlatformValues) Source #
This value is set to windows
for Windows AMIs; otherwise, it is blank.
image_platformDetails :: Lens' Image (Maybe Text) Source #
The platform details associated with the billing code of the AMI. For more information, see Understand AMI billing information in the Amazon EC2 User Guide.
image_productCodes :: Lens' Image (Maybe [ProductCode]) Source #
Any product codes associated with the AMI.
image_ramdiskId :: Lens' Image (Maybe Text) Source #
The RAM disk associated with the image, if any. Only applicable for machine images.
image_rootDeviceName :: Lens' Image (Maybe Text) Source #
The device name of the root device volume (for example, /dev/sda1
).
image_sriovNetSupport :: Lens' Image (Maybe Text) Source #
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
image_stateReason :: Lens' Image (Maybe StateReason) Source #
The reason for the state change.
image_tpmSupport :: Lens' Image (Maybe TpmSupportValues) Source #
If the image is configured for NitroTPM support, the value is v2.0
.
For more information, see
NitroTPM
in the Amazon EC2 User Guide.
image_usageOperation :: Lens' Image (Maybe Text) Source #
The operation of the Amazon EC2 instance and the billing code that is
associated with the AMI. usageOperation
corresponds to the
lineitem/Operation
column on your Amazon Web Services Cost and Usage Report and in the
Amazon Web Services Price List API.
You can view these fields on the Instances or AMIs pages in the
Amazon EC2 console, or in the responses that are returned by the
DescribeImages
command in the Amazon EC2 API, or the
describe-images
command in the CLI.
image_state :: Lens' Image ImageState Source #
The current state of the AMI. If the state is available
, the image is
successfully registered and can be used to launch an instance.
image_ownerId :: Lens' Image Text Source #
The ID of the Amazon Web Services account that owns the image.
image_public :: Lens' Image Bool Source #
Indicates whether the image has public launch permissions. The value is
true
if this image has public launch permissions or false
if it has
only implicit and explicit launch permissions.
image_architecture :: Lens' Image ArchitectureValues Source #
The architecture of the image.
image_imageType :: Lens' Image ImageTypeValues Source #
The type of image.
image_rootDeviceType :: Lens' Image DeviceType Source #
The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.
image_virtualizationType :: Lens' Image VirtualizationType Source #
The type of virtualization of the AMI.
image_hypervisor :: Lens' Image HypervisorType Source #
The hypervisor type of the image.