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 AWS Network Firewall UpdateFirewallPolicy API operation.

Syntax

Update-NWFWFirewallPolicy
-UpdateToken <String>
-Description <String>
-DryRun <Boolean>
-FirewallPolicyArn <String>
-FirewallPolicyName <String>
-EncryptionConfiguration_KeyId <String>
-StatefulEngineOptions_RuleOrder <RuleOrder>
-PolicyVariables_RuleVariable <Hashtable>
-FirewallPolicy_StatefulDefaultAction <String[]>
-FirewallPolicy_StatefulRuleGroupReference <StatefulRuleGroupReference[]>
-FirewallPolicy_StatelessCustomAction <CustomAction[]>
-FirewallPolicy_StatelessDefaultAction <String[]>
-FirewallPolicy_StatelessFragmentDefaultAction <String[]>
-FirewallPolicy_StatelessRuleGroupReference <StatelessRuleGroupReference[]>
-StatefulEngineOptions_StreamExceptionPolicy <StreamExceptionPolicy>
-FirewallPolicy_TLSInspectionConfigurationArn <String>
-EncryptionConfiguration_Type <EncryptionType>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonNetworkFirewallConfig>

Description

Updates the properties of the specified firewall policy.

Parameters

-ClientConfig <AmazonNetworkFirewallConfig>
Amazon.PowerShell.Cmdlets.NWFW.AmazonNetworkFirewallClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
A description of the firewall policy.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DryRun <Boolean>
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request. If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid. If set to FALSE, Network Firewall makes the requested changes to your resources.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EncryptionConfiguration_KeyId <String>
The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EncryptionConfiguration_Type <EncryptionType>
The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FirewallPolicy_StatefulDefaultAction <String[]>
The default actions to take on a packet that doesn't match any stateful rules. The stateful default action is optional, and is only valid when using the strict rule order.Valid values of the stateful default action:
  • aws:drop_strict
  • aws:drop_established
  • aws:alert_strict
  • aws:alert_established
For more information, see Strict evaluation order in the Network Firewall Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFirewallPolicy_StatefulDefaultActions
-FirewallPolicy_StatefulRuleGroupReference <StatefulRuleGroupReference[]>
References to the stateful rule groups that are used in the policy. These define the inspection criteria in stateful rules.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFirewallPolicy_StatefulRuleGroupReferences
-FirewallPolicy_StatelessCustomAction <CustomAction[]>
The custom action definitions that are available for use in the firewall policy's StatelessDefaultActions setting. You name each custom action that you define, and then you can use it by name in your default actions specifications.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFirewallPolicy_StatelessCustomActions
-FirewallPolicy_StatelessDefaultAction <String[]>
The actions to take on a packet if it doesn't match any of the stateless rules in the policy. If you want non-matching packets to be forwarded for stateful inspection, specify aws:forward_to_sfe. You must specify one of the standard actions: aws:pass, aws:drop, or aws:forward_to_sfe. In addition, you can specify custom actions that are compatible with your standard section choice.For example, you could specify ["aws:pass"] or you could specify ["aws:pass", “customActionName”]. For information about compatibility, see the custom action descriptions under CustomAction.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFirewallPolicy_StatelessDefaultActions
-FirewallPolicy_StatelessFragmentDefaultAction <String[]>
The actions to take on a fragmented UDP packet if it doesn't match any of the stateless rules in the policy. Network Firewall only manages UDP packet fragments and silently drops packet fragments for other protocols. If you want non-matching fragmented UDP packets to be forwarded for stateful inspection, specify aws:forward_to_sfe.You must specify one of the standard actions: aws:pass, aws:drop, or aws:forward_to_sfe. In addition, you can specify custom actions that are compatible with your standard section choice.For example, you could specify ["aws:pass"] or you could specify ["aws:pass", “customActionName”]. For information about compatibility, see the custom action descriptions under CustomAction.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFirewallPolicy_StatelessFragmentDefaultActions
-FirewallPolicy_StatelessRuleGroupReference <StatelessRuleGroupReference[]>
References to the stateless rule groups that are used in the policy. These define the matching criteria in stateless rules.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFirewallPolicy_StatelessRuleGroupReferences
-FirewallPolicy_TLSInspectionConfigurationArn <String>
The Amazon Resource Name (ARN) of the TLS inspection configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FirewallPolicyArn <String>
The Amazon Resource Name (ARN) of the firewall policy.You must specify the ARN or the name, and you can specify both.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FirewallPolicyName <String>
The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.You must specify the ARN or the name, and you can specify both.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the UpdateToken parameter. The -PassThru parameter is deprecated, use -Select '^UpdateToken' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PolicyVariables_RuleVariable <Hashtable>
The IPv4 or IPv6 addresses in CIDR notation to use for the Suricata HOME_NET variable. If your firewall uses an inspection VPC, you might want to override the HOME_NET variable with the CIDRs of your home networks. If you don't override HOME_NET with your own CIDRs, Network Firewall by default uses the CIDR of your inspection VPC.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFirewallPolicy_PolicyVariables_RuleVariables
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NetworkFirewall.Model.UpdateFirewallPolicyResponse). Specifying the name of a property of type Amazon.NetworkFirewall.Model.UpdateFirewallPolicyResponse 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)
-StatefulEngineOptions_RuleOrder <RuleOrder>
Indicates how to manage the order of stateful rule evaluation for the policy. STRICT_ORDER is the default and recommended option. With STRICT_ORDER, provide your rules in the order that you want them to be evaluated. You can then choose one or more default actions for packets that don't match any rules. Choose STRICT_ORDER to have the stateful rules engine determine the evaluation order of your rules. The default action for this rule order is PASS, followed by DROP, REJECT, and ALERT actions. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on your settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFirewallPolicy_StatefulEngineOptions_RuleOrder
-StatefulEngineOptions_StreamExceptionPolicy <StreamExceptionPolicy>
Configures how Network Firewall processes traffic when a network connection breaks midstream. Network connections can break due to disruptions in external networks or within the firewall itself.
  • DROP - Network Firewall fails closed and drops all subsequent traffic going to the firewall. This is the default behavior.
  • CONTINUE - Network Firewall continues to apply rules to the subsequent traffic without context from traffic before the break. This impacts the behavior of rules that depend on this context. For example, if you have a stateful rule to drop http traffic, Network Firewall won't match the traffic for this rule because the service won't have the context from session initialization defining the application layer protocol as HTTP. However, this behavior is rule dependent—a TCP-layer rule using a flow:stateless rule would still match, as would the aws:drop_strict default action.
  • REJECT - Network Firewall fails closed and drops all subsequent traffic going to the firewall. Network Firewall also sends a TCP reject packet back to your client so that the client can immediately establish a new session. Network Firewall will have context about the new session and will apply rules to the subsequent traffic.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFirewallPolicy_StatefulEngineOptions_StreamExceptionPolicy
-UpdateToken <String>
A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request. To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.
Required?True
Position?1
Accept pipeline input?True (ByValue, 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

Amazon.NetworkFirewall.Model.UpdateFirewallPolicyResponse
This cmdlet returns an Amazon.NetworkFirewall.Model.UpdateFirewallPolicyResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

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