createLaunchConfiguration method

Future<void> createLaunchConfiguration({
  1. required String launchConfigurationName,
  2. bool? associatePublicIpAddress,
  3. List<BlockDeviceMapping>? blockDeviceMappings,
  4. String? classicLinkVPCId,
  5. List<String>? classicLinkVPCSecurityGroups,
  6. bool? ebsOptimized,
  7. String? iamInstanceProfile,
  8. String? imageId,
  9. String? instanceId,
  10. InstanceMonitoring? instanceMonitoring,
  11. String? instanceType,
  12. String? kernelId,
  13. String? keyName,
  14. InstanceMetadataOptions? metadataOptions,
  15. String? placementTenancy,
  16. String? ramdiskId,
  17. List<String>? securityGroups,
  18. String? spotPrice,
  19. String? userData,
})

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 Amazon EC2 Auto Scaling service quotas in the Amazon EC2 Auto Scaling User Guide.

For more information, see Launch configurations in the Amazon EC2 Auto Scaling User Guide.

May throw AlreadyExistsFault. May throw LimitExceededFault. May throw ResourceContentionFault.

Parameter launchConfigurationName : The name of the launch configuration. This name must be unique per Region per account.

Parameter associatePublicIpAddress : For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether to assign a public IP address to the group's instances. If you specify true, each instance in the Auto Scaling group receives a unique public IP address. For more information, see Launching Auto Scaling instances in a VPC in the Amazon EC2 Auto Scaling User Guide.

If you specify this parameter, you must specify at least one subnet for VPCZoneIdentifier when you create your group.

Parameter blockDeviceMappings : A block device mapping, which specifies the block devices for the instance. You can specify virtual devices and EBS volumes. For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances.

Parameter classicLinkVPCId : The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

This parameter can only be used if you are launching EC2-Classic instances.

Parameter classicLinkVPCSecurityGroups : The IDs of one or more security groups for the specified ClassicLink-enabled VPC. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

If you specify the ClassicLinkVPCId parameter, you must specify this parameter.

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

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

Parameter imageId : The ID of the Amazon Machine Image (AMI) that was assigned during registration. For more information, see Finding an AMI in the Amazon EC2 User Guide for Linux Instances.

If you do not specify InstanceId, you must specify ImageId.

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

If you do not specify InstanceId, you must specify both ImageId and InstanceType.

Parameter instanceMonitoring : Controls whether instances in this group are launched with detailed (true) or basic (false) monitoring.

The default value is true (enabled).

Parameter 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 do not specify InstanceId, you must specify InstanceType.

Parameter kernelId : The ID of the kernel associated with the AMI.

Parameter keyName : The name of the key pair. For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances.

Parameter metadataOptions : The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the Amazon EC2 Auto Scaling User Guide.

Parameter placementTenancy : The tenancy of the instance. 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 parameter to dedicated.

If you specify PlacementTenancy, you must specify at least one subnet for VPCZoneIdentifier when you create your group.

For more information, see Configuring instance tenancy with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Valid Values: default | dedicated

Parameter ramdiskId : The ID of the RAM disk to select.

Parameter securityGroups : A list that contains the security groups to assign to the instances in the Auto Scaling group.

EC2-VPC Specify the security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

EC2-Classic Specify either the security group names or the security group IDs. For more information, see Amazon EC2 Security Groups in the Amazon EC2 User Guide for Linux Instances.

Parameter 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 Requesting Spot Instances in the Amazon EC2 Auto Scaling User Guide.

Parameter userData : The Base64-encoded user data to make available to the launched EC2 instances. For more information, see Instance metadata and user data in the Amazon EC2 User Guide for Linux Instances.

Implementation

Future<void> createLaunchConfiguration({
  required String launchConfigurationName,
  bool? associatePublicIpAddress,
  List<BlockDeviceMapping>? blockDeviceMappings,
  String? classicLinkVPCId,
  List<String>? classicLinkVPCSecurityGroups,
  bool? ebsOptimized,
  String? iamInstanceProfile,
  String? imageId,
  String? instanceId,
  InstanceMonitoring? instanceMonitoring,
  String? instanceType,
  String? kernelId,
  String? keyName,
  InstanceMetadataOptions? metadataOptions,
  String? placementTenancy,
  String? ramdiskId,
  List<String>? securityGroups,
  String? spotPrice,
  String? userData,
}) async {
  ArgumentError.checkNotNull(
      launchConfigurationName, 'launchConfigurationName');
  _s.validateStringLength(
    'launchConfigurationName',
    launchConfigurationName,
    1,
    255,
    isRequired: true,
  );
  _s.validateStringLength(
    'classicLinkVPCId',
    classicLinkVPCId,
    1,
    255,
  );
  _s.validateStringLength(
    'iamInstanceProfile',
    iamInstanceProfile,
    1,
    1600,
  );
  _s.validateStringLength(
    'imageId',
    imageId,
    1,
    255,
  );
  _s.validateStringLength(
    'instanceId',
    instanceId,
    1,
    19,
  );
  _s.validateStringLength(
    'instanceType',
    instanceType,
    1,
    255,
  );
  _s.validateStringLength(
    'kernelId',
    kernelId,
    1,
    255,
  );
  _s.validateStringLength(
    'keyName',
    keyName,
    1,
    255,
  );
  _s.validateStringLength(
    'placementTenancy',
    placementTenancy,
    1,
    64,
  );
  _s.validateStringLength(
    'ramdiskId',
    ramdiskId,
    1,
    255,
  );
  _s.validateStringLength(
    'spotPrice',
    spotPrice,
    1,
    255,
  );
  _s.validateStringLength(
    'userData',
    userData,
    0,
    21847,
  );
  final $request = <String, dynamic>{};
  $request['LaunchConfigurationName'] = launchConfigurationName;
  associatePublicIpAddress
      ?.also((arg) => $request['AssociatePublicIpAddress'] = arg);
  blockDeviceMappings?.also((arg) => $request['BlockDeviceMappings'] = arg);
  classicLinkVPCId?.also((arg) => $request['ClassicLinkVPCId'] = arg);
  classicLinkVPCSecurityGroups
      ?.also((arg) => $request['ClassicLinkVPCSecurityGroups'] = arg);
  ebsOptimized?.also((arg) => $request['EbsOptimized'] = arg);
  iamInstanceProfile?.also((arg) => $request['IamInstanceProfile'] = arg);
  imageId?.also((arg) => $request['ImageId'] = arg);
  instanceId?.also((arg) => $request['InstanceId'] = arg);
  instanceMonitoring?.also((arg) => $request['InstanceMonitoring'] = arg);
  instanceType?.also((arg) => $request['InstanceType'] = arg);
  kernelId?.also((arg) => $request['KernelId'] = arg);
  keyName?.also((arg) => $request['KeyName'] = arg);
  metadataOptions?.also((arg) => $request['MetadataOptions'] = arg);
  placementTenancy?.also((arg) => $request['PlacementTenancy'] = arg);
  ramdiskId?.also((arg) => $request['RamdiskId'] = arg);
  securityGroups?.also((arg) => $request['SecurityGroups'] = arg);
  spotPrice?.also((arg) => $request['SpotPrice'] = arg);
  userData?.also((arg) => $request['UserData'] = arg);
  await _protocol.send(
    $request,
    action: 'CreateLaunchConfiguration',
    version: '2011-01-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['CreateLaunchConfigurationType'],
    shapes: shapes,
  );
}