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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an Network Firewall Firewall and accompanying FirewallStatus for a VPC.

The firewall defines the configuration settings for an Network Firewall firewall. The settings that you can define at creation include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall Amazon Web Services resource.

After you create a firewall, you can provide additional settings, like the logging configuration.

To update the settings for a firewall, you use the operations that apply to the settings themselves, for example UpdateLoggingConfiguration, AssociateSubnets, and UpdateFirewallDeleteProtection.

To manage a firewall's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.

To retrieve information about firewalls, use ListFirewalls and DescribeFirewall.

Synopsis

data CreateFirewall = CreateFirewall' {
- deleteProtection :: Maybe Bool
- description :: Maybe Text
- encryptionConfiguration :: Maybe EncryptionConfiguration
- firewallPolicyChangeProtection :: Maybe Bool
- subnetChangeProtection :: Maybe Bool
- tags :: Maybe (NonEmpty Tag)
- firewallName :: Text
- firewallPolicyArn :: Text
- vpcId :: Text
- subnetMappings :: [SubnetMapping]
}
newCreateFirewall :: Text -> Text -> Text -> CreateFirewall
createFirewall_deleteProtection :: Lens' CreateFirewall (Maybe Bool)
createFirewall_description :: Lens' CreateFirewall (Maybe Text)
createFirewall_encryptionConfiguration :: Lens' CreateFirewall (Maybe EncryptionConfiguration)
createFirewall_firewallPolicyChangeProtection :: Lens' CreateFirewall (Maybe Bool)
createFirewall_subnetChangeProtection :: Lens' CreateFirewall (Maybe Bool)
createFirewall_tags :: Lens' CreateFirewall (Maybe (NonEmpty Tag))
createFirewall_firewallName :: Lens' CreateFirewall Text
createFirewall_firewallPolicyArn :: Lens' CreateFirewall Text
createFirewall_vpcId :: Lens' CreateFirewall Text
createFirewall_subnetMappings :: Lens' CreateFirewall [SubnetMapping]
data CreateFirewallResponse = CreateFirewallResponse' {
- firewall :: Maybe Firewall
- firewallStatus :: Maybe FirewallStatus
- httpStatus :: Int
}
newCreateFirewallResponse :: Int -> CreateFirewallResponse
createFirewallResponse_firewall :: Lens' CreateFirewallResponse (Maybe Firewall)
createFirewallResponse_firewallStatus :: Lens' CreateFirewallResponse (Maybe FirewallStatus)
createFirewallResponse_httpStatus :: Lens' CreateFirewallResponse Int

Creating a Request

data CreateFirewall Source #

See: newCreateFirewall smart constructor.

Constructors

CreateFirewall'

Fields

deleteProtection :: Maybe Bool
A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.
description :: Maybe Text
A description of the firewall.
encryptionConfiguration :: Maybe EncryptionConfiguration
A complex type that contains settings for encryption of your firewall resources.
firewallPolicyChangeProtection :: Maybe Bool
A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
subnetChangeProtection :: Maybe Bool
A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
tags :: Maybe (NonEmpty Tag)
The key:value pairs to associate with the resource.
firewallName :: Text
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
firewallPolicyArn :: Text
The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall.
vpcId :: Text
The unique identifier of the VPC where Network Firewall should create the firewall.
You can't change this setting after you create the firewall.
subnetMappings :: [SubnetMapping]
The public subnets to use for your Network Firewall firewalls. Each subnet must belong to a different Availability Zone in the VPC. Network Firewall creates a firewall endpoint in each subnet.

Instances

Instances details

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

newCreateFirewall Source #

Arguments

:: Text	`CreateFirewall`
-> Text	`CreateFirewall`
-> Text	`CreateFirewall`
-> CreateFirewall

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

CreateFirewall, createFirewall_deleteProtection - A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.

CreateFirewall, createFirewall_description - A description of the firewall.

CreateFirewall, createFirewall_encryptionConfiguration - A complex type that contains settings for encryption of your firewall resources.

CreateFirewall, createFirewall_firewallPolicyChangeProtection - A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

CreateFirewall, createFirewall_subnetChangeProtection - A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

CreateFirewall, createFirewall_tags - The key:value pairs to associate with the resource.

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

CreateFirewall, createFirewall_firewallPolicyArn - The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall.

CreateFirewall, createFirewall_vpcId - The unique identifier of the VPC where Network Firewall should create the firewall.

You can't change this setting after you create the firewall.

CreateFirewall, createFirewall_subnetMappings - The public subnets to use for your Network Firewall firewalls. Each subnet must belong to a different Availability Zone in the VPC. Network Firewall creates a firewall endpoint in each subnet.

Request Lenses

createFirewall_deleteProtection :: Lens' CreateFirewall (Maybe Bool) Source #

A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.

createFirewall_description :: Lens' CreateFirewall (Maybe Text) Source #

A description of the firewall.

createFirewall_encryptionConfiguration :: Lens' CreateFirewall (Maybe EncryptionConfiguration) Source #

A complex type that contains settings for encryption of your firewall resources.

createFirewall_firewallPolicyChangeProtection :: Lens' CreateFirewall (Maybe Bool) Source #

A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

createFirewall_subnetChangeProtection :: Lens' CreateFirewall (Maybe Bool) Source #

A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

createFirewall_tags :: Lens' CreateFirewall (Maybe (NonEmpty Tag)) Source #

The key:value pairs to associate with the resource.

createFirewall_firewallName :: Lens' CreateFirewall Text Source #

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

createFirewall_firewallPolicyArn :: Lens' CreateFirewall Text Source #

The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall.

createFirewall_vpcId :: Lens' CreateFirewall Text Source #

The unique identifier of the VPC where Network Firewall should create the firewall.

You can't change this setting after you create the firewall.

createFirewall_subnetMappings :: Lens' CreateFirewall [SubnetMapping] Source #

The public subnets to use for your Network Firewall firewalls. Each subnet must belong to a different Availability Zone in the VPC. Network Firewall creates a firewall endpoint in each subnet.

Destructuring the Response

data CreateFirewallResponse Source #

See: newCreateFirewallResponse smart constructor.

Constructors

CreateFirewallResponse'

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

Instances

Instances details

Generic CreateFirewallResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.CreateFirewall Associated Types type Rep CreateFirewallResponse :: Type -> Type # Methods from :: CreateFirewallResponse -> Rep CreateFirewallResponse x # to :: Rep CreateFirewallResponse x -> CreateFirewallResponse #
Read CreateFirewallResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.CreateFirewall Methods readsPrec :: Int -> ReadS CreateFirewallResponse # readList :: ReadS [CreateFirewallResponse] # readPrec :: ReadPrec CreateFirewallResponse # readListPrec :: ReadPrec [CreateFirewallResponse] #
Show CreateFirewallResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.CreateFirewall Methods showsPrec :: Int -> CreateFirewallResponse -> ShowS # show :: CreateFirewallResponse -> String # showList :: [CreateFirewallResponse] -> ShowS #
NFData CreateFirewallResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.CreateFirewall Methods rnf :: CreateFirewallResponse -> () #
Eq CreateFirewallResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.CreateFirewall Methods (==) :: CreateFirewallResponse -> CreateFirewallResponse -> Bool # (/=) :: CreateFirewallResponse -> CreateFirewallResponse -> Bool #
type Rep CreateFirewallResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.CreateFirewall type Rep CreateFirewallResponse = D1 ('MetaData "CreateFirewallResponse" "Amazonka.NetworkFirewall.CreateFirewall" "amazonka-network-firewall-2.0-4y6HybZBSNcEwGPO5AYVfm" 'False) (C1 ('MetaCons "CreateFirewallResponse'" '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 "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateFirewallResponse Source #

Arguments

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

Create a value of CreateFirewallResponse 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:CreateFirewallResponse', createFirewallResponse_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:CreateFirewallResponse', createFirewallResponse_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:httpStatus:CreateFirewallResponse', createFirewallResponse_httpStatus - The response's http status code.

Response Lenses

createFirewallResponse_firewall :: Lens' CreateFirewallResponse (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.

createFirewallResponse_firewallStatus :: Lens' CreateFirewallResponse (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.

createFirewallResponse_httpStatus :: Lens' CreateFirewallResponse Int Source #

The response's http status code.