You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EC2::Types::ScheduledInstancesLaunchSpecification

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass ScheduledInstancesLaunchSpecification data as a hash:

{
  block_device_mappings: [
    {
      device_name: "String",
      ebs: {
        delete_on_termination: false,
        encrypted: false,
        iops: 1,
        snapshot_id: "String",
        volume_size: 1,
        volume_type: "String",
      },
      no_device: "String",
      virtual_name: "String",
    },
  ],
  ebs_optimized: false,
  iam_instance_profile: {
    arn: "String",
    name: "String",
  },
  image_id: "String", # required
  instance_type: "String",
  kernel_id: "String",
  key_name: "String",
  monitoring: {
    enabled: false,
  },
  network_interfaces: [
    {
      associate_public_ip_address: false,
      delete_on_termination: false,
      description: "String",
      device_index: 1,
      groups: ["String"],
      ipv_6_address_count: 1,
      ipv_6_addresses: [
        {
          ipv_6_address: "Ipv6Address",
        },
      ],
      network_interface_id: "String",
      private_ip_address: "String",
      private_ip_address_configs: [
        {
          primary: false,
          private_ip_address: "String",
        },
      ],
      secondary_private_ip_address_count: 1,
      subnet_id: "String",
    },
  ],
  placement: {
    availability_zone: "String",
    group_name: "String",
  },
  ramdisk_id: "String",
  security_group_ids: ["String"],
  subnet_id: "String",
  user_data: "String",
}

Describes the launch specification for a Scheduled Instance.

If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can specify the subnet using either SubnetId or NetworkInterface.

Instance Attribute Summary collapse

Instance Attribute Details

#block_device_mappingsArray<Types::ScheduledInstancesBlockDeviceMapping>

One or more block device mapping entries.



22611
22612
22613
22614
22615
22616
22617
22618
22619
22620
22621
22622
22623
22624
22625
22626
22627
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 22611

class ScheduledInstancesLaunchSpecification < Struct.new(
  :block_device_mappings,
  :ebs_optimized,
  :iam_instance_profile,
  :image_id,
  :instance_type,
  :kernel_id,
  :key_name,
  :monitoring,
  :network_interfaces,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :subnet_id,
  :user_data)
  include Aws::Structure
end

#ebs_optimizedBoolean

Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

Returns:

  • (Boolean)


22611
22612
22613
22614
22615
22616
22617
22618
22619
22620
22621
22622
22623
22624
22625
22626
22627
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 22611

class ScheduledInstancesLaunchSpecification < Struct.new(
  :block_device_mappings,
  :ebs_optimized,
  :iam_instance_profile,
  :image_id,
  :instance_type,
  :kernel_id,
  :key_name,
  :monitoring,
  :network_interfaces,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :subnet_id,
  :user_data)
  include Aws::Structure
end

#iam_instance_profileTypes::ScheduledInstancesIamInstanceProfile

The IAM instance profile.



22611
22612
22613
22614
22615
22616
22617
22618
22619
22620
22621
22622
22623
22624
22625
22626
22627
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 22611

class ScheduledInstancesLaunchSpecification < Struct.new(
  :block_device_mappings,
  :ebs_optimized,
  :iam_instance_profile,
  :image_id,
  :instance_type,
  :kernel_id,
  :key_name,
  :monitoring,
  :network_interfaces,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :subnet_id,
  :user_data)
  include Aws::Structure
end

#image_idString

The ID of the Amazon Machine Image (AMI).

Returns:

  • (String)


22611
22612
22613
22614
22615
22616
22617
22618
22619
22620
22621
22622
22623
22624
22625
22626
22627
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 22611

class ScheduledInstancesLaunchSpecification < Struct.new(
  :block_device_mappings,
  :ebs_optimized,
  :iam_instance_profile,
  :image_id,
  :instance_type,
  :kernel_id,
  :key_name,
  :monitoring,
  :network_interfaces,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :subnet_id,
  :user_data)
  include Aws::Structure
end

#instance_typeString

The instance type.

Returns:

  • (String)


22611
22612
22613
22614
22615
22616
22617
22618
22619
22620
22621
22622
22623
22624
22625
22626
22627
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 22611

class ScheduledInstancesLaunchSpecification < Struct.new(
  :block_device_mappings,
  :ebs_optimized,
  :iam_instance_profile,
  :image_id,
  :instance_type,
  :kernel_id,
  :key_name,
  :monitoring,
  :network_interfaces,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :subnet_id,
  :user_data)
  include Aws::Structure
end

#kernel_idString

The ID of the kernel.

Returns:

  • (String)


22611
22612
22613
22614
22615
22616
22617
22618
22619
22620
22621
22622
22623
22624
22625
22626
22627
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 22611

class ScheduledInstancesLaunchSpecification < Struct.new(
  :block_device_mappings,
  :ebs_optimized,
  :iam_instance_profile,
  :image_id,
  :instance_type,
  :kernel_id,
  :key_name,
  :monitoring,
  :network_interfaces,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :subnet_id,
  :user_data)
  include Aws::Structure
end

#key_nameString

The name of the key pair.

Returns:

  • (String)


22611
22612
22613
22614
22615
22616
22617
22618
22619
22620
22621
22622
22623
22624
22625
22626
22627
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 22611

class ScheduledInstancesLaunchSpecification < Struct.new(
  :block_device_mappings,
  :ebs_optimized,
  :iam_instance_profile,
  :image_id,
  :instance_type,
  :kernel_id,
  :key_name,
  :monitoring,
  :network_interfaces,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :subnet_id,
  :user_data)
  include Aws::Structure
end

#monitoringTypes::ScheduledInstancesMonitoring

Enable or disable monitoring for the instances.



22611
22612
22613
22614
22615
22616
22617
22618
22619
22620
22621
22622
22623
22624
22625
22626
22627
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 22611

class ScheduledInstancesLaunchSpecification < Struct.new(
  :block_device_mappings,
  :ebs_optimized,
  :iam_instance_profile,
  :image_id,
  :instance_type,
  :kernel_id,
  :key_name,
  :monitoring,
  :network_interfaces,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :subnet_id,
  :user_data)
  include Aws::Structure
end

#network_interfacesArray<Types::ScheduledInstancesNetworkInterface>

One or more network interfaces.



22611
22612
22613
22614
22615
22616
22617
22618
22619
22620
22621
22622
22623
22624
22625
22626
22627
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 22611

class ScheduledInstancesLaunchSpecification < Struct.new(
  :block_device_mappings,
  :ebs_optimized,
  :iam_instance_profile,
  :image_id,
  :instance_type,
  :kernel_id,
  :key_name,
  :monitoring,
  :network_interfaces,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :subnet_id,
  :user_data)
  include Aws::Structure
end

#placementTypes::ScheduledInstancesPlacement

The placement information.



22611
22612
22613
22614
22615
22616
22617
22618
22619
22620
22621
22622
22623
22624
22625
22626
22627
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 22611

class ScheduledInstancesLaunchSpecification < Struct.new(
  :block_device_mappings,
  :ebs_optimized,
  :iam_instance_profile,
  :image_id,
  :instance_type,
  :kernel_id,
  :key_name,
  :monitoring,
  :network_interfaces,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :subnet_id,
  :user_data)
  include Aws::Structure
end

#ramdisk_idString

The ID of the RAM disk.

Returns:

  • (String)


22611
22612
22613
22614
22615
22616
22617
22618
22619
22620
22621
22622
22623
22624
22625
22626
22627
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 22611

class ScheduledInstancesLaunchSpecification < Struct.new(
  :block_device_mappings,
  :ebs_optimized,
  :iam_instance_profile,
  :image_id,
  :instance_type,
  :kernel_id,
  :key_name,
  :monitoring,
  :network_interfaces,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :subnet_id,
  :user_data)
  include Aws::Structure
end

#security_group_idsArray<String>

The IDs of one or more security groups.

Returns:

  • (Array<String>)


22611
22612
22613
22614
22615
22616
22617
22618
22619
22620
22621
22622
22623
22624
22625
22626
22627
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 22611

class ScheduledInstancesLaunchSpecification < Struct.new(
  :block_device_mappings,
  :ebs_optimized,
  :iam_instance_profile,
  :image_id,
  :instance_type,
  :kernel_id,
  :key_name,
  :monitoring,
  :network_interfaces,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :subnet_id,
  :user_data)
  include Aws::Structure
end

#subnet_idString

The ID of the subnet in which to launch the instances.

Returns:

  • (String)


22611
22612
22613
22614
22615
22616
22617
22618
22619
22620
22621
22622
22623
22624
22625
22626
22627
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 22611

class ScheduledInstancesLaunchSpecification < Struct.new(
  :block_device_mappings,
  :ebs_optimized,
  :iam_instance_profile,
  :image_id,
  :instance_type,
  :kernel_id,
  :key_name,
  :monitoring,
  :network_interfaces,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :subnet_id,
  :user_data)
  include Aws::Structure
end

#user_dataString

The base64-encoded MIME user data.

Returns:

  • (String)


22611
22612
22613
22614
22615
22616
22617
22618
22619
22620
22621
22622
22623
22624
22625
22626
22627
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 22611

class ScheduledInstancesLaunchSpecification < Struct.new(
  :block_device_mappings,
  :ebs_optimized,
  :iam_instance_profile,
  :image_id,
  :instance_type,
  :kernel_id,
  :key_name,
  :monitoring,
  :network_interfaces,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :subnet_id,
  :user_data)
  include Aws::Structure
end