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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Associates the specified subnets in the Amazon VPC to the firewall. You can specify one subnet for each of the Availability Zones that the VPC spans.

This request creates an Network Firewall firewall endpoint in each of the subnets. To enable the firewall's protections, you must also modify the VPC's route tables for each subnet's Availability Zone, to redirect the traffic that's coming into and going out of the zone through the firewall endpoint.

Synopsis

data AssociateSubnets = AssociateSubnets' {
- firewallArn :: Maybe Text
- firewallName :: Maybe Text
- updateToken :: Maybe Text
- subnetMappings :: [SubnetMapping]
}
newAssociateSubnets :: AssociateSubnets
associateSubnets_firewallArn :: Lens' AssociateSubnets (Maybe Text)
associateSubnets_firewallName :: Lens' AssociateSubnets (Maybe Text)
associateSubnets_updateToken :: Lens' AssociateSubnets (Maybe Text)
associateSubnets_subnetMappings :: Lens' AssociateSubnets [SubnetMapping]
data AssociateSubnetsResponse = AssociateSubnetsResponse' {
- firewallArn :: Maybe Text
- firewallName :: Maybe Text
- subnetMappings :: Maybe [SubnetMapping]
- updateToken :: Maybe Text
- httpStatus :: Int
}
newAssociateSubnetsResponse :: Int -> AssociateSubnetsResponse
associateSubnetsResponse_firewallArn :: Lens' AssociateSubnetsResponse (Maybe Text)
associateSubnetsResponse_firewallName :: Lens' AssociateSubnetsResponse (Maybe Text)
associateSubnetsResponse_subnetMappings :: Lens' AssociateSubnetsResponse (Maybe [SubnetMapping])
associateSubnetsResponse_updateToken :: Lens' AssociateSubnetsResponse (Maybe Text)
associateSubnetsResponse_httpStatus :: Lens' AssociateSubnetsResponse Int

Creating a Request

data AssociateSubnets Source #

See: newAssociateSubnets smart constructor.

Constructors

AssociateSubnets'

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.
subnetMappings :: [SubnetMapping]
The IDs of the subnets that you want to associate with the firewall.

Instances

Instances details

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

newAssociateSubnets :: AssociateSubnets Source #

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

AssociateSubnets, associateSubnets_firewallArn - The Amazon Resource Name (ARN) of the firewall.

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

AssociateSubnets, associateSubnets_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.

AssociateSubnets, associateSubnets_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.

AssociateSubnets, associateSubnets_subnetMappings - The IDs of the subnets that you want to associate with the firewall.

Request Lenses

associateSubnets_firewallArn :: Lens' AssociateSubnets (Maybe Text) Source #

The Amazon Resource Name (ARN) of the firewall.

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

associateSubnets_firewallName :: Lens' AssociateSubnets (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.

associateSubnets_updateToken :: Lens' AssociateSubnets (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.

associateSubnets_subnetMappings :: Lens' AssociateSubnets [SubnetMapping] Source #

The IDs of the subnets that you want to associate with the firewall.

Destructuring the Response

data AssociateSubnetsResponse Source #

See: newAssociateSubnetsResponse smart constructor.

Constructors

AssociateSubnetsResponse'

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.
subnetMappings :: Maybe [SubnetMapping]
The IDs of the subnets that are associated with the firewall.
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 AssociateSubnetsResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.AssociateSubnets Associated Types type Rep AssociateSubnetsResponse :: Type -> Type # Methods from :: AssociateSubnetsResponse -> Rep AssociateSubnetsResponse x # to :: Rep AssociateSubnetsResponse x -> AssociateSubnetsResponse #
Read AssociateSubnetsResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.AssociateSubnets Methods readsPrec :: Int -> ReadS AssociateSubnetsResponse # readList :: ReadS [AssociateSubnetsResponse] # readPrec :: ReadPrec AssociateSubnetsResponse # readListPrec :: ReadPrec [AssociateSubnetsResponse] #
Show AssociateSubnetsResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.AssociateSubnets Methods showsPrec :: Int -> AssociateSubnetsResponse -> ShowS # show :: AssociateSubnetsResponse -> String # showList :: [AssociateSubnetsResponse] -> ShowS #
NFData AssociateSubnetsResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.AssociateSubnets Methods rnf :: AssociateSubnetsResponse -> () #
Eq AssociateSubnetsResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.AssociateSubnets Methods (==) :: AssociateSubnetsResponse -> AssociateSubnetsResponse -> Bool # (/=) :: AssociateSubnetsResponse -> AssociateSubnetsResponse -> Bool #
type Rep AssociateSubnetsResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.AssociateSubnets type Rep AssociateSubnetsResponse = D1 ('MetaData "AssociateSubnetsResponse" "Amazonka.NetworkFirewall.AssociateSubnets" "amazonka-network-firewall-2.0-4y6HybZBSNcEwGPO5AYVfm" 'False) (C1 ('MetaCons "AssociateSubnetsResponse'" '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 "subnetMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SubnetMapping])) :: (S1 ('MetaSel ('Just "updateToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newAssociateSubnetsResponse Source #

Arguments

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

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

AssociateSubnets, associateSubnetsResponse_firewallArn - The Amazon Resource Name (ARN) of the firewall.

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

AssociateSubnets, associateSubnetsResponse_subnetMappings - The IDs of the subnets that are associated with the firewall.

AssociateSubnets, associateSubnetsResponse_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:AssociateSubnetsResponse', associateSubnetsResponse_httpStatus - The response's http status code.

Response Lenses

associateSubnetsResponse_firewallArn :: Lens' AssociateSubnetsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the firewall.

associateSubnetsResponse_firewallName :: Lens' AssociateSubnetsResponse (Maybe Text) Source #

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

associateSubnetsResponse_subnetMappings :: Lens' AssociateSubnetsResponse (Maybe [SubnetMapping]) Source #

The IDs of the subnets that are associated with the firewall.

associateSubnetsResponse_updateToken :: Lens' AssociateSubnetsResponse (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.

associateSubnetsResponse_httpStatus :: Lens' AssociateSubnetsResponse Int Source #

The response's http status code.