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

Inherits:

Struct

Object
Struct
Aws::AutoScaling::Types::CreateLaunchConfigurationType

show all

Includes:: Structure

Defined in:: 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

#associate_public_ip_address ⇒ Boolean

Used for groups that launch instances into a virtual private cloud (VPC).
#block_device_mappings ⇒ Array<Types::BlockDeviceMapping>

One or more mappings that specify how block devices are exposed to the instance.
#classic_link_vpc_id ⇒ String

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.
#classic_link_vpc_security_groups ⇒ Array<String>

The IDs of one or more security groups for the specified ClassicLink-enabled VPC.
#ebs_optimized ⇒ Boolean

Indicates whether the instance is optimized for Amazon EBS I/O.
#iam_instance_profile ⇒ String

The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.
#image_id ⇒ String

The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances.
#instance_id ⇒ String

The ID of the instance to use to create the launch configuration.
#instance_monitoring ⇒ Types::InstanceMonitoring

Enables detailed monitoring (‘true`) or basic monitoring (`false`) for the Auto Scaling instances.
#instance_type ⇒ String

The instance type of the EC2 instance.
#kernel_id ⇒ String

The ID of the kernel associated with the AMI.
#key_name ⇒ String

The name of the key pair.
#launch_configuration_name ⇒ String

The name of the launch configuration.
#placement_tenancy ⇒ String

The tenancy of the instance.
#ramdisk_id ⇒ String

The ID of the RAM disk associated with the AMI.
#security_groups ⇒ Array<String>

One or more security groups with which to associate the instances.
#spot_price ⇒ String

The maximum hourly price to be paid for any Spot Instance launched to fulfill the request.
#user_data ⇒ String

The user data to make available to the launched EC2 instances.

Instance Attribute Details

#associate_public_ip_address ⇒ `Boolean`

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 *Amazon EC2 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 to assign a public IP address. If the instance is launched into a nondefault subnet, the default is not to assign a public IP address.

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html

Returns:

(Boolean)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1226

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_mappings ⇒ `Array<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*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html

Returns:

(Array<Types::BlockDeviceMapping>)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1226

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

#classic_link_vpc_id ⇒ `String`

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html

Returns:

(String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1226

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

#classic_link_vpc_security_groups ⇒ `Array<String>`

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html

Returns:

(Array<String>)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1226

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_optimized ⇒ `Boolean`

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html

Returns:

(Boolean)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1226

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_profile ⇒ `String`

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 automatically have AWS security credentials available. You can use IAM roles with Amazon EC2 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 *Amazon EC2 Auto Scaling User Guide*.

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html

Returns:

(String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1226

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_id ⇒ `String`

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html

Returns:

(String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1226

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_id ⇒ `String`

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.

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

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/create-lc-with-instanceID.html

Returns:

(String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1226

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_monitoring ⇒ `Types::InstanceMonitoring`

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

Returns:

(Types::InstanceMonitoring)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1226

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_type ⇒ `String`

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes

Returns:

(String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1226

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_id ⇒ `String`

The ID of the kernel associated with the AMI.

Returns:

(String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1226

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_name ⇒ `String`

The name of the key pair. For more information, see [Amazon EC2 Key Pairs] in the *Amazon Elastic Compute Cloud User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html

Returns:

(String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1226

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_name ⇒ `String`

The name of the launch configuration. This name must be unique within the scope of your AWS account.

Returns:

(String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1226

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_tenancy ⇒ `String`

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.

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

Valid values: ‘default` | `dedicated`

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html

Returns:

(String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1226

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_id ⇒ `String`

The ID of the RAM disk associated with the AMI.

Returns:

(String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1226

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_groups ⇒ `Array<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, 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*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html [2]: docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html

Returns:

(Array<String>)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1226

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_price ⇒ `String`

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

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/asg-launch-spot-instances.html

Returns:

(String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1226

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_data ⇒ `String`

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html

Returns:

(String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 1226

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

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#associate_public_ip_address ⇒ Boolean

#block_device_mappings ⇒ Array<Types::BlockDeviceMapping>

#classic_link_vpc_id ⇒ String

#classic_link_vpc_security_groups ⇒ Array<String>

#ebs_optimized ⇒ Boolean

#iam_instance_profile ⇒ String

#image_id ⇒ String

#instance_id ⇒ String

#instance_monitoring ⇒ Types::InstanceMonitoring

#instance_type ⇒ String

#kernel_id ⇒ String

#key_name ⇒ String

#launch_configuration_name ⇒ String

#placement_tenancy ⇒ String

#ramdisk_id ⇒ String

#security_groups ⇒ Array<String>

#spot_price ⇒ String

#user_data ⇒ String

#associate_public_ip_address ⇒ `Boolean`

#block_device_mappings ⇒ `Array<Types::BlockDeviceMapping>`

#classic_link_vpc_id ⇒ `String`

#classic_link_vpc_security_groups ⇒ `Array<String>`

#ebs_optimized ⇒ `Boolean`

#iam_instance_profile ⇒ `String`

#image_id ⇒ `String`

#instance_id ⇒ `String`

#instance_monitoring ⇒ `Types::InstanceMonitoring`

#instance_type ⇒ `String`

#kernel_id ⇒ `String`

#key_name ⇒ `String`

#launch_configuration_name ⇒ `String`

#placement_tenancy ⇒ `String`

#ramdisk_id ⇒ `String`

#security_groups ⇒ `Array<String>`

#spot_price ⇒ `String`

#user_data ⇒ `String`