github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/route53/queryLog.go

// Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***

package route53

import (
	"context"
	"reflect"

	"errors"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

// 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](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/query-logs.html?console_help=true#query-logs-configuring) for additional details.
//
// ## Example Usage
//
// <!--Start PulumiCodeChooser -->
// ```go
// 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
//		})
//	}
//
// ```
// <!--End PulumiCodeChooser -->
//
// ## Import
//
// Using `pulumi import`, import Route53 query logging configurations using their ID. For example:
//
// ```sh
// $ pulumi import aws:route53/queryLog:QueryLog example_com xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
// ```
type QueryLog struct {
	pulumi.CustomResourceState

	// The Amazon Resource Name (ARN) of the Query Logging Config.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// CloudWatch log group ARN to send query logs.
	CloudwatchLogGroupArn pulumi.StringOutput `pulumi:"cloudwatchLogGroupArn"`
	// Route53 hosted zone ID to enable query logs.
	ZoneId pulumi.StringOutput `pulumi:"zoneId"`
}

// NewQueryLog registers a new resource with the given unique name, arguments, and options.
func NewQueryLog(ctx *pulumi.Context,
	name string, args *QueryLogArgs, opts ...pulumi.ResourceOption) (*QueryLog, error) {
	if args == nil {
		return nil, errors.New("missing one or more required arguments")
	}

	if args.CloudwatchLogGroupArn == nil {
		return nil, errors.New("invalid value for required argument 'CloudwatchLogGroupArn'")
	}
	if args.ZoneId == nil {
		return nil, errors.New("invalid value for required argument 'ZoneId'")
	}
	opts = internal.PkgResourceDefaultOpts(opts)
	var resource QueryLog
	err := ctx.RegisterResource("aws:route53/queryLog:QueryLog", name, args, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// GetQueryLog gets an existing QueryLog resource's state with the given name, ID, and optional
// state properties that are used to uniquely qualify the lookup (nil if not required).
func GetQueryLog(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *QueryLogState, opts ...pulumi.ResourceOption) (*QueryLog, error) {
	var resource QueryLog
	err := ctx.ReadResource("aws:route53/queryLog:QueryLog", name, id, state, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// Input properties used for looking up and filtering QueryLog resources.
type queryLogState struct {
	// The Amazon Resource Name (ARN) of the Query Logging Config.
	Arn *string `pulumi:"arn"`
	// CloudWatch log group ARN to send query logs.
	CloudwatchLogGroupArn *string `pulumi:"cloudwatchLogGroupArn"`
	// Route53 hosted zone ID to enable query logs.
	ZoneId *string `pulumi:"zoneId"`
}

type QueryLogState struct {
	// The Amazon Resource Name (ARN) of the Query Logging Config.
	Arn pulumi.StringPtrInput
	// CloudWatch log group ARN to send query logs.
	CloudwatchLogGroupArn pulumi.StringPtrInput
	// Route53 hosted zone ID to enable query logs.
	ZoneId pulumi.StringPtrInput
}

func (QueryLogState) ElementType() reflect.Type {
	return reflect.TypeOf((*queryLogState)(nil)).Elem()
}

type queryLogArgs struct {
	// CloudWatch log group ARN to send query logs.
	CloudwatchLogGroupArn string `pulumi:"cloudwatchLogGroupArn"`
	// Route53 hosted zone ID to enable query logs.
	ZoneId string `pulumi:"zoneId"`
}

// The set of arguments for constructing a QueryLog resource.
type QueryLogArgs struct {
	// CloudWatch log group ARN to send query logs.
	CloudwatchLogGroupArn pulumi.StringInput
	// Route53 hosted zone ID to enable query logs.
	ZoneId pulumi.StringInput
}

func (QueryLogArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*queryLogArgs)(nil)).Elem()
}

type QueryLogInput interface {
	pulumi.Input

	ToQueryLogOutput() QueryLogOutput
	ToQueryLogOutputWithContext(ctx context.Context) QueryLogOutput
}

func (*QueryLog) ElementType() reflect.Type {
	return reflect.TypeOf((**QueryLog)(nil)).Elem()
}

func (i *QueryLog) ToQueryLogOutput() QueryLogOutput {
	return i.ToQueryLogOutputWithContext(context.Background())
}

func (i *QueryLog) ToQueryLogOutputWithContext(ctx context.Context) QueryLogOutput {
	return pulumi.ToOutputWithContext(ctx, i).(QueryLogOutput)
}

// QueryLogArrayInput is an input type that accepts QueryLogArray and QueryLogArrayOutput values.
// You can construct a concrete instance of `QueryLogArrayInput` via:
//
//	QueryLogArray{ QueryLogArgs{...} }
type QueryLogArrayInput interface {
	pulumi.Input

	ToQueryLogArrayOutput() QueryLogArrayOutput
	ToQueryLogArrayOutputWithContext(context.Context) QueryLogArrayOutput
}

type QueryLogArray []QueryLogInput

func (QueryLogArray) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*QueryLog)(nil)).Elem()
}

func (i QueryLogArray) ToQueryLogArrayOutput() QueryLogArrayOutput {
	return i.ToQueryLogArrayOutputWithContext(context.Background())
}

func (i QueryLogArray) ToQueryLogArrayOutputWithContext(ctx context.Context) QueryLogArrayOutput {
	return pulumi.ToOutputWithContext(ctx, i).(QueryLogArrayOutput)
}

// QueryLogMapInput is an input type that accepts QueryLogMap and QueryLogMapOutput values.
// You can construct a concrete instance of `QueryLogMapInput` via:
//
//	QueryLogMap{ "key": QueryLogArgs{...} }
type QueryLogMapInput interface {
	pulumi.Input

	ToQueryLogMapOutput() QueryLogMapOutput
	ToQueryLogMapOutputWithContext(context.Context) QueryLogMapOutput
}

type QueryLogMap map[string]QueryLogInput

func (QueryLogMap) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*QueryLog)(nil)).Elem()
}

func (i QueryLogMap) ToQueryLogMapOutput() QueryLogMapOutput {
	return i.ToQueryLogMapOutputWithContext(context.Background())
}

func (i QueryLogMap) ToQueryLogMapOutputWithContext(ctx context.Context) QueryLogMapOutput {
	return pulumi.ToOutputWithContext(ctx, i).(QueryLogMapOutput)
}

type QueryLogOutput struct{ *pulumi.OutputState }

func (QueryLogOutput) ElementType() reflect.Type {
	return reflect.TypeOf((**QueryLog)(nil)).Elem()
}

func (o QueryLogOutput) ToQueryLogOutput() QueryLogOutput {
	return o
}

func (o QueryLogOutput) ToQueryLogOutputWithContext(ctx context.Context) QueryLogOutput {
	return o
}

// The Amazon Resource Name (ARN) of the Query Logging Config.
func (o QueryLogOutput) Arn() pulumi.StringOutput {
	return o.ApplyT(func(v *QueryLog) pulumi.StringOutput { return v.Arn }).(pulumi.StringOutput)
}

// CloudWatch log group ARN to send query logs.
func (o QueryLogOutput) CloudwatchLogGroupArn() pulumi.StringOutput {
	return o.ApplyT(func(v *QueryLog) pulumi.StringOutput { return v.CloudwatchLogGroupArn }).(pulumi.StringOutput)
}

// Route53 hosted zone ID to enable query logs.
func (o QueryLogOutput) ZoneId() pulumi.StringOutput {
	return o.ApplyT(func(v *QueryLog) pulumi.StringOutput { return v.ZoneId }).(pulumi.StringOutput)
}

type QueryLogArrayOutput struct{ *pulumi.OutputState }

func (QueryLogArrayOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*QueryLog)(nil)).Elem()
}

func (o QueryLogArrayOutput) ToQueryLogArrayOutput() QueryLogArrayOutput {
	return o
}

func (o QueryLogArrayOutput) ToQueryLogArrayOutputWithContext(ctx context.Context) QueryLogArrayOutput {
	return o
}

func (o QueryLogArrayOutput) Index(i pulumi.IntInput) QueryLogOutput {
	return pulumi.All(o, i).ApplyT(func(vs []interface{}) *QueryLog {
		return vs[0].([]*QueryLog)[vs[1].(int)]
	}).(QueryLogOutput)
}

type QueryLogMapOutput struct{ *pulumi.OutputState }

func (QueryLogMapOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*QueryLog)(nil)).Elem()
}

func (o QueryLogMapOutput) ToQueryLogMapOutput() QueryLogMapOutput {
	return o
}

func (o QueryLogMapOutput) ToQueryLogMapOutputWithContext(ctx context.Context) QueryLogMapOutput {
	return o
}

func (o QueryLogMapOutput) MapIndex(k pulumi.StringInput) QueryLogOutput {
	return pulumi.All(o, k).ApplyT(func(vs []interface{}) *QueryLog {
		return vs[0].(map[string]*QueryLog)[vs[1].(string)]
	}).(QueryLogOutput)
}

func init() {
	pulumi.RegisterInputType(reflect.TypeOf((*QueryLogInput)(nil)).Elem(), &QueryLog{})
	pulumi.RegisterInputType(reflect.TypeOf((*QueryLogArrayInput)(nil)).Elem(), QueryLogArray{})
	pulumi.RegisterInputType(reflect.TypeOf((*QueryLogMapInput)(nil)).Elem(), QueryLogMap{})
	pulumi.RegisterOutputType(QueryLogOutput{})
	pulumi.RegisterOutputType(QueryLogArrayOutput{})
	pulumi.RegisterOutputType(QueryLogMapOutput{})
}