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 Instance = Instance' {
- blockDeviceMappings :: Maybe [InstanceBlockDeviceMapping]
- bootMode :: Maybe BootModeValues
- capacityReservationId :: Maybe Text
- capacityReservationSpecification :: Maybe CapacityReservationSpecificationResponse
- clientToken :: Maybe Text
- cpuOptions :: Maybe CpuOptions
- ebsOptimized :: Maybe Bool
- elasticGpuAssociations :: Maybe [ElasticGpuAssociation]
- elasticInferenceAcceleratorAssociations :: Maybe [ElasticInferenceAcceleratorAssociation]
- enaSupport :: Maybe Bool
- enclaveOptions :: Maybe EnclaveOptions
- hibernationOptions :: Maybe HibernationOptions
- iamInstanceProfile :: Maybe IamInstanceProfile
- instanceLifecycle :: Maybe InstanceLifecycleType
- ipv6Address :: Maybe Text
- kernelId :: Maybe Text
- keyName :: Maybe Text
- licenses :: Maybe [LicenseConfiguration]
- maintenanceOptions :: Maybe InstanceMaintenanceOptions
- metadataOptions :: Maybe InstanceMetadataOptionsResponse
- networkInterfaces :: Maybe [InstanceNetworkInterface]
- outpostArn :: Maybe Text
- platform :: Maybe PlatformValues
- platformDetails :: Maybe Text
- privateDnsName :: Maybe Text
- privateDnsNameOptions :: Maybe PrivateDnsNameOptionsResponse
- privateIpAddress :: Maybe Text
- productCodes :: Maybe [ProductCode]
- publicDnsName :: Maybe Text
- publicIpAddress :: Maybe Text
- ramdiskId :: Maybe Text
- rootDeviceName :: Maybe Text
- securityGroups :: Maybe [GroupIdentifier]
- sourceDestCheck :: Maybe Bool
- spotInstanceRequestId :: Maybe Text
- sriovNetSupport :: Maybe Text
- stateReason :: Maybe StateReason
- stateTransitionReason :: Maybe Text
- subnetId :: Maybe Text
- tags :: Maybe [Tag]
- tpmSupport :: Maybe Text
- usageOperation :: Maybe Text
- usageOperationUpdateTime :: Maybe ISO8601
- vpcId :: Maybe Text
- instanceId :: Text
- imageId :: Text
- amiLaunchIndex :: Int
- instanceType :: InstanceType
- launchTime :: ISO8601
- placement :: Placement
- monitoring :: Monitoring
- architecture :: ArchitectureValues
- rootDeviceType :: DeviceType
- virtualizationType :: VirtualizationType
- hypervisor :: HypervisorType
- state :: InstanceState
- newInstance :: Text -> Text -> Int -> InstanceType -> UTCTime -> Placement -> Monitoring -> ArchitectureValues -> DeviceType -> VirtualizationType -> HypervisorType -> InstanceState -> Instance
- instance_blockDeviceMappings :: Lens' Instance (Maybe [InstanceBlockDeviceMapping])
- instance_bootMode :: Lens' Instance (Maybe BootModeValues)
- instance_capacityReservationId :: Lens' Instance (Maybe Text)
- instance_capacityReservationSpecification :: Lens' Instance (Maybe CapacityReservationSpecificationResponse)
- instance_clientToken :: Lens' Instance (Maybe Text)
- instance_cpuOptions :: Lens' Instance (Maybe CpuOptions)
- instance_ebsOptimized :: Lens' Instance (Maybe Bool)
- instance_elasticGpuAssociations :: Lens' Instance (Maybe [ElasticGpuAssociation])
- instance_elasticInferenceAcceleratorAssociations :: Lens' Instance (Maybe [ElasticInferenceAcceleratorAssociation])
- instance_enaSupport :: Lens' Instance (Maybe Bool)
- instance_enclaveOptions :: Lens' Instance (Maybe EnclaveOptions)
- instance_hibernationOptions :: Lens' Instance (Maybe HibernationOptions)
- instance_iamInstanceProfile :: Lens' Instance (Maybe IamInstanceProfile)
- instance_instanceLifecycle :: Lens' Instance (Maybe InstanceLifecycleType)
- instance_ipv6Address :: Lens' Instance (Maybe Text)
- instance_kernelId :: Lens' Instance (Maybe Text)
- instance_keyName :: Lens' Instance (Maybe Text)
- instance_licenses :: Lens' Instance (Maybe [LicenseConfiguration])
- instance_maintenanceOptions :: Lens' Instance (Maybe InstanceMaintenanceOptions)
- instance_metadataOptions :: Lens' Instance (Maybe InstanceMetadataOptionsResponse)
- instance_networkInterfaces :: Lens' Instance (Maybe [InstanceNetworkInterface])
- instance_outpostArn :: Lens' Instance (Maybe Text)
- instance_platform :: Lens' Instance (Maybe PlatformValues)
- instance_platformDetails :: Lens' Instance (Maybe Text)
- instance_privateDnsName :: Lens' Instance (Maybe Text)
- instance_privateDnsNameOptions :: Lens' Instance (Maybe PrivateDnsNameOptionsResponse)
- instance_privateIpAddress :: Lens' Instance (Maybe Text)
- instance_productCodes :: Lens' Instance (Maybe [ProductCode])
- instance_publicDnsName :: Lens' Instance (Maybe Text)
- instance_publicIpAddress :: Lens' Instance (Maybe Text)
- instance_ramdiskId :: Lens' Instance (Maybe Text)
- instance_rootDeviceName :: Lens' Instance (Maybe Text)
- instance_securityGroups :: Lens' Instance (Maybe [GroupIdentifier])
- instance_sourceDestCheck :: Lens' Instance (Maybe Bool)
- instance_spotInstanceRequestId :: Lens' Instance (Maybe Text)
- instance_sriovNetSupport :: Lens' Instance (Maybe Text)
- instance_stateReason :: Lens' Instance (Maybe StateReason)
- instance_stateTransitionReason :: Lens' Instance (Maybe Text)
- instance_subnetId :: Lens' Instance (Maybe Text)
- instance_tags :: Lens' Instance (Maybe [Tag])
- instance_tpmSupport :: Lens' Instance (Maybe Text)
- instance_usageOperation :: Lens' Instance (Maybe Text)
- instance_usageOperationUpdateTime :: Lens' Instance (Maybe UTCTime)
- instance_vpcId :: Lens' Instance (Maybe Text)
- instance_instanceId :: Lens' Instance Text
- instance_imageId :: Lens' Instance Text
- instance_amiLaunchIndex :: Lens' Instance Int
- instance_instanceType :: Lens' Instance InstanceType
- instance_launchTime :: Lens' Instance UTCTime
- instance_placement :: Lens' Instance Placement
- instance_monitoring :: Lens' Instance Monitoring
- instance_architecture :: Lens' Instance ArchitectureValues
- instance_rootDeviceType :: Lens' Instance DeviceType
- instance_virtualizationType :: Lens' Instance VirtualizationType
- instance_hypervisor :: Lens' Instance HypervisorType
- instance_state :: Lens' Instance InstanceState
Documentation
Describes an instance.
See: newInstance
smart constructor.
Instance' | |
|
Instances
:: Text | |
-> Text | |
-> Int | |
-> InstanceType | |
-> UTCTime | |
-> Placement | |
-> Monitoring | |
-> ArchitectureValues | |
-> DeviceType | |
-> VirtualizationType | |
-> HypervisorType | |
-> InstanceState | |
-> Instance |
Create a value of Instance
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:Instance'
, instance_blockDeviceMappings
- Any block device mapping entries for the instance.
$sel:bootMode:Instance'
, instance_bootMode
- The boot mode of the instance. For more information, see
Boot modes
in the Amazon EC2 User Guide.
$sel:capacityReservationId:Instance'
, instance_capacityReservationId
- The ID of the Capacity Reservation.
$sel:capacityReservationSpecification:Instance'
, instance_capacityReservationSpecification
- Information about the Capacity Reservation targeting option.
$sel:clientToken:Instance'
, instance_clientToken
- The idempotency token you provided when you launched the instance, if
applicable.
$sel:cpuOptions:Instance'
, instance_cpuOptions
- The CPU options for the instance.
$sel:ebsOptimized:Instance'
, instance_ebsOptimized
- 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.
$sel:elasticGpuAssociations:Instance'
, instance_elasticGpuAssociations
- The Elastic GPU associated with the instance.
$sel:elasticInferenceAcceleratorAssociations:Instance'
, instance_elasticInferenceAcceleratorAssociations
- The elastic inference accelerator associated with the instance.
$sel:enaSupport:Instance'
, instance_enaSupport
- Specifies whether enhanced networking with ENA is enabled.
$sel:enclaveOptions:Instance'
, instance_enclaveOptions
- Indicates whether the instance is enabled for Amazon Web Services Nitro
Enclaves.
$sel:hibernationOptions:Instance'
, instance_hibernationOptions
- Indicates whether the instance is enabled for hibernation.
$sel:iamInstanceProfile:Instance'
, instance_iamInstanceProfile
- The IAM instance profile associated with the instance, if applicable.
$sel:instanceLifecycle:Instance'
, instance_instanceLifecycle
- Indicates whether this is a Spot Instance or a Scheduled Instance.
$sel:ipv6Address:Instance'
, instance_ipv6Address
- The IPv6 address assigned to the instance.
$sel:kernelId:Instance'
, instance_kernelId
- The kernel associated with this instance, if applicable.
$sel:keyName:Instance'
, instance_keyName
- The name of the key pair, if this instance was launched with an
associated key pair.
$sel:licenses:Instance'
, instance_licenses
- The license configurations for the instance.
$sel:maintenanceOptions:Instance'
, instance_maintenanceOptions
- Provides information on the recovery and maintenance options of your
instance.
$sel:metadataOptions:Instance'
, instance_metadataOptions
- The metadata options for the instance.
$sel:networkInterfaces:Instance'
, instance_networkInterfaces
- [EC2-VPC] The network interfaces for the instance.
$sel:outpostArn:Instance'
, instance_outpostArn
- The Amazon Resource Name (ARN) of the Outpost.
$sel:platform:Instance'
, instance_platform
- The value is Windows
for Windows instances; otherwise blank.
$sel:platformDetails:Instance'
, instance_platformDetails
- The platform details value for the instance. For more information, see
AMI billing information fields
in the Amazon EC2 User Guide.
Instance
, instance_privateDnsName
- (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.
- EC2-VPC
- 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.
$sel:privateDnsNameOptions:Instance'
, instance_privateDnsNameOptions
- The options for the instance hostname.
Instance
, instance_privateIpAddress
- The private IPv4 address assigned to the instance.
$sel:productCodes:Instance'
, instance_productCodes
- The product codes attached to this instance, if applicable.
$sel:publicDnsName:Instance'
, instance_publicDnsName
- (IPv4 only) The public DNS name assigned to the instance. This name is
not available until the instance enters the running
state. For
EC2-VPC, this name is only available if you've enabled DNS hostnames
for your VPC.
$sel:publicIpAddress:Instance'
, instance_publicIpAddress
- 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.
$sel:ramdiskId:Instance'
, instance_ramdiskId
- The RAM disk associated with this instance, if applicable.
$sel:rootDeviceName:Instance'
, instance_rootDeviceName
- The device name of the root device volume (for example, /dev/sda1
).
$sel:securityGroups:Instance'
, instance_securityGroups
- The security groups for the instance.
Instance
, instance_sourceDestCheck
- Indicates whether source/destination checking is enabled.
$sel:spotInstanceRequestId:Instance'
, instance_spotInstanceRequestId
- If the request is a Spot Instance request, the ID of the request.
$sel:sriovNetSupport:Instance'
, instance_sriovNetSupport
- Specifies whether enhanced networking with the Intel 82599 Virtual
Function interface is enabled.
$sel:stateReason:Instance'
, instance_stateReason
- The reason for the most recent state transition.
$sel:stateTransitionReason:Instance'
, instance_stateTransitionReason
- The reason for the most recent state transition. This might be an empty
string.
Instance
, instance_subnetId
- [EC2-VPC] The ID of the subnet in which the instance is running.
$sel:tags:Instance'
, instance_tags
- Any tags assigned to the instance.
$sel:tpmSupport:Instance'
, instance_tpmSupport
- If the instance is configured for NitroTPM support, the value is v2.0
.
For more information, see
NitroTPM
in the Amazon EC2 User Guide.
$sel:usageOperation:Instance'
, instance_usageOperation
- The usage operation value for the instance. For more information, see
AMI billing information fields
in the Amazon EC2 User Guide.
$sel:usageOperationUpdateTime:Instance'
, instance_usageOperationUpdateTime
- The time that the usage operation was last updated.
Instance
, instance_vpcId
- [EC2-VPC] The ID of the VPC in which the instance is running.
$sel:instanceId:Instance'
, instance_instanceId
- The ID of the instance.
$sel:imageId:Instance'
, instance_imageId
- The ID of the AMI used to launch the instance.
$sel:amiLaunchIndex:Instance'
, instance_amiLaunchIndex
- The AMI launch index, which can be used to find this instance in the
launch group.
$sel:instanceType:Instance'
, instance_instanceType
- The instance type.
$sel:launchTime:Instance'
, instance_launchTime
- The time the instance was launched.
$sel:placement:Instance'
, instance_placement
- The location where the instance launched, if applicable.
$sel:monitoring:Instance'
, instance_monitoring
- The monitoring for the instance.
$sel:architecture:Instance'
, instance_architecture
- The architecture of the image.
$sel:rootDeviceType:Instance'
, instance_rootDeviceType
- The root device type used by the AMI. The AMI can use an EBS volume or
an instance store volume.
$sel:virtualizationType:Instance'
, instance_virtualizationType
- The virtualization type of the instance.
$sel:hypervisor:Instance'
, instance_hypervisor
- The hypervisor type of the instance. The value xen
is used for both
Xen and Nitro hypervisors.
Instance
, instance_state
- The current state of the instance.
instance_blockDeviceMappings :: Lens' Instance (Maybe [InstanceBlockDeviceMapping]) Source #
Any block device mapping entries for the instance.
instance_bootMode :: Lens' Instance (Maybe BootModeValues) Source #
The boot mode of the instance. For more information, see Boot modes in the Amazon EC2 User Guide.
instance_capacityReservationId :: Lens' Instance (Maybe Text) Source #
The ID of the Capacity Reservation.
instance_capacityReservationSpecification :: Lens' Instance (Maybe CapacityReservationSpecificationResponse) Source #
Information about the Capacity Reservation targeting option.
instance_clientToken :: Lens' Instance (Maybe Text) Source #
The idempotency token you provided when you launched the instance, if applicable.
instance_cpuOptions :: Lens' Instance (Maybe CpuOptions) Source #
The CPU options for the instance.
instance_ebsOptimized :: Lens' Instance (Maybe Bool) Source #
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.
instance_elasticGpuAssociations :: Lens' Instance (Maybe [ElasticGpuAssociation]) Source #
The Elastic GPU associated with the instance.
instance_elasticInferenceAcceleratorAssociations :: Lens' Instance (Maybe [ElasticInferenceAcceleratorAssociation]) Source #
The elastic inference accelerator associated with the instance.
instance_enaSupport :: Lens' Instance (Maybe Bool) Source #
Specifies whether enhanced networking with ENA is enabled.
instance_enclaveOptions :: Lens' Instance (Maybe EnclaveOptions) Source #
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
instance_hibernationOptions :: Lens' Instance (Maybe HibernationOptions) Source #
Indicates whether the instance is enabled for hibernation.
instance_iamInstanceProfile :: Lens' Instance (Maybe IamInstanceProfile) Source #
The IAM instance profile associated with the instance, if applicable.
instance_instanceLifecycle :: Lens' Instance (Maybe InstanceLifecycleType) Source #
Indicates whether this is a Spot Instance or a Scheduled Instance.
instance_ipv6Address :: Lens' Instance (Maybe Text) Source #
The IPv6 address assigned to the instance.
instance_kernelId :: Lens' Instance (Maybe Text) Source #
The kernel associated with this instance, if applicable.
instance_keyName :: Lens' Instance (Maybe Text) Source #
The name of the key pair, if this instance was launched with an associated key pair.
instance_licenses :: Lens' Instance (Maybe [LicenseConfiguration]) Source #
The license configurations for the instance.
instance_maintenanceOptions :: Lens' Instance (Maybe InstanceMaintenanceOptions) Source #
Provides information on the recovery and maintenance options of your instance.
instance_metadataOptions :: Lens' Instance (Maybe InstanceMetadataOptionsResponse) Source #
The metadata options for the instance.
instance_networkInterfaces :: Lens' Instance (Maybe [InstanceNetworkInterface]) Source #
- EC2-VPC
- The network interfaces for the instance.
instance_outpostArn :: Lens' Instance (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Outpost.
instance_platform :: Lens' Instance (Maybe PlatformValues) Source #
The value is Windows
for Windows instances; otherwise blank.
instance_platformDetails :: Lens' Instance (Maybe Text) Source #
The platform details value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.
instance_privateDnsName :: Lens' Instance (Maybe Text) Source #
(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.
- EC2-VPC
- 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.
instance_privateDnsNameOptions :: Lens' Instance (Maybe PrivateDnsNameOptionsResponse) Source #
The options for the instance hostname.
instance_privateIpAddress :: Lens' Instance (Maybe Text) Source #
The private IPv4 address assigned to the instance.
instance_productCodes :: Lens' Instance (Maybe [ProductCode]) Source #
The product codes attached to this instance, if applicable.
instance_publicDnsName :: Lens' Instance (Maybe Text) Source #
(IPv4 only) The public DNS name assigned to the instance. This name is
not available until the instance enters the running
state. For
EC2-VPC, this name is only available if you've enabled DNS hostnames
for your VPC.
instance_publicIpAddress :: Lens' Instance (Maybe Text) Source #
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.
instance_ramdiskId :: Lens' Instance (Maybe Text) Source #
The RAM disk associated with this instance, if applicable.
instance_rootDeviceName :: Lens' Instance (Maybe Text) Source #
The device name of the root device volume (for example, /dev/sda1
).
instance_securityGroups :: Lens' Instance (Maybe [GroupIdentifier]) Source #
The security groups for the instance.
instance_sourceDestCheck :: Lens' Instance (Maybe Bool) Source #
Indicates whether source/destination checking is enabled.
instance_spotInstanceRequestId :: Lens' Instance (Maybe Text) Source #
If the request is a Spot Instance request, the ID of the request.
instance_sriovNetSupport :: Lens' Instance (Maybe Text) Source #
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
instance_stateReason :: Lens' Instance (Maybe StateReason) Source #
The reason for the most recent state transition.
instance_stateTransitionReason :: Lens' Instance (Maybe Text) Source #
The reason for the most recent state transition. This might be an empty string.
instance_subnetId :: Lens' Instance (Maybe Text) Source #
- EC2-VPC
- The ID of the subnet in which the instance is running.
instance_tpmSupport :: Lens' Instance (Maybe Text) Source #
If the instance is configured for NitroTPM support, the value is v2.0
.
For more information, see
NitroTPM
in the Amazon EC2 User Guide.
instance_usageOperation :: Lens' Instance (Maybe Text) Source #
The usage operation value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.
instance_usageOperationUpdateTime :: Lens' Instance (Maybe UTCTime) Source #
The time that the usage operation was last updated.
instance_vpcId :: Lens' Instance (Maybe Text) Source #
- EC2-VPC
- The ID of the VPC in which the instance is running.
instance_amiLaunchIndex :: Lens' Instance Int Source #
The AMI launch index, which can be used to find this instance in the launch group.
instance_instanceType :: Lens' Instance InstanceType Source #
The instance type.
instance_placement :: Lens' Instance Placement Source #
The location where the instance launched, if applicable.
instance_monitoring :: Lens' Instance Monitoring Source #
The monitoring for the instance.
instance_architecture :: Lens' Instance ArchitectureValues Source #
The architecture of the image.
instance_rootDeviceType :: Lens' Instance DeviceType Source #
The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.
instance_virtualizationType :: Lens' Instance VirtualizationType Source #
The virtualization type of the instance.
instance_hypervisor :: Lens' Instance HypervisorType Source #
The hypervisor type of the instance. The value xen
is used for both
Xen and Nitro hypervisors.
instance_state :: Lens' Instance InstanceState Source #
The current state of the instance.