Logo

Documentation home for Transend tools

  • Get-AWSInstanceStatus
  • Start-AWSInstances
  • Stop-AWSInstances

    • Home

    Start-AWSInstances

    SYNOPSIS

    Starts one or more AWS EC2 instances.

    SYNTAX

    Name

    Start-AWSInstances
  -Name <String>
  [-ProfileName <String>]
  [-Region <String>]
  [<CommonParameters>]

    Id

    Start-AWSInstances
  -Id <String>
  [-ProfileName <String>]
  [-Region <String>]
  [<CommonParameters>]

    Project

    Start-AWSInstances
  -Project <String>
  [-ProfileName <String>]
  [-Region <String>]
  [<CommonParameters>]

    DESCRIPTION

    Use the Start-AWSInstances cmdlet to start one or more instances in an AWS EC2 region.

    EXAMPLES

    Example 1

    Start-AWSInstances -Region 'us-west-2' -Name 'Test'

    Starts instance Test in the Oregon region.

    Example 2

    Start-AWSInstances -Region 'us-west-2' -Project 'Initech'

    Starts all instances in the Oregon region that have a Project tag set to Initech.

    PARAMETERS

    -Id

    Type: String
Parameter Sets: Id
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    -Name

    Type: String
Parameter Sets: Name
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    -ProfileName

    Specifies the AWS configuration profile. Configuration profiles are stored in C:\Users\$User\.aws\config. If -ProfileName is not specified, the AWS.Profile configuration variable will be used. If neither is specified, an error will be thrown.

    Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    -Project

    A Project tag identifying all instances to start.

    Type: String
Parameter Sets: Project
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    -Region

    Specifies the AWS EC2 region identifier. For example, us-west-2 for the Oregon region. If -Region is not specified, the AWS.Region configuration variable will be used. If neither is specified, an error will be thrown.

    Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    CommonParameters

    This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

    INPUTS

    None

    OUTPUTS

    System.Void

    NOTES

    Optional config.psd1 configurations

    These configuration keys are scoped to the AWS node in config.psd1.

    • Profile: The profile to use in the AWS config file. This has the same effect as using -ProfileName.

    • Region: The AWS region to connect to. This has the same effect as using -Region.

    General configuration options