libZSservicesZSamazonka-route53ZSamazonka-route53
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.Route53.CreateQueryLoggingConfig

Description

Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group.

DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following:

  • Route 53 edge location that responded to the DNS query
  • Domain or subdomain that was requested
  • DNS record type, such as A or AAAA
  • DNS response code, such as NoError or ServFail
Log Group and Resource Policy
Before you create a query logging configuration, perform the following operations.

If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically.

  1. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following:

    • You must create the log group in the us-east-1 region.
    • You must use the same Amazon Web Services account to create the log group and the hosted zone that you want to configure query logging for.
    • When you create log groups for query logging, we recommend that you use a consistent prefix, for example:

      /aws/route53/hosted zone name

      In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated Amazon Web Services resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging.

  2. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example:

    arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*

    You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the Amazon Web Services SDKs, or the CLI.

Log Streams and Edge Locations
When Route 53 finishes creating the configuration for DNS query logging, it does the following:
  • Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location.
  • Begins to send query logs to the applicable log stream.

The name of each log stream is in the following format:

 hosted zone ID/edge location code

The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see "The Route 53 Global Network" on the Route 53 Product Details page.

Queries That Are Logged
Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide.
Log File Format
For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide.
Pricing
For information about charges for query logs, see Amazon CloudWatch Pricing.
How to Stop Logging
If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig.
Synopsis

Creating a Request

data CreateQueryLoggingConfig Source #

See: newCreateQueryLoggingConfig smart constructor.

Constructors

CreateQueryLoggingConfig' 

Fields

  • hostedZoneId :: ResourceId

    The ID of the hosted zone that you want to log queries for. You can log queries only for public hosted zones.

  • cloudWatchLogsLogGroupArn :: Text

    The Amazon Resource Name (ARN) for the log group that you want to Amazon Route 53 to send query logs to. This is the format of the ARN:

    arn:aws:logs:region:account-id:log-group:log_group_name

    To get the ARN for a log group, you can use the CloudWatch console, the DescribeLogGroups API action, the describe-log-groups command, or the applicable command in one of the Amazon Web Services SDKs.

Instances

Instances details
Eq CreateQueryLoggingConfig Source # 
Instance details

Defined in Amazonka.Route53.CreateQueryLoggingConfig

Read CreateQueryLoggingConfig Source # 
Instance details

Defined in Amazonka.Route53.CreateQueryLoggingConfig

Show CreateQueryLoggingConfig Source # 
Instance details

Defined in Amazonka.Route53.CreateQueryLoggingConfig

Generic CreateQueryLoggingConfig Source # 
Instance details

Defined in Amazonka.Route53.CreateQueryLoggingConfig

Associated Types

type Rep CreateQueryLoggingConfig :: Type -> Type #

NFData CreateQueryLoggingConfig Source # 
Instance details

Defined in Amazonka.Route53.CreateQueryLoggingConfig

Hashable CreateQueryLoggingConfig Source # 
Instance details

Defined in Amazonka.Route53.CreateQueryLoggingConfig

AWSRequest CreateQueryLoggingConfig Source # 
Instance details

Defined in Amazonka.Route53.CreateQueryLoggingConfig

ToHeaders CreateQueryLoggingConfig Source # 
Instance details

Defined in Amazonka.Route53.CreateQueryLoggingConfig

ToPath CreateQueryLoggingConfig Source # 
Instance details

Defined in Amazonka.Route53.CreateQueryLoggingConfig

ToQuery CreateQueryLoggingConfig Source # 
Instance details

Defined in Amazonka.Route53.CreateQueryLoggingConfig

ToElement CreateQueryLoggingConfig Source # 
Instance details

Defined in Amazonka.Route53.CreateQueryLoggingConfig

ToXML CreateQueryLoggingConfig Source # 
Instance details

Defined in Amazonka.Route53.CreateQueryLoggingConfig

type Rep CreateQueryLoggingConfig Source # 
Instance details

Defined in Amazonka.Route53.CreateQueryLoggingConfig

type Rep CreateQueryLoggingConfig = D1 ('MetaData "CreateQueryLoggingConfig" "Amazonka.Route53.CreateQueryLoggingConfig" "libZSservicesZSamazonka-route53ZSamazonka-route53" 'False) (C1 ('MetaCons "CreateQueryLoggingConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResourceId) :*: S1 ('MetaSel ('Just "cloudWatchLogsLogGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse CreateQueryLoggingConfig Source # 
Instance details

Defined in Amazonka.Route53.CreateQueryLoggingConfig

newCreateQueryLoggingConfig Source #

Create a value of CreateQueryLoggingConfig 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:hostedZoneId:CreateQueryLoggingConfig', createQueryLoggingConfig_hostedZoneId - The ID of the hosted zone that you want to log queries for. You can log queries only for public hosted zones.

$sel:cloudWatchLogsLogGroupArn:CreateQueryLoggingConfig', createQueryLoggingConfig_cloudWatchLogsLogGroupArn - The Amazon Resource Name (ARN) for the log group that you want to Amazon Route 53 to send query logs to. This is the format of the ARN:

arn:aws:logs:region:account-id:log-group:log_group_name

To get the ARN for a log group, you can use the CloudWatch console, the DescribeLogGroups API action, the describe-log-groups command, or the applicable command in one of the Amazon Web Services SDKs.

Request Lenses

createQueryLoggingConfig_hostedZoneId :: Lens' CreateQueryLoggingConfig ResourceId Source #

The ID of the hosted zone that you want to log queries for. You can log queries only for public hosted zones.

createQueryLoggingConfig_cloudWatchLogsLogGroupArn :: Lens' CreateQueryLoggingConfig Text Source #

The Amazon Resource Name (ARN) for the log group that you want to Amazon Route 53 to send query logs to. This is the format of the ARN:

arn:aws:logs:region:account-id:log-group:log_group_name

To get the ARN for a log group, you can use the CloudWatch console, the DescribeLogGroups API action, the describe-log-groups command, or the applicable command in one of the Amazon Web Services SDKs.

Destructuring the Response

data CreateQueryLoggingConfigResponse Source #

See: newCreateQueryLoggingConfigResponse smart constructor.

Constructors

CreateQueryLoggingConfigResponse' 

Fields

  • httpStatus :: Int

    The response's http status code.

  • queryLoggingConfig :: QueryLoggingConfig

    A complex type that contains the ID for a query logging configuration, the ID of the hosted zone that you want to log queries for, and the ARN for the log group that you want Amazon Route 53 to send query logs to.

  • location :: Text

    The unique URL representing the new query logging configuration.

Instances

Instances details
Eq CreateQueryLoggingConfigResponse Source # 
Instance details

Defined in Amazonka.Route53.CreateQueryLoggingConfig

Read CreateQueryLoggingConfigResponse Source # 
Instance details

Defined in Amazonka.Route53.CreateQueryLoggingConfig

Show CreateQueryLoggingConfigResponse Source # 
Instance details

Defined in Amazonka.Route53.CreateQueryLoggingConfig

Generic CreateQueryLoggingConfigResponse Source # 
Instance details

Defined in Amazonka.Route53.CreateQueryLoggingConfig

Associated Types

type Rep CreateQueryLoggingConfigResponse :: Type -> Type #

NFData CreateQueryLoggingConfigResponse Source # 
Instance details

Defined in Amazonka.Route53.CreateQueryLoggingConfig

type Rep CreateQueryLoggingConfigResponse Source # 
Instance details

Defined in Amazonka.Route53.CreateQueryLoggingConfig

type Rep CreateQueryLoggingConfigResponse = D1 ('MetaData "CreateQueryLoggingConfigResponse" "Amazonka.Route53.CreateQueryLoggingConfig" "libZSservicesZSamazonka-route53ZSamazonka-route53" 'False) (C1 ('MetaCons "CreateQueryLoggingConfigResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "queryLoggingConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 QueryLoggingConfig) :*: S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateQueryLoggingConfigResponse Source #

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

$sel:queryLoggingConfig:CreateQueryLoggingConfigResponse', createQueryLoggingConfigResponse_queryLoggingConfig - A complex type that contains the ID for a query logging configuration, the ID of the hosted zone that you want to log queries for, and the ARN for the log group that you want Amazon Route 53 to send query logs to.

$sel:location:CreateQueryLoggingConfigResponse', createQueryLoggingConfigResponse_location - The unique URL representing the new query logging configuration.

Response Lenses

createQueryLoggingConfigResponse_queryLoggingConfig :: Lens' CreateQueryLoggingConfigResponse QueryLoggingConfig Source #

A complex type that contains the ID for a query logging configuration, the ID of the hosted zone that you want to log queries for, and the ARN for the log group that you want Amazon Route 53 to send query logs to.

createQueryLoggingConfigResponse_location :: Lens' CreateQueryLoggingConfigResponse Text Source #

The unique URL representing the new query logging configuration.