Class: Aws::AutoScaling::Types::LaunchConfiguration

Inherits:

Struct

Object
Struct
Aws::AutoScaling::Types::LaunchConfiguration

show all

Includes:: Structure

Defined in:: lib/aws-sdk-autoscaling/types.rb

Overview

Describes a launch configuration.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#associate_public_ip_address ⇒ Boolean

Specifies whether to assign a public IPv4 address to the group’s instances.
#block_device_mappings ⇒ Array<Types::BlockDeviceMapping>

The block device mapping entries that define the block devices to attach to the instances at launch.
#classic_link_vpc_id ⇒ String

Available for backward compatibility.
#classic_link_vpc_security_groups ⇒ Array<String>

Available for backward compatibility.
#created_time ⇒ Time

The creation date and time for the launch configuration.
#ebs_optimized ⇒ Boolean

Specifies whether the launch configuration is optimized for EBS I/O (‘true`) or not (`false`).
#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_monitoring ⇒ Types::InstanceMonitoring

Controls whether instances in this group are launched with detailed (‘true`) or basic (`false`) monitoring.
#instance_type ⇒ String

The instance type for the instances.
#kernel_id ⇒ String

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

The name of the key pair.
#launch_configuration_arn ⇒ String

The Amazon Resource Name (ARN) of the launch configuration.
#launch_configuration_name ⇒ String

The name of the launch configuration.
#metadata_options ⇒ Types::InstanceMetadataOptions

The metadata options for the instances.
#placement_tenancy ⇒ String

The tenancy of the instance, either ‘default` or `dedicated`.
#ramdisk_id ⇒ String

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

A list that contains the security groups to assign to the instances in the Auto Scaling group.
#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`

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. For more information, see [Launching Auto Scaling instances in a VPC] in the *Amazon EC2 Auto Scaling User Guide*.

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

Returns:

(Boolean)

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

class LaunchConfiguration < Struct.new(
  :launch_configuration_name,
  :launch_configuration_arn,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :created_time,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy,
  :metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

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

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 Mapping] in the *Amazon EC2 User Guide for Linux Instances*.

[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 4234

class LaunchConfiguration < Struct.new(
  :launch_configuration_name,
  :launch_configuration_arn,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :created_time,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy,
  :metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#classic_link_vpc_id ⇒ `String`

Available for backward compatibility.

Returns:

(String)

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

class LaunchConfiguration < Struct.new(
  :launch_configuration_name,
  :launch_configuration_arn,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :created_time,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy,
  :metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#classic_link_vpc_security_groups ⇒ `Array<String>`

Available for backward compatibility.

Returns:

(Array<String>)

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

class LaunchConfiguration < Struct.new(
  :launch_configuration_name,
  :launch_configuration_arn,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :created_time,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy,
  :metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#created_time ⇒ `Time`

The creation date and time for the launch configuration.

Returns:

(Time)

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

class LaunchConfiguration < Struct.new(
  :launch_configuration_name,
  :launch_configuration_arn,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :created_time,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy,
  :metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#ebs_optimized ⇒ `Boolean`

Specifies whether the launch configuration is optimized for EBS I/O (‘true`) or not (`false`). For more information, see [Amazon EBS-Optimized Instances] in the *Amazon EC2 User Guide for Linux Instances*.

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

Returns:

(Boolean)

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

class LaunchConfiguration < Struct.new(
  :launch_configuration_name,
  :launch_configuration_arn,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :created_time,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy,
  :metadata_options)
  SENSITIVE = []
  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. 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*.

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

Returns:

(String)

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

class LaunchConfiguration < Struct.new(
  :launch_configuration_name,
  :launch_configuration_arn,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :created_time,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy,
  :metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#image_id ⇒ `String`

The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more information, see [Find a Linux AMI] in the *Amazon EC2 User Guide for Linux Instances*.

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

Returns:

(String)

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

class LaunchConfiguration < Struct.new(
  :launch_configuration_name,
  :launch_configuration_arn,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :created_time,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy,
  :metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#instance_monitoring ⇒ `Types::InstanceMonitoring`

Controls whether instances in this group are launched with detailed (‘true`) or basic (`false`) monitoring.

For more information, see [Configure Monitoring for Auto Scaling Instances] in the *Amazon EC2 Auto Scaling User Guide*.

[1]: docs.aws.amazon.com/autoscaling/latest/userguide/enable-as-instance-metrics.html

Returns:

(Types::InstanceMonitoring)

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

class LaunchConfiguration < Struct.new(
  :launch_configuration_name,
  :launch_configuration_arn,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :created_time,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy,
  :metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#instance_type ⇒ `String`

The instance type for the instances. For information about available instance types, see [Available instance types] in the *Amazon EC2 User Guide for Linux Instances*.

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

Returns:

(String)

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

class LaunchConfiguration < Struct.new(
  :launch_configuration_name,
  :launch_configuration_arn,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :created_time,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy,
  :metadata_options)
  SENSITIVE = []
  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 4234

class LaunchConfiguration < Struct.new(
  :launch_configuration_name,
  :launch_configuration_arn,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :created_time,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy,
  :metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#key_name ⇒ `String`

The name of the key pair.

For more information, see [Amazon EC2 Key Pairs] in the *Amazon EC2 User Guide for Linux Instances*.

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

Returns:

(String)

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

class LaunchConfiguration < Struct.new(
  :launch_configuration_name,
  :launch_configuration_arn,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :created_time,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy,
  :metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#launch_configuration_arn ⇒ `String`

The Amazon Resource Name (ARN) of the launch configuration.

Returns:

(String)

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

class LaunchConfiguration < Struct.new(
  :launch_configuration_name,
  :launch_configuration_arn,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :created_time,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy,
  :metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#launch_configuration_name ⇒ `String`

The name of the launch configuration.

Returns:

(String)

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

class LaunchConfiguration < Struct.new(
  :launch_configuration_name,
  :launch_configuration_arn,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :created_time,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy,
  :metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#metadata_options ⇒ `Types::InstanceMetadataOptions`

The metadata options for the instances. For more information, see

Configuring the Instance Metadata Options][1: in the *Amazon EC2

Auto Scaling User Guide*.

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html#launch-configurations-imds

Returns:

(Types::InstanceMetadataOptions)

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

class LaunchConfiguration < Struct.new(
  :launch_configuration_name,
  :launch_configuration_arn,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :created_time,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy,
  :metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#placement_tenancy ⇒ `String`

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.

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

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/auto-scaling-dedicated-instances.html

Returns:

(String)

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

class LaunchConfiguration < Struct.new(
  :launch_configuration_name,
  :launch_configuration_arn,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :created_time,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy,
  :metadata_options)
  SENSITIVE = []
  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 4234

class LaunchConfiguration < Struct.new(
  :launch_configuration_name,
  :launch_configuration_arn,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :created_time,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy,
  :metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#security_groups ⇒ `Array<String>`

A list that contains the security groups to assign to the instances in the Auto Scaling group. For more information, see [Security Groups for Your VPC] in the *Amazon Virtual Private Cloud User Guide*.

[1]: docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html

Returns:

(Array<String>)

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

class LaunchConfiguration < Struct.new(
  :launch_configuration_name,
  :launch_configuration_arn,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :created_time,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy,
  :metadata_options)
  SENSITIVE = []
  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 price. For more information, see [Requesting Spot Instances] 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 4234

class LaunchConfiguration < Struct.new(
  :launch_configuration_name,
  :launch_configuration_arn,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :created_time,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy,
  :metadata_options)
  SENSITIVE = []
  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] (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.

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

Returns:

(String)

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

class LaunchConfiguration < Struct.new(
  :launch_configuration_name,
  :launch_configuration_arn,
  :image_id,
  :key_name,
  :security_groups,
  :classic_link_vpc_id,
  :classic_link_vpc_security_groups,
  :user_data,
  :instance_type,
  :kernel_id,
  :ramdisk_id,
  :block_device_mappings,
  :instance_monitoring,
  :spot_price,
  :iam_instance_profile,
  :created_time,
  :ebs_optimized,
  :associate_public_ip_address,
  :placement_tenancy,
  :metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::AutoScaling::Types::LaunchConfiguration

Overview

Constant Summary collapse

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>

#created_time ⇒ Time

#ebs_optimized ⇒ Boolean

#iam_instance_profile ⇒ String

#image_id ⇒ String

#instance_monitoring ⇒ Types::InstanceMonitoring

#instance_type ⇒ String

#kernel_id ⇒ String

#key_name ⇒ String

#launch_configuration_arn ⇒ String

#launch_configuration_name ⇒ String

#metadata_options ⇒ Types::InstanceMetadataOptions

#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>`

#created_time ⇒ `Time`

#ebs_optimized ⇒ `Boolean`

#iam_instance_profile ⇒ `String`

#image_id ⇒ `String`

#instance_monitoring ⇒ `Types::InstanceMonitoring`

#instance_type ⇒ `String`

#kernel_id ⇒ `String`

#key_name ⇒ `String`

#launch_configuration_arn ⇒ `String`

#launch_configuration_name ⇒ `String`

#metadata_options ⇒ `Types::InstanceMetadataOptions`

#placement_tenancy ⇒ `String`

#ramdisk_id ⇒ `String`

#security_groups ⇒ `Array<String>`

#spot_price ⇒ `String`

#user_data ⇒ `String`