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 |
Creates a launch configuration.
If you exceed your maximum limit of launch configurations, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
For more information, see Launch configurations in the Amazon EC2 Auto Scaling User Guide.
Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a launch template or a launch configuration. We strongly recommend that you do not use launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2. For information about using launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.
Synopsis
- data CreateLaunchConfiguration = CreateLaunchConfiguration' {
- associatePublicIpAddress :: Maybe Bool
- blockDeviceMappings :: Maybe [BlockDeviceMapping]
- classicLinkVPCId :: Maybe Text
- classicLinkVPCSecurityGroups :: Maybe [Text]
- ebsOptimized :: Maybe Bool
- iamInstanceProfile :: Maybe Text
- imageId :: Maybe Text
- instanceId :: Maybe Text
- instanceMonitoring :: Maybe InstanceMonitoring
- instanceType :: Maybe Text
- kernelId :: Maybe Text
- keyName :: Maybe Text
- metadataOptions :: Maybe InstanceMetadataOptions
- placementTenancy :: Maybe Text
- ramdiskId :: Maybe Text
- securityGroups :: Maybe [Text]
- spotPrice :: Maybe Text
- userData :: Maybe Text
- launchConfigurationName :: Text
- newCreateLaunchConfiguration :: Text -> CreateLaunchConfiguration
- createLaunchConfiguration_associatePublicIpAddress :: Lens' CreateLaunchConfiguration (Maybe Bool)
- createLaunchConfiguration_blockDeviceMappings :: Lens' CreateLaunchConfiguration (Maybe [BlockDeviceMapping])
- createLaunchConfiguration_classicLinkVPCId :: Lens' CreateLaunchConfiguration (Maybe Text)
- createLaunchConfiguration_classicLinkVPCSecurityGroups :: Lens' CreateLaunchConfiguration (Maybe [Text])
- createLaunchConfiguration_ebsOptimized :: Lens' CreateLaunchConfiguration (Maybe Bool)
- createLaunchConfiguration_iamInstanceProfile :: Lens' CreateLaunchConfiguration (Maybe Text)
- createLaunchConfiguration_imageId :: Lens' CreateLaunchConfiguration (Maybe Text)
- createLaunchConfiguration_instanceId :: Lens' CreateLaunchConfiguration (Maybe Text)
- createLaunchConfiguration_instanceMonitoring :: Lens' CreateLaunchConfiguration (Maybe InstanceMonitoring)
- createLaunchConfiguration_instanceType :: Lens' CreateLaunchConfiguration (Maybe Text)
- createLaunchConfiguration_kernelId :: Lens' CreateLaunchConfiguration (Maybe Text)
- createLaunchConfiguration_keyName :: Lens' CreateLaunchConfiguration (Maybe Text)
- createLaunchConfiguration_metadataOptions :: Lens' CreateLaunchConfiguration (Maybe InstanceMetadataOptions)
- createLaunchConfiguration_placementTenancy :: Lens' CreateLaunchConfiguration (Maybe Text)
- createLaunchConfiguration_ramdiskId :: Lens' CreateLaunchConfiguration (Maybe Text)
- createLaunchConfiguration_securityGroups :: Lens' CreateLaunchConfiguration (Maybe [Text])
- createLaunchConfiguration_spotPrice :: Lens' CreateLaunchConfiguration (Maybe Text)
- createLaunchConfiguration_userData :: Lens' CreateLaunchConfiguration (Maybe Text)
- createLaunchConfiguration_launchConfigurationName :: Lens' CreateLaunchConfiguration Text
- data CreateLaunchConfigurationResponse = CreateLaunchConfigurationResponse' {
- newCreateLaunchConfigurationResponse :: CreateLaunchConfigurationResponse
Creating a Request
data CreateLaunchConfiguration Source #
See: newCreateLaunchConfiguration
smart constructor.
CreateLaunchConfiguration' | |
|
Instances
newCreateLaunchConfiguration Source #
Create a value of CreateLaunchConfiguration
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:
CreateLaunchConfiguration
, createLaunchConfiguration_associatePublicIpAddress
- Specifies whether to assign a public IPv4 address to the group's
instances. If the instance is launched into a default subnet, the
default is to assign a public IPv4 address, unless you disabled the
option to assign a public IPv4 address on the subnet. If the instance is
launched into a nondefault subnet, the default is not to assign a public
IPv4 address, unless you enabled the option to assign a public IPv4
address on the subnet.
If you specify true
, each instance in the Auto Scaling group receives
a unique public IPv4 address. For more information, see
Launching Auto Scaling instances in a VPC
in the Amazon EC2 Auto Scaling User Guide.
If you specify this property, you must specify at least one subnet for
VPCZoneIdentifier
when you create your group.
CreateLaunchConfiguration
, createLaunchConfiguration_blockDeviceMappings
- The block device mapping entries that define the block devices to attach
to the instances at launch. By default, the block devices specified in
the block device mapping for the AMI are used. For more information, see
Block device mappings
in the Amazon EC2 User Guide for Linux Instances.
CreateLaunchConfiguration
, createLaunchConfiguration_classicLinkVPCId
- Available for backward compatibility.
CreateLaunchConfiguration
, createLaunchConfiguration_classicLinkVPCSecurityGroups
- Available for backward compatibility.
CreateLaunchConfiguration
, createLaunchConfiguration_ebsOptimized
- Specifies whether the launch configuration is optimized for EBS I/O
(true
) or not (false
). The optimization provides dedicated
throughput to Amazon EBS and an optimized configuration stack to provide
optimal I/O performance. This optimization is not available with all
instance types. Additional fees are incurred when you enable EBS
optimization for an instance type that is not EBS-optimized by default.
For more information, see
Amazon EBS-optimized instances
in the Amazon EC2 User Guide for Linux Instances.
The default value is false
.
CreateLaunchConfiguration
, createLaunchConfiguration_iamInstanceProfile
- The name or the Amazon Resource Name (ARN) of the instance profile
associated with the IAM role for the instance. The instance profile
contains the IAM role. For more information, see
IAM role for applications that run on Amazon EC2 instances
in the Amazon EC2 Auto Scaling User Guide.
CreateLaunchConfiguration
, createLaunchConfiguration_imageId
- The ID of the Amazon Machine Image (AMI) that was assigned during
registration. For more information, see
Finding a Linux AMI
in the Amazon EC2 User Guide for Linux Instances.
If you specify InstanceId
, an ImageId
is not required.
CreateLaunchConfiguration
, createLaunchConfiguration_instanceId
- The ID of the instance to use to create the launch configuration. The
new launch configuration derives attributes from the instance, except
for the block device mapping.
To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.
For more information, see Creating a launch configuration using an EC2 instance in the Amazon EC2 Auto Scaling User Guide.
CreateLaunchConfiguration
, createLaunchConfiguration_instanceMonitoring
- Controls whether instances in this group are launched with detailed
(true
) or basic (false
) monitoring.
The default value is true
(enabled).
When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. For more information, see Configure Monitoring for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.
CreateLaunchConfiguration
, createLaunchConfiguration_instanceType
- Specifies the instance type of the EC2 instance. For information about
available instance types, see
Available instance types
in the Amazon EC2 User Guide for Linux Instances.
If you specify InstanceId
, an InstanceType
is not required.
CreateLaunchConfiguration
, createLaunchConfiguration_kernelId
- The ID of the kernel associated with the AMI.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide for Linux Instances.
CreateLaunchConfiguration
, createLaunchConfiguration_keyName
- The name of the key pair. For more information, see
Amazon EC2 key pairs and Linux instances
in the Amazon EC2 User Guide for Linux Instances.
CreateLaunchConfiguration
, createLaunchConfiguration_metadataOptions
- The metadata options for the instances. For more information, see
Configuring the Instance Metadata Options
in the Amazon EC2 Auto Scaling User Guide.
CreateLaunchConfiguration
, createLaunchConfiguration_placementTenancy
- The tenancy of the instance, either default
or dedicated
. An
instance with dedicated
tenancy runs on isolated, single-tenant
hardware and can only be launched into a VPC. To launch dedicated
instances into a shared tenancy VPC (a VPC with the instance placement
tenancy attribute set to default
), you must set the value of this
property to dedicated
. For more information, see
Configuring instance tenancy with Amazon EC2 Auto Scaling
in the Amazon EC2 Auto Scaling User Guide.
If you specify PlacementTenancy
, you must specify at least one subnet
for VPCZoneIdentifier
when you create your group.
Valid values: default
| dedicated
CreateLaunchConfiguration
, createLaunchConfiguration_ramdiskId
- The ID of the RAM disk to select.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide for Linux Instances.
CreateLaunchConfiguration
, createLaunchConfiguration_securityGroups
- A list that contains the security group IDs to assign to the instances
in the Auto Scaling group. For more information, see
Control traffic to resources using security groups
in the Amazon Virtual Private Cloud User Guide.
CreateLaunchConfiguration
, createLaunchConfiguration_spotPrice
- The maximum hourly price to be paid for any Spot Instance launched to
fulfill the request. Spot Instances are launched when the price you
specify exceeds the current Spot price. For more information, see
Request Spot Instances for fault-tolerant and flexible applications
in the Amazon EC2 Auto Scaling User Guide.
Valid Range: Minimum value of 0.001
When you change your maximum price by creating a new launch configuration, running instances will continue to run as long as the maximum price for those running instances is higher than the current Spot price.
CreateLaunchConfiguration
, createLaunchConfiguration_userData
- The user data to make available to the launched EC2 instances. For more
information, see
Instance metadata and user data
(Linux) and
Instance metadata and user data
(Windows). 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.
CreateLaunchConfiguration
, createLaunchConfiguration_launchConfigurationName
- The name of the launch configuration. This name must be unique per
Region per account.
Request Lenses
createLaunchConfiguration_associatePublicIpAddress :: Lens' CreateLaunchConfiguration (Maybe Bool) Source #
Specifies whether to assign a public IPv4 address to the group's instances. If the instance is launched into a default subnet, the default is to assign a public IPv4 address, unless you disabled the option to assign a public IPv4 address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IPv4 address, unless you enabled the option to assign a public IPv4 address on the subnet.
If you specify true
, each instance in the Auto Scaling group receives
a unique public IPv4 address. For more information, see
Launching Auto Scaling instances in a VPC
in the Amazon EC2 Auto Scaling User Guide.
If you specify this property, you must specify at least one subnet for
VPCZoneIdentifier
when you create your group.
createLaunchConfiguration_blockDeviceMappings :: Lens' CreateLaunchConfiguration (Maybe [BlockDeviceMapping]) Source #
The block device mapping entries that define the block devices to attach to the instances at launch. By default, the block devices specified in the block device mapping for the AMI are used. For more information, see Block device mappings in the Amazon EC2 User Guide for Linux Instances.
createLaunchConfiguration_classicLinkVPCId :: Lens' CreateLaunchConfiguration (Maybe Text) Source #
Available for backward compatibility.
createLaunchConfiguration_classicLinkVPCSecurityGroups :: Lens' CreateLaunchConfiguration (Maybe [Text]) Source #
Available for backward compatibility.
createLaunchConfiguration_ebsOptimized :: Lens' CreateLaunchConfiguration (Maybe Bool) Source #
Specifies whether the launch configuration is optimized for EBS I/O
(true
) or not (false
). The optimization provides dedicated
throughput to Amazon EBS and an optimized configuration stack to provide
optimal I/O performance. This optimization is not available with all
instance types. Additional fees are incurred when you enable EBS
optimization for an instance type that is not EBS-optimized by default.
For more information, see
Amazon EBS-optimized instances
in the Amazon EC2 User Guide for Linux Instances.
The default value is false
.
createLaunchConfiguration_iamInstanceProfile :: Lens' CreateLaunchConfiguration (Maybe Text) Source #
The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role. For more information, see IAM role for applications that run on Amazon EC2 instances in the Amazon EC2 Auto Scaling User Guide.
createLaunchConfiguration_imageId :: Lens' CreateLaunchConfiguration (Maybe Text) Source #
The ID of the Amazon Machine Image (AMI) that was assigned during registration. For more information, see Finding a Linux AMI in the Amazon EC2 User Guide for Linux Instances.
If you specify InstanceId
, an ImageId
is not required.
createLaunchConfiguration_instanceId :: Lens' CreateLaunchConfiguration (Maybe Text) Source #
The ID of the instance to use to create the launch configuration. The new launch configuration derives attributes from the instance, except for the block device mapping.
To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.
For more information, see Creating a launch configuration using an EC2 instance in the Amazon EC2 Auto Scaling User Guide.
createLaunchConfiguration_instanceMonitoring :: Lens' CreateLaunchConfiguration (Maybe InstanceMonitoring) Source #
Controls whether instances in this group are launched with detailed
(true
) or basic (false
) monitoring.
The default value is true
(enabled).
When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. For more information, see Configure Monitoring for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.
createLaunchConfiguration_instanceType :: Lens' CreateLaunchConfiguration (Maybe Text) Source #
Specifies the instance type of the EC2 instance. For information about available instance types, see Available instance types in the Amazon EC2 User Guide for Linux Instances.
If you specify InstanceId
, an InstanceType
is not required.
createLaunchConfiguration_kernelId :: Lens' CreateLaunchConfiguration (Maybe Text) Source #
The ID of the kernel associated with the AMI.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide for Linux Instances.
createLaunchConfiguration_keyName :: Lens' CreateLaunchConfiguration (Maybe Text) Source #
The name of the key pair. For more information, see Amazon EC2 key pairs and Linux instances in the Amazon EC2 User Guide for Linux Instances.
createLaunchConfiguration_metadataOptions :: Lens' CreateLaunchConfiguration (Maybe InstanceMetadataOptions) Source #
The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the Amazon EC2 Auto Scaling User Guide.
createLaunchConfiguration_placementTenancy :: Lens' CreateLaunchConfiguration (Maybe Text) Source #
The tenancy of the instance, either default
or dedicated
. An
instance with dedicated
tenancy runs on isolated, single-tenant
hardware and can only be launched into a VPC. To launch dedicated
instances into a shared tenancy VPC (a VPC with the instance placement
tenancy attribute set to default
), you must set the value of this
property to dedicated
. For more information, see
Configuring instance tenancy with Amazon EC2 Auto Scaling
in the Amazon EC2 Auto Scaling User Guide.
If you specify PlacementTenancy
, you must specify at least one subnet
for VPCZoneIdentifier
when you create your group.
Valid values: default
| dedicated
createLaunchConfiguration_ramdiskId :: Lens' CreateLaunchConfiguration (Maybe Text) Source #
The ID of the RAM disk to select.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide for Linux Instances.
createLaunchConfiguration_securityGroups :: Lens' CreateLaunchConfiguration (Maybe [Text]) Source #
A list that contains the security group IDs to assign to the instances in the Auto Scaling group. For more information, see Control traffic to resources using security groups in the Amazon Virtual Private Cloud User Guide.
createLaunchConfiguration_spotPrice :: Lens' CreateLaunchConfiguration (Maybe Text) Source #
The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot price. For more information, see Request Spot Instances for fault-tolerant and flexible applications in the Amazon EC2 Auto Scaling User Guide.
Valid Range: Minimum value of 0.001
When you change your maximum price by creating a new launch configuration, running instances will continue to run as long as the maximum price for those running instances is higher than the current Spot price.
createLaunchConfiguration_userData :: Lens' CreateLaunchConfiguration (Maybe Text) Source #
The user data to make available to the launched EC2 instances. For more information, see Instance metadata and user data (Linux) and Instance metadata and user data (Windows). 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.
createLaunchConfiguration_launchConfigurationName :: Lens' CreateLaunchConfiguration Text Source #
The name of the launch configuration. This name must be unique per Region per account.
Destructuring the Response
data CreateLaunchConfigurationResponse Source #
See: newCreateLaunchConfigurationResponse
smart constructor.
Instances
newCreateLaunchConfigurationResponse :: CreateLaunchConfigurationResponse Source #
Create a value of CreateLaunchConfigurationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.