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

Amazonka.EC2.RunInstances

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Launches the specified number of instances using an AMI for which you have permissions.

You can specify a number of options, or leave the default options. The following rules apply:

[EC2-VPC] If you don't specify a subnet ID, we choose a default subnet from your default VPC for you. If you don't have a default VPC, you must specify a subnet ID in the request.
[EC2-Classic] If don't specify an Availability Zone, we choose one for you.
Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see Instance types available only in a VPC.
[EC2-VPC] All instances have a network interface with a primary private IPv4 address. If you don't specify this address, we choose one from the IPv4 range of your subnet.
Not all instance types support IPv6 addresses. For more information, see Instance types.
If you don't specify a security group ID, we use the default security group. For more information, see Security groups.
If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.

You can create a launch template, which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters.

To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.

An instance is ready for you to use when it's in the running state. You can check the state of your instance using DescribeInstances. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and Tagging your Amazon EC2 resources.

Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key pairs.

For troubleshooting, see What to do if an instance immediately terminates, and Troubleshooting connecting to your instance.

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide.

Synopsis

data RunInstances = RunInstances' {
- additionalInfo :: Maybe Text
- blockDeviceMappings :: Maybe [BlockDeviceMapping]
- capacityReservationSpecification :: Maybe CapacityReservationSpecification
- clientToken :: Maybe Text
- cpuOptions :: Maybe CpuOptionsRequest
- creditSpecification :: Maybe CreditSpecificationRequest
- disableApiStop :: Maybe Bool
- disableApiTermination :: Maybe Bool
- dryRun :: Maybe Bool
- ebsOptimized :: Maybe Bool
- elasticGpuSpecification :: Maybe [ElasticGpuSpecification]
- elasticInferenceAccelerators :: Maybe [ElasticInferenceAccelerator]
- enclaveOptions :: Maybe EnclaveOptionsRequest
- hibernationOptions :: Maybe HibernationOptionsRequest
- iamInstanceProfile :: Maybe IamInstanceProfileSpecification
- imageId :: Maybe Text
- instanceInitiatedShutdownBehavior :: Maybe ShutdownBehavior
- instanceMarketOptions :: Maybe InstanceMarketOptionsRequest
- instanceType :: Maybe InstanceType
- ipv6AddressCount :: Maybe Int
- ipv6Addresses :: Maybe [InstanceIpv6Address]
- kernelId :: Maybe Text
- keyName :: Maybe Text
- launchTemplate :: Maybe LaunchTemplateSpecification
- licenseSpecifications :: Maybe [LicenseConfigurationRequest]
- maintenanceOptions :: Maybe InstanceMaintenanceOptionsRequest
- metadataOptions :: Maybe InstanceMetadataOptionsRequest
- monitoring :: Maybe RunInstancesMonitoringEnabled
- networkInterfaces :: Maybe [InstanceNetworkInterfaceSpecification]
- placement :: Maybe Placement
- privateDnsNameOptions :: Maybe PrivateDnsNameOptionsRequest
- privateIpAddress :: Maybe Text
- ramdiskId :: Maybe Text
- securityGroupIds :: Maybe [Text]
- securityGroups :: Maybe [Text]
- subnetId :: Maybe Text
- tagSpecifications :: Maybe [TagSpecification]
- userData :: Maybe (Sensitive Text)
- maxCount :: Int
- minCount :: Int
}
newRunInstances :: Int -> Int -> RunInstances
runInstances_additionalInfo :: Lens' RunInstances (Maybe Text)
runInstances_blockDeviceMappings :: Lens' RunInstances (Maybe [BlockDeviceMapping])
runInstances_capacityReservationSpecification :: Lens' RunInstances (Maybe CapacityReservationSpecification)
runInstances_clientToken :: Lens' RunInstances (Maybe Text)
runInstances_cpuOptions :: Lens' RunInstances (Maybe CpuOptionsRequest)
runInstances_creditSpecification :: Lens' RunInstances (Maybe CreditSpecificationRequest)
runInstances_disableApiStop :: Lens' RunInstances (Maybe Bool)
runInstances_disableApiTermination :: Lens' RunInstances (Maybe Bool)
runInstances_dryRun :: Lens' RunInstances (Maybe Bool)
runInstances_ebsOptimized :: Lens' RunInstances (Maybe Bool)
runInstances_elasticGpuSpecification :: Lens' RunInstances (Maybe [ElasticGpuSpecification])
runInstances_elasticInferenceAccelerators :: Lens' RunInstances (Maybe [ElasticInferenceAccelerator])
runInstances_enclaveOptions :: Lens' RunInstances (Maybe EnclaveOptionsRequest)
runInstances_hibernationOptions :: Lens' RunInstances (Maybe HibernationOptionsRequest)
runInstances_iamInstanceProfile :: Lens' RunInstances (Maybe IamInstanceProfileSpecification)
runInstances_imageId :: Lens' RunInstances (Maybe Text)
runInstances_instanceInitiatedShutdownBehavior :: Lens' RunInstances (Maybe ShutdownBehavior)
runInstances_instanceMarketOptions :: Lens' RunInstances (Maybe InstanceMarketOptionsRequest)
runInstances_instanceType :: Lens' RunInstances (Maybe InstanceType)
runInstances_ipv6AddressCount :: Lens' RunInstances (Maybe Int)
runInstances_ipv6Addresses :: Lens' RunInstances (Maybe [InstanceIpv6Address])
runInstances_kernelId :: Lens' RunInstances (Maybe Text)
runInstances_keyName :: Lens' RunInstances (Maybe Text)
runInstances_launchTemplate :: Lens' RunInstances (Maybe LaunchTemplateSpecification)
runInstances_licenseSpecifications :: Lens' RunInstances (Maybe [LicenseConfigurationRequest])
runInstances_maintenanceOptions :: Lens' RunInstances (Maybe InstanceMaintenanceOptionsRequest)
runInstances_metadataOptions :: Lens' RunInstances (Maybe InstanceMetadataOptionsRequest)
runInstances_monitoring :: Lens' RunInstances (Maybe RunInstancesMonitoringEnabled)
runInstances_networkInterfaces :: Lens' RunInstances (Maybe [InstanceNetworkInterfaceSpecification])
runInstances_placement :: Lens' RunInstances (Maybe Placement)
runInstances_privateDnsNameOptions :: Lens' RunInstances (Maybe PrivateDnsNameOptionsRequest)
runInstances_privateIpAddress :: Lens' RunInstances (Maybe Text)
runInstances_ramdiskId :: Lens' RunInstances (Maybe Text)
runInstances_securityGroupIds :: Lens' RunInstances (Maybe [Text])
runInstances_securityGroups :: Lens' RunInstances (Maybe [Text])
runInstances_subnetId :: Lens' RunInstances (Maybe Text)
runInstances_tagSpecifications :: Lens' RunInstances (Maybe [TagSpecification])
runInstances_userData :: Lens' RunInstances (Maybe Text)
runInstances_maxCount :: Lens' RunInstances Int
runInstances_minCount :: Lens' RunInstances Int
data Reservation = Reservation' {
- groups :: Maybe [GroupIdentifier]
- instances :: Maybe [Instance]
- requesterId :: Maybe Text
- reservationId :: Text
- ownerId :: Text
}
newReservation :: Text -> Text -> Reservation
reservation_groups :: Lens' Reservation (Maybe [GroupIdentifier])
reservation_instances :: Lens' Reservation (Maybe [Instance])
reservation_requesterId :: Lens' Reservation (Maybe Text)
reservation_reservationId :: Lens' Reservation Text
reservation_ownerId :: Lens' Reservation Text

Creating a Request

data RunInstances Source #

See: newRunInstances smart constructor.

Constructors

RunInstances'

Fields

additionalInfo :: Maybe Text
Reserved.
blockDeviceMappings :: Maybe [BlockDeviceMapping]
The block device mapping, which defines the EBS volumes and instance store volumes to attach to the instance at launch. For more information, see Block device mappings in the Amazon EC2 User Guide.
capacityReservationSpecification :: Maybe CapacityReservationSpecification
Information about the Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
clientToken :: Maybe Text
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
For more information, see Ensuring Idempotency.
Constraints: Maximum 64 ASCII characters
cpuOptions :: Maybe CpuOptionsRequest
The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.
creditSpecification :: Maybe CreditSpecificationRequest
The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification. For more information, see Burstable performance instances in the Amazon EC2 User Guide.
Default: standard (T2 instances) or unlimited (T3/T3a/T4g instances)
For T3 instances with host tenancy, only standard is supported.
disableApiStop :: Maybe Bool
Indicates whether an instance is enabled for stop protection. For more information, see Stop protection.
disableApiTermination :: Maybe Bool
If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.
Default: false
dryRun :: Maybe Bool
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
ebsOptimized :: Maybe Bool
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 Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default: false
elasticGpuSpecification :: Maybe [ElasticGpuSpecification]
An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon EC2 User Guide.
elasticInferenceAccelerators :: Maybe [ElasticInferenceAccelerator]
An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.
You cannot specify accelerators from different generations in the same request.
enclaveOptions :: Maybe EnclaveOptionsRequest
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.
You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.
hibernationOptions :: Maybe HibernationOptionsRequest
Indicates whether an instance is enabled for hibernation. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
You can't enable hibernation and Amazon Web Services Nitro Enclaves on the same instance.
iamInstanceProfile :: Maybe IamInstanceProfileSpecification
The name or Amazon Resource Name (ARN) of an IAM instance profile.
imageId :: Maybe Text
The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.
instanceInitiatedShutdownBehavior :: Maybe ShutdownBehavior
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
instanceMarketOptions :: Maybe InstanceMarketOptionsRequest
The market (purchasing) option for the instances.
For RunInstances, persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop.
instanceType :: Maybe InstanceType
The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
Default: m1.small
ipv6AddressCount :: Maybe Int
EC2-VPC
The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
ipv6Addresses :: Maybe [InstanceIpv6Address]
EC2-VPC
The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
kernelId :: Maybe Text
The ID of the kernel.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.
keyName :: Maybe Text
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
launchTemplate :: Maybe LaunchTemplateSpecification
The launch template to use to launch the instances. Any parameters that you specify in RunInstances override the same parameters in the launch template. You can specify either the name or ID of a launch template, but not both.
licenseSpecifications :: Maybe [LicenseConfigurationRequest]
The license configurations.
maintenanceOptions :: Maybe InstanceMaintenanceOptionsRequest
The maintenance and recovery options for the instance.
metadataOptions :: Maybe InstanceMetadataOptionsRequest
The metadata options for the instance. For more information, see Instance metadata and user data.
monitoring :: Maybe RunInstancesMonitoringEnabled
Specifies whether detailed monitoring is enabled for the instance.
networkInterfaces :: Maybe [InstanceNetworkInterfaceSpecification]
The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.
placement :: Maybe Placement
The placement for the instance.
privateDnsNameOptions :: Maybe PrivateDnsNameOptionsRequest
The options for the instance hostname. The default values are inherited from the subnet.
privateIpAddress :: Maybe Text
EC2-VPC
The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.
Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request.
You cannot specify this option and the network interfaces option in the same request.
ramdiskId :: Maybe Text
The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the Amazon Web Services Resource Center and search for the kernel ID.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.
securityGroupIds :: Maybe [Text]
The IDs of the security groups. You can create a security group using CreateSecurityGroup.
If you specify a network interface, you must specify any security groups as part of the network interface.
securityGroups :: Maybe [Text]
EC2-Classic, default VPC
The names of the security groups. For a nondefault VPC, you must use security group IDs instead.
If you specify a network interface, you must specify any security groups as part of the network interface.
Default: Amazon EC2 uses the default security group.
subnetId :: Maybe Text
EC2-VPC
The ID of the subnet to launch the instance into.
If you specify a network interface, you must specify any subnets as part of the network interface.
tagSpecifications :: Maybe [TagSpecification]
The tags to apply to the resources that are created during instance launch.
You can specify tags for the following resources only:
- Instances
- Volumes
- Elastic graphics
- Spot Instance requests
- Network interfaces
To tag a resource after it has been created, see CreateTags.
userData :: Maybe (Sensitive Text)
The user data script to make available to the instance. For more information, see Run commands on your Linux instance at launch and Run commands on your Windows instance at launch. If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.
maxCount :: Int
The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.
Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.
minCount :: Int
The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.
Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

Instances

Instances details

ToHeaders RunInstances Source #
Instance details Defined in Amazonka.EC2.RunInstances Methods toHeaders :: RunInstances -> [Header] #
ToPath RunInstances Source #
Instance details Defined in Amazonka.EC2.RunInstances Methods toPath :: RunInstances -> ByteString #
ToQuery RunInstances Source #
Instance details Defined in Amazonka.EC2.RunInstances Methods toQuery :: RunInstances -> QueryString #
AWSRequest RunInstances Source #
Instance details Defined in Amazonka.EC2.RunInstances Associated Types type AWSResponse RunInstances # Methods request :: (Service -> Service) -> RunInstances -> Request RunInstances # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RunInstances -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RunInstances))) #
Generic RunInstances Source #
Instance details Defined in Amazonka.EC2.RunInstances Associated Types type Rep RunInstances :: Type -> Type # Methods from :: RunInstances -> Rep RunInstances x # to :: Rep RunInstances x -> RunInstances #
Show RunInstances Source #
Instance details Defined in Amazonka.EC2.RunInstances Methods showsPrec :: Int -> RunInstances -> ShowS # show :: RunInstances -> String # showList :: [RunInstances] -> ShowS #
NFData RunInstances Source #
Instance details Defined in Amazonka.EC2.RunInstances Methods rnf :: RunInstances -> () #
Eq RunInstances Source #
Instance details Defined in Amazonka.EC2.RunInstances Methods (==) :: RunInstances -> RunInstances -> Bool # (/=) :: RunInstances -> RunInstances -> Bool #
Hashable RunInstances Source #
Instance details Defined in Amazonka.EC2.RunInstances Methods hashWithSalt :: Int -> RunInstances -> Int # hash :: RunInstances -> Int #
type AWSResponse RunInstances Source #
Instance details Defined in Amazonka.EC2.RunInstances type AWSResponse RunInstances = Reservation
type Rep RunInstances Source #
Instance details Defined in Amazonka.EC2.RunInstances type Rep RunInstances = D1 ('MetaData "RunInstances" "Amazonka.EC2.RunInstances" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "RunInstances'" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "additionalInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "blockDeviceMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BlockDeviceMapping]))) :: (S1 ('MetaSel ('Just "capacityReservationSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CapacityReservationSpecification)) :: (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "cpuOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CpuOptionsRequest))))) :: ((S1 ('MetaSel ('Just "creditSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CreditSpecificationRequest)) :: S1 ('MetaSel ('Just "disableApiStop") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "disableApiTermination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "ebsOptimized") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))) :: (((S1 ('MetaSel ('Just "elasticGpuSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ElasticGpuSpecification])) :: S1 ('MetaSel ('Just "elasticInferenceAccelerators") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ElasticInferenceAccelerator]))) :: (S1 ('MetaSel ('Just "enclaveOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EnclaveOptionsRequest)) :: (S1 ('MetaSel ('Just "hibernationOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HibernationOptionsRequest)) :: S1 ('MetaSel ('Just "iamInstanceProfile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IamInstanceProfileSpecification))))) :: ((S1 ('MetaSel ('Just "imageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "instanceInitiatedShutdownBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ShutdownBehavior))) :: (S1 ('MetaSel ('Just "instanceMarketOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceMarketOptionsRequest)) :: (S1 ('MetaSel ('Just "instanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceType)) :: S1 ('MetaSel ('Just "ipv6AddressCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))) :: ((((S1 ('MetaSel ('Just "ipv6Addresses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InstanceIpv6Address])) :: S1 ('MetaSel ('Just "kernelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "keyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "launchTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LaunchTemplateSpecification)) :: S1 ('MetaSel ('Just "licenseSpecifications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LicenseConfigurationRequest]))))) :: ((S1 ('MetaSel ('Just "maintenanceOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceMaintenanceOptionsRequest)) :: S1 ('MetaSel ('Just "metadataOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceMetadataOptionsRequest))) :: (S1 ('MetaSel ('Just "monitoring") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RunInstancesMonitoringEnabled)) :: (S1 ('MetaSel ('Just "networkInterfaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InstanceNetworkInterfaceSpecification])) :: S1 ('MetaSel ('Just "placement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Placement)))))) :: (((S1 ('MetaSel ('Just "privateDnsNameOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PrivateDnsNameOptionsRequest)) :: S1 ('MetaSel ('Just "privateIpAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "ramdiskId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "securityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :: ((S1 ('MetaSel ('Just "subnetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tagSpecifications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagSpecification]))) :: (S1 ('MetaSel ('Just "userData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "maxCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "minCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))))

newRunInstances Source #

Arguments

:: Int	`$sel:maxCount:RunInstances'`
-> Int	`$sel:minCount:RunInstances'`
-> RunInstances

Create a value of RunInstances 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:

RunInstances, runInstances_additionalInfo - Reserved.

RunInstances, runInstances_blockDeviceMappings - The block device mapping, which defines the EBS volumes and instance store volumes to attach to the instance at launch. For more information, see Block device mappings in the Amazon EC2 User Guide.

RunInstances, runInstances_capacityReservationSpecification - Information about the Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

RunInstances, runInstances_clientToken - Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.

For more information, see Ensuring Idempotency.

Constraints: Maximum 64 ASCII characters

RunInstances, runInstances_cpuOptions - The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.

RunInstances, runInstances_creditSpecification - The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification. For more information, see Burstable performance instances in the Amazon EC2 User Guide.

Default: standard (T2 instances) or unlimited (T3/T3a/T4g instances)

For T3 instances with host tenancy, only standard is supported.

RunInstances, runInstances_disableApiStop - Indicates whether an instance is enabled for stop protection. For more information, see Stop protection.

RunInstances, runInstances_disableApiTermination - If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

Default: false

$sel:dryRun:RunInstances', runInstances_dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

RunInstances, runInstances_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 Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

$sel:elasticGpuSpecification:RunInstances', runInstances_elasticGpuSpecification - An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon EC2 User Guide.

RunInstances, runInstances_elasticInferenceAccelerators - An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.

You cannot specify accelerators from different generations in the same request.

RunInstances, runInstances_enclaveOptions - Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.

You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.

RunInstances, runInstances_hibernationOptions - Indicates whether an instance is enabled for hibernation. For more information, see Hibernate your instance in the Amazon EC2 User Guide.

You can't enable hibernation and Amazon Web Services Nitro Enclaves on the same instance.

RunInstances, runInstances_iamInstanceProfile - The name or Amazon Resource Name (ARN) of an IAM instance profile.

RunInstances, runInstances_imageId - The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.

RunInstances, runInstances_instanceInitiatedShutdownBehavior - Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop

RunInstances, runInstances_instanceMarketOptions - The market (purchasing) option for the instances.

For RunInstances, persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop.

RunInstances, runInstances_instanceType - The instance type. For more information, see Instance types in the Amazon EC2 User Guide.

Default: m1.small

RunInstances, runInstances_ipv6AddressCount - [EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.

You cannot specify this option and the network interfaces option in the same request.

RunInstances, runInstances_ipv6Addresses - [EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.

You cannot specify this option and the network interfaces option in the same request.

RunInstances, runInstances_kernelId - The ID of the kernel.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.

RunInstances, runInstances_keyName - The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.

RunInstances, runInstances_launchTemplate - The launch template to use to launch the instances. Any parameters that you specify in RunInstances override the same parameters in the launch template. You can specify either the name or ID of a launch template, but not both.

RunInstances, runInstances_licenseSpecifications - The license configurations.

RunInstances, runInstances_maintenanceOptions - The maintenance and recovery options for the instance.

RunInstances, runInstances_metadataOptions - The metadata options for the instance. For more information, see Instance metadata and user data.

RunInstances, runInstances_monitoring - Specifies whether detailed monitoring is enabled for the instance.

RunInstances, runInstances_networkInterfaces - The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.

RunInstances, runInstances_placement - The placement for the instance.

RunInstances, runInstances_privateDnsNameOptions - The options for the instance hostname. The default values are inherited from the subnet.

RunInstances, runInstances_privateIpAddress - [EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.

Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request.

You cannot specify this option and the network interfaces option in the same request.

RunInstances, runInstances_ramdiskId - The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the Amazon Web Services Resource Center and search for the kernel ID.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.

RunInstances, runInstances_securityGroupIds - The IDs of the security groups. You can create a security group using CreateSecurityGroup.

If you specify a network interface, you must specify any security groups as part of the network interface.

RunInstances, runInstances_securityGroups - [EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.

If you specify a network interface, you must specify any security groups as part of the network interface.

Default: Amazon EC2 uses the default security group.

RunInstances, runInstances_subnetId - [EC2-VPC] The ID of the subnet to launch the instance into.

If you specify a network interface, you must specify any subnets as part of the network interface.

RunInstances, runInstances_tagSpecifications - The tags to apply to the resources that are created during instance launch.

You can specify tags for the following resources only:

Instances
Volumes
Elastic graphics
Spot Instance requests
Network interfaces

To tag a resource after it has been created, see CreateTags.

RunInstances, runInstances_userData - The user data script to make available to the instance. For more information, see Run commands on your Linux instance at launch and Run commands on your Windows instance at launch. If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.

$sel:maxCount:RunInstances', runInstances_maxCount - The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.

$sel:minCount:RunInstances', runInstances_minCount - The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

Request Lenses

runInstances_additionalInfo :: Lens' RunInstances (Maybe Text) Source #

Reserved.

runInstances_blockDeviceMappings :: Lens' RunInstances (Maybe [BlockDeviceMapping]) Source #

The block device mapping, which defines the EBS volumes and instance store volumes to attach to the instance at launch. For more information, see Block device mappings in the Amazon EC2 User Guide.

runInstances_capacityReservationSpecification :: Lens' RunInstances (Maybe CapacityReservationSpecification) Source #

Information about the Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

runInstances_clientToken :: Lens' RunInstances (Maybe Text) Source #

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.

For more information, see Ensuring Idempotency.

Constraints: Maximum 64 ASCII characters

runInstances_cpuOptions :: Lens' RunInstances (Maybe CpuOptionsRequest) Source #

The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.

runInstances_creditSpecification :: Lens' RunInstances (Maybe CreditSpecificationRequest) Source #

The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification. For more information, see Burstable performance instances in the Amazon EC2 User Guide.

Default: standard (T2 instances) or unlimited (T3/T3a/T4g instances)

For T3 instances with host tenancy, only standard is supported.

runInstances_disableApiStop :: Lens' RunInstances (Maybe Bool) Source #

Indicates whether an instance is enabled for stop protection. For more information, see Stop protection.

runInstances_disableApiTermination :: Lens' RunInstances (Maybe Bool) Source #

If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

Default: false

runInstances_dryRun :: Lens' RunInstances (Maybe Bool) Source #

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

runInstances_ebsOptimized :: Lens' RunInstances (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 Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

runInstances_elasticGpuSpecification :: Lens' RunInstances (Maybe [ElasticGpuSpecification]) Source #

An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon EC2 User Guide.

runInstances_elasticInferenceAccelerators :: Lens' RunInstances (Maybe [ElasticInferenceAccelerator]) Source #

An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.

You cannot specify accelerators from different generations in the same request.

runInstances_enclaveOptions :: Lens' RunInstances (Maybe EnclaveOptionsRequest) Source #

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.

You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.

runInstances_hibernationOptions :: Lens' RunInstances (Maybe HibernationOptionsRequest) Source #

Indicates whether an instance is enabled for hibernation. For more information, see Hibernate your instance in the Amazon EC2 User Guide.

You can't enable hibernation and Amazon Web Services Nitro Enclaves on the same instance.

runInstances_iamInstanceProfile :: Lens' RunInstances (Maybe IamInstanceProfileSpecification) Source #

The name or Amazon Resource Name (ARN) of an IAM instance profile.

runInstances_imageId :: Lens' RunInstances (Maybe Text) Source #

The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.

runInstances_instanceInitiatedShutdownBehavior :: Lens' RunInstances (Maybe ShutdownBehavior) Source #

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop

runInstances_instanceMarketOptions :: Lens' RunInstances (Maybe InstanceMarketOptionsRequest) Source #

The market (purchasing) option for the instances.

For RunInstances, persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop.

runInstances_instanceType :: Lens' RunInstances (Maybe InstanceType) Source #

The instance type. For more information, see Instance types in the Amazon EC2 User Guide.

Default: m1.small

runInstances_ipv6AddressCount :: Lens' RunInstances (Maybe Int) Source #

EC2-VPC: The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.

You cannot specify this option and the network interfaces option in the same request.

runInstances_ipv6Addresses :: Lens' RunInstances (Maybe [InstanceIpv6Address]) Source #

EC2-VPC: The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.

You cannot specify this option and the network interfaces option in the same request.

runInstances_kernelId :: Lens' RunInstances (Maybe Text) Source #

The ID of the kernel.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.

runInstances_keyName :: Lens' RunInstances (Maybe Text) Source #

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.

runInstances_launchTemplate :: Lens' RunInstances (Maybe LaunchTemplateSpecification) Source #

The launch template to use to launch the instances. Any parameters that you specify in RunInstances override the same parameters in the launch template. You can specify either the name or ID of a launch template, but not both.

runInstances_licenseSpecifications :: Lens' RunInstances (Maybe [LicenseConfigurationRequest]) Source #

The license configurations.

runInstances_maintenanceOptions :: Lens' RunInstances (Maybe InstanceMaintenanceOptionsRequest) Source #

The maintenance and recovery options for the instance.

runInstances_metadataOptions :: Lens' RunInstances (Maybe InstanceMetadataOptionsRequest) Source #

The metadata options for the instance. For more information, see Instance metadata and user data.

runInstances_monitoring :: Lens' RunInstances (Maybe RunInstancesMonitoringEnabled) Source #

Specifies whether detailed monitoring is enabled for the instance.

runInstances_networkInterfaces :: Lens' RunInstances (Maybe [InstanceNetworkInterfaceSpecification]) Source #

The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.

runInstances_placement :: Lens' RunInstances (Maybe Placement) Source #

The placement for the instance.

runInstances_privateDnsNameOptions :: Lens' RunInstances (Maybe PrivateDnsNameOptionsRequest) Source #

The options for the instance hostname. The default values are inherited from the subnet.

runInstances_privateIpAddress :: Lens' RunInstances (Maybe Text) Source #

EC2-VPC: The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.

Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request.

You cannot specify this option and the network interfaces option in the same request.

runInstances_ramdiskId :: Lens' RunInstances (Maybe Text) Source #

The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the Amazon Web Services Resource Center and search for the kernel ID.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.

runInstances_securityGroupIds :: Lens' RunInstances (Maybe [Text]) Source #

The IDs of the security groups. You can create a security group using CreateSecurityGroup.

If you specify a network interface, you must specify any security groups as part of the network interface.

runInstances_securityGroups :: Lens' RunInstances (Maybe [Text]) Source #

EC2-Classic, default VPC: The names of the security groups. For a nondefault VPC, you must use security group IDs instead.

If you specify a network interface, you must specify any security groups as part of the network interface.

Default: Amazon EC2 uses the default security group.

runInstances_subnetId :: Lens' RunInstances (Maybe Text) Source #

EC2-VPC: The ID of the subnet to launch the instance into.

If you specify a network interface, you must specify any subnets as part of the network interface.

runInstances_tagSpecifications :: Lens' RunInstances (Maybe [TagSpecification]) Source #

The tags to apply to the resources that are created during instance launch.

You can specify tags for the following resources only:

Instances
Volumes
Elastic graphics
Spot Instance requests
Network interfaces

To tag a resource after it has been created, see CreateTags.

runInstances_userData :: Lens' RunInstances (Maybe Text) Source #

The user data script to make available to the instance. For more information, see Run commands on your Linux instance at launch and Run commands on your Windows instance at launch. If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.

runInstances_maxCount :: Lens' RunInstances Int Source #

The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.

runInstances_minCount :: Lens' RunInstances Int Source #

The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

Destructuring the Response

data Reservation Source #

Describes a launch request for one or more instances, and includes owner, requester, and security group information that applies to all instances in the launch request.

See: newReservation smart constructor.

Constructors

Reservation'

Fields

groups :: Maybe [GroupIdentifier]
EC2-Classic only
The security groups.
instances :: Maybe [Instance]
The instances.
requesterId :: Maybe Text
The ID of the requester that launched the instances on your behalf (for example, Amazon Web Services Management Console or Auto Scaling).
reservationId :: Text
The ID of the reservation.
ownerId :: Text
The ID of the Amazon Web Services account that owns the reservation.

Instances

Instances details

FromXML Reservation Source #
Instance details Defined in Amazonka.EC2.Types.Reservation Methods parseXML :: [Node] -> Either String Reservation #
Generic Reservation Source #
Instance details Defined in Amazonka.EC2.Types.Reservation Associated Types type Rep Reservation :: Type -> Type # Methods from :: Reservation -> Rep Reservation x # to :: Rep Reservation x -> Reservation #
Read Reservation Source #
Instance details Defined in Amazonka.EC2.Types.Reservation Methods readsPrec :: Int -> ReadS Reservation # readList :: ReadS [Reservation] # readPrec :: ReadPrec Reservation # readListPrec :: ReadPrec [Reservation] #
Show Reservation Source #
Instance details Defined in Amazonka.EC2.Types.Reservation Methods showsPrec :: Int -> Reservation -> ShowS # show :: Reservation -> String # showList :: [Reservation] -> ShowS #
NFData Reservation Source #
Instance details Defined in Amazonka.EC2.Types.Reservation Methods rnf :: Reservation -> () #
Eq Reservation Source #
Instance details Defined in Amazonka.EC2.Types.Reservation Methods (==) :: Reservation -> Reservation -> Bool # (/=) :: Reservation -> Reservation -> Bool #
Hashable Reservation Source #
Instance details Defined in Amazonka.EC2.Types.Reservation Methods hashWithSalt :: Int -> Reservation -> Int # hash :: Reservation -> Int #
type Rep Reservation Source #
Instance details Defined in Amazonka.EC2.Types.Reservation type Rep Reservation = D1 ('MetaData "Reservation" "Amazonka.EC2.Types.Reservation" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "Reservation'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "groups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GroupIdentifier])) :: S1 ('MetaSel ('Just "instances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Instance]))) :: (S1 ('MetaSel ('Just "requesterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "reservationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "ownerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newReservation Source #

Arguments

:: Text	`$sel:reservationId:Reservation'`
-> Text	`$sel:ownerId:Reservation'`
-> Reservation

Create a value of Reservation 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:groups:Reservation', reservation_groups - [EC2-Classic only] The security groups.

$sel:instances:Reservation', reservation_instances - The instances.

$sel:requesterId:Reservation', reservation_requesterId - The ID of the requester that launched the instances on your behalf (for example, Amazon Web Services Management Console or Auto Scaling).

$sel:reservationId:Reservation', reservation_reservationId - The ID of the reservation.

$sel:ownerId:Reservation', reservation_ownerId - The ID of the Amazon Web Services account that owns the reservation.

Response Lenses

reservation_groups :: Lens' Reservation (Maybe [GroupIdentifier]) Source #

EC2-Classic only: The security groups.

reservation_instances :: Lens' Reservation (Maybe [Instance]) Source #

The instances.

reservation_requesterId :: Lens' Reservation (Maybe Text) Source #

The ID of the requester that launched the instances on your behalf (for example, Amazon Web Services Management Console or Auto Scaling).

reservation_reservationId :: Lens' Reservation Text Source #

The ID of the reservation.

reservation_ownerId :: Lens' Reservation Text Source #

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