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

Invokes the ReplaceNetworkAclEntry operation against Amazon Elastic Compute Cloud.

Syntax

Set-EC2NetworkAclEntry
-NetworkAclId <String>
-CidrBlock <String>
-IcmpTypeCode_Code <Int32>
-Egress <Boolean>
-PortRange_From <Int32>
-Ipv6CidrBlock <String>
-Protocol <String>
-RuleAction <RuleAction>
-RuleNumber <Int32>
-PortRange_To <Int32>
-IcmpTypeCode_Type <Int32>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Replaces an entry (rule) in a network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

Parameters

-CidrBlock <String>
The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).
Required?False
Position?Named
Accept pipeline input?False
-Egress <Boolean>
Indicates whether to replace the egress rule.Default: If no value is specified, we replace the ingress rule.
Required?False
Position?Named
Accept pipeline input?False
-Force <SwitchParameter>
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?False
-IcmpTypeCode_Code <Int32>
The ICMP code. A value of -1 means all codes for the specified ICMP type.
Required?False
Position?Named
Accept pipeline input?False
-IcmpTypeCode_Type <Int32>
The ICMP type. A value of -1 means all types.
Required?False
Position?Named
Accept pipeline input?False
-Ipv6CidrBlock <String>
The IPv6 network range to allow or deny, in CIDR notation (for example 2001:bd8:1234:1a00::/64).
Required?False
Position?Named
Accept pipeline input?False
-NetworkAclId <String>
The ID of the ACL.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PassThru <SwitchParameter>
Returns the value passed to the NetworkAclId parameter. By default, this cmdlet does not generate any output.
Required?False
Position?Named
Accept pipeline input?False
-PortRange_From <Int32>
The first port in the range.
Required?False
Position?Named
Accept pipeline input?False
-PortRange_To <Int32>
The last port in the range.
Required?False
Position?Named
Accept pipeline input?False
-Protocol <String>
The IP protocol. You can specify all or -1 to mean all protocols. If you specify all, -1, or a protocol number other than tcp, udp, or icmp, traffic on all ports is allowed, regardless of any ports or ICMP types or codes you specify. If you specify protocol 58 (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol 58 (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.
Required?False
Position?Named
Accept pipeline input?False
-RuleAction <RuleAction>
Indicates whether to allow or deny the traffic that matches the rule.
Required?False
Position?Named
Accept pipeline input?False
-RuleNumber <Int32>
The rule number of the entry to replace.
Required?False
Position?Named
Accept pipeline input?False

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? False
-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? False
-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? False
-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? False
-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? False
-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? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-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? False
-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? False

Inputs

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

Outputs

None or System.String
When you use the PassThru parameter, this cmdlet outputs the value supplied to the NetworkAclId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.EC2.Model.ReplaceNetworkAclEntryResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Examples

Example 1

PS C:\> Set-EC2NetworkAclEntry -NetworkAclId acl-12345678 -Egress $false -RuleNumber 100 -Protocol 17 -PortRange_From 53 -PortRange_To 53 -CidrBlock 203.0.113.12/24 -RuleAction allow
This example replaces the specified entry for the specified network ACL. The new rule allows inbound traffic from the specified address to any associated subnet.

Supported Version

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