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

Used for groups that launch instances into a virtual private cloud (VPC). Specifies whether to assign a public IP address to each instance. For more information, see Launching Auto Scaling Instances in a VPC in the Auto Scaling User Guide.

If you specify this parameter, be sure to specify at least one subnet when you create your group.

Default: If the instance is launched into a default subnet, the default is true. If the instance is launched into a nondefault subnet, the default is false. For more information, see Supported Platforms in the Amazon Elastic Compute Cloud User Guide.

Returns:

  • (Boolean)


1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1069

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>

One or more mappings that specify how block devices are exposed to the instance. For more information, see Block Device Mapping in the Amazon Elastic Compute Cloud User Guide.

Returns:



1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1069

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. This parameter is supported only if you are launching EC2-Classic instances. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

Returns:

  • (String)


1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1069

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. This parameter is required if you specify a ClassicLink-enabled VPC, and is not supported otherwise. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

Returns:

  • (Array<String>)


1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1069

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

Indicates whether the instance is optimized for Amazon EBS I/O. By default, the instance is not optimized for EBS I/O. 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 usage charges apply. For more information, see Amazon EBS-Optimized Instances in the Amazon Elastic Compute Cloud User Guide.

Returns:

  • (Boolean)


1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1069

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.

EC2 instances launched with an IAM role will automatically have AWS security credentials available. You can use IAM roles with Auto Scaling to automatically enable applications running on your EC2 instances to securely access other AWS resources. For more information, see Launch Auto Scaling Instances with an IAM Role in the Auto Scaling User Guide.

Returns:

  • (String)


1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1069

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) to use to launch your EC2 instances.

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

For more information, see Finding an AMI in the Amazon Elastic Compute Cloud User Guide.

Returns:

  • (String)


1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1069

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, with the exception of the block device mapping.

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

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 Auto Scaling User Guide.

Returns:

  • (String)


1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1069

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

Enables detailed monitoring (true) or basic monitoring (false) for the Auto Scaling instances. The default is true.



1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1069

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

The instance type of the EC2 instance.

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

For information about available instance types, see Available Instance Types in the Amazon Elastic Compute Cloud User Guide.

Returns:

  • (String)


1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1069

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)


1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1069

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 Elastic Compute Cloud User Guide.

Returns:

  • (String)


1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1069

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 within the scope of your AWS account.

Returns:

  • (String)


1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1069

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 a tenancy of dedicated runs on single-tenant hardware and can only be launched into a VPC.

You must set the value of this parameter to dedicated if want to launch Dedicated Instances into a shared tenancy VPC (VPC with instance placement tenancy attribute set to default).

If you specify this parameter, be sure to specify at least one subnet when you create your group.

For more information, see Launching Auto Scaling Instances in a VPC in the Auto Scaling User Guide.

Valid values: default | dedicated

Returns:

  • (String)


1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1069

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 associated with the AMI.

Returns:

  • (String)


1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1069

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>

One or more security groups with which to associate the instances.

If your instances are launched in EC2-Classic, you can either specify security group names or the security group IDs. For more information about security groups for EC2-Classic, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide.

If your instances are launched into a VPC, specify security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

Returns:

  • (Array<String>)


1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1069

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 Auto Scaling User Guide.

Returns:

  • (String)


1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1069

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 user data to make available to the launched EC2 instances. For more information, see Instance Metadata and User Data in the Amazon Elastic Compute Cloud User Guide.

Returns:

  • (String)


1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1069

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