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

Inherits:
Struct
  • Object
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

Instance Attribute Details

#associate_public_ip_addressBoolean

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 [Provide network connectivity for your Auto Scaling instances using Amazon VPC] in the *Amazon EC2 Auto Scaling User Guide*.

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

Returns:

  • (Boolean)


4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
# File 'lib/aws-sdk-autoscaling/types.rb', line 4545

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

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

Returns:



4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
# File 'lib/aws-sdk-autoscaling/types.rb', line 4545

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

Available for backward compatibility.

Returns:

  • (String)


4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
# File 'lib/aws-sdk-autoscaling/types.rb', line 4545

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

Available for backward compatibility.

Returns:

  • (Array<String>)


4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
# File 'lib/aws-sdk-autoscaling/types.rb', line 4545

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_timeTime

The creation date and time for the launch configuration.

Returns:

  • (Time)


4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
# File 'lib/aws-sdk-autoscaling/types.rb', line 4545

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_optimizedBoolean

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/ebs-optimized.html

Returns:

  • (Boolean)


4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
# File 'lib/aws-sdk-autoscaling/types.rb', line 4545

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

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

Returns:

  • (String)


4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
# File 'lib/aws-sdk-autoscaling/types.rb', line 4545

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_idString

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)


4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
# File 'lib/aws-sdk-autoscaling/types.rb', line 4545

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_monitoringTypes::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



4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
# File 'lib/aws-sdk-autoscaling/types.rb', line 4545

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_typeString

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)


4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
# File 'lib/aws-sdk-autoscaling/types.rb', line 4545

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_idString

The ID of the kernel associated with the AMI.

Returns:

  • (String)


4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
# File 'lib/aws-sdk-autoscaling/types.rb', line 4545

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_nameString

The name of the key pair.

For more information, see [Amazon EC2 key pairs and Amazon EC2 instances] in the *Amazon EC2 User Guide for Linux Instances*.

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

Returns:

  • (String)


4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
# File 'lib/aws-sdk-autoscaling/types.rb', line 4545

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_arnString

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

Returns:

  • (String)


4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
# File 'lib/aws-sdk-autoscaling/types.rb', line 4545

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_nameString

The name of the launch configuration.

Returns:

  • (String)


4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
# File 'lib/aws-sdk-autoscaling/types.rb', line 4545

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_optionsTypes::InstanceMetadataOptions

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

Configure 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



4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
# File 'lib/aws-sdk-autoscaling/types.rb', line 4545

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_tenancyString

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.

Returns:

  • (String)


4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
# File 'lib/aws-sdk-autoscaling/types.rb', line 4545

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_idString

The ID of the RAM disk associated with the AMI.

Returns:

  • (String)


4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
# File 'lib/aws-sdk-autoscaling/types.rb', line 4545

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_groupsArray<String>

A list that contains the security groups to assign to the instances in the Auto Scaling group. For more information, see [Control traffic to your Amazon Web Services resources using security groups] in the *Amazon Virtual Private Cloud User Guide*.

[1]: docs.aws.amazon.com/vpc/latest/userguide/vpc-security-groups.html

Returns:

  • (Array<String>)


4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
# File 'lib/aws-sdk-autoscaling/types.rb', line 4545

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_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 price. For more information, see [Requesting Spot Instances for fault-tolerant and flexible applications] in the *Amazon EC2 Auto Scaling User Guide*.

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

Returns:

  • (String)


4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
# File 'lib/aws-sdk-autoscaling/types.rb', line 4545

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_dataString

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)


4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
# File 'lib/aws-sdk-autoscaling/types.rb', line 4545

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