You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::AutoScaling::Types::CreateLaunchConfigurationType

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb

Overview

Note:

When making an API call, you may pass CreateLaunchConfigurationType data as a hash:

{
  launch_configuration_name: "XmlStringMaxLen255", # required
  image_id: "XmlStringMaxLen255",
  key_name: "XmlStringMaxLen255",
  security_groups: ["XmlString"],
  classic_link_vpc_id: "XmlStringMaxLen255",
  classic_link_vpc_security_groups: ["XmlStringMaxLen255"],
  user_data: "XmlStringUserData",
  instance_id: "XmlStringMaxLen19",
  instance_type: "XmlStringMaxLen255",
  kernel_id: "XmlStringMaxLen255",
  ramdisk_id: "XmlStringMaxLen255",
  block_device_mappings: [
    {
      virtual_name: "XmlStringMaxLen255",
      device_name: "XmlStringMaxLen255", # required
      ebs: {
        snapshot_id: "XmlStringMaxLen255",
        volume_size: 1,
        volume_type: "BlockDeviceEbsVolumeType",
        delete_on_termination: false,
        iops: 1,
        encrypted: false,
      },
      no_device: false,
    },
  ],
  instance_monitoring: {
    enabled: false,
  },
  spot_price: "SpotPrice",
  iam_instance_profile: "XmlStringMaxLen1600",
  ebs_optimized: false,
  associate_public_ip_address: false,
  placement_tenancy: "XmlStringMaxLen64",
}

Instance Attribute Summary collapse

Instance Attribute Details

#associate_public_ip_addressBoolean

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.

If the instance is launched into a default subnet, the default is to assign a public IP address, unless you disabled the option to assign a public IP address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IP address, unless you enabled the option to assign a public IP address on the subnet.

Returns:

  • (Boolean)


1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1341

class CreateLaunchConfigurationType < Struct.new(
  :launch_configuration_name,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_id,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy)
  include Aws::Structure
end

#block_device_mappingsArray<Types::BlockDeviceMapping>

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.

Returns:



1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1341

class CreateLaunchConfigurationType < Struct.new(
  :launch_configuration_name,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_id,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy)
  include Aws::Structure
end

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.

Returns:

  • (String)


1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1341

class CreateLaunchConfigurationType < Struct.new(
  :launch_configuration_name,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_id,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy)
  include Aws::Structure
end

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.

Returns:

  • (Array<String>)


1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1341

class CreateLaunchConfigurationType < Struct.new(
  :launch_configuration_name,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_id,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy)
  include Aws::Structure
end

#ebs_optimizedBoolean

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.

Returns:

  • (Boolean)


1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1341

class CreateLaunchConfigurationType < Struct.new(
  :launch_configuration_name,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_id,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy)
  include Aws::Structure
end

#iam_instance_profileString

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.

Returns:

  • (String)


1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1341

class CreateLaunchConfigurationType < Struct.new(
  :launch_configuration_name,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_id,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy)
  include Aws::Structure
end

#image_idString

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.

Returns:

  • (String)


1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1341

class CreateLaunchConfigurationType < Struct.new(
  :launch_configuration_name,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_id,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy)
  include Aws::Structure
end

#instance_idString

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

Returns:

  • (String)


1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1341

class CreateLaunchConfigurationType < Struct.new(
  :launch_configuration_name,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_id,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy)
  include Aws::Structure
end

#instance_monitoringTypes::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.



1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1341

class CreateLaunchConfigurationType < Struct.new(
  :launch_configuration_name,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_id,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy)
  include Aws::Structure
end

#instance_typeString

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.

Returns:

  • (String)


1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1341

class CreateLaunchConfigurationType < Struct.new(
  :launch_configuration_name,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_id,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy)
  include Aws::Structure
end

#kernel_idString

The ID of the kernel associated with the AMI.

Returns:

  • (String)


1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1341

class CreateLaunchConfigurationType < Struct.new(
  :launch_configuration_name,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_id,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy)
  include Aws::Structure
end

#key_nameString

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

Returns:

  • (String)


1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1341

class CreateLaunchConfigurationType < Struct.new(
  :launch_configuration_name,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_id,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy)
  include Aws::Structure
end

#launch_configuration_nameString

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

Returns:

  • (String)


1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1341

class CreateLaunchConfigurationType < Struct.new(
  :launch_configuration_name,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_id,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy)
  include Aws::Structure
end

#placement_tenancyString

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 Instance Placement Tenancy in the Amazon EC2 Auto Scaling User Guide.

Valid values: default | dedicated

Returns:

  • (String)


1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1341

class CreateLaunchConfigurationType < Struct.new(
  :launch_configuration_name,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_id,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy)
  include Aws::Structure
end

#ramdisk_idString

The ID of the RAM disk to select.

Returns:

  • (String)


1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1341

class CreateLaunchConfigurationType < Struct.new(
  :launch_configuration_name,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_id,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy)
  include Aws::Structure
end

#security_groupsArray<String>

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.

Returns:

  • (Array<String>)


1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1341

class CreateLaunchConfigurationType < Struct.new(
  :launch_configuration_name,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_id,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy)
  include Aws::Structure
end

#spot_priceString

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 market price. For more information, see Launching Spot Instances in Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

If a Spot price is set, then the Auto Scaling group will only launch instances when the Spot price has been met, regardless of the setting in the Auto Scaling group's DesiredCapacity.

When you change your Spot price by creating a new launch configuration, running instances will continue to run as long as the Spot price for those running instances is higher than the current Spot market price.

Returns:

  • (String)


1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1341

class CreateLaunchConfigurationType < Struct.new(
  :launch_configuration_name,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_id,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy)
  include Aws::Structure
end

#user_dataString

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.

Returns:

  • (String)


1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1341

class CreateLaunchConfigurationType < Struct.new(
  :launch_configuration_name,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_id,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy)
  include Aws::Structure
end