libZSservicesZSamazonka-route53resolverZSamazonka-route53resolver
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.Route53Resolver.CreateFirewallRule

Description

Creates a single DNS Firewall rule in the specified rule group, using the specified domain list.

Synopsis

Creating a Request

data CreateFirewallRule Source #

See: newCreateFirewallRule smart constructor.

Constructors

CreateFirewallRule' 

Fields

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

    This setting is required if the BlockResponse setting is OVERRIDE.

  • blockResponse :: Maybe BlockResponse

    The way that you want DNS Firewall to block the request, used with 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.

    This setting is required if the rule action setting is BLOCK.

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

    This setting is required if the BlockResponse setting is 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.

    This setting is required if the BlockResponse setting is OVERRIDE.

  • creatorRequestId :: Text

    A unique string that identifies the request and that allows you to retry failed requests without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

  • firewallRuleGroupId :: Text

    The unique identifier of the firewall rule group where you want to create the rule.

  • firewallDomainListId :: Text

    The ID of the domain list that you want to use in the rule.

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

  • action :: 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 and send metrics and logs to Cloud Watch.
    • BLOCK - Disallow the request. This option requires additional details in the rule's BlockResponse.
  • name :: Text

    A name that lets you identify the rule in the rule group.

Instances

Instances details
Eq CreateFirewallRule Source # 
Instance details

Defined in Amazonka.Route53Resolver.CreateFirewallRule

Read CreateFirewallRule Source # 
Instance details

Defined in Amazonka.Route53Resolver.CreateFirewallRule

Show CreateFirewallRule Source # 
Instance details

Defined in Amazonka.Route53Resolver.CreateFirewallRule

Generic CreateFirewallRule Source # 
Instance details

Defined in Amazonka.Route53Resolver.CreateFirewallRule

Associated Types

type Rep CreateFirewallRule :: Type -> Type #

NFData CreateFirewallRule Source # 
Instance details

Defined in Amazonka.Route53Resolver.CreateFirewallRule

Methods

rnf :: CreateFirewallRule -> () #

Hashable CreateFirewallRule Source # 
Instance details

Defined in Amazonka.Route53Resolver.CreateFirewallRule

ToJSON CreateFirewallRule Source # 
Instance details

Defined in Amazonka.Route53Resolver.CreateFirewallRule

AWSRequest CreateFirewallRule Source # 
Instance details

Defined in Amazonka.Route53Resolver.CreateFirewallRule

Associated Types

type AWSResponse CreateFirewallRule #

ToHeaders CreateFirewallRule Source # 
Instance details

Defined in Amazonka.Route53Resolver.CreateFirewallRule

ToPath CreateFirewallRule Source # 
Instance details

Defined in Amazonka.Route53Resolver.CreateFirewallRule

ToQuery CreateFirewallRule Source # 
Instance details

Defined in Amazonka.Route53Resolver.CreateFirewallRule

type Rep CreateFirewallRule Source # 
Instance details

Defined in Amazonka.Route53Resolver.CreateFirewallRule

type Rep CreateFirewallRule = D1 ('MetaData "CreateFirewallRule" "Amazonka.Route53Resolver.CreateFirewallRule" "libZSservicesZSamazonka-route53resolverZSamazonka-route53resolver" 'False) (C1 ('MetaCons "CreateFirewallRule'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "blockOverrideDnsType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BlockOverrideDnsType)) :*: S1 ('MetaSel ('Just "blockResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BlockResponse))) :*: (S1 ('MetaSel ('Just "blockOverrideTtl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "blockOverrideDomain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "creatorRequestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) :*: ((S1 ('MetaSel ('Just "firewallRuleGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "firewallDomainListId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Action) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse CreateFirewallRule Source # 
Instance details

Defined in Amazonka.Route53Resolver.CreateFirewallRule

newCreateFirewallRule Source #

Create a value of CreateFirewallRule 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:blockOverrideDnsType:CreateFirewallRule', createFirewallRule_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.

This setting is required if the BlockResponse setting is OVERRIDE.

$sel:blockResponse:CreateFirewallRule', createFirewallRule_blockResponse - The way that you want DNS Firewall to block the request, used with 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.

This setting is required if the rule action setting is BLOCK.

$sel:blockOverrideTtl:CreateFirewallRule', createFirewallRule_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.

This setting is required if the BlockResponse setting is OVERRIDE.

$sel:blockOverrideDomain:CreateFirewallRule', createFirewallRule_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.

This setting is required if the BlockResponse setting is OVERRIDE.

$sel:creatorRequestId:CreateFirewallRule', createFirewallRule_creatorRequestId - A unique string that identifies the request and that allows you to retry failed requests without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

$sel:firewallRuleGroupId:CreateFirewallRule', createFirewallRule_firewallRuleGroupId - The unique identifier of the firewall rule group where you want to create the rule.

$sel:firewallDomainListId:CreateFirewallRule', createFirewallRule_firewallDomainListId - The ID of the domain list that you want to use in the rule.

$sel:priority:CreateFirewallRule', createFirewallRule_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.

$sel:action:CreateFirewallRule', createFirewallRule_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 and send metrics and logs to Cloud Watch.
  • BLOCK - Disallow the request. This option requires additional details in the rule's BlockResponse.

$sel:name:CreateFirewallRule', createFirewallRule_name - A name that lets you identify the rule in the rule group.

Request Lenses

createFirewallRule_blockOverrideDnsType :: Lens' CreateFirewallRule (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.

This setting is required if the BlockResponse setting is OVERRIDE.

createFirewallRule_blockResponse :: Lens' CreateFirewallRule (Maybe BlockResponse) Source #

The way that you want DNS Firewall to block the request, used with 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.

This setting is required if the rule action setting is BLOCK.

createFirewallRule_blockOverrideTtl :: Lens' CreateFirewallRule (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.

This setting is required if the BlockResponse setting is OVERRIDE.

createFirewallRule_blockOverrideDomain :: Lens' CreateFirewallRule (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.

This setting is required if the BlockResponse setting is OVERRIDE.

createFirewallRule_creatorRequestId :: Lens' CreateFirewallRule Text Source #

A unique string that identifies the request and that allows you to retry failed requests without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

createFirewallRule_firewallRuleGroupId :: Lens' CreateFirewallRule Text Source #

The unique identifier of the firewall rule group where you want to create the rule.

createFirewallRule_firewallDomainListId :: Lens' CreateFirewallRule Text Source #

The ID of the domain list that you want to use in the rule.

createFirewallRule_priority :: Lens' CreateFirewallRule 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.

createFirewallRule_action :: Lens' CreateFirewallRule 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 and send metrics and logs to Cloud Watch.
  • BLOCK - Disallow the request. This option requires additional details in the rule's BlockResponse.

createFirewallRule_name :: Lens' CreateFirewallRule Text Source #

A name that lets you identify the rule in the rule group.

Destructuring the Response

data CreateFirewallRuleResponse Source #

See: newCreateFirewallRuleResponse smart constructor.

Constructors

CreateFirewallRuleResponse' 

Fields

Instances

Instances details
Eq CreateFirewallRuleResponse Source # 
Instance details

Defined in Amazonka.Route53Resolver.CreateFirewallRule

Read CreateFirewallRuleResponse Source # 
Instance details

Defined in Amazonka.Route53Resolver.CreateFirewallRule

Show CreateFirewallRuleResponse Source # 
Instance details

Defined in Amazonka.Route53Resolver.CreateFirewallRule

Generic CreateFirewallRuleResponse Source # 
Instance details

Defined in Amazonka.Route53Resolver.CreateFirewallRule

Associated Types

type Rep CreateFirewallRuleResponse :: Type -> Type #

NFData CreateFirewallRuleResponse Source # 
Instance details

Defined in Amazonka.Route53Resolver.CreateFirewallRule

type Rep CreateFirewallRuleResponse Source # 
Instance details

Defined in Amazonka.Route53Resolver.CreateFirewallRule

type Rep CreateFirewallRuleResponse = D1 ('MetaData "CreateFirewallRuleResponse" "Amazonka.Route53Resolver.CreateFirewallRule" "libZSservicesZSamazonka-route53resolverZSamazonka-route53resolver" 'False) (C1 ('MetaCons "CreateFirewallRuleResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "firewallRule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FirewallRule)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateFirewallRuleResponse Source #

Create a value of CreateFirewallRuleResponse 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:CreateFirewallRuleResponse', createFirewallRuleResponse_firewallRule - The firewall rule that you just created.

$sel:httpStatus:CreateFirewallRuleResponse', createFirewallRuleResponse_httpStatus - The response's http status code.

Response Lenses