2017/09/07 - Amazon Route 53 - 4 new api methods
Changes You can configure Amazon Route 53 to log information about the DNS queries that Amazon Route 53 receives for your domains and subdomains. When you configure query logging, Amazon Route 53 starts to send logs to CloudWatch Logs. You can use various tools, including the AWS console, to access the query logs.
Deletes a configuration for DNS query logging. If you delete a configuration, Amazon Route 53 stops sending query logs to CloudWatch Logs. Amazon Route 53 doesn't delete any logs that are already in CloudWatch Logs.
For more information about DNS query logs, see CreateQueryLoggingConfig .
See also: AWS API Documentation
Request Syntax
client.delete_query_logging_config(
Id='string'
)
string
[REQUIRED]
The ID of the configuration that you want to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Gets information about a specified configuration for DNS query logging.
For more information about DNS query logs, see CreateQueryLoggingConfig and Logging DNS Queries .
See also: AWS API Documentation
Request Syntax
client.get_query_logging_config(
Id='string'
)
string
[REQUIRED]
The ID of the configuration for DNS query logging that you want to get information about.
dict
Response Syntax
{
'QueryLoggingConfig': {
'Id': 'string',
'HostedZoneId': 'string',
'CloudWatchLogsLogGroupArn': 'string'
}
}
Response Structure
(dict) --
QueryLoggingConfig (dict) --
A complex type that contains information about the query logging configuration that you specified in a GetQueryLoggingConfig request.
Id (string) --
The ID for a configuration for DNS query logging.
HostedZoneId (string) --
The ID of the hosted zone that CloudWatch Logs is logging queries for.
CloudWatchLogsLogGroupArn (string) --
The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to.
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 Amazon Route 53 receives for a specified public hosted zone, such as the following:
Amazon 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.
Note
If you create a query logging configuration using the Amazon Route 53 console, Amazon Route 53 performs these operations automatically.
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 AWS 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 AWS resources, such as Amazon 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.
Create a CloudWatch Logs resource policy, and give it the permissions that Amazon Route 53 needs to create log streams and to 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/*
Note
You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the AWS SDKs, or the AWS CLI.
Log Streams and Edge Locations
When Amazon 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 Amazon 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 Amazon Route 53 Global Network" on the Amazon Route 53 Product Details page.
Queries That Are Logged
Query logs contain only the queries that DNS resolvers forward to Amazon 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 Amazon 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 Amazon Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig .
See also: AWS API Documentation
Request Syntax
client.create_query_logging_config(
HostedZoneId='string',
CloudWatchLogsLogGroupArn='string'
)
string
[REQUIRED]
The ID of the hosted zone that you want to log queries for. You can log queries only for public hosted zones.
string
[REQUIRED]
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 AWS SDKs.
dict
Response Syntax
{
'QueryLoggingConfig': {
'Id': 'string',
'HostedZoneId': 'string',
'CloudWatchLogsLogGroupArn': 'string'
},
'Location': 'string'
}
Response Structure
(dict) --
QueryLoggingConfig (dict) --
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.
Id (string) --
The ID for a configuration for DNS query logging.
HostedZoneId (string) --
The ID of the hosted zone that CloudWatch Logs is logging queries for.
CloudWatchLogsLogGroupArn (string) --
The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to.
Location (string) --
The unique URL representing the new query logging configuration.
Lists the configurations for DNS query logging that are associated with the current AWS account or the configuration that is associated with a specified hosted zone.
For more information about DNS query logs, see CreateQueryLoggingConfig . Additional information, including the format of DNS query logs, appears in Logging DNS Queries in the Amazon Route 53 Developer Guide .
See also: AWS API Documentation
Request Syntax
client.list_query_logging_configs(
HostedZoneId='string',
NextToken='string',
MaxResults='string'
)
string
(Optional) If you want to list the query logging configuration that is associated with a hosted zone, specify the ID in HostedZoneId .
If you don't specify a hosted zone ID, ListQueryLoggingConfigs returns all of the configurations that are associated with the current AWS account.
string
(Optional) If the current AWS account has more than MaxResults query logging configurations, use NextToken to get the second and subsequent pages of results.
For the first ListQueryLoggingConfigs request, omit this value.
For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.
string
(Optional) The maximum number of query logging configurations that you want Amazon Route 53 to return in response to the current request. If the current AWS account has more than MaxResults configurations, use the value of ListQueryLoggingConfigsResponse$NextToken in the response to get the next page of results.
If you don't specify a value for MaxResults , Amazon Route 53 returns up to 100 configurations.
dict
Response Syntax
{
'QueryLoggingConfigs': [
{
'Id': 'string',
'HostedZoneId': 'string',
'CloudWatchLogsLogGroupArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
QueryLoggingConfigs (list) --
An array that contains one QueryLoggingConfig element for each configuration for DNS query logging that is associated with the current AWS account.
(dict) --
A complex type that contains information about a configuration for DNS query logging.
Id (string) --
The ID for a configuration for DNS query logging.
HostedZoneId (string) --
The ID of the hosted zone that CloudWatch Logs is logging queries for.
CloudWatchLogsLogGroupArn (string) --
The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to.
NextToken (string) --
If a response includes the last of the query logging configurations that are associated with the current AWS account, NextToken doesn't appear in the response.
If a response doesn't include the last of the configurations, you can get more configurations by submitting another ListQueryLoggingConfigs request. Get the value of NextToken that Amazon Route 53 returned in the previous response and include it in NextToken in the next request.