Module Values_2.ImageSource

Describes an image.

Sourcetype nonrec t = {
  1. platformDetails : Values_0.String_.t option;
    (*

    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.

    *)
  2. usageOperation : Values_0.String_.t option;
    (*

    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.

    *)
  3. blockDeviceMappings : Values_0.BlockDeviceMappingList.t option;
    (*

    Any block device mapping entries.

    *)
  4. description : Values_0.String_.t option;
    (*

    The description of the AMI that was provided during image creation.

    *)
  5. enaSupport : Values_0.Boolean.t option;
    (*

    Specifies whether enhanced networking with ENA is enabled.

    *)
  6. hypervisor : Values_0.HypervisorType.t option;
    (*

    The hypervisor type of the image. Only xen is supported. ovm is not supported.

    *)
  7. imageOwnerAlias : Values_0.String_.t option;
    (*

    The owner alias (amazon | aws-backup-vault | aws-marketplace).

    *)
  8. name : Values_0.String_.t option;
    (*

    The name of the AMI that was provided during image creation.

    *)
  9. rootDeviceName : Values_0.String_.t option;
    (*

    The device name of the root device volume (for example, /dev/sda1).

    *)
  10. rootDeviceType : Values_0.DeviceType.t option;
    (*

    The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.

    *)
  11. sriovNetSupport : Values_0.String_.t option;
    (*

    Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

    *)
  12. stateReason : Values_0.StateReason.t option;
    (*

    The reason for the state change.

    *)
  13. tags : Values_0.TagList.t option;
    (*

    Any tags assigned to the image.

    *)
  14. virtualizationType : Values_0.VirtualizationType.t option;
    (*

    The type of virtualization of the AMI.

    *)
  15. bootMode : Values_0.BootModeValues.t option;
    (*

    The boot mode of the image. For more information, see Instance launch behavior with Amazon EC2 boot modes in the Amazon EC2 User Guide.

    *)
  16. tpmSupport : Values_1.TpmSupportValues.t option;
    (*

    If the image is configured for NitroTPM support, the value is v2.0. For more information, see NitroTPM in the Amazon EC2 User Guide.

    *)
  17. deprecationTime : Values_0.String_.t option;
    (*

    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.

    *)
  18. imdsSupport : Values_1.ImdsSupportValues.t option;
    (*

    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.

    *)
  19. sourceInstanceId : Values_0.String_.t option;
    (*

    The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This field only appears if the AMI was created using CreateImage.

    *)
  20. deregistrationProtection : Values_0.String_.t option;
    (*

    Indicates whether deregistration protection is enabled for the AMI.

    *)
  21. lastLaunchedTime : Values_0.String_.t option;
    (*

    The date and time, in ISO 8601 date-time format, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported. lastLaunchedTime data is available starting April 2017.

    *)
  22. imageAllowed : Values_0.Boolean.t option;
    (*

    If true, the AMI satisfies the criteria for Allowed AMIs and can be discovered and used in the account. If false and Allowed AMIs is set to enabled, the AMI can't be discovered or used in the account. If false and Allowed AMIs is set to audit-mode, the AMI can be discovered and used in the account. For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in Amazon EC2 User Guide.

    *)
  23. sourceImageId : Values_0.String_.t option;
    (*

    The ID of the source AMI from which the AMI was created.

    *)
  24. sourceImageRegion : Values_0.String_.t option;
    (*

    The Region of the source AMI.

    *)
  25. freeTierEligible : Values_0.Boolean.t option;
    (*

    Indicates whether the image is eligible for Amazon Web Services Free Tier. If true, the AMI is eligible for Free Tier and can be used to launch instances under the Free Tier limits. If false, the AMI is not eligible for Free Tier.

    *)
  26. imageId : Values_0.String_.t option;
    (*

    The ID of the AMI.

    *)
  27. imageLocation : Values_0.String_.t option;
    (*

    The location of the AMI.

    *)
  28. state : Values_1.ImageState.t option;
    (*

    The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

    *)
  29. ownerId : Values_0.String_.t option;
    (*

    The ID of the Amazon Web Services account that owns the image.

    *)
  30. creationDate : Values_0.String_.t option;
    (*

    The date and time the image was created.

    *)
  31. public : Values_0.Boolean.t option;
    (*

    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.

    *)
  32. productCodes : Values_0.ProductCodeList.t option;
    (*

    Any product codes associated with the AMI.

    *)
  33. architecture : Values_0.ArchitectureValues.t option;
    (*

    The architecture of the image.

    *)
  34. imageType : Values_1.ImageTypeValues.t option;
    (*

    The type of image.

    *)
  35. kernelId : Values_0.String_.t option;
    (*

    The kernel associated with the image, if any. Only applicable for machine images.

    *)
  36. ramdiskId : Values_0.String_.t option;
    (*

    The RAM disk associated with the image, if any. Only applicable for machine images.

    *)
  37. platform : Values_0.PlatformValues.t option;
    (*

    This value is set to windows for Windows AMIs; otherwise, it is blank.

    *)
}
Sourceval make : ?platformDetails:??? -> ?usageOperation:??? -> ?blockDeviceMappings:??? -> ?description:??? -> ?enaSupport:??? -> ?hypervisor:??? -> ?imageOwnerAlias:??? -> ?name:??? -> ?rootDeviceName:??? -> ?rootDeviceType:??? -> ?sriovNetSupport:??? -> ?stateReason:??? -> ?tags:??? -> ?virtualizationType:??? -> ?bootMode:??? -> ?tpmSupport:??? -> ?deprecationTime:??? -> ?imdsSupport:??? -> ?sourceInstanceId:??? -> ?deregistrationProtection:??? -> ?lastLaunchedTime:??? -> ?imageAllowed:??? -> ?sourceImageId:??? -> ?sourceImageRegion:??? -> ?freeTierEligible:??? -> ?imageId:??? -> ?imageLocation:??? -> ?state:??? -> ?ownerId:??? -> ?creationDate:??? -> ?public:??? -> ?productCodes:??? -> ?architecture:??? -> ?imageType:??? -> ?kernelId:??? -> ?ramdiskId:??? -> ?platform:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of Values_0.Boolean.t | `Enum of string | `List of [> `Structure of (string * [> `Enum of string | `String of string | `Structure of (string * [> `Boolean of bool | `Enum of string | `Integer of int | `String of string ]) list ]) list ] list | `String of Values_0.String_.t | `Structure of (string * [> `String of string ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t