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

Class: Aws::EC2::Types::RunScheduledInstancesRequest

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 RunScheduledInstancesRequest data as a hash:

{
  client_token: "String",
  dry_run: false,
  instance_count: 1,
  launch_specification: { # required
    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",
  },
  scheduled_instance_id: "String", # required
}

Contains the parameters for RunScheduledInstances.

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


21371
21372
21373
21374
21375
21376
21377
21378
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21371

class RunScheduledInstancesRequest < Struct.new(
  :client_token,
  :dry_run,
  :instance_count,
  :launch_specification,
  :scheduled_instance_id)
  include Aws::Structure
end

#dry_runBoolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

  • (Boolean)


21371
21372
21373
21374
21375
21376
21377
21378
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21371

class RunScheduledInstancesRequest < Struct.new(
  :client_token,
  :dry_run,
  :instance_count,
  :launch_specification,
  :scheduled_instance_id)
  include Aws::Structure
end

#instance_countInteger

The number of instances.

Default: 1

Returns:

  • (Integer)


21371
21372
21373
21374
21375
21376
21377
21378
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21371

class RunScheduledInstancesRequest < Struct.new(
  :client_token,
  :dry_run,
  :instance_count,
  :launch_specification,
  :scheduled_instance_id)
  include Aws::Structure
end

#launch_specificationTypes::ScheduledInstancesLaunchSpecification

The launch specification. You must match the instance type, Availability Zone, network, and platform of the schedule that you purchased.



21371
21372
21373
21374
21375
21376
21377
21378
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21371

class RunScheduledInstancesRequest < Struct.new(
  :client_token,
  :dry_run,
  :instance_count,
  :launch_specification,
  :scheduled_instance_id)
  include Aws::Structure
end

#scheduled_instance_idString

The Scheduled Instance ID.

Returns:

  • (String)


21371
21372
21373
21374
21375
21376
21377
21378
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21371

class RunScheduledInstancesRequest < Struct.new(
  :client_token,
  :dry_run,
  :instance_count,
  :launch_specification,
  :scheduled_instance_id)
  include Aws::Structure
end