Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. oam
  5. Link

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

aws.oam.Link

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

    Resource for managing an AWS CloudWatch Observability Access Manager Link.

    Example Usage

    Basic Usage

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

const example = new aws.oam.Link("example", {
    labelTemplate: "$AccountName",
    resourceTypes: ["AWS::CloudWatch::Metric"],
    sinkIdentifier: test.id,
    tags: {
        Env: "prod",
    },
});

    import pulumi
import pulumi_aws as aws

example = aws.oam.Link("example",
    label_template="$AccountName",
    resource_types=["AWS::CloudWatch::Metric"],
    sink_identifier=test["id"],
    tags={
        "Env": "prod",
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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{
			LabelTemplate: pulumi.String("$AccountName"),
			ResourceTypes: pulumi.StringArray{
				pulumi.String("AWS::CloudWatch::Metric"),
			},
			SinkIdentifier: pulumi.Any(test.Id),
			Tags: pulumi.StringMap{
				"Env": pulumi.String("prod"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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()
    {
        LabelTemplate = "$AccountName",
        ResourceTypes = new[]
        {
            "AWS::CloudWatch::Metric",
        },
        SinkIdentifier = test.Id,
        Tags = 
        {
            { "Env", "prod" },
        },
    });

});

    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 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) {
        var example = new Link("example", LinkArgs.builder()
            .labelTemplate("$AccountName")
            .resourceTypes("AWS::CloudWatch::Metric")
            .sinkIdentifier(test.id())
            .tags(Map.of("Env", "prod"))
            .build());

    }
}

    resources:
  example:
    type: aws:oam:Link
    properties:
      labelTemplate: $AccountName
      resourceTypes:
        - AWS::CloudWatch::Metric
      sinkIdentifier: ${test.id}
      tags:
        Env: prod

    Create Link Resource

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

    Constructor syntax

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

@overload
def Link(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         label_template: Optional[str] = None,
         resource_types: Optional[Sequence[str]] = None,
         sink_identifier: Optional[str] = None,
         tags: Optional[Mapping[str, str]] = None)
    func NewLink(ctx *Context, name string, args LinkArgs, opts ...ResourceOption) (*Link, error)
    public Link(string name, LinkArgs args, CustomResourceOptions? opts = null)
    public Link(String name, LinkArgs args)
public Link(String name, LinkArgs args, CustomResourceOptions options)

    type: aws:oam:Link
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 LinkArgs
    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 LinkArgs
    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 LinkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LinkArgs
    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 awsLinkResource = new Aws.Oam.Link("awsLinkResource", new()
{
    LabelTemplate = "string",
    ResourceTypes = new[]
    {
        "string",
    },
    SinkIdentifier = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := oam.NewLink(ctx, "awsLinkResource", &oam.LinkArgs{
	LabelTemplate: pulumi.String("string"),
	ResourceTypes: pulumi.StringArray{
		pulumi.String("string"),
	},
	SinkIdentifier: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var awsLinkResource = new Link("awsLinkResource", LinkArgs.builder()
    .labelTemplate("string")
    .resourceTypes("string")
    .sinkIdentifier("string")
    .tags(Map.of("string", "string"))
    .build());

    aws_link_resource = aws.oam.Link("awsLinkResource",
    label_template="string",
    resource_types=["string"],
    sink_identifier="string",
    tags={
        "string": "string",
    })

    const awsLinkResource = new aws.oam.Link("awsLinkResource", {
    labelTemplate: "string",
    resourceTypes: ["string"],
    sinkIdentifier: "string",
    tags: {
        string: "string",
    },
});

    type: aws:oam:Link
properties:
    labelTemplate: string
    resourceTypes:
        - string
    sinkIdentifier: string
    tags:
        string: string

    Link Resource Properties

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

    Inputs

    The Link resource accepts the following input properties:

    LabelTemplate string
    Human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.
    ResourceTypes List<string>
    Types of data that the source account shares with the monitoring account.
    SinkIdentifier string

    Identifier of the sink to use to create this link.

    The following arguments are optional:

    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    LabelTemplate string
    Human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.
    ResourceTypes []string
    Types of data that the source account shares with the monitoring account.
    SinkIdentifier string

    Identifier of the sink to use to create this link.

    The following arguments are optional:

    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    labelTemplate String
    Human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.
    resourceTypes List<String>
    Types of data that the source account shares with the monitoring account.
    sinkIdentifier String

    Identifier of the sink to use to create this link.

    The following arguments are optional:

    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    labelTemplate string
    Human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.
    resourceTypes string[]
    Types of data that the source account shares with the monitoring account.
    sinkIdentifier string

    Identifier of the sink to use to create this link.

    The following arguments are optional:

    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    label_template str
    Human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.
    resource_types Sequence[str]
    Types of data that the source account shares with the monitoring account.
    sink_identifier str

    Identifier of the sink to use to create this link.

    The following arguments are optional:

    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    labelTemplate String
    Human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.
    resourceTypes List<String>
    Types of data that the source account shares with the monitoring account.
    sinkIdentifier String

    Identifier of the sink to use to create this link.

    The following arguments are optional:

    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string
    ARN of the link.
    Id string
    The provider-assigned unique ID for this managed resource.
    Label string
    Label that is assigned to this link.
    LinkId string
    ID string that AWS generated as part of the link ARN.
    SinkArn string
    ARN of the sink that is used for this link.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    Arn string
    ARN of the link.
    Id string
    The provider-assigned unique ID for this managed resource.
    Label string
    Label that is assigned to this link.
    LinkId string
    ID string that AWS generated as part of the link ARN.
    SinkArn string
    ARN of the sink that is used for this link.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    arn String
    ARN of the link.
    id String
    The provider-assigned unique ID for this managed resource.
    label String
    Label that is assigned to this link.
    linkId String
    ID string that AWS generated as part of the link ARN.
    sinkArn String
    ARN of the sink that is used for this link.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    arn string
    ARN of the link.
    id string
    The provider-assigned unique ID for this managed resource.
    label string
    Label that is assigned to this link.
    linkId string
    ID string that AWS generated as part of the link ARN.
    sinkArn string
    ARN of the sink that is used for this link.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    arn str
    ARN of the link.
    id str
    The provider-assigned unique ID for this managed resource.
    label str
    Label that is assigned to this link.
    link_id str
    ID string that AWS generated as part of the link ARN.
    sink_arn str
    ARN of the sink that is used for this link.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    arn String
    ARN of the link.
    id String
    The provider-assigned unique ID for this managed resource.
    label String
    Label that is assigned to this link.
    linkId String
    ID string that AWS generated as part of the link ARN.
    sinkArn String
    ARN of the sink that is used for this link.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    Look up Existing Link Resource

    Get an existing Link 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?: LinkState, opts?: CustomResourceOptions): Link
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        label: Optional[str] = None,
        label_template: Optional[str] = None,
        link_id: Optional[str] = None,
        resource_types: Optional[Sequence[str]] = None,
        sink_arn: Optional[str] = None,
        sink_identifier: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> Link
    func GetLink(ctx *Context, name string, id IDInput, state *LinkState, opts ...ResourceOption) (*Link, error)
    public static Link Get(string name, Input<string> id, LinkState? state, CustomResourceOptions? opts = null)
    public static Link get(String name, Output<String> id, LinkState 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
    ARN of the link.
    Label string
    Label that is assigned to this link.
    LabelTemplate string
    Human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.
    LinkId string
    ID string that AWS generated as part of the link ARN.
    ResourceTypes List<string>
    Types of data that the source account shares with the monitoring account.
    SinkArn string
    ARN of the sink that is used for this link.
    SinkIdentifier string

    Identifier of the sink to use to create this link.

    The following arguments are optional:

    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    Arn string
    ARN of the link.
    Label string
    Label that is assigned to this link.
    LabelTemplate string
    Human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.
    LinkId string
    ID string that AWS generated as part of the link ARN.
    ResourceTypes []string
    Types of data that the source account shares with the monitoring account.
    SinkArn string
    ARN of the sink that is used for this link.
    SinkIdentifier string

    Identifier of the sink to use to create this link.

    The following arguments are optional:

    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    arn String
    ARN of the link.
    label String
    Label that is assigned to this link.
    labelTemplate String
    Human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.
    linkId String
    ID string that AWS generated as part of the link ARN.
    resourceTypes List<String>
    Types of data that the source account shares with the monitoring account.
    sinkArn String
    ARN of the sink that is used for this link.
    sinkIdentifier String

    Identifier of the sink to use to create this link.

    The following arguments are optional:

    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    arn string
    ARN of the link.
    label string
    Label that is assigned to this link.
    labelTemplate string
    Human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.
    linkId string
    ID string that AWS generated as part of the link ARN.
    resourceTypes string[]
    Types of data that the source account shares with the monitoring account.
    sinkArn string
    ARN of the sink that is used for this link.
    sinkIdentifier string

    Identifier of the sink to use to create this link.

    The following arguments are optional:

    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    arn str
    ARN of the link.
    label str
    Label that is assigned to this link.
    label_template str
    Human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.
    link_id str
    ID string that AWS generated as part of the link ARN.
    resource_types Sequence[str]
    Types of data that the source account shares with the monitoring account.
    sink_arn str
    ARN of the sink that is used for this link.
    sink_identifier str

    Identifier of the sink to use to create this link.

    The following arguments are optional:

    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    arn String
    ARN of the link.
    label String
    Label that is assigned to this link.
    labelTemplate String
    Human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.
    linkId String
    ID string that AWS generated as part of the link ARN.
    resourceTypes List<String>
    Types of data that the source account shares with the monitoring account.
    sinkArn String
    ARN of the sink that is used for this link.
    sinkIdentifier String

    Identifier of the sink to use to create this link.

    The following arguments are optional:

    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    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

    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

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws