Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Updates the properties of the specified firewall policy.
Synopsis
- data UpdateFirewallPolicy = UpdateFirewallPolicy' {}
- newUpdateFirewallPolicy :: Text -> FirewallPolicy -> UpdateFirewallPolicy
- updateFirewallPolicy_firewallPolicyName :: Lens' UpdateFirewallPolicy (Maybe Text)
- updateFirewallPolicy_firewallPolicyArn :: Lens' UpdateFirewallPolicy (Maybe Text)
- updateFirewallPolicy_description :: Lens' UpdateFirewallPolicy (Maybe Text)
- updateFirewallPolicy_dryRun :: Lens' UpdateFirewallPolicy (Maybe Bool)
- updateFirewallPolicy_updateToken :: Lens' UpdateFirewallPolicy Text
- updateFirewallPolicy_firewallPolicy :: Lens' UpdateFirewallPolicy FirewallPolicy
- data UpdateFirewallPolicyResponse = UpdateFirewallPolicyResponse' {}
- newUpdateFirewallPolicyResponse :: Int -> Text -> FirewallPolicyResponse -> UpdateFirewallPolicyResponse
- updateFirewallPolicyResponse_httpStatus :: Lens' UpdateFirewallPolicyResponse Int
- updateFirewallPolicyResponse_updateToken :: Lens' UpdateFirewallPolicyResponse Text
- updateFirewallPolicyResponse_firewallPolicyResponse :: Lens' UpdateFirewallPolicyResponse FirewallPolicyResponse
Creating a Request
data UpdateFirewallPolicy Source #
See: newUpdateFirewallPolicy
smart constructor.
UpdateFirewallPolicy' | |
|
Instances
newUpdateFirewallPolicy Source #
Create a value of UpdateFirewallPolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:firewallPolicyName:UpdateFirewallPolicy'
, updateFirewallPolicy_firewallPolicyName
- 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.
$sel:firewallPolicyArn:UpdateFirewallPolicy'
, updateFirewallPolicy_firewallPolicyArn
- The Amazon Resource Name (ARN) of the firewall policy.
You must specify the ARN or the name, and you can specify both.
$sel:description:UpdateFirewallPolicy'
, updateFirewallPolicy_description
- A description of the firewall policy.
$sel:dryRun:UpdateFirewallPolicy'
, updateFirewallPolicy_dryRun
- 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.
$sel:updateToken:UpdateFirewallPolicy'
, updateFirewallPolicy_updateToken
- 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.
$sel:firewallPolicy:UpdateFirewallPolicy'
, updateFirewallPolicy_firewallPolicy
- The updated firewall policy to use for the firewall.
Request Lenses
updateFirewallPolicy_firewallPolicyName :: Lens' UpdateFirewallPolicy (Maybe Text) Source #
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.
updateFirewallPolicy_firewallPolicyArn :: Lens' UpdateFirewallPolicy (Maybe Text) Source #
The Amazon Resource Name (ARN) of the firewall policy.
You must specify the ARN or the name, and you can specify both.
updateFirewallPolicy_description :: Lens' UpdateFirewallPolicy (Maybe Text) Source #
A description of the firewall policy.
updateFirewallPolicy_dryRun :: Lens' UpdateFirewallPolicy (Maybe Bool) Source #
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.
updateFirewallPolicy_updateToken :: Lens' UpdateFirewallPolicy Text Source #
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.
updateFirewallPolicy_firewallPolicy :: Lens' UpdateFirewallPolicy FirewallPolicy Source #
The updated firewall policy to use for the firewall.
Destructuring the Response
data UpdateFirewallPolicyResponse Source #
See: newUpdateFirewallPolicyResponse
smart constructor.
UpdateFirewallPolicyResponse' | |
|
Instances
newUpdateFirewallPolicyResponse Source #
Create a value of UpdateFirewallPolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateFirewallPolicyResponse'
, updateFirewallPolicyResponse_httpStatus
- The response's http status code.
$sel:updateToken:UpdateFirewallPolicy'
, updateFirewallPolicyResponse_updateToken
- 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.
$sel:firewallPolicyResponse:UpdateFirewallPolicyResponse'
, updateFirewallPolicyResponse_firewallPolicyResponse
- The high-level properties of a firewall policy. This, along with the
FirewallPolicy, define the policy. You can retrieve all objects for a
firewall policy by calling DescribeFirewallPolicy.
Response Lenses
updateFirewallPolicyResponse_httpStatus :: Lens' UpdateFirewallPolicyResponse Int Source #
The response's http status code.
updateFirewallPolicyResponse_updateToken :: Lens' UpdateFirewallPolicyResponse Text Source #
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.
updateFirewallPolicyResponse_firewallPolicyResponse :: Lens' UpdateFirewallPolicyResponse FirewallPolicyResponse Source #
The high-level properties of a firewall policy. This, along with the FirewallPolicy, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.