AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the RunScheduledInstances operation. Launches the specified Scheduled Instances.

Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.

You must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes. For more information, see Scheduled Instances in the Amazon Elastic Compute Cloud User Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.EC2.AmazonEC2Request
      Amazon.EC2.Model.RunScheduledInstancesRequest

Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z

Syntax

C#
public class RunScheduledInstancesRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The RunScheduledInstancesRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property ClientToken System.String

Gets and sets the property ClientToken.

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

Public Property InstanceCount System.Int32

Gets and sets the property InstanceCount.

The number of instances.

Default: 1

Public Property LaunchSpecification Amazon.EC2.Model.ScheduledInstancesLaunchSpecification

Gets and sets the property LaunchSpecification.

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

Public Property ScheduledInstanceId System.String

Gets and sets the property ScheduledInstanceId.

The Scheduled Instance ID.

Examples

This example launches the specified Scheduled Instance in a VPC.

To launch a Scheduled Instance in a VPC


var response = client.RunScheduledInstances(new RunScheduledInstancesRequest 
{
    InstanceCount = 1,
    LaunchSpecification = new ScheduledInstancesLaunchSpecification {
        IamInstanceProfile = new ScheduledInstancesIamInstanceProfile { Name = "my-iam-role" },
        ImageId = "ami-12345678",
        InstanceType = "c4.large",
        KeyName = "my-key-pair",
        NetworkInterfaces = new List {
            new ScheduledInstancesNetworkInterface {
                AssociatePublicIpAddress = true,
                DeviceIndex = 0,
                Groups = new List {
                    "sg-12345678"
                },
                SubnetId = "subnet-12345678"
            }
        }
    },
    ScheduledInstanceId = "sci-1234-1234-1234-1234-123456789012"
});

List instanceIdSet = response.InstanceIdSet;

            

This example launches the specified Scheduled Instance in EC2-Classic.

To launch a Scheduled Instance in EC2-Classic


var response = client.RunScheduledInstances(new RunScheduledInstancesRequest 
{
    InstanceCount = 1,
    LaunchSpecification = new ScheduledInstancesLaunchSpecification {
        IamInstanceProfile = new ScheduledInstancesIamInstanceProfile { Name = "my-iam-role" },
        ImageId = "ami-12345678",
        InstanceType = "c4.large",
        KeyName = "my-key-pair",
        Placement = new ScheduledInstancesPlacement { AvailabilityZone = "us-west-2b" },
        SecurityGroupIds = new List {
            "sg-12345678"
        }
    },
    ScheduledInstanceId = "sci-1234-1234-1234-1234-123456789012"
});

List instanceIdSet = response.InstanceIdSet;

            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms