Documentation home for Transend tools
Stop-AWSInstances
SYNOPSIS
Stops one or more AWS EC2 instances.
SYNTAX
Name
Stop-AWSInstances -Name <String> [-ProfileName <String>] [-Region <String>] [<CommonParameters>]
Id
Stop-AWSInstances -Id <String> [-ProfileName <String>] [-Region <String>] [<CommonParameters>]
Project
Stop-AWSInstances -Project <String> [-ProfileName <String>] [-Region <String>] [<CommonParameters>]
DESCRIPTION
Use the Stop-AWSInstances cmdlet to stop one or more instances in an AWS EC2
region.
EXAMPLES
Example 1
Stop-AWSInstances -Region 'us-west-2' -InstanceId 'i-0123456789abcdef0'
Stops instance i-0123456789abcdef0 in the Oregon region.
Example 2
Stop-AWSInstances -Region 'us-west-2' -Project 'Initech'
Stops 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 stop.
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.