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.Route53Resolver.UpdateFirewallRule

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the specified firewall rule.

Synopsis

data UpdateFirewallRule = UpdateFirewallRule' {
- action :: Maybe Action
- blockOverrideDnsType :: Maybe BlockOverrideDnsType
- blockOverrideDomain :: Maybe Text
- blockOverrideTtl :: Maybe Natural
- blockResponse :: Maybe BlockResponse
- name :: Maybe Text
- priority :: Maybe Int
- firewallRuleGroupId :: Text
- firewallDomainListId :: Text
}
newUpdateFirewallRule :: Text -> Text -> UpdateFirewallRule
updateFirewallRule_action :: Lens' UpdateFirewallRule (Maybe Action)
updateFirewallRule_blockOverrideDnsType :: Lens' UpdateFirewallRule (Maybe BlockOverrideDnsType)
updateFirewallRule_blockOverrideDomain :: Lens' UpdateFirewallRule (Maybe Text)
updateFirewallRule_blockOverrideTtl :: Lens' UpdateFirewallRule (Maybe Natural)
updateFirewallRule_blockResponse :: Lens' UpdateFirewallRule (Maybe BlockResponse)
updateFirewallRule_name :: Lens' UpdateFirewallRule (Maybe Text)
updateFirewallRule_priority :: Lens' UpdateFirewallRule (Maybe Int)
updateFirewallRule_firewallRuleGroupId :: Lens' UpdateFirewallRule Text
updateFirewallRule_firewallDomainListId :: Lens' UpdateFirewallRule Text
data UpdateFirewallRuleResponse = UpdateFirewallRuleResponse' {
- firewallRule :: Maybe FirewallRule
- httpStatus :: Int
}
newUpdateFirewallRuleResponse :: Int -> UpdateFirewallRuleResponse
updateFirewallRuleResponse_firewallRule :: Lens' UpdateFirewallRuleResponse (Maybe FirewallRule)
updateFirewallRuleResponse_httpStatus :: Lens' UpdateFirewallRuleResponse Int

Creating a Request

data UpdateFirewallRule Source #

See: newUpdateFirewallRule smart constructor.

Constructors

UpdateFirewallRule'

Fields

action :: Maybe Action
The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:
- ALLOW - Permit the request to go through.
- ALERT - Permit the request to go through but send an alert to the logs.
- BLOCK - Disallow the request. This option requires additional details in the rule's BlockResponse.
blockOverrideDnsType :: Maybe BlockOverrideDnsType
The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.
blockOverrideDomain :: Maybe Text
The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.
blockOverrideTtl :: Maybe Natural
The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.
blockResponse :: Maybe BlockResponse
The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK.
- NODATA - Respond indicating that the query was successful, but no response is available for it.
- NXDOMAIN - Respond indicating that the domain name that's in the query doesn't exist.
- OVERRIDE - Provide a custom override in the response. This option requires custom handling details in the rule's BlockOverride* settings.
name :: Maybe Text
The name of the rule.
priority :: Maybe Int
The setting that determines the processing order of the rule in the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.
You must specify a unique priority for each rule in a rule group. To make it easier to insert rules later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for the rules in a rule group at any time.
firewallRuleGroupId :: Text
The unique identifier of the firewall rule group for the rule.
firewallDomainListId :: Text
The ID of the domain list to use in the rule.

Instances

Instances details

ToJSON UpdateFirewallRule Source #
Instance details Defined in Amazonka.Route53Resolver.UpdateFirewallRule Methods toJSON :: UpdateFirewallRule -> Value # toEncoding :: UpdateFirewallRule -> Encoding # toJSONList :: [UpdateFirewallRule] -> Value # toEncodingList :: [UpdateFirewallRule] -> Encoding #
ToHeaders UpdateFirewallRule Source #
Instance details Defined in Amazonka.Route53Resolver.UpdateFirewallRule Methods toHeaders :: UpdateFirewallRule -> [Header] #
ToPath UpdateFirewallRule Source #
Instance details Defined in Amazonka.Route53Resolver.UpdateFirewallRule Methods toPath :: UpdateFirewallRule -> ByteString #
ToQuery UpdateFirewallRule Source #
Instance details Defined in Amazonka.Route53Resolver.UpdateFirewallRule Methods toQuery :: UpdateFirewallRule -> QueryString #
AWSRequest UpdateFirewallRule Source #
Instance details Defined in Amazonka.Route53Resolver.UpdateFirewallRule Associated Types type AWSResponse UpdateFirewallRule # Methods request :: (Service -> Service) -> UpdateFirewallRule -> Request UpdateFirewallRule # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateFirewallRule -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateFirewallRule))) #
Generic UpdateFirewallRule Source #
Instance details Defined in Amazonka.Route53Resolver.UpdateFirewallRule Associated Types type Rep UpdateFirewallRule :: Type -> Type # Methods from :: UpdateFirewallRule -> Rep UpdateFirewallRule x # to :: Rep UpdateFirewallRule x -> UpdateFirewallRule #
Read UpdateFirewallRule Source #
Instance details Defined in Amazonka.Route53Resolver.UpdateFirewallRule Methods readsPrec :: Int -> ReadS UpdateFirewallRule # readList :: ReadS [UpdateFirewallRule] # readPrec :: ReadPrec UpdateFirewallRule # readListPrec :: ReadPrec [UpdateFirewallRule] #
Show UpdateFirewallRule Source #
Instance details Defined in Amazonka.Route53Resolver.UpdateFirewallRule Methods showsPrec :: Int -> UpdateFirewallRule -> ShowS # show :: UpdateFirewallRule -> String # showList :: [UpdateFirewallRule] -> ShowS #
NFData UpdateFirewallRule Source #
Instance details Defined in Amazonka.Route53Resolver.UpdateFirewallRule Methods rnf :: UpdateFirewallRule -> () #
Eq UpdateFirewallRule Source #
Instance details Defined in Amazonka.Route53Resolver.UpdateFirewallRule Methods (==) :: UpdateFirewallRule -> UpdateFirewallRule -> Bool # (/=) :: UpdateFirewallRule -> UpdateFirewallRule -> Bool #
Hashable UpdateFirewallRule Source #
Instance details Defined in Amazonka.Route53Resolver.UpdateFirewallRule Methods hashWithSalt :: Int -> UpdateFirewallRule -> Int # hash :: UpdateFirewallRule -> Int #
type AWSResponse UpdateFirewallRule Source #
Instance details Defined in Amazonka.Route53Resolver.UpdateFirewallRule type AWSResponse UpdateFirewallRule = UpdateFirewallRuleResponse
type Rep UpdateFirewallRule Source #
Instance details Defined in Amazonka.Route53Resolver.UpdateFirewallRule type Rep UpdateFirewallRule = D1 ('MetaData "UpdateFirewallRule" "Amazonka.Route53Resolver.UpdateFirewallRule" "amazonka-route53resolver-2.0-GFukx1WIgCPEXMh1BiYlp6" 'False) (C1 ('MetaCons "UpdateFirewallRule'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Action)) :: S1 ('MetaSel ('Just "blockOverrideDnsType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BlockOverrideDnsType))) :: (S1 ('MetaSel ('Just "blockOverrideDomain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "blockOverrideTtl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: ((S1 ('MetaSel ('Just "blockResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BlockResponse)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "firewallRuleGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "firewallDomainListId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdateFirewallRule Source #

Arguments

:: Text	`UpdateFirewallRule`
-> Text	`UpdateFirewallRule`
-> UpdateFirewallRule

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

UpdateFirewallRule, updateFirewallRule_action - The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:

ALLOW - Permit the request to go through.
ALERT - Permit the request to go through but send an alert to the logs.
BLOCK - Disallow the request. This option requires additional details in the rule's BlockResponse.

UpdateFirewallRule, updateFirewallRule_blockOverrideDnsType - The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

UpdateFirewallRule, updateFirewallRule_blockOverrideDomain - The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

UpdateFirewallRule, updateFirewallRule_blockOverrideTtl - The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

UpdateFirewallRule, updateFirewallRule_blockResponse - The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK.

NODATA - Respond indicating that the query was successful, but no response is available for it.
NXDOMAIN - Respond indicating that the domain name that's in the query doesn't exist.
OVERRIDE - Provide a custom override in the response. This option requires custom handling details in the rule's BlockOverride* settings.

UpdateFirewallRule, updateFirewallRule_name - The name of the rule.

UpdateFirewallRule, updateFirewallRule_priority - The setting that determines the processing order of the rule in the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

You must specify a unique priority for each rule in a rule group. To make it easier to insert rules later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for the rules in a rule group at any time.

UpdateFirewallRule, updateFirewallRule_firewallRuleGroupId - The unique identifier of the firewall rule group for the rule.

UpdateFirewallRule, updateFirewallRule_firewallDomainListId - The ID of the domain list to use in the rule.

Request Lenses

updateFirewallRule_action :: Lens' UpdateFirewallRule (Maybe Action) Source #

The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:

ALLOW - Permit the request to go through.
ALERT - Permit the request to go through but send an alert to the logs.
BLOCK - Disallow the request. This option requires additional details in the rule's BlockResponse.

updateFirewallRule_blockOverrideDnsType :: Lens' UpdateFirewallRule (Maybe BlockOverrideDnsType) Source #

The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

updateFirewallRule_blockOverrideDomain :: Lens' UpdateFirewallRule (Maybe Text) Source #

The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

updateFirewallRule_blockOverrideTtl :: Lens' UpdateFirewallRule (Maybe Natural) Source #

The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

updateFirewallRule_blockResponse :: Lens' UpdateFirewallRule (Maybe BlockResponse) Source #

The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK.

NODATA - Respond indicating that the query was successful, but no response is available for it.
NXDOMAIN - Respond indicating that the domain name that's in the query doesn't exist.
OVERRIDE - Provide a custom override in the response. This option requires custom handling details in the rule's BlockOverride* settings.

updateFirewallRule_name :: Lens' UpdateFirewallRule (Maybe Text) Source #

The name of the rule.

updateFirewallRule_priority :: Lens' UpdateFirewallRule (Maybe Int) Source #

The setting that determines the processing order of the rule in the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

You must specify a unique priority for each rule in a rule group. To make it easier to insert rules later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for the rules in a rule group at any time.

updateFirewallRule_firewallRuleGroupId :: Lens' UpdateFirewallRule Text Source #

The unique identifier of the firewall rule group for the rule.

updateFirewallRule_firewallDomainListId :: Lens' UpdateFirewallRule Text Source #

The ID of the domain list to use in the rule.

Destructuring the Response

data UpdateFirewallRuleResponse Source #

See: newUpdateFirewallRuleResponse smart constructor.

Constructors

UpdateFirewallRuleResponse'
Fields firewallRule :: Maybe FirewallRule The firewall rule that you just updated. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateFirewallRuleResponse Source #
Instance details Defined in Amazonka.Route53Resolver.UpdateFirewallRule Associated Types type Rep UpdateFirewallRuleResponse :: Type -> Type # Methods from :: UpdateFirewallRuleResponse -> Rep UpdateFirewallRuleResponse x # to :: Rep UpdateFirewallRuleResponse x -> UpdateFirewallRuleResponse #
Read UpdateFirewallRuleResponse Source #
Instance details Defined in Amazonka.Route53Resolver.UpdateFirewallRule Methods readsPrec :: Int -> ReadS UpdateFirewallRuleResponse # readList :: ReadS [UpdateFirewallRuleResponse] # readPrec :: ReadPrec UpdateFirewallRuleResponse # readListPrec :: ReadPrec [UpdateFirewallRuleResponse] #
Show UpdateFirewallRuleResponse Source #
Instance details Defined in Amazonka.Route53Resolver.UpdateFirewallRule Methods showsPrec :: Int -> UpdateFirewallRuleResponse -> ShowS # show :: UpdateFirewallRuleResponse -> String # showList :: [UpdateFirewallRuleResponse] -> ShowS #
NFData UpdateFirewallRuleResponse Source #
Instance details Defined in Amazonka.Route53Resolver.UpdateFirewallRule Methods rnf :: UpdateFirewallRuleResponse -> () #
Eq UpdateFirewallRuleResponse Source #
Instance details Defined in Amazonka.Route53Resolver.UpdateFirewallRule Methods (==) :: UpdateFirewallRuleResponse -> UpdateFirewallRuleResponse -> Bool # (/=) :: UpdateFirewallRuleResponse -> UpdateFirewallRuleResponse -> Bool #
type Rep UpdateFirewallRuleResponse Source #
Instance details Defined in Amazonka.Route53Resolver.UpdateFirewallRule type Rep UpdateFirewallRuleResponse = D1 ('MetaData "UpdateFirewallRuleResponse" "Amazonka.Route53Resolver.UpdateFirewallRule" "amazonka-route53resolver-2.0-GFukx1WIgCPEXMh1BiYlp6" 'False) (C1 ('MetaCons "UpdateFirewallRuleResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "firewallRule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FirewallRule)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateFirewallRuleResponse Source #

Arguments

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

Create a value of UpdateFirewallRuleResponse 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:firewallRule:UpdateFirewallRuleResponse', updateFirewallRuleResponse_firewallRule - The firewall rule that you just updated.

$sel:httpStatus:UpdateFirewallRuleResponse', updateFirewallRuleResponse_httpStatus - The response's http status code.

Response Lenses

updateFirewallRuleResponse_firewallRule :: Lens' UpdateFirewallRuleResponse (Maybe FirewallRule) Source #

The firewall rule that you just updated.

updateFirewallRuleResponse_httpStatus :: Lens' UpdateFirewallRuleResponse Int Source #

The response's http status code.