Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. route53
  5. QueryLog
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.route53.QueryLog

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Provides a Route53 query logging configuration resource.

    NOTE: There are restrictions on the configuration of query logging. Notably, the CloudWatch log group must be in the us-east-1 region, a permissive CloudWatch log resource policy must be in place, and the Route53 hosted zone must be public. See Configuring Logging for DNS Queries for additional details.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

// Example Route53 zone with query logging
const exampleCom = new aws.route53.Zone("example_com", {name: "example.com"});
const awsRoute53ExampleCom = new aws.cloudwatch.LogGroup("aws_route53_example_com", {
    name: pulumi.interpolate`/aws/route53/${exampleCom.name}`,
    retentionInDays: 30,
});
// Example CloudWatch log resource policy to allow Route53 to write logs
// to any log group under /aws/route53/*
const route53-query-logging-policy = aws.iam.getPolicyDocument({
    statements: [{
        actions: [
            "logs:CreateLogStream",
            "logs:PutLogEvents",
        ],
        resources: ["arn:aws:logs:*:*:log-group:/aws/route53/*"],
        principals: [{
            identifiers: ["route53.amazonaws.com"],
            type: "Service",
        }],
    }],
});
const route53_query_logging_policyLogResourcePolicy = new aws.cloudwatch.LogResourcePolicy("route53-query-logging-policy", {
    policyDocument: route53_query_logging_policy.then(route53_query_logging_policy => route53_query_logging_policy.json),
    policyName: "route53-query-logging-policy",
});
const exampleComQueryLog = new aws.route53.QueryLog("example_com", {
    cloudwatchLogGroupArn: awsRoute53ExampleCom.arn,
    zoneId: exampleCom.zoneId,
}, {
    dependsOn: [route53_query_logging_policyLogResourcePolicy],
});

    import pulumi
import pulumi_aws as aws

# Example Route53 zone with query logging
example_com = aws.route53.Zone("example_com", name="example.com")
aws_route53_example_com = aws.cloudwatch.LogGroup("aws_route53_example_com",
    name=example_com.name.apply(lambda name: f"/aws/route53/{name}"),
    retention_in_days=30)
# Example CloudWatch log resource policy to allow Route53 to write logs
# to any log group under /aws/route53/*
route53_query_logging_policy = aws.iam.get_policy_document(statements=[{
    "actions": [
        "logs:CreateLogStream",
        "logs:PutLogEvents",
    ],
    "resources": ["arn:aws:logs:*:*:log-group:/aws/route53/*"],
    "principals": [{
        "identifiers": ["route53.amazonaws.com"],
        "type": "Service",
    }],
}])
route53_query_logging_policy_log_resource_policy = aws.cloudwatch.LogResourcePolicy("route53-query-logging-policy",
    policy_document=route53_query_logging_policy.json,
    policy_name="route53-query-logging-policy")
example_com_query_log = aws.route53.QueryLog("example_com",
    cloudwatch_log_group_arn=aws_route53_example_com.arn,
    zone_id=example_com.zone_id,
    opts = pulumi.ResourceOptions(depends_on=[route53_query_logging_policy_log_resource_policy]))

    package main

import (
	"fmt"

	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cloudwatch"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iam"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/route53"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Example Route53 zone with query logging
		exampleCom, err := route53.NewZone(ctx, "example_com", &route53.ZoneArgs{
			Name: pulumi.String("example.com"),
		})
		if err != nil {
			return err
		}
		awsRoute53ExampleCom, err := cloudwatch.NewLogGroup(ctx, "aws_route53_example_com", &cloudwatch.LogGroupArgs{
			Name: exampleCom.Name.ApplyT(func(name string) (string, error) {
				return fmt.Sprintf("/aws/route53/%v", name), nil
			}).(pulumi.StringOutput),
			RetentionInDays: pulumi.Int(30),
		})
		if err != nil {
			return err
		}
		// Example CloudWatch log resource policy to allow Route53 to write logs
		// to any log group under /aws/route53/*
		route53_query_logging_policy, err := iam.GetPolicyDocument(ctx, &iam.GetPolicyDocumentArgs{
			Statements: []iam.GetPolicyDocumentStatement{
				{
					Actions: []string{
						"logs:CreateLogStream",
						"logs:PutLogEvents",
					},
					Resources: []string{
						"arn:aws:logs:*:*:log-group:/aws/route53/*",
					},
					Principals: []iam.GetPolicyDocumentStatementPrincipal{
						{
							Identifiers: []string{
								"route53.amazonaws.com",
							},
							Type: "Service",
						},
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = cloudwatch.NewLogResourcePolicy(ctx, "route53-query-logging-policy", &cloudwatch.LogResourcePolicyArgs{
			PolicyDocument: pulumi.String(route53_query_logging_policy.Json),
			PolicyName:     pulumi.String("route53-query-logging-policy"),
		})
		if err != nil {
			return err
		}
		_, err = route53.NewQueryLog(ctx, "example_com", &route53.QueryLogArgs{
			CloudwatchLogGroupArn: awsRoute53ExampleCom.Arn,
			ZoneId:                exampleCom.ZoneId,
		}, pulumi.DependsOn([]pulumi.Resource{
			route53_query_logging_policyLogResourcePolicy,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    // Example Route53 zone with query logging
    var exampleCom = new Aws.Route53.Zone("example_com", new()
    {
        Name = "example.com",
    });

    var awsRoute53ExampleCom = new Aws.CloudWatch.LogGroup("aws_route53_example_com", new()
    {
        Name = exampleCom.Name.Apply(name => $"/aws/route53/{name}"),
        RetentionInDays = 30,
    });

    // Example CloudWatch log resource policy to allow Route53 to write logs
    // to any log group under /aws/route53/*
    var route53_query_logging_policy = Aws.Iam.GetPolicyDocument.Invoke(new()
    {
        Statements = new[]
        {
            new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
            {
                Actions = new[]
                {
                    "logs:CreateLogStream",
                    "logs:PutLogEvents",
                },
                Resources = new[]
                {
                    "arn:aws:logs:*:*:log-group:/aws/route53/*",
                },
                Principals = new[]
                {
                    new Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalInputArgs
                    {
                        Identifiers = new[]
                        {
                            "route53.amazonaws.com",
                        },
                        Type = "Service",
                    },
                },
            },
        },
    });

    var route53_query_logging_policyLogResourcePolicy = new Aws.CloudWatch.LogResourcePolicy("route53-query-logging-policy", new()
    {
        PolicyDocument = route53_query_logging_policy.Apply(route53_query_logging_policy => route53_query_logging_policy.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json)),
        PolicyName = "route53-query-logging-policy",
    });

    var exampleComQueryLog = new Aws.Route53.QueryLog("example_com", new()
    {
        CloudwatchLogGroupArn = awsRoute53ExampleCom.Arn,
        ZoneId = exampleCom.ZoneId,
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            route53_query_logging_policyLogResourcePolicy,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.route53.Zone;
import com.pulumi.aws.route53.ZoneArgs;
import com.pulumi.aws.cloudwatch.LogGroup;
import com.pulumi.aws.cloudwatch.LogGroupArgs;
import com.pulumi.aws.iam.IamFunctions;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs;
import com.pulumi.aws.cloudwatch.LogResourcePolicy;
import com.pulumi.aws.cloudwatch.LogResourcePolicyArgs;
import com.pulumi.aws.route53.QueryLog;
import com.pulumi.aws.route53.QueryLogArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // Example Route53 zone with query logging
        var exampleCom = new Zone("exampleCom", ZoneArgs.builder()
            .name("example.com")
            .build());

        var awsRoute53ExampleCom = new LogGroup("awsRoute53ExampleCom", LogGroupArgs.builder()
            .name(exampleCom.name().applyValue(name -> String.format("/aws/route53/%s", name)))
            .retentionInDays(30)
            .build());

        // Example CloudWatch log resource policy to allow Route53 to write logs
        // to any log group under /aws/route53/*
        final var route53-query-logging-policy = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
            .statements(GetPolicyDocumentStatementArgs.builder()
                .actions(                
                    "logs:CreateLogStream",
                    "logs:PutLogEvents")
                .resources("arn:aws:logs:*:*:log-group:/aws/route53/*")
                .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
                    .identifiers("route53.amazonaws.com")
                    .type("Service")
                    .build())
                .build())
            .build());

        var route53_query_logging_policyLogResourcePolicy = new LogResourcePolicy("route53-query-logging-policyLogResourcePolicy", LogResourcePolicyArgs.builder()
            .policyDocument(route53_query_logging_policy.json())
            .policyName("route53-query-logging-policy")
            .build());

        var exampleComQueryLog = new QueryLog("exampleComQueryLog", QueryLogArgs.builder()
            .cloudwatchLogGroupArn(awsRoute53ExampleCom.arn())
            .zoneId(exampleCom.zoneId())
            .build(), CustomResourceOptions.builder()
                .dependsOn(route53_query_logging_policyLogResourcePolicy)
                .build());

    }
}

    resources:
  awsRoute53ExampleCom:
    type: aws:cloudwatch:LogGroup
    name: aws_route53_example_com
    properties:
      name: /aws/route53/${exampleCom.name}
      retentionInDays: 30
  route53-query-logging-policyLogResourcePolicy:
    type: aws:cloudwatch:LogResourcePolicy
    name: route53-query-logging-policy
    properties:
      policyDocument: ${["route53-query-logging-policy"].json}
      policyName: route53-query-logging-policy
  # Example Route53 zone with query logging
  exampleCom:
    type: aws:route53:Zone
    name: example_com
    properties:
      name: example.com
  exampleComQueryLog:
    type: aws:route53:QueryLog
    name: example_com
    properties:
      cloudwatchLogGroupArn: ${awsRoute53ExampleCom.arn}
      zoneId: ${exampleCom.zoneId}
    options:
      dependson:
        - ${["route53-query-logging-policyLogResourcePolicy"]}
variables:
  # Example CloudWatch log resource policy to allow Route53 to write logs
  # to any log group under /aws/route53/*
  route53-query-logging-policy:
    fn::invoke:
      Function: aws:iam:getPolicyDocument
      Arguments:
        statements:
          - actions:
              - logs:CreateLogStream
              - logs:PutLogEvents
            resources:
              - arn:aws:logs:*:*:log-group:/aws/route53/*
            principals:
              - identifiers:
                  - route53.amazonaws.com
                type: Service

    Create QueryLog Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new QueryLog(name: string, args: QueryLogArgs, opts?: CustomResourceOptions);
    @overload
def QueryLog(resource_name: str,
             args: QueryLogArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def QueryLog(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             cloudwatch_log_group_arn: Optional[str] = None,
             zone_id: Optional[str] = None)
    func NewQueryLog(ctx *Context, name string, args QueryLogArgs, opts ...ResourceOption) (*QueryLog, error)
    public QueryLog(string name, QueryLogArgs args, CustomResourceOptions? opts = null)
    public QueryLog(String name, QueryLogArgs args)
public QueryLog(String name, QueryLogArgs args, CustomResourceOptions options)

    type: aws:route53:QueryLog
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args QueryLogArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args QueryLogArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args QueryLogArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args QueryLogArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args QueryLogArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var queryLogResource = new Aws.Route53.QueryLog("queryLogResource", new()
{
    CloudwatchLogGroupArn = "string",
    ZoneId = "string",
});

    example, err := route53.NewQueryLog(ctx, "queryLogResource", &route53.QueryLogArgs{
	CloudwatchLogGroupArn: pulumi.String("string"),
	ZoneId:                pulumi.String("string"),
})

    var queryLogResource = new QueryLog("queryLogResource", QueryLogArgs.builder()
    .cloudwatchLogGroupArn("string")
    .zoneId("string")
    .build());

    query_log_resource = aws.route53.QueryLog("queryLogResource",
    cloudwatch_log_group_arn="string",
    zone_id="string")

    const queryLogResource = new aws.route53.QueryLog("queryLogResource", {
    cloudwatchLogGroupArn: "string",
    zoneId: "string",
});

    type: aws:route53:QueryLog
properties:
    cloudwatchLogGroupArn: string
    zoneId: string

    QueryLog Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The QueryLog resource accepts the following input properties:

    CloudwatchLogGroupArn string
    CloudWatch log group ARN to send query logs.
    ZoneId string
    Route53 hosted zone ID to enable query logs.
    CloudwatchLogGroupArn string
    CloudWatch log group ARN to send query logs.
    ZoneId string
    Route53 hosted zone ID to enable query logs.
    cloudwatchLogGroupArn String
    CloudWatch log group ARN to send query logs.
    zoneId String
    Route53 hosted zone ID to enable query logs.
    cloudwatchLogGroupArn string
    CloudWatch log group ARN to send query logs.
    zoneId string
    Route53 hosted zone ID to enable query logs.
    cloudwatch_log_group_arn str
    CloudWatch log group ARN to send query logs.
    zone_id str
    Route53 hosted zone ID to enable query logs.
    cloudwatchLogGroupArn String
    CloudWatch log group ARN to send query logs.
    zoneId String
    Route53 hosted zone ID to enable query logs.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the QueryLog resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) of the Query Logging Config.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The Amazon Resource Name (ARN) of the Query Logging Config.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the Query Logging Config.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The Amazon Resource Name (ARN) of the Query Logging Config.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The Amazon Resource Name (ARN) of the Query Logging Config.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the Query Logging Config.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing QueryLog Resource

    Get an existing QueryLog resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: QueryLogState, opts?: CustomResourceOptions): QueryLog
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        cloudwatch_log_group_arn: Optional[str] = None,
        zone_id: Optional[str] = None) -> QueryLog
    func GetQueryLog(ctx *Context, name string, id IDInput, state *QueryLogState, opts ...ResourceOption) (*QueryLog, error)
    public static QueryLog Get(string name, Input<string> id, QueryLogState? state, CustomResourceOptions? opts = null)
    public static QueryLog get(String name, Output<String> id, QueryLogState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    The Amazon Resource Name (ARN) of the Query Logging Config.
    CloudwatchLogGroupArn string
    CloudWatch log group ARN to send query logs.
    ZoneId string
    Route53 hosted zone ID to enable query logs.
    Arn string
    The Amazon Resource Name (ARN) of the Query Logging Config.
    CloudwatchLogGroupArn string
    CloudWatch log group ARN to send query logs.
    ZoneId string
    Route53 hosted zone ID to enable query logs.
    arn String
    The Amazon Resource Name (ARN) of the Query Logging Config.
    cloudwatchLogGroupArn String
    CloudWatch log group ARN to send query logs.
    zoneId String
    Route53 hosted zone ID to enable query logs.
    arn string
    The Amazon Resource Name (ARN) of the Query Logging Config.
    cloudwatchLogGroupArn string
    CloudWatch log group ARN to send query logs.
    zoneId string
    Route53 hosted zone ID to enable query logs.
    arn str
    The Amazon Resource Name (ARN) of the Query Logging Config.
    cloudwatch_log_group_arn str
    CloudWatch log group ARN to send query logs.
    zone_id str
    Route53 hosted zone ID to enable query logs.
    arn String
    The Amazon Resource Name (ARN) of the Query Logging Config.
    cloudwatchLogGroupArn String
    CloudWatch log group ARN to send query logs.
    zoneId String
    Route53 hosted zone ID to enable query logs.

    Import

    Using pulumi import, import Route53 query logging configurations using their ID. For example:

    $ pulumi import aws:route53/queryLog:QueryLog example_com xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws