libZSservicesZSamazonka-network-firewallZSamazonka-network-firewall
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.NetworkFirewall.CreateFirewallPolicy

Description

Creates the firewall policy for the firewall according to the specifications.

An AWS Network Firewall firewall policy defines the behavior of a firewall, in a collection of stateless and stateful rule groups and other settings. You can use one firewall policy for multiple firewalls.

Synopsis

Creating a Request

data CreateFirewallPolicy Source #

See: newCreateFirewallPolicy smart constructor.

Constructors

CreateFirewallPolicy' 

Fields

  • description :: Maybe Text

    A description of the firewall policy.

  • dryRun :: Maybe Bool

    Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

    If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.

    If set to FALSE, Network Firewall makes the requested changes to your resources.

  • tags :: Maybe (NonEmpty Tag)

    The key:value pairs to associate with the resource.

  • firewallPolicyName :: Text

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

  • firewallPolicy :: FirewallPolicy

    The rule groups and policy actions to use in the firewall policy.

Instances

Instances details
Eq CreateFirewallPolicy Source # 
Instance details

Defined in Amazonka.NetworkFirewall.CreateFirewallPolicy

Read CreateFirewallPolicy Source # 
Instance details

Defined in Amazonka.NetworkFirewall.CreateFirewallPolicy

Show CreateFirewallPolicy Source # 
Instance details

Defined in Amazonka.NetworkFirewall.CreateFirewallPolicy

Generic CreateFirewallPolicy Source # 
Instance details

Defined in Amazonka.NetworkFirewall.CreateFirewallPolicy

Associated Types

type Rep CreateFirewallPolicy :: Type -> Type #

NFData CreateFirewallPolicy Source # 
Instance details

Defined in Amazonka.NetworkFirewall.CreateFirewallPolicy

Methods

rnf :: CreateFirewallPolicy -> () #

Hashable CreateFirewallPolicy Source # 
Instance details

Defined in Amazonka.NetworkFirewall.CreateFirewallPolicy

ToJSON CreateFirewallPolicy Source # 
Instance details

Defined in Amazonka.NetworkFirewall.CreateFirewallPolicy

AWSRequest CreateFirewallPolicy Source # 
Instance details

Defined in Amazonka.NetworkFirewall.CreateFirewallPolicy

Associated Types

type AWSResponse CreateFirewallPolicy #

ToHeaders CreateFirewallPolicy Source # 
Instance details

Defined in Amazonka.NetworkFirewall.CreateFirewallPolicy

ToPath CreateFirewallPolicy Source # 
Instance details

Defined in Amazonka.NetworkFirewall.CreateFirewallPolicy

ToQuery CreateFirewallPolicy Source # 
Instance details

Defined in Amazonka.NetworkFirewall.CreateFirewallPolicy

type Rep CreateFirewallPolicy Source # 
Instance details

Defined in Amazonka.NetworkFirewall.CreateFirewallPolicy

type Rep CreateFirewallPolicy = D1 ('MetaData "CreateFirewallPolicy" "Amazonka.NetworkFirewall.CreateFirewallPolicy" "libZSservicesZSamazonka-network-firewallZSamazonka-network-firewall" 'False) (C1 ('MetaCons "CreateFirewallPolicy'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: (S1 ('MetaSel ('Just "firewallPolicyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "firewallPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FirewallPolicy)))))
type AWSResponse CreateFirewallPolicy Source # 
Instance details

Defined in Amazonka.NetworkFirewall.CreateFirewallPolicy

newCreateFirewallPolicy Source #

Create a value of CreateFirewallPolicy 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:description:CreateFirewallPolicy', createFirewallPolicy_description - A description of the firewall policy.

$sel:dryRun:CreateFirewallPolicy', createFirewallPolicy_dryRun - Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.

If set to FALSE, Network Firewall makes the requested changes to your resources.

$sel:tags:CreateFirewallPolicy', createFirewallPolicy_tags - The key:value pairs to associate with the resource.

$sel:firewallPolicyName:CreateFirewallPolicy', createFirewallPolicy_firewallPolicyName - The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

$sel:firewallPolicy:CreateFirewallPolicy', createFirewallPolicy_firewallPolicy - The rule groups and policy actions to use in the firewall policy.

Request Lenses

createFirewallPolicy_dryRun :: Lens' CreateFirewallPolicy (Maybe Bool) Source #

Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.

If set to FALSE, Network Firewall makes the requested changes to your resources.

createFirewallPolicy_tags :: Lens' CreateFirewallPolicy (Maybe (NonEmpty Tag)) Source #

The key:value pairs to associate with the resource.

createFirewallPolicy_firewallPolicyName :: Lens' CreateFirewallPolicy Text Source #

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

createFirewallPolicy_firewallPolicy :: Lens' CreateFirewallPolicy FirewallPolicy Source #

The rule groups and policy actions to use in the firewall policy.

Destructuring the Response

data CreateFirewallPolicyResponse Source #

See: newCreateFirewallPolicyResponse smart constructor.

Constructors

CreateFirewallPolicyResponse' 

Fields

  • httpStatus :: Int

    The response's http status code.

  • updateToken :: Text

    A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.

    To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.

  • firewallPolicyResponse :: FirewallPolicyResponse

    The high-level properties of a firewall policy. This, along with the FirewallPolicy, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.

Instances

Instances details
Eq CreateFirewallPolicyResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.CreateFirewallPolicy

Read CreateFirewallPolicyResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.CreateFirewallPolicy

Show CreateFirewallPolicyResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.CreateFirewallPolicy

Generic CreateFirewallPolicyResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.CreateFirewallPolicy

Associated Types

type Rep CreateFirewallPolicyResponse :: Type -> Type #

NFData CreateFirewallPolicyResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.CreateFirewallPolicy

type Rep CreateFirewallPolicyResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.CreateFirewallPolicy

type Rep CreateFirewallPolicyResponse = D1 ('MetaData "CreateFirewallPolicyResponse" "Amazonka.NetworkFirewall.CreateFirewallPolicy" "libZSservicesZSamazonka-network-firewallZSamazonka-network-firewall" 'False) (C1 ('MetaCons "CreateFirewallPolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "updateToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "firewallPolicyResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FirewallPolicyResponse))))

newCreateFirewallPolicyResponse Source #

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

$sel:updateToken:CreateFirewallPolicyResponse', createFirewallPolicyResponse_updateToken - A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.

To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.

$sel:firewallPolicyResponse:CreateFirewallPolicyResponse', createFirewallPolicyResponse_firewallPolicyResponse - The high-level properties of a firewall policy. This, along with the FirewallPolicy, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.

Response Lenses

createFirewallPolicyResponse_updateToken :: Lens' CreateFirewallPolicyResponse Text Source #

A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.

To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.

createFirewallPolicyResponse_firewallPolicyResponse :: Lens' CreateFirewallPolicyResponse FirewallPolicyResponse Source #

The high-level properties of a firewall policy. This, along with the FirewallPolicy, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.