LogDeliveryDestination class

Resource for managing an AWS CloudWatch Logs Delivery Destination.

Example Usage

Basic Usage

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

const example = new aws.cloudwatch.LogDeliveryDestination("example", {
    deliveryDestinationConfiguration: {
        destinationResourceArn: exampleAwsCloudwatchLogGroup.arn,
    },
    name: "example",
});

import pulumi
import pulumi_aws as aws

example = aws.cloudwatch.LogDeliveryDestination("example",
    delivery_destination_configuration={
        "destination_resource_arn": example_aws_cloudwatch_log_group["arn"],
    },
    name="example")

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

return await Deployment.RunAsync(() =>
{
    var example = new Aws.CloudWatch.LogDeliveryDestination("example", new()
    {
        DeliveryDestinationConfiguration = new Aws.CloudWatch.Inputs.LogDeliveryDestinationDeliveryDestinationConfigurationArgs
        {
            DestinationResourceArn = exampleAwsCloudwatchLogGroup.Arn,
        },
        Name = "example",
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cloudwatch"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudwatch.NewLogDeliveryDestination(ctx, "example", &cloudwatch.LogDeliveryDestinationArgs{
			DeliveryDestinationConfiguration: &cloudwatch.LogDeliveryDestinationDeliveryDestinationConfigurationArgs{
				DestinationResourceArn: pulumi.Any(exampleAwsCloudwatchLogGroup.Arn),
			},
			Name: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_cloudwatch_logdeliverydestination" "example" {
  delivery_destination_configuration = {
    destination_resource_arn = exampleAwsCloudwatchLogGroup.arn
  }
  name = "example"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudwatch.LogDeliveryDestination;
import com.pulumi.aws.cloudwatch.LogDeliveryDestinationArgs;
import com.pulumi.aws.cloudwatch.inputs.LogDeliveryDestinationDeliveryDestinationConfigurationArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
        var example = new LogDeliveryDestination("example", LogDeliveryDestinationArgs.builder()
            .deliveryDestinationConfiguration(LogDeliveryDestinationDeliveryDestinationConfigurationArgs.builder()
                .destinationResourceArn(exampleAwsCloudwatchLogGroup.arn())
                .build())
            .name("example")
            .build());

    }
}

resources:
  example:
    type: aws:cloudwatch:LogDeliveryDestination
    properties:
      deliveryDestinationConfiguration:
        destinationResourceArn: ${exampleAwsCloudwatchLogGroup.arn}
      name: example

X-Ray Trace Delivery

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

const xray = new aws.cloudwatch.LogDeliveryDestination("xray", {
    name: "xray-traces",
    deliveryDestinationType: "XRAY",
});

import pulumi
import pulumi_aws as aws

xray = aws.cloudwatch.LogDeliveryDestination("xray",
    name="xray-traces",
    delivery_destination_type="XRAY")

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

return await Deployment.RunAsync(() =>
{
    var xray = new Aws.CloudWatch.LogDeliveryDestination("xray", new()
    {
        Name = "xray-traces",
        DeliveryDestinationType = "XRAY",
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cloudwatch"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudwatch.NewLogDeliveryDestination(ctx, "xray", &cloudwatch.LogDeliveryDestinationArgs{
			Name:                    pulumi.String("xray-traces"),
			DeliveryDestinationType: pulumi.String("XRAY"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_cloudwatch_logdeliverydestination" "xray" {
  name                      = "xray-traces"
  delivery_destination_type = "XRAY"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudwatch.LogDeliveryDestination;
import com.pulumi.aws.cloudwatch.LogDeliveryDestinationArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
        var xray = new LogDeliveryDestination("xray", LogDeliveryDestinationArgs.builder()
            .name("xray-traces")
            .deliveryDestinationType("XRAY")
            .build());

    }
}

resources:
  xray:
    type: aws:cloudwatch:LogDeliveryDestination
    properties:
      name: xray-traces
      deliveryDestinationType: XRAY

Import

Identity Schema

Required

  • name (String) Name of the delivery destination.

Optional

  • accountId (String) AWS Account where this resource is managed.
  • region (String) Region where this resource is managed.

Using pulumi import, import Delivery Destinations using name. For example:

$ pulumi import aws:cloudwatch/logDeliveryDestination:LogDeliveryDestination example example

Constructors

LogDeliveryDestination(String name, {LogDeliveryDestinationArgs? args, CustomResourceOptions? options})
Creates a new LogDeliveryDestination. name The Pulumi resource name. args Arguments used to configure this LogDeliveryDestination. The set of arguments for LogDeliveryDestination. options Resource options controlling this resource's behavior.
LogDeliveryDestination.reference(String urn)
Creates a typed reference to an existing LogDeliveryDestination resource.

Properties

arn ↔ Output<String>
ARN of the delivery destination.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
deliveryDestinationConfiguration ↔ Output<LogDeliveryDestinationDeliveryDestinationConfiguration?>
The AWS resource that will receive the logs. Required for CloudWatch Logs, Amazon S3, and Firehose destinations. Not required for X-Ray trace delivery destinations.
latefinal
deliveryDestinationType ↔ Output<String>
The type of delivery destination. Valid values: S3, CWL, FH, XRAY. Required for X-Ray trace delivery destinations. For other destination types, this is computed from the destinationResourceArn.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>
The name for this delivery destination.
latefinal
outputFormat ↔ Output<String?>
The format of the logs that are sent to this delivery destination. Valid values: json, plain, w3c, raw, parquet.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, String>?>
A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {LogDeliveryDestinationState? state, CustomResourceOptions? options}) → LogDeliveryDestination
Gets an existing LogDeliveryDestination resource's state with the given name and id.