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

Description

Updates the properties of the specified firewall policy.

Synopsis

Creating a Request

data UpdateFirewallPolicy Source #

See: newUpdateFirewallPolicy smart constructor.

Constructors

UpdateFirewallPolicy' 

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.

  • encryptionConfiguration :: Maybe EncryptionConfiguration

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

  • firewallPolicyArn :: Maybe Text

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

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

  • firewallPolicyName :: Maybe Text

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

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

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

  • firewallPolicy :: FirewallPolicy

    The updated firewall policy to use for the firewall.

Instances

Instances details
ToJSON UpdateFirewallPolicy Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallPolicy

ToHeaders UpdateFirewallPolicy Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallPolicy

ToPath UpdateFirewallPolicy Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallPolicy

ToQuery UpdateFirewallPolicy Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallPolicy

AWSRequest UpdateFirewallPolicy Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallPolicy

Associated Types

type AWSResponse UpdateFirewallPolicy #

Generic UpdateFirewallPolicy Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallPolicy

Associated Types

type Rep UpdateFirewallPolicy :: Type -> Type #

Read UpdateFirewallPolicy Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallPolicy

Show UpdateFirewallPolicy Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallPolicy

NFData UpdateFirewallPolicy Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallPolicy

Methods

rnf :: UpdateFirewallPolicy -> () #

Eq UpdateFirewallPolicy Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallPolicy

Hashable UpdateFirewallPolicy Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallPolicy

type AWSResponse UpdateFirewallPolicy Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallPolicy

type Rep UpdateFirewallPolicy Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallPolicy

type Rep UpdateFirewallPolicy = D1 ('MetaData "UpdateFirewallPolicy" "Amazonka.NetworkFirewall.UpdateFirewallPolicy" "amazonka-network-firewall-2.0-4y6HybZBSNcEwGPO5AYVfm" 'False) (C1 ('MetaCons "UpdateFirewallPolicy'" '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 "encryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionConfiguration)))) :*: ((S1 ('MetaSel ('Just "firewallPolicyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "firewallPolicyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "updateToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "firewallPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FirewallPolicy)))))

newUpdateFirewallPolicy Source #

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

UpdateFirewallPolicy, updateFirewallPolicy_description - A description of the firewall policy.

$sel:dryRun:UpdateFirewallPolicy', updateFirewallPolicy_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.

UpdateFirewallPolicy, updateFirewallPolicy_encryptionConfiguration - A complex type that contains settings for encryption of your firewall policy resources.

UpdateFirewallPolicy, updateFirewallPolicy_firewallPolicyArn - The Amazon Resource Name (ARN) of the firewall policy.

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

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

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

UpdateFirewallPolicy, updateFirewallPolicy_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:firewallPolicy:UpdateFirewallPolicy', updateFirewallPolicy_firewallPolicy - The updated firewall policy to use for the firewall.

Request Lenses

updateFirewallPolicy_dryRun :: Lens' UpdateFirewallPolicy (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.

updateFirewallPolicy_encryptionConfiguration :: Lens' UpdateFirewallPolicy (Maybe EncryptionConfiguration) Source #

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

updateFirewallPolicy_firewallPolicyArn :: Lens' UpdateFirewallPolicy (Maybe Text) Source #

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

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

updateFirewallPolicy_firewallPolicyName :: Lens' UpdateFirewallPolicy (Maybe Text) Source #

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

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

updateFirewallPolicy_updateToken :: Lens' UpdateFirewallPolicy 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.

updateFirewallPolicy_firewallPolicy :: Lens' UpdateFirewallPolicy FirewallPolicy Source #

The updated firewall policy to use for the firewall.

Destructuring the Response

data UpdateFirewallPolicyResponse Source #

See: newUpdateFirewallPolicyResponse smart constructor.

Constructors

UpdateFirewallPolicyResponse' 

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
Generic UpdateFirewallPolicyResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallPolicy

Associated Types

type Rep UpdateFirewallPolicyResponse :: Type -> Type #

Read UpdateFirewallPolicyResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallPolicy

Show UpdateFirewallPolicyResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallPolicy

NFData UpdateFirewallPolicyResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallPolicy

Eq UpdateFirewallPolicyResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallPolicy

type Rep UpdateFirewallPolicyResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallPolicy

type Rep UpdateFirewallPolicyResponse = D1 ('MetaData "UpdateFirewallPolicyResponse" "Amazonka.NetworkFirewall.UpdateFirewallPolicy" "amazonka-network-firewall-2.0-4y6HybZBSNcEwGPO5AYVfm" 'False) (C1 ('MetaCons "UpdateFirewallPolicyResponse'" '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))))

newUpdateFirewallPolicyResponse Source #

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

UpdateFirewallPolicy, updateFirewallPolicyResponse_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:UpdateFirewallPolicyResponse', updateFirewallPolicyResponse_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

updateFirewallPolicyResponse_updateToken :: Lens' UpdateFirewallPolicyResponse 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.

updateFirewallPolicyResponse_firewallPolicyResponse :: Lens' UpdateFirewallPolicyResponse 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.