You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::EC2::Types::RunScheduledInstancesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::EC2::Types::RunScheduledInstancesRequest
- Defined in:
- (unknown)
Overview
When passing RunScheduledInstancesRequest as input to an Aws::Client method, you can use a vanilla 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: "SnapshotId",
volume_size: 1,
volume_type: "String",
},
no_device: "String",
virtual_name: "String",
},
],
ebs_optimized: false,
iam_instance_profile: {
arn: "String",
name: "String",
},
image_id: "ImageId", # required
instance_type: "String",
kernel_id: "KernelId",
key_name: "KeyPairName",
monitoring: {
enabled: false,
},
network_interfaces: [
{
associate_public_ip_address: false,
delete_on_termination: false,
description: "String",
device_index: 1,
groups: ["SecurityGroupId"],
ipv_6_address_count: 1,
ipv_6_addresses: [
{
ipv_6_address: "Ipv6Address",
},
],
network_interface_id: "NetworkInterfaceId",
private_ip_address: "String",
private_ip_address_configs: [
{
primary: false,
private_ip_address: "String",
},
],
secondary_private_ip_address_count: 1,
subnet_id: "SubnetId",
},
],
placement: {
availability_zone: "String",
group_name: "PlacementGroupName",
},
ramdisk_id: "RamdiskId",
security_group_ids: ["SecurityGroupId"],
subnet_id: "SubnetId",
user_data: "String",
},
scheduled_instance_id: "ScheduledInstanceId", # required
}
Contains the parameters for RunScheduledInstances.
Instance Attribute Summary collapse
-
#client_token ⇒ String
Unique, case-sensitive identifier that ensures the idempotency of the request.
-
#dry_run ⇒ Boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
-
#instance_count ⇒ Integer
The number of instances.
-
#launch_specification ⇒ Types::ScheduledInstancesLaunchSpecification
The launch specification.
-
#scheduled_instance_id ⇒ String
The Scheduled Instance ID.
Instance Attribute Details
#client_token ⇒ String
Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.
#dry_run ⇒ Boolean
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
.
#instance_count ⇒ Integer
The number of instances.
Default: 1
#launch_specification ⇒ Types::ScheduledInstancesLaunchSpecification
The launch specification. You must match the instance type, Availability Zone, network, and platform of the schedule that you purchased.
#scheduled_instance_id ⇒ String
The Scheduled Instance ID.