AWSEC2Image

Objective-C

@interface AWSEC2Image

Swift

class AWSEC2Image

Describes an image.

  • The architecture of the image.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2ArchitectureValues architecture;

    Swift

    var architecture: AWSEC2ArchitectureValues { get set }

  • Any block device mapping entries.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSEC2BlockDeviceMapping *> *_Nullable blockDeviceMappings;

    Swift

    var blockDeviceMappings: [AWSEC2BlockDeviceMapping]? { get set }

  • The boot mode of the image. For more information, see Boot modes in the Amazon EC2 User Guide.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2BootModeValues bootMode;

    Swift

    var bootMode: AWSEC2BootModeValues { get set }

  • The date and time the image was created.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable creationDate;

    Swift

    var creationDate: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable deprecationTime;

    Swift

    var deprecationTime: String? { get set }

  • Indicates whether deregistration protection is enabled for the AMI.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable deregistrationProtection;

    Swift

    var deregistrationProtection: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable detail;

    Swift

    var detail: String? { get set }

  • Specifies whether enhanced networking with ENA is enabled.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable enaSupport;

    Swift

    var enaSupport: NSNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2HypervisorType hypervisor;

    Swift

    var hypervisor: AWSEC2HypervisorType { get set }

  • The ID of the AMI.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable imageId;

    Swift

    var imageId: String? { get set }

  • The location of the AMI.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable imageLocation;

    Swift

    var imageLocation: String? { get set }

  • The owner alias (amazon | aws-marketplace).

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable imageOwnerAlias;

    Swift

    var imageOwnerAlias: String? { get set }

  • The type of image.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2ImageTypeValues imageType;

    Swift

    var imageType: AWSEC2ImageTypeValues { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2ImdsSupportValues imdsSupport;

    Swift

    var imdsSupport: AWSEC2ImdsSupportValues { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable kernelId;

    Swift

    var kernelId: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable lastLaunchedTime;

    Swift

    var lastLaunchedTime: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable name;

    Swift

    var name: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable ownerId;

    Swift

    var ownerId: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2PlatformValues platform;

    Swift

    var platform: AWSEC2PlatformValues { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable platformDetails;

    Swift

    var platformDetails: String? { get set }

  • Any product codes associated with the AMI.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSEC2ProductCode *> *_Nullable productCodes;

    Swift

    var productCodes: [AWSEC2ProductCode]? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable public;

    Swift

    var `public`: NSNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable ramdiskId;

    Swift

    var ramdiskId: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable rootDeviceName;

    Swift

    var rootDeviceName: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2DeviceType rootDeviceType;

    Swift

    var rootDeviceType: AWSEC2DeviceType { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable sourceInstanceId;

    Swift

    var sourceInstanceId: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable sriovNetSupport;

    Swift

    var sriovNetSupport: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2ImageState state;

    Swift

    var state: AWSEC2ImageState { get set }

  • The reason for the state change.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2StateReason *_Nullable stateReason;

    Swift

    var stateReason: AWSEC2StateReason? { get set }

  • Any tags assigned to the image.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSEC2Tag *> *_Nullable tags;

    Swift

    var tags: [AWSEC2Tag]? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2TpmSupportValues tpmSupport;

    Swift

    var tpmSupport: AWSEC2TpmSupportValues { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable usageOperation;

    Swift

    var usageOperation: String? { get set }

  • The type of virtualization of the AMI.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2VirtualizationType virtualizationType;

    Swift

    var virtualizationType: AWSEC2VirtualizationType { get set }