AWS Tools for Windows PowerShell
Command 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.

Synopsis

Calls the Amazon Elastic Compute Cloud (EC2) RunScheduledInstances API operation.

Syntax

New-EC2ScheduledInstance
-ScheduledInstanceId <String>
-IamInstanceProfile_Arn <String>
-Placement_AvailabilityZone <String>
-LaunchSpecification_BlockDeviceMapping <ScheduledInstancesBlockDeviceMapping[]>
-LaunchSpecification_EbsOptimized <Boolean>
-Monitoring_Enabled <Boolean>
-Placement_GroupName <String>
-LaunchSpecification_ImageId <String>
-InstanceCount <Int32>
-LaunchSpecification_InstanceType <String>
-LaunchSpecification_KernelId <String>
-LaunchSpecification_KeyName <String>
-IamInstanceProfile_Name <String>
-LaunchSpecification_NetworkInterface <ScheduledInstancesNetworkInterface[]>
-LaunchSpecification_RamdiskId <String>
-LaunchSpecification_SecurityGroupId <String[]>
-LaunchSpecification_SubnetId <String>
-LaunchSpecification_UserData <String>
-ClientToken <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

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.

Parameters

-ClientToken <String>
Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IamInstanceProfile_Arn <String>
The Amazon Resource Name (ARN).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLaunchSpecification_IamInstanceProfile_Arn
-IamInstanceProfile_Name <String>
The name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLaunchSpecification_IamInstanceProfile_Name
-InstanceCount <Int32>
The number of instances.Default: 1
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LaunchSpecification_BlockDeviceMapping <ScheduledInstancesBlockDeviceMapping[]>
The block device mapping entries.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLaunchSpecification_BlockDeviceMappings
-LaunchSpecification_EbsOptimized <Boolean>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LaunchSpecification_ImageId <String>
The ID of the Amazon Machine Image (AMI).
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-LaunchSpecification_InstanceType <String>
The instance type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LaunchSpecification_KernelId <String>
The ID of the kernel.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LaunchSpecification_KeyName <String>
The name of the key pair.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LaunchSpecification_NetworkInterface <ScheduledInstancesNetworkInterface[]>
The network interfaces.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLaunchSpecification_NetworkInterfaces
-LaunchSpecification_RamdiskId <String>
The ID of the RAM disk.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LaunchSpecification_SecurityGroupId <String[]>
The IDs of the security groups.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLaunchSpecification_SecurityGroupIds
-LaunchSpecification_SubnetId <String>
The ID of the subnet in which to launch the instances.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LaunchSpecification_UserData <String>
The base64-encoded MIME user data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Monitoring_Enabled <Boolean>
Indicates whether monitoring is enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLaunchSpecification_Monitoring_Enabled
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ScheduledInstanceId parameter. The -PassThru parameter is deprecated, use -Select '^ScheduledInstanceId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Placement_AvailabilityZone <String>
The Availability Zone.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLaunchSpecification_Placement_AvailabilityZone
-Placement_GroupName <String>
The name of the placement group.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLaunchSpecification_Placement_GroupName
-ScheduledInstanceId <String>
The Scheduled Instance ID.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'InstanceIdSet'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.RunScheduledInstancesResponse). Specifying the name of a property of type Amazon.EC2.Model.RunScheduledInstancesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns a collection of System.String objects. The service call response (type Amazon.EC2.Model.RunScheduledInstancesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Examples

Example 1

PS C:\> New-EC2ScheduledInstance -ScheduledInstanceId sci-1234-1234-1234-1234-123456789012 -InstanceCount 1 `
-IamInstanceProfile_Name my-iam-role `
-LaunchSpecification_ImageId ami-12345678 `
-LaunchSpecification_InstanceType c4.large `
-LaunchSpecification_SubnetId subnet-12345678`
-LaunchSpecification_SecurityGroupId sg-12345678
This example launches the specified Scheduled Instance.

Supported Version

AWS Tools for PowerShell: 2.x.y.z