AWSEC2Instance

Objective-C

@interface AWSEC2Instance

Swift

class AWSEC2Instance

Describes an instance.

  • The AMI launch index, which can be used to find this instance in the launch group.

    Declaration

    Objective-C

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

    Swift

    var amiLaunchIndex: NSNumber? { get set }

  • The architecture of the image.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2ArchitectureValues architecture;

    Swift

    var architecture: AWSEC2ArchitectureValues { get set }

  • Any block device mapping entries for the instance.

    Declaration

    Objective-C

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

    Swift

    var blockDeviceMappings: [AWSEC2InstanceBlockDeviceMapping]? { get set }

  • The boot mode that was specified by the AMI. If the value is uefi-preferred, the AMI supports both UEFI and Legacy BIOS. The currentInstanceBootMode parameter is the boot mode that is used to boot the instance at launch or start.

    The operating system contained in the AMI must be configured to support the specified boot mode.

    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 ID of the Capacity Reservation.

    Declaration

    Objective-C

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

    Swift

    var capacityReservationId: String? { get set }

  • Information about the Capacity Reservation targeting option.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2CapacityReservationSpecificationResponse *_Nullable capacityReservationSpecification;

    Swift

    var capacityReservationSpecification: AWSEC2CapacityReservationSpecificationResponse? { get set }

  • The idempotency token you provided when you launched the instance, if applicable.

    Declaration

    Objective-C

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

    Swift

    var clientToken: String? { get set }

  • The CPU options for the instance.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2CpuOptions *_Nullable cpuOptions;

    Swift

    var cpuOptions: AWSEC2CpuOptions? { get set }

  • The boot mode that is used to boot the instance at launch or start. For more information, see Boot modes in the Amazon EC2 User Guide.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2InstanceBootModeValues currentInstanceBootMode;

    Swift

    var currentInstanceBootMode: AWSEC2InstanceBootModeValues { get set }

  • Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn’t available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

    Declaration

    Objective-C

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

    Swift

    var ebsOptimized: NSNumber? { get set }

  • Deprecated.

    Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSEC2ElasticGpuAssociation *> *_Nullable elasticGpuAssociations;

    Swift

    var elasticGpuAssociations: [AWSEC2ElasticGpuAssociation]? { get set }

  • The elastic inference accelerator associated with the instance.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSEC2ElasticInferenceAcceleratorAssociation *> *_Nullable elasticInferenceAcceleratorAssociations;

    Swift

    var elasticInferenceAcceleratorAssociations: [AWSEC2ElasticInferenceAcceleratorAssociation]? { 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 }

  • Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2EnclaveOptions *_Nullable enclaveOptions;

    Swift

    var enclaveOptions: AWSEC2EnclaveOptions? { get set }

  • Indicates whether the instance is enabled for hibernation.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2HibernationOptions *_Nullable hibernationOptions;

    Swift

    var hibernationOptions: AWSEC2HibernationOptions? { get set }

  • The hypervisor type of the instance. The value xen is used for both Xen and Nitro hypervisors.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2HypervisorType hypervisor;

    Swift

    var hypervisor: AWSEC2HypervisorType { get set }

  • The IAM instance profile associated with the instance, if applicable.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2IamInstanceProfile *_Nullable iamInstanceProfile;

    Swift

    var iamInstanceProfile: AWSEC2IamInstanceProfile? { get set }

  • The ID of the AMI used to launch the instance.

    Declaration

    Objective-C

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

    Swift

    var imageId: String? { get set }

  • The ID of the instance.

    Declaration

    Objective-C

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

    Swift

    var instanceId: String? { get set }

  • Indicates whether this is a Spot Instance or a Scheduled Instance.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2InstanceLifecycleType instanceLifecycle;

    Swift

    var instanceLifecycle: AWSEC2InstanceLifecycleType { get set }

  • The instance type.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2InstanceType instanceType;

    Swift

    var instanceType: AWSEC2InstanceType { get set }

  • The IPv6 address assigned to the instance.

    Declaration

    Objective-C

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

    Swift

    var ipv6Address: String? { get set }

  • The kernel associated with this instance, if applicable.

    Declaration

    Objective-C

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

    Swift

    var kernelId: String? { get set }

  • The name of the key pair, if this instance was launched with an associated key pair.

    Declaration

    Objective-C

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

    Swift

    var keyName: String? { get set }

  • The time the instance was launched.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable launchTime;

    Swift

    var launchTime: Date? { get set }

  • The license configurations for the instance.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSEC2LicenseConfiguration *> *_Nullable licenses;

    Swift

    var licenses: [AWSEC2LicenseConfiguration]? { get set }

  • Provides information on the recovery and maintenance options of your instance.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2InstanceMaintenanceOptions *_Nullable maintenanceOptions;

    Swift

    var maintenanceOptions: AWSEC2InstanceMaintenanceOptions? { get set }

  • The metadata options for the instance.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2InstanceMetadataOptionsResponse *_Nullable metadataOptions;

    Swift

    var metadataOptions: AWSEC2InstanceMetadataOptionsResponse? { get set }

  • The monitoring for the instance.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2Monitoring *_Nullable monitoring;

    Swift

    var monitoring: AWSEC2Monitoring? { get set }

  • The network interfaces for the instance.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSEC2InstanceNetworkInterface *> *_Nullable networkInterfaces;

    Swift

    var networkInterfaces: [AWSEC2InstanceNetworkInterface]? { get set }

  • The Amazon Resource Name (ARN) of the Outpost.

    Declaration

    Objective-C

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

    Swift

    var outpostArn: String? { get set }

  • The location where the instance launched, if applicable.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2Placement *_Nullable placement;

    Swift

    var placement: AWSEC2Placement? { get set }

  • The platform. This value is windows for Windows instances; otherwise, it is empty.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2PlatformValues platform;

    Swift

    var platform: AWSEC2PlatformValues { get set }

  • The platform details value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.

    Declaration

    Objective-C

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

    Swift

    var platformDetails: String? { get set }

  • [IPv4 only] The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.

    The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you’ve enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.

    Declaration

    Objective-C

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

    Swift

    var privateDnsName: String? { get set }

  • The options for the instance hostname.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2PrivateDnsNameOptionsResponse *_Nullable privateDnsNameOptions;

    Swift

    var privateDnsNameOptions: AWSEC2PrivateDnsNameOptionsResponse? { get set }

  • The private IPv4 address assigned to the instance.

    Declaration

    Objective-C

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

    Swift

    var privateIpAddress: String? { get set }

  • The product codes attached to this instance, if applicable.

    Declaration

    Objective-C

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

    Swift

    var productCodes: [AWSEC2ProductCode]? { get set }

  • [IPv4 only] The public DNS name assigned to the instance. This name is not available until the instance enters the running state. This name is only available if you’ve enabled DNS hostnames for your VPC.

    Declaration

    Objective-C

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

    Swift

    var publicDnsName: String? { get set }

  • The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.

    A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.

    Declaration

    Objective-C

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

    Swift

    var publicIpAddress: String? { get set }

  • The RAM disk associated with this instance, if applicable.

    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 root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2DeviceType rootDeviceType;

    Swift

    var rootDeviceType: AWSEC2DeviceType { get set }

  • The security groups for the instance.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSEC2GroupIdentifier *> *_Nullable securityGroups;

    Swift

    var securityGroups: [AWSEC2GroupIdentifier]? { get set }

  • Indicates whether source/destination checking is enabled.

    Declaration

    Objective-C

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

    Swift

    var sourceDestCheck: NSNumber? { get set }

  • If the request is a Spot Instance request, the ID of the request.

    Declaration

    Objective-C

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

    Swift

    var spotInstanceRequestId: 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 instance.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2InstanceState *_Nullable state;

    Swift

    var state: AWSEC2InstanceState? { get set }

  • The reason for the most recent state transition.

    Declaration

    Objective-C

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

    Swift

    var stateReason: AWSEC2StateReason? { get set }

  • The reason for the most recent state transition. This might be an empty string.

    Declaration

    Objective-C

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

    Swift

    var stateTransitionReason: String? { get set }

  • The ID of the subnet in which the instance is running.

    Declaration

    Objective-C

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

    Swift

    var subnetId: String? { get set }

  • Any tags assigned to the instance.

    Declaration

    Objective-C

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

    Swift

    var tags: [AWSEC2Tag]? { get set }

  • If the instance 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, strong) NSString *_Nullable tpmSupport;

    Swift

    var tpmSupport: String? { get set }

  • The usage operation value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.

    Declaration

    Objective-C

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

    Swift

    var usageOperation: String? { get set }

  • The time that the usage operation was last updated.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable usageOperationUpdateTime;

    Swift

    var usageOperationUpdateTime: Date? { get set }

  • The virtualization type of the instance.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2VirtualizationType virtualizationType;

    Swift

    var virtualizationType: AWSEC2VirtualizationType { get set }

  • The ID of the VPC in which the instance is running.

    Declaration

    Objective-C

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

    Swift

    var vpcId: String? { get set }