amazonka-network-firewall-2.0: Amazon Network Firewall SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.NetworkFirewall.DescribeFirewall

Description

Returns the data objects for the specified firewall.

Synopsis

Creating a Request

data DescribeFirewall Source #

See: newDescribeFirewall smart constructor.

Constructors

DescribeFirewall' 

Fields

  • firewallArn :: Maybe Text

    The Amazon Resource Name (ARN) of the firewall.

    You must specify the ARN or the name, and you can specify both.

  • firewallName :: Maybe Text

    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.

Instances

Instances details
ToJSON DescribeFirewall Source # 
Instance details

Defined in Amazonka.NetworkFirewall.DescribeFirewall

ToHeaders DescribeFirewall Source # 
Instance details

Defined in Amazonka.NetworkFirewall.DescribeFirewall

ToPath DescribeFirewall Source # 
Instance details

Defined in Amazonka.NetworkFirewall.DescribeFirewall

ToQuery DescribeFirewall Source # 
Instance details

Defined in Amazonka.NetworkFirewall.DescribeFirewall

AWSRequest DescribeFirewall Source # 
Instance details

Defined in Amazonka.NetworkFirewall.DescribeFirewall

Associated Types

type AWSResponse DescribeFirewall #

Generic DescribeFirewall Source # 
Instance details

Defined in Amazonka.NetworkFirewall.DescribeFirewall

Associated Types

type Rep DescribeFirewall :: Type -> Type #

Read DescribeFirewall Source # 
Instance details

Defined in Amazonka.NetworkFirewall.DescribeFirewall

Show DescribeFirewall Source # 
Instance details

Defined in Amazonka.NetworkFirewall.DescribeFirewall

NFData DescribeFirewall Source # 
Instance details

Defined in Amazonka.NetworkFirewall.DescribeFirewall

Methods

rnf :: DescribeFirewall -> () #

Eq DescribeFirewall Source # 
Instance details

Defined in Amazonka.NetworkFirewall.DescribeFirewall

Hashable DescribeFirewall Source # 
Instance details

Defined in Amazonka.NetworkFirewall.DescribeFirewall

type AWSResponse DescribeFirewall Source # 
Instance details

Defined in Amazonka.NetworkFirewall.DescribeFirewall

type Rep DescribeFirewall Source # 
Instance details

Defined in Amazonka.NetworkFirewall.DescribeFirewall

type Rep DescribeFirewall = D1 ('MetaData "DescribeFirewall" "Amazonka.NetworkFirewall.DescribeFirewall" "amazonka-network-firewall-2.0-4y6HybZBSNcEwGPO5AYVfm" 'False) (C1 ('MetaCons "DescribeFirewall'" 'PrefixI 'True) (S1 ('MetaSel ('Just "firewallArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "firewallName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

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:

DescribeFirewall, describeFirewall_firewallArn - The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

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

  • firewall :: Maybe 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.

  • firewallStatus :: Maybe 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.

  • updateToken :: Maybe Text

    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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic DescribeFirewallResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.DescribeFirewall

Associated Types

type Rep DescribeFirewallResponse :: Type -> Type #

Read DescribeFirewallResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.DescribeFirewall

Show DescribeFirewallResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.DescribeFirewall

NFData DescribeFirewallResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.DescribeFirewall

Eq DescribeFirewallResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.DescribeFirewall

type Rep DescribeFirewallResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.DescribeFirewall

type Rep DescribeFirewallResponse = D1 ('MetaData "DescribeFirewallResponse" "Amazonka.NetworkFirewall.DescribeFirewall" "amazonka-network-firewall-2.0-4y6HybZBSNcEwGPO5AYVfm" 'False) (C1 ('MetaCons "DescribeFirewallResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "firewall") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Firewall)) :*: S1 ('MetaSel ('Just "firewallStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FirewallStatus))) :*: (S1 ('MetaSel ('Just "updateToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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: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: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.

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:httpStatus:DescribeFirewallResponse', describeFirewallResponse_httpStatus - The response's http status code.

Response Lenses

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_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.