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

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.
#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) that was assigned during registration.
#instance_id ⇒ String

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

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

Specifies 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.
#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 to select.
#security_groups ⇒ Array<String>

A list that contains the security group IDs 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.

If you specify ‘true`, each instance in the Auto Scaling group receives a unique public IPv4 address. For more information, see [Provide network connectivity for your Auto Scaling instances using Amazon VPC] in the *Amazon EC2 Auto Scaling User Guide*.

If you specify this property, you must specify at least one subnet for ‘VPCZoneIdentifier` when you create your group.

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

Returns:

(Boolean)

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

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,
  :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 mappings] 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 1531

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,
  :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 1531

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,
  :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 1531

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,
  :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`). 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`.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html

Returns:

(Boolean)

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

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,
  :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 1531

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,
  :metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#image_id ⇒ `String`

The ID of the Amazon Machine Image (AMI) that was assigned during registration. For more information, see [Find a Linux AMI] in the *Amazon EC2 User Guide for Linux Instances*.

If you specify ‘InstanceId`, an `ImageId` is not required.

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

Returns:

(String)

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

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,
  :metadata_options)
  SENSITIVE = []
  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.

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

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

Returns:

(String)

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

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,
  :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.

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

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

Returns:

(Types::InstanceMonitoring)

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

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,
  :metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#instance_type ⇒ `String`

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 specify ‘InstanceId`, an `InstanceType` is not required.

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

Returns:

(String)

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

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,
  :metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#kernel_id ⇒ `String`

The ID of the kernel associated with the AMI.

<note markdown=“1”> We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User provided kernels] in the *Amazon EC2 User Guide for Linux Instances*.

</note>

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

Returns:

(String)

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

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,
  :metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#key_name ⇒ `String`

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)

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

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,
  :metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#launch_configuration_name ⇒ `String`

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

Returns:

(String)

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

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,
  :metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#metadata_options ⇒ `Types::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

Returns:

(Types::InstanceMetadataOptions)

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

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,
  :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. 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 property to `dedicated`.

If you specify ‘PlacementTenancy`, you must specify at least one subnet for `VPCZoneIdentifier` when you create your group.

Valid values: ‘default` | `dedicated`

Returns:

(String)

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

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,
  :metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#ramdisk_id ⇒ `String`

The ID of the RAM disk to select.

<note markdown=“1”> We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User provided kernels] in the *Amazon EC2 User Guide for Linux Instances*.

</note>

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

Returns:

(String)

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

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,
  :metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#security_groups ⇒ `Array<String>`

A list that contains the security group IDs 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>)

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

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,
  :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 [Request Spot Instances for fault-tolerant and flexible applications] in the *Amazon EC2 Auto Scaling User Guide*.

Valid Range: Minimum value of 0.001

<note markdown=“1”> When you change your maximum price by creating a new launch configuration, running instances will continue to run as long as the maximum price for those running instances is higher than the current Spot price.

</note>

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

Returns:

(String)

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

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,
  :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 1531

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,
  :metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

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

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>

#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

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

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

#metadata_options ⇒ `Types::InstanceMetadataOptions`

#placement_tenancy ⇒ `String`

#ramdisk_id ⇒ `String`

#security_groups ⇒ `Array<String>`

#spot_price ⇒ `String`

#user_data ⇒ `String`