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) AuthorizeSecurityGroupIngress API operation.

Syntax

Grant-EC2SecurityGroupIngress
-GroupId <String>
-GroupName <String>
-IpPermission <IpPermission[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Adds the specified ingress rules to a security group. An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address ranges, or from the instances associated with the specified destination security groups. You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify the destination port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes. Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. For more information about VPC security group limits, see Amazon VPC Limits.

Parameters

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)
-GroupId <String>
The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-GroupName <String>
[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IpPermission <IpPermission[]>
The sets of IP permissions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesIpPermissions
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the GroupId parameter. The -PassThru parameter is deprecated, use -Select '^GroupId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.AuthorizeSecurityGroupIngressResponse). 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)
Aliases AK
-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 (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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

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)
Aliases AWSProfilesLocation, 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)
Aliases AWSProfileName, StoredCredentials
-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 (ByPropertyName)
-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)
Aliases SecretAccessKey, SK
-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)
Aliases ST
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
Aliases RegionToCall
-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)

Inputs

You can pipe a String object to this cmdlet for the GroupId parameter.

Outputs

This cmdlet does not generate any output.The service response (type Amazon.EC2.Model.AuthorizeSecurityGroupIngressResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Examples

Example 1

PS C:\> $ip1 = @{ IpProtocol="tcp"; FromPort="22"; ToPort="22"; IpRanges="203.0.113.25/32" }
PS C:\> $ip2 = @{ IpProtocol="tcp"; FromPort="3389"; ToPort="3389"; IpRanges="203.0.113.25/32" }

PS C:\> Grant-EC2SecurityGroupIngress -GroupId sg-12345678 -IpPermission @( $ip1, $ip2 )
This example defines ingress rules for a security group for EC2-VPC. These rules grant access to a specific IP address for SSH (port 22) and RDC (port 3389). Note that you must identify security groups for EC2-VPC using the security group ID not the security group name. The syntax used by this example requires PowerShell version 3 or higher.

Example 2

PS C:\> $ip1 = New-Object Amazon.EC2.Model.IpPermission
PS C:\> $ip1.IpProtocol = "tcp"
PS C:\> $ip1.FromPort = 22
PS C:\> $ip1.ToPort = 22
PS C:\> $ip1.IpRanges.Add("203.0.113.25/32")

PS C:\> $ip2 = new-object Amazon.EC2.Model.IpPermission
PS C:\> $ip2.IpProtocol = "tcp"
PS C:\> $ip2.FromPort = 3389
PS C:\> $ip2.ToPort = 3389
PS C:\> $ip2.IpRanges.Add("203.0.113.25/32")

PS C:\> Grant-EC2SecurityGroupIngress -GroupId sg-12345678 -IpPermission @( $ip1, $ip2 )
With PowerShell version 2, you must use New-Object to create the IpPermission objects.

Example 3

PS C:\> $ip1 = @{ IpProtocol="tcp"; FromPort="22"; ToPort="22"; IpRanges="203.0.113.25/32" }
PS C:\> $ip2 = @{ IpProtocol="tcp"; FromPort="3389"; ToPort="3389"; IpRanges="203.0.113.25/32" }

PS C:\> Grant-EC2SecurityGroupIngress -GroupName "my-security-group" -IpPermission @( $ip1, $ip2 )
This example defines ingress rules for a security group for EC2-Classic. These rules grant access to a specific IP address for SSH (port 22) and RDC (port 3389). The syntax used by this example requires PowerShell version 3 or higher.

Example 4

PS C:\> $ip1 = New-Object Amazon.EC2.Model.IpPermission
PS C:\> $ip1.IpProtocol = "tcp"
PS C:\> $ip1.FromPort = 22
PS C:\> $ip1.ToPort = 22
PS C:\> $ip1.IpRanges.Add("203.0.113.25/32")

PS C:\> $ip2 = new-object Amazon.EC2.Model.IpPermission
PS C:\> $ip2.IpProtocol = "tcp"
PS C:\> $ip2.FromPort = 3389
PS C:\> $ip2.ToPort = 3389
PS C:\> $ip2.IpRanges.Add("203.0.113.25/32")

PS C:\> Grant-EC2SecurityGroupIngress -GroupName "my-security-group" -IpPermission @( $ip1, $ip2 )
With PowerShell version 2, you must use New-Object to create the IpPermission objects.

Example 5

PS C:\> $ug = New-Object Amazon.EC2.Model.UserIdGroupPair
PS C:\> $ug.GroupId = "sg-1a2b3c4d"
PS C:\> $ug.UserId = "123456789012"

PS C:\> Grant-EC2SecurityGroupIngress -GroupId sg-12345678 -IpPermission @( @{ IpProtocol="tcp"; FromPort="8081"; ToPort="8081"; UserIdGroupPairs=$ug } )
This example grants TCP port 8081 access from the specified source security group (sg-1a2b3c4d) to the specified security group (sg-12345678).

Example 6

PS C:\> $IpRange = New-Object -TypeName Amazon.EC2.Model.IpRange
PS C:\> $IpRange.CidrIp = "5.5.5.5/32"
PS C:\> $IpRange.Description = "SSH from Office"
PS C:\> $IpPermission = New-Object Amazon.EC2.Model.IpPermission
PS C:\> $IpPermission.IpProtocol = "tcp"
PS C:\> $IpPermission.ToPort = 22
PS C:\> $IpPermission.FromPort = 22
PS C:\> $IpPermission.Ipv4Ranges = $IpRange
PS C:\> Grant-EC2SecurityGroupIngress -GroupId sg-1234abcd -IpPermission $IpPermission
This example adds the CIDR 5.5.5.5/32 to the Ingress rules of security Group sg-1234abcd for TCP port 22 traffic with a description.

Supported Version

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