Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.NetworkFirewall.AssociateFirewallPolicy

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Associates a FirewallPolicy to a Firewall.

A firewall policy defines how to monitor and manage your VPC network traffic, using a collection of inspection rule groups and other settings. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.

Synopsis

Creating a Request

data AssociateFirewallPolicy Source #

See: newAssociateFirewallPolicy smart constructor.

Constructors

AssociateFirewallPolicy'

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.
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.
firewallPolicyArn :: Text
The Amazon Resource Name (ARN) of the firewall policy.

Instances

Instances details

ToJSON AssociateFirewallPolicy Source #
Instance details Defined in Amazonka.NetworkFirewall.AssociateFirewallPolicy Methods toJSON :: AssociateFirewallPolicy -> Value # toEncoding :: AssociateFirewallPolicy -> Encoding # toJSONList :: [AssociateFirewallPolicy] -> Value # toEncodingList :: [AssociateFirewallPolicy] -> Encoding #
ToHeaders AssociateFirewallPolicy Source #
Instance details Defined in Amazonka.NetworkFirewall.AssociateFirewallPolicy Methods toHeaders :: AssociateFirewallPolicy -> [Header] #
ToPath AssociateFirewallPolicy Source #
Instance details Defined in Amazonka.NetworkFirewall.AssociateFirewallPolicy Methods toPath :: AssociateFirewallPolicy -> ByteString #
ToQuery AssociateFirewallPolicy Source #
Instance details Defined in Amazonka.NetworkFirewall.AssociateFirewallPolicy Methods toQuery :: AssociateFirewallPolicy -> QueryString #
AWSRequest AssociateFirewallPolicy Source #
Instance details Defined in Amazonka.NetworkFirewall.AssociateFirewallPolicy Associated Types type AWSResponse AssociateFirewallPolicy # Methods request :: (Service -> Service) -> AssociateFirewallPolicy -> Request AssociateFirewallPolicy # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AssociateFirewallPolicy -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AssociateFirewallPolicy))) #
Generic AssociateFirewallPolicy Source #
Instance details Defined in Amazonka.NetworkFirewall.AssociateFirewallPolicy Associated Types type Rep AssociateFirewallPolicy :: Type -> Type # Methods from :: AssociateFirewallPolicy -> Rep AssociateFirewallPolicy x # to :: Rep AssociateFirewallPolicy x -> AssociateFirewallPolicy #
Read AssociateFirewallPolicy Source #
Instance details Defined in Amazonka.NetworkFirewall.AssociateFirewallPolicy Methods readsPrec :: Int -> ReadS AssociateFirewallPolicy # readList :: ReadS [AssociateFirewallPolicy] # readPrec :: ReadPrec AssociateFirewallPolicy # readListPrec :: ReadPrec [AssociateFirewallPolicy] #
Show AssociateFirewallPolicy Source #
Instance details Defined in Amazonka.NetworkFirewall.AssociateFirewallPolicy Methods showsPrec :: Int -> AssociateFirewallPolicy -> ShowS # show :: AssociateFirewallPolicy -> String # showList :: [AssociateFirewallPolicy] -> ShowS #
NFData AssociateFirewallPolicy Source #
Instance details Defined in Amazonka.NetworkFirewall.AssociateFirewallPolicy Methods rnf :: AssociateFirewallPolicy -> () #
Eq AssociateFirewallPolicy Source #
Instance details Defined in Amazonka.NetworkFirewall.AssociateFirewallPolicy Methods (==) :: AssociateFirewallPolicy -> AssociateFirewallPolicy -> Bool # (/=) :: AssociateFirewallPolicy -> AssociateFirewallPolicy -> Bool #
Hashable AssociateFirewallPolicy Source #
Instance details Defined in Amazonka.NetworkFirewall.AssociateFirewallPolicy Methods hashWithSalt :: Int -> AssociateFirewallPolicy -> Int # hash :: AssociateFirewallPolicy -> Int #
type AWSResponse AssociateFirewallPolicy Source #
Instance details Defined in Amazonka.NetworkFirewall.AssociateFirewallPolicy type AWSResponse AssociateFirewallPolicy = AssociateFirewallPolicyResponse
type Rep AssociateFirewallPolicy Source #
Instance details Defined in Amazonka.NetworkFirewall.AssociateFirewallPolicy type Rep AssociateFirewallPolicy = D1 ('MetaData "AssociateFirewallPolicy" "Amazonka.NetworkFirewall.AssociateFirewallPolicy" "amazonka-network-firewall-2.0-4y6HybZBSNcEwGPO5AYVfm" 'False) (C1 ('MetaCons "AssociateFirewallPolicy'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "firewallArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "firewallName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "updateToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "firewallPolicyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newAssociateFirewallPolicy Source #

Arguments

:: Text	`AssociateFirewallPolicy`
-> AssociateFirewallPolicy

Create a value of AssociateFirewallPolicy 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:

AssociateFirewallPolicy, associateFirewallPolicy_firewallArn - The Amazon Resource Name (ARN) of the firewall.

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

AssociateFirewallPolicy, associateFirewallPolicy_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.

AssociateFirewallPolicy, associateFirewallPolicy_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.

AssociateFirewallPolicy, associateFirewallPolicy_firewallPolicyArn - The Amazon Resource Name (ARN) of the firewall policy.

Request Lenses

associateFirewallPolicy_firewallArn :: Lens' AssociateFirewallPolicy (Maybe Text) Source #

The Amazon Resource Name (ARN) of the firewall.

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

associateFirewallPolicy_firewallName :: Lens' AssociateFirewallPolicy (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.

associateFirewallPolicy_updateToken :: Lens' AssociateFirewallPolicy (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.

associateFirewallPolicy_firewallPolicyArn :: Lens' AssociateFirewallPolicy Text Source #

The Amazon Resource Name (ARN) of the firewall policy.

Destructuring the Response

data AssociateFirewallPolicyResponse Source #

See: newAssociateFirewallPolicyResponse smart constructor.

Constructors

AssociateFirewallPolicyResponse'

Fields

firewallArn :: Maybe Text
The Amazon Resource Name (ARN) of the firewall.
firewallName :: Maybe Text
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
firewallPolicyArn :: Maybe Text
The Amazon Resource Name (ARN) of the firewall policy.
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 AssociateFirewallPolicyResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.AssociateFirewallPolicy Associated Types type Rep AssociateFirewallPolicyResponse :: Type -> Type # Methods from :: AssociateFirewallPolicyResponse -> Rep AssociateFirewallPolicyResponse x # to :: Rep AssociateFirewallPolicyResponse x -> AssociateFirewallPolicyResponse #
Read AssociateFirewallPolicyResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.AssociateFirewallPolicy Methods readsPrec :: Int -> ReadS AssociateFirewallPolicyResponse # readList :: ReadS [AssociateFirewallPolicyResponse] # readPrec :: ReadPrec AssociateFirewallPolicyResponse # readListPrec :: ReadPrec [AssociateFirewallPolicyResponse] #
Show AssociateFirewallPolicyResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.AssociateFirewallPolicy Methods showsPrec :: Int -> AssociateFirewallPolicyResponse -> ShowS # show :: AssociateFirewallPolicyResponse -> String # showList :: [AssociateFirewallPolicyResponse] -> ShowS #
NFData AssociateFirewallPolicyResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.AssociateFirewallPolicy Methods rnf :: AssociateFirewallPolicyResponse -> () #
Eq AssociateFirewallPolicyResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.AssociateFirewallPolicy Methods (==) :: AssociateFirewallPolicyResponse -> AssociateFirewallPolicyResponse -> Bool # (/=) :: AssociateFirewallPolicyResponse -> AssociateFirewallPolicyResponse -> Bool #
type Rep AssociateFirewallPolicyResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.AssociateFirewallPolicy type Rep AssociateFirewallPolicyResponse = D1 ('MetaData "AssociateFirewallPolicyResponse" "Amazonka.NetworkFirewall.AssociateFirewallPolicy" "amazonka-network-firewall-2.0-4y6HybZBSNcEwGPO5AYVfm" 'False) (C1 ('MetaCons "AssociateFirewallPolicyResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "firewallArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "firewallName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "firewallPolicyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "updateToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newAssociateFirewallPolicyResponse Source #

Arguments

:: Int	`$sel:httpStatus:AssociateFirewallPolicyResponse'`
-> AssociateFirewallPolicyResponse

Create a value of AssociateFirewallPolicyResponse 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:

AssociateFirewallPolicy, associateFirewallPolicyResponse_firewallArn - The Amazon Resource Name (ARN) of the firewall.

AssociateFirewallPolicy, associateFirewallPolicyResponse_firewallName - The descriptive name of the firewall. You can't change the name of a firewall after you create it.

AssociateFirewallPolicy, associateFirewallPolicyResponse_firewallPolicyArn - The Amazon Resource Name (ARN) of the firewall policy.

AssociateFirewallPolicy, associateFirewallPolicyResponse_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:AssociateFirewallPolicyResponse', associateFirewallPolicyResponse_httpStatus - The response's http status code.

Response Lenses

associateFirewallPolicyResponse_firewallArn :: Lens' AssociateFirewallPolicyResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the firewall.

associateFirewallPolicyResponse_firewallName :: Lens' AssociateFirewallPolicyResponse (Maybe Text) Source #

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

associateFirewallPolicyResponse_firewallPolicyArn :: Lens' AssociateFirewallPolicyResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the firewall policy.

associateFirewallPolicyResponse_updateToken :: Lens' AssociateFirewallPolicyResponse (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.

associateFirewallPolicyResponse_httpStatus :: Lens' AssociateFirewallPolicyResponse Int Source #

The response's http status code.