1. Packages
  2. AWS
  3. API Docs
  4. oam
  5. getLink
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi

aws.oam.getLink

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi

    Data source 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 = aws.oam.getLink({
        linkIdentifier: "arn:aws:oam:us-west-1:111111111111:link/abcd1234-a123-456a-a12b-a123b456c789",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.oam.get_link(link_identifier="arn:aws:oam:us-west-1:111111111111:link/abcd1234-a123-456a-a12b-a123b456c789")
    
    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.LookupLink(ctx, &oam.LookupLinkArgs{
    			LinkIdentifier: "arn:aws:oam:us-west-1:111111111111:link/abcd1234-a123-456a-a12b-a123b456c789",
    		}, nil)
    		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 = Aws.Oam.GetLink.Invoke(new()
        {
            LinkIdentifier = "arn:aws:oam:us-west-1:111111111111:link/abcd1234-a123-456a-a12b-a123b456c789",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.oam.OamFunctions;
    import com.pulumi.aws.oam.inputs.GetLinkArgs;
    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) {
            final var example = OamFunctions.getLink(GetLinkArgs.builder()
                .linkIdentifier("arn:aws:oam:us-west-1:111111111111:link/abcd1234-a123-456a-a12b-a123b456c789")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: aws:oam:getLink
          Arguments:
            linkIdentifier: arn:aws:oam:us-west-1:111111111111:link/abcd1234-a123-456a-a12b-a123b456c789
    

    Using getLink

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getLink(args: GetLinkArgs, opts?: InvokeOptions): Promise<GetLinkResult>
    function getLinkOutput(args: GetLinkOutputArgs, opts?: InvokeOptions): Output<GetLinkResult>
    def get_link(link_identifier: Optional[str] = None,
                 tags: Optional[Mapping[str, str]] = None,
                 opts: Optional[InvokeOptions] = None) -> GetLinkResult
    def get_link_output(link_identifier: Optional[pulumi.Input[str]] = None,
                 tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetLinkResult]
    func LookupLink(ctx *Context, args *LookupLinkArgs, opts ...InvokeOption) (*LookupLinkResult, error)
    func LookupLinkOutput(ctx *Context, args *LookupLinkOutputArgs, opts ...InvokeOption) LookupLinkResultOutput

    > Note: This function is named LookupLink in the Go SDK.

    public static class GetLink 
    {
        public static Task<GetLinkResult> InvokeAsync(GetLinkArgs args, InvokeOptions? opts = null)
        public static Output<GetLinkResult> Invoke(GetLinkInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetLinkResult> getLink(GetLinkArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws:oam/getLink:getLink
      arguments:
        # arguments dictionary

    The following arguments are supported:

    LinkIdentifier string
    ARN of the link.
    Tags Dictionary<string, string>
    LinkIdentifier string
    ARN of the link.
    Tags map[string]string
    linkIdentifier String
    ARN of the link.
    tags Map<String,String>
    linkIdentifier string
    ARN of the link.
    tags {[key: string]: string}
    link_identifier str
    ARN of the link.
    tags Mapping[str, str]
    linkIdentifier String
    ARN of the link.
    tags Map<String>

    getLink Result

    The following output properties are available:

    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.
    LabelTemplate string
    Human-readable name used to identify this source account when you are viewing data from it in the monitoring account.
    LinkConfigurations List<GetLinkLinkConfiguration>
    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 link_configuration Block for details.
    LinkId string
    ID string that AWS generated as part of the link ARN.
    LinkIdentifier string
    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.
    Tags Dictionary<string, string>
    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.
    LabelTemplate string
    Human-readable name used to identify this source account when you are viewing data from it in the monitoring account.
    LinkConfigurations []GetLinkLinkConfiguration
    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 link_configuration Block for details.
    LinkId string
    ID string that AWS generated as part of the link ARN.
    LinkIdentifier string
    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.
    Tags map[string]string
    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.
    labelTemplate String
    Human-readable name used to identify this source account when you are viewing data from it in the monitoring account.
    linkConfigurations List<GetLinkLinkConfiguration>
    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 link_configuration Block for details.
    linkId String
    ID string that AWS generated as part of the link ARN.
    linkIdentifier String
    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.
    tags Map<String,String>
    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.
    labelTemplate string
    Human-readable name used to identify this source account when you are viewing data from it in the monitoring account.
    linkConfigurations GetLinkLinkConfiguration[]
    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 link_configuration Block for details.
    linkId string
    ID string that AWS generated as part of the link ARN.
    linkIdentifier string
    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.
    tags {[key: string]: string}
    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.
    label_template str
    Human-readable name used to identify this source account when you are viewing data from it in the monitoring account.
    link_configurations Sequence[GetLinkLinkConfiguration]
    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 link_configuration Block for details.
    link_id str
    ID string that AWS generated as part of the link ARN.
    link_identifier str
    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.
    tags Mapping[str, str]
    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.
    labelTemplate String
    Human-readable name used to identify this source account when you are viewing data from it in the monitoring account.
    linkConfigurations List<Property Map>
    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 link_configuration Block for details.
    linkId String
    ID string that AWS generated as part of the link ARN.
    linkIdentifier String
    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.
    tags Map<String>

    Supporting Types

    GetLinkLinkConfiguration

    LogGroupConfigurations List<GetLinkLinkConfigurationLogGroupConfiguration>
    Configuration for filtering which log groups are to send log events from the source account to the monitoring account. See log_group_configuration Block for details.
    MetricConfigurations List<GetLinkLinkConfigurationMetricConfiguration>
    Configuration for filtering which metric namespaces are to be shared from the source account to the monitoring account. See metric_configuration Block for details.
    LogGroupConfigurations []GetLinkLinkConfigurationLogGroupConfiguration
    Configuration for filtering which log groups are to send log events from the source account to the monitoring account. See log_group_configuration Block for details.
    MetricConfigurations []GetLinkLinkConfigurationMetricConfiguration
    Configuration for filtering which metric namespaces are to be shared from the source account to the monitoring account. See metric_configuration Block for details.
    logGroupConfigurations List<GetLinkLinkConfigurationLogGroupConfiguration>
    Configuration for filtering which log groups are to send log events from the source account to the monitoring account. See log_group_configuration Block for details.
    metricConfigurations List<GetLinkLinkConfigurationMetricConfiguration>
    Configuration for filtering which metric namespaces are to be shared from the source account to the monitoring account. See metric_configuration Block for details.
    logGroupConfigurations GetLinkLinkConfigurationLogGroupConfiguration[]
    Configuration for filtering which log groups are to send log events from the source account to the monitoring account. See log_group_configuration Block for details.
    metricConfigurations GetLinkLinkConfigurationMetricConfiguration[]
    Configuration for filtering which metric namespaces are to be shared from the source account to the monitoring account. See metric_configuration Block for details.
    log_group_configurations Sequence[GetLinkLinkConfigurationLogGroupConfiguration]
    Configuration for filtering which log groups are to send log events from the source account to the monitoring account. See log_group_configuration Block for details.
    metric_configurations Sequence[GetLinkLinkConfigurationMetricConfiguration]
    Configuration for filtering which metric namespaces are to be shared from the source account to the monitoring account. See metric_configuration Block for details.
    logGroupConfigurations List<Property Map>
    Configuration for filtering which log groups are to send log events from the source account to the monitoring account. See log_group_configuration Block for details.
    metricConfigurations List<Property Map>
    Configuration for filtering which metric namespaces are to be shared from the source account to the monitoring account. See metric_configuration Block for details.

    GetLinkLinkConfigurationLogGroupConfiguration

    Filter string
    Filter string that specifies which metrics are to be shared with the monitoring account. See MetricConfiguration for details.
    Filter string
    Filter string that specifies which metrics are to be shared with the monitoring account. See MetricConfiguration for details.
    filter String
    Filter string that specifies which metrics are to be shared with the monitoring account. See MetricConfiguration for details.
    filter string
    Filter string that specifies which metrics are to be shared with the monitoring account. See MetricConfiguration for details.
    filter str
    Filter string that specifies which metrics are to be shared with the monitoring account. See MetricConfiguration for details.
    filter String
    Filter string that specifies which metrics are to be shared with the monitoring account. See MetricConfiguration for details.

    GetLinkLinkConfigurationMetricConfiguration

    Filter string
    Filter string that specifies which metrics are to be shared with the monitoring account. See MetricConfiguration for details.
    Filter string
    Filter string that specifies which metrics are to be shared with the monitoring account. See MetricConfiguration for details.
    filter String
    Filter string that specifies which metrics are to be shared with the monitoring account. See MetricConfiguration for details.
    filter string
    Filter string that specifies which metrics are to be shared with the monitoring account. See MetricConfiguration for details.
    filter str
    Filter string that specifies which metrics are to be shared with the monitoring account. See MetricConfiguration for details.
    filter String
    Filter string that specifies which metrics are to be shared with the monitoring account. See MetricConfiguration for details.

    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.54.0 published on Friday, Sep 27, 2024 by Pulumi