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 |
Amazonka.NetworkFirewall.DescribeFirewall
Description
Returns the data objects for the specified firewall.
Synopsis
- data DescribeFirewall = DescribeFirewall' {}
- newDescribeFirewall :: DescribeFirewall
- describeFirewall_firewallArn :: Lens' DescribeFirewall (Maybe Text)
- describeFirewall_firewallName :: Lens' DescribeFirewall (Maybe Text)
- data DescribeFirewallResponse = DescribeFirewallResponse' {}
- newDescribeFirewallResponse :: Int -> DescribeFirewallResponse
- describeFirewallResponse_firewallStatus :: Lens' DescribeFirewallResponse (Maybe FirewallStatus)
- describeFirewallResponse_updateToken :: Lens' DescribeFirewallResponse (Maybe Text)
- describeFirewallResponse_firewall :: Lens' DescribeFirewallResponse (Maybe Firewall)
- describeFirewallResponse_httpStatus :: Lens' DescribeFirewallResponse Int
Creating a Request
data DescribeFirewall Source #
See: newDescribeFirewall
smart constructor.
Constructors
DescribeFirewall' | |
Fields
|
Instances
newDescribeFirewall :: DescribeFirewall Source #
Create a value of DescribeFirewall
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:firewallArn:DescribeFirewall'
, describeFirewall_firewallArn
- The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
$sel:firewallName:DescribeFirewall'
, describeFirewall_firewallName
- The descriptive name of the firewall. You can't change the name of a
firewall after you create it.
You must specify the ARN or the name, and you can specify both.
Request Lenses
describeFirewall_firewallArn :: Lens' DescribeFirewall (Maybe Text) Source #
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
describeFirewall_firewallName :: Lens' DescribeFirewall (Maybe Text) Source #
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
Destructuring the Response
data DescribeFirewallResponse Source #
See: newDescribeFirewallResponse
smart constructor.
Constructors
DescribeFirewallResponse' | |
Fields
|
Instances
newDescribeFirewallResponse Source #
Create a value of DescribeFirewallResponse
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:firewallStatus:DescribeFirewallResponse'
, describeFirewallResponse_firewallStatus
- Detailed information about the current status of a Firewall. You can
retrieve this for a firewall by calling DescribeFirewall and providing
the firewall name and ARN.
$sel:updateToken:DescribeFirewallResponse'
, describeFirewallResponse_updateToken
- An optional token that you can use for optimistic locking. Network
Firewall returns a token to your requests that access the firewall. The
token marks the state of the firewall resource at the time of the
request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your
update request. Network Firewall uses the token to ensure that the
firewall hasn't changed since you last retrieved it. If it has changed,
the operation fails with an InvalidTokenException
. If this happens,
retrieve the firewall again to get a current copy of it with a new
token. Reapply your changes as needed, then try the operation again
using the new token.
$sel:firewall:DescribeFirewallResponse'
, describeFirewallResponse_firewall
- The configuration settings for the firewall. These settings include the
firewall policy and the subnets in your VPC to use for the firewall
endpoints.
$sel:httpStatus:DescribeFirewallResponse'
, describeFirewallResponse_httpStatus
- The response's http status code.
Response Lenses
describeFirewallResponse_firewallStatus :: Lens' DescribeFirewallResponse (Maybe FirewallStatus) Source #
Detailed information about the current status of a Firewall. You can retrieve this for a firewall by calling DescribeFirewall and providing the firewall name and ARN.
describeFirewallResponse_updateToken :: Lens' DescribeFirewallResponse (Maybe Text) Source #
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your
update request. Network Firewall uses the token to ensure that the
firewall hasn't changed since you last retrieved it. If it has changed,
the operation fails with an InvalidTokenException
. If this happens,
retrieve the firewall again to get a current copy of it with a new
token. Reapply your changes as needed, then try the operation again
using the new token.
describeFirewallResponse_firewall :: Lens' DescribeFirewallResponse (Maybe Firewall) Source #
The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints.
describeFirewallResponse_httpStatus :: Lens' DescribeFirewallResponse Int Source #
The response's http status code.