Link class

Resource for managing an AWS CloudWatch Observability Access Manager Link.

> NOTE: Creating an aws.oam.Link may sometimes fail if the aws.oam.SinkPolicy for the attached aws.oam.Sink is not created before the aws.oam.Link. To prevent this, declare an explicit dependency using a dependsOn meta-argument.

Example Usage

Basic Usage

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

const exampleSink = new aws.oam.Sink("example", {});
const exampleSinkPolicy = new aws.oam.SinkPolicy("example", {sinkIdentifier: exampleSink.arn});
const example = new aws.oam.Link("example", {
    labelTemplate: "$AccountName",
    resourceTypes: ["AWS::CloudWatch::Metric"],
    sinkIdentifier: exampleSink.arn,
    tags: {
        Env: "prod",
    },
}, {
    dependsOn: [exampleSinkPolicy],
});
import pulumi
import pulumi_aws as aws

example_sink = aws.oam.Sink("example")
example_sink_policy = aws.oam.SinkPolicy("example", sink_identifier=example_sink.arn)
example = aws.oam.Link("example",
    label_template="$AccountName",
    resource_types=["AWS::CloudWatch::Metric"],
    sink_identifier=example_sink.arn,
    tags={
        "Env": "prod",
    },
    opts = pulumi.ResourceOptions(depends_on=[example_sink_policy]))
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var exampleSink = new Aws.Oam.Sink("example");

    var exampleSinkPolicy = new Aws.Oam.SinkPolicy("example", new()
    {
        SinkIdentifier = exampleSink.Arn,
    });

    var example = new Aws.Oam.Link("example", new()
    {
        LabelTemplate = "$AccountName",
        ResourceTypes = new[]
        {
            "AWS::CloudWatch::Metric",
        },
        SinkIdentifier = exampleSink.Arn,
        Tags =
        {
            { "Env", "prod" },
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            exampleSinkPolicy,
        },
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleSink, err := oam.NewSink(ctx, "example", nil)
		if err != nil {
			return err
		}
		exampleSinkPolicy, err := oam.NewSinkPolicy(ctx, "example", &oam.SinkPolicyArgs{
			SinkIdentifier: exampleSink.Arn,
		})
		if err != nil {
			return err
		}
		_, err = oam.NewLink(ctx, "example", &oam.LinkArgs{
			LabelTemplate: pulumi.String("$AccountName"),
			ResourceTypes: pulumi.StringArray{
				pulumi.String("AWS::CloudWatch::Metric"),
			},
			SinkIdentifier: exampleSink.Arn,
			Tags: pulumi.StringMap{
				"Env": pulumi.String("prod"),
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			exampleSinkPolicy,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_oam_link" "example" {
  depends_on      = [aws_oam_sinkpolicy.example]
  label_template  = "$AccountName"
  resource_types  = ["AWS::CloudWatch::Metric"]
  sink_identifier = aws_oam_sink.example.arn
  tags = {
    "Env" = "prod"
  }
}
resource "aws_oam_sink" "example" {
}
resource "aws_oam_sinkpolicy" "example" {
  sink_identifier = aws_oam_sink.example.arn
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.oam.Sink;
import com.pulumi.aws.oam.SinkPolicy;
import com.pulumi.aws.oam.SinkPolicyArgs;
import com.pulumi.aws.oam.Link;
import com.pulumi.aws.oam.LinkArgs;
import com.pulumi.resources.CustomResourceOptions;
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 exampleSink = new Sink("exampleSink");

        var exampleSinkPolicy = new SinkPolicy("exampleSinkPolicy", SinkPolicyArgs.builder()
            .sinkIdentifier(exampleSink.arn())
            .build());

        var example = new Link("example", LinkArgs.builder()
            .labelTemplate("$AccountName")
            .resourceTypes("AWS::CloudWatch::Metric")
            .sinkIdentifier(exampleSink.arn())
            .tags(Map.of("Env", "prod"))
            .build(), CustomResourceOptions.builder()
                .dependsOn(exampleSinkPolicy)
                .build());

    }
}
resources:
  example:
    type: aws:oam:Link
    properties:
      labelTemplate: $AccountName
      resourceTypes:
        - AWS::CloudWatch::Metric
      sinkIdentifier: ${exampleSink.arn}
      tags:
        Env: prod
    options:
      dependsOn:
        - ${exampleSinkPolicy}
  exampleSink:
    type: aws:oam:Sink
    name: example
  exampleSinkPolicy:
    type: aws:oam:SinkPolicy
    name: example
    properties:
      sinkIdentifier: ${exampleSink.arn}

Log Group Filtering

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

const example = new aws.oam.Link("example", {
    linkConfiguration: {
        logGroupConfiguration: {
            filter: "LogGroupName LIKE 'aws/lambda/%' OR LogGroupName LIKE 'AWSLogs%'",
        },
    },
    labelTemplate: "$AccountName",
    resourceTypes: ["AWS::Logs::LogGroup"],
    sinkIdentifier: exampleAwsOamSink.arn,
}, {
    dependsOn: [exampleAwsOamSinkPolicy],
});
import pulumi
import pulumi_aws as aws

example = aws.oam.Link("example",
    link_configuration={
        "log_group_configuration": {
            "filter": "LogGroupName LIKE 'aws/lambda/%' OR LogGroupName LIKE 'AWSLogs%'",
        },
    },
    label_template="$AccountName",
    resource_types=["AWS::Logs::LogGroup"],
    sink_identifier=example_aws_oam_sink["arn"],
    opts = pulumi.ResourceOptions(depends_on=[example_aws_oam_sink_policy]))
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Oam.Link("example", new()
    {
        LinkConfiguration = new Aws.Oam.Inputs.LinkLinkConfigurationArgs
        {
            LogGroupConfiguration = new Aws.Oam.Inputs.LinkLinkConfigurationLogGroupConfigurationArgs
            {
                Filter = "LogGroupName LIKE 'aws/lambda/%' OR LogGroupName LIKE 'AWSLogs%'",
            },
        },
        LabelTemplate = "$AccountName",
        ResourceTypes = new[]
        {
            "AWS::Logs::LogGroup",
        },
        SinkIdentifier = exampleAwsOamSink.Arn,
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            exampleAwsOamSinkPolicy,
        },
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := oam.NewLink(ctx, "example", &oam.LinkArgs{
			LinkConfiguration: &oam.LinkLinkConfigurationArgs{
				LogGroupConfiguration: &oam.LinkLinkConfigurationLogGroupConfigurationArgs{
					Filter: pulumi.String("LogGroupName LIKE 'aws/lambda/%' OR LogGroupName LIKE 'AWSLogs%'"),
				},
			},
			LabelTemplate: pulumi.String("$AccountName"),
			ResourceTypes: pulumi.StringArray{
				pulumi.String("AWS::Logs::LogGroup"),
			},
			SinkIdentifier: pulumi.Any(exampleAwsOamSink.Arn),
		}, pulumi.DependsOn([]pulumi.Resource{
			exampleAwsOamSinkPolicy,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_oam_link" "example" {
  depends_on = [exampleAwsOamSinkPolicy]
  link_configuration = {
    log_group_configuration = {
      filter = "LogGroupName LIKE 'aws/lambda/%' OR LogGroupName LIKE 'AWSLogs%'"
    }
  }
  label_template  = "$AccountName"
  resource_types  = ["AWS::Logs::LogGroup"]
  sink_identifier = exampleAwsOamSink.arn
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.oam.Link;
import com.pulumi.aws.oam.LinkArgs;
import com.pulumi.aws.oam.inputs.LinkLinkConfigurationArgs;
import com.pulumi.aws.oam.inputs.LinkLinkConfigurationLogGroupConfigurationArgs;
import com.pulumi.resources.CustomResourceOptions;
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 Link("example", LinkArgs.builder()
            .linkConfiguration(LinkLinkConfigurationArgs.builder()
                .logGroupConfiguration(LinkLinkConfigurationLogGroupConfigurationArgs.builder()
                    .filter("LogGroupName LIKE 'aws/lambda/%' OR LogGroupName LIKE 'AWSLogs%'")
                    .build())
                .build())
            .labelTemplate("$AccountName")
            .resourceTypes("AWS::Logs::LogGroup")
            .sinkIdentifier(exampleAwsOamSink.arn())
            .build(), CustomResourceOptions.builder()
                .dependsOn(exampleAwsOamSinkPolicy)
                .build());

    }
}
resources:
  example:
    type: aws:oam:Link
    properties:
      linkConfiguration:
        logGroupConfiguration:
          filter: LogGroupName LIKE 'aws/lambda/%' OR LogGroupName LIKE 'AWSLogs%'
      labelTemplate: $AccountName
      resourceTypes:
        - AWS::Logs::LogGroup
      sinkIdentifier: ${exampleAwsOamSink.arn}
    options:
      dependsOn:
        - ${exampleAwsOamSinkPolicy}

Metric Filtering

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

const example = new aws.oam.Link("example", {
    linkConfiguration: {
        metricConfiguration: {
            filter: "Namespace IN ('AWS/EC2', 'AWS/ELB', 'AWS/S3')",
        },
    },
    labelTemplate: "$AccountName",
    resourceTypes: ["AWS::CloudWatch::Metric"],
    sinkIdentifier: exampleAwsOamSink.arn,
}, {
    dependsOn: [exampleAwsOamSinkPolicy],
});
import pulumi
import pulumi_aws as aws

example = aws.oam.Link("example",
    link_configuration={
        "metric_configuration": {
            "filter": "Namespace IN ('AWS/EC2', 'AWS/ELB', 'AWS/S3')",
        },
    },
    label_template="$AccountName",
    resource_types=["AWS::CloudWatch::Metric"],
    sink_identifier=example_aws_oam_sink["arn"],
    opts = pulumi.ResourceOptions(depends_on=[example_aws_oam_sink_policy]))
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Oam.Link("example", new()
    {
        LinkConfiguration = new Aws.Oam.Inputs.LinkLinkConfigurationArgs
        {
            MetricConfiguration = new Aws.Oam.Inputs.LinkLinkConfigurationMetricConfigurationArgs
            {
                Filter = "Namespace IN ('AWS/EC2', 'AWS/ELB', 'AWS/S3')",
            },
        },
        LabelTemplate = "$AccountName",
        ResourceTypes = new[]
        {
            "AWS::CloudWatch::Metric",
        },
        SinkIdentifier = exampleAwsOamSink.Arn,
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            exampleAwsOamSinkPolicy,
        },
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := oam.NewLink(ctx, "example", &oam.LinkArgs{
			LinkConfiguration: &oam.LinkLinkConfigurationArgs{
				MetricConfiguration: &oam.LinkLinkConfigurationMetricConfigurationArgs{
					Filter: pulumi.String("Namespace IN ('AWS/EC2', 'AWS/ELB', 'AWS/S3')"),
				},
			},
			LabelTemplate: pulumi.String("$AccountName"),
			ResourceTypes: pulumi.StringArray{
				pulumi.String("AWS::CloudWatch::Metric"),
			},
			SinkIdentifier: pulumi.Any(exampleAwsOamSink.Arn),
		}, pulumi.DependsOn([]pulumi.Resource{
			exampleAwsOamSinkPolicy,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_oam_link" "example" {
  depends_on = [exampleAwsOamSinkPolicy]
  link_configuration = {
    metric_configuration = {
      filter = "Namespace IN ('AWS/EC2', 'AWS/ELB', 'AWS/S3')"
    }
  }
  label_template  = "$AccountName"
  resource_types  = ["AWS::CloudWatch::Metric"]
  sink_identifier = exampleAwsOamSink.arn
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.oam.Link;
import com.pulumi.aws.oam.LinkArgs;
import com.pulumi.aws.oam.inputs.LinkLinkConfigurationArgs;
import com.pulumi.aws.oam.inputs.LinkLinkConfigurationMetricConfigurationArgs;
import com.pulumi.resources.CustomResourceOptions;
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 Link("example", LinkArgs.builder()
            .linkConfiguration(LinkLinkConfigurationArgs.builder()
                .metricConfiguration(LinkLinkConfigurationMetricConfigurationArgs.builder()
                    .filter("Namespace IN ('AWS/EC2', 'AWS/ELB', 'AWS/S3')")
                    .build())
                .build())
            .labelTemplate("$AccountName")
            .resourceTypes("AWS::CloudWatch::Metric")
            .sinkIdentifier(exampleAwsOamSink.arn())
            .build(), CustomResourceOptions.builder()
                .dependsOn(exampleAwsOamSinkPolicy)
                .build());

    }
}
resources:
  example:
    type: aws:oam:Link
    properties:
      linkConfiguration:
        metricConfiguration:
          filter: Namespace IN ('AWS/EC2', 'AWS/ELB', 'AWS/S3')
      labelTemplate: $AccountName
      resourceTypes:
        - AWS::CloudWatch::Metric
      sinkIdentifier: ${exampleAwsOamSink.arn}
    options:
      dependsOn:
        - ${exampleAwsOamSinkPolicy}

Import

Using pulumi import, import CloudWatch Observability Access Manager Link using the arn. For example:

$ pulumi import aws:oam/link:Link example arn:aws:oam:us-west-2:123456789012:link/link-id

Constructors

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

Properties

arn ↔ Output<String>
ARN of the link.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
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
label ↔ Output<String>
Label that is assigned to this link.
latefinal
labelTemplate ↔ Output<String>
Human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.
latefinal
linkConfiguration ↔ Output<LinkLinkConfiguration?>
Configuration for creating filters that specify that only some metric namespaces or log groups are to be shared from the source account to the monitoring account. See linkConfiguration Block for details.
latefinal
linkId ↔ Output<String>
ID string that AWS generated as part of the link ARN.
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
resourceTypes ↔ Output<List<String>>
Types of data that the source account shares with the monitoring account.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sinkArn ↔ Output<String>
ARN of the sink that is used for this link.
latefinal
sinkIdentifier ↔ Output<String>
Identifier of the sink to use to create this link.
latefinal
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>>
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, {LinkState? state, CustomResourceOptions? options}) → Link
Gets an existing Link resource's state with the given name and id.