Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. oam
  5. getLink

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.oam.getLink

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::Oam::Link Resource Type

    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(arn: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetLinkResult
def get_link_output(arn: Optional[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-native:oam:getLink
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Arn string
    The ARN of the link. For example, arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789
    Arn string
    The ARN of the link. For example, arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789
    arn String
    The ARN of the link. For example, arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789
    arn string
    The ARN of the link. For example, arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789
    arn str
    The ARN of the link. For example, arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789
    arn String
    The ARN of the link. For example, arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789

    getLink Result

    The following output properties are available:

    Arn string
    The ARN of the link. For example, arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789
    Label string
    The friendly human-readable name used to identify this source account when it is viewed from the monitoring account. For example, my-account1 .
    LinkConfiguration Pulumi.AwsNative.Oam.Outputs.LinkConfiguration
    Use this structure to optionally create filters that specify that only some metric namespaces or log groups are to be shared from the source account to the monitoring account.
    ResourceTypes List<Pulumi.AwsNative.Oam.LinkResourceType>
    An array of strings that define which types of data that the source account shares with the monitoring account. Valid values are AWS::CloudWatch::Metric | AWS::Logs::LogGroup | AWS::XRay::Trace | AWS::ApplicationInsights::Application | AWS::InternetMonitor::Monitor .
    Tags Dictionary<string, string>
    Tags to apply to the link
    Arn string
    The ARN of the link. For example, arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789
    Label string
    The friendly human-readable name used to identify this source account when it is viewed from the monitoring account. For example, my-account1 .
    LinkConfiguration LinkConfiguration
    Use this structure to optionally create filters that specify that only some metric namespaces or log groups are to be shared from the source account to the monitoring account.
    ResourceTypes []LinkResourceType
    An array of strings that define which types of data that the source account shares with the monitoring account. Valid values are AWS::CloudWatch::Metric | AWS::Logs::LogGroup | AWS::XRay::Trace | AWS::ApplicationInsights::Application | AWS::InternetMonitor::Monitor .
    Tags map[string]string
    Tags to apply to the link
    arn String
    The ARN of the link. For example, arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789
    label String
    The friendly human-readable name used to identify this source account when it is viewed from the monitoring account. For example, my-account1 .
    linkConfiguration LinkConfiguration
    Use this structure to optionally create filters that specify that only some metric namespaces or log groups are to be shared from the source account to the monitoring account.
    resourceTypes List<LinkResourceType>
    An array of strings that define which types of data that the source account shares with the monitoring account. Valid values are AWS::CloudWatch::Metric | AWS::Logs::LogGroup | AWS::XRay::Trace | AWS::ApplicationInsights::Application | AWS::InternetMonitor::Monitor .
    tags Map<String,String>
    Tags to apply to the link
    arn string
    The ARN of the link. For example, arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789
    label string
    The friendly human-readable name used to identify this source account when it is viewed from the monitoring account. For example, my-account1 .
    linkConfiguration LinkConfiguration
    Use this structure to optionally create filters that specify that only some metric namespaces or log groups are to be shared from the source account to the monitoring account.
    resourceTypes LinkResourceType[]
    An array of strings that define which types of data that the source account shares with the monitoring account. Valid values are AWS::CloudWatch::Metric | AWS::Logs::LogGroup | AWS::XRay::Trace | AWS::ApplicationInsights::Application | AWS::InternetMonitor::Monitor .
    tags {[key: string]: string}
    Tags to apply to the link
    arn str
    The ARN of the link. For example, arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789
    label str
    The friendly human-readable name used to identify this source account when it is viewed from the monitoring account. For example, my-account1 .
    link_configuration LinkConfiguration
    Use this structure to optionally create filters that specify that only some metric namespaces or log groups are to be shared from the source account to the monitoring account.
    resource_types Sequence[LinkResourceType]
    An array of strings that define which types of data that the source account shares with the monitoring account. Valid values are AWS::CloudWatch::Metric | AWS::Logs::LogGroup | AWS::XRay::Trace | AWS::ApplicationInsights::Application | AWS::InternetMonitor::Monitor .
    tags Mapping[str, str]
    Tags to apply to the link
    arn String
    The ARN of the link. For example, arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789
    label String
    The friendly human-readable name used to identify this source account when it is viewed from the monitoring account. For example, my-account1 .
    linkConfiguration Property Map
    Use this structure to optionally create filters that specify that only some metric namespaces or log groups are to be shared from the source account to the monitoring account.
    resourceTypes List<"AWS::CloudWatch::Metric" | "AWS::Logs::LogGroup" | "AWS::XRay::Trace" | "AWS::ApplicationInsights::Application" | "AWS::InternetMonitor::Monitor">
    An array of strings that define which types of data that the source account shares with the monitoring account. Valid values are AWS::CloudWatch::Metric | AWS::Logs::LogGroup | AWS::XRay::Trace | AWS::ApplicationInsights::Application | AWS::InternetMonitor::Monitor .
    tags Map<String>
    Tags to apply to the link

    Supporting Types

    LinkConfiguration

    LogGroupConfiguration Pulumi.AwsNative.Oam.Inputs.LinkFilter
    Use this structure to filter which log groups are to share log events from this source account to the monitoring account.
    MetricConfiguration Pulumi.AwsNative.Oam.Inputs.LinkFilter
    Use this structure to filter which metric namespaces are to be shared from the source account to the monitoring account.
    LogGroupConfiguration LinkFilter
    Use this structure to filter which log groups are to share log events from this source account to the monitoring account.
    MetricConfiguration LinkFilter
    Use this structure to filter which metric namespaces are to be shared from the source account to the monitoring account.
    logGroupConfiguration LinkFilter
    Use this structure to filter which log groups are to share log events from this source account to the monitoring account.
    metricConfiguration LinkFilter
    Use this structure to filter which metric namespaces are to be shared from the source account to the monitoring account.
    logGroupConfiguration LinkFilter
    Use this structure to filter which log groups are to share log events from this source account to the monitoring account.
    metricConfiguration LinkFilter
    Use this structure to filter which metric namespaces are to be shared from the source account to the monitoring account.
    log_group_configuration LinkFilter
    Use this structure to filter which log groups are to share log events from this source account to the monitoring account.
    metric_configuration LinkFilter
    Use this structure to filter which metric namespaces are to be shared from the source account to the monitoring account.
    logGroupConfiguration Property Map
    Use this structure to filter which log groups are to share log events from this source account to the monitoring account.
    metricConfiguration Property Map
    Use this structure to filter which metric namespaces are to be shared from the source account to the monitoring account.

    LinkFilter

    Filter string

    When used in MetricConfiguration this field specifies which metric namespaces are to be shared with the monitoring account

    When used in LogGroupConfiguration this field specifies which log groups are to share their log events with the monitoring account. Use the term LogGroupName and one or more of the following operands.

    Use single quotation marks (') around log group names and metric namespaces.

    The matching of log group names and metric namespaces is case sensitive. Each filter has a limit of five conditional operands. Conditional operands are AND and OR .

    • = and !=
    • AND
    • OR
    • LIKE and NOT LIKE . These can be used only as prefix searches. Include a % at the end of the string that you want to search for and include.
    • IN and NOT IN , using parentheses ( )

    Examples:

    • Namespace NOT LIKE 'AWS/%' includes only namespaces that don't start with AWS/ , such as custom namespaces.
    • Namespace IN ('AWS/EC2', 'AWS/ELB', 'AWS/S3') includes only the metrics in the EC2, Elastic Load Balancing , and Amazon S3 namespaces.
    • Namespace = 'AWS/EC2' OR Namespace NOT LIKE 'AWS/%' includes only the EC2 namespace and your custom namespaces.
    • LogGroupName IN ('This-Log-Group', 'Other-Log-Group') includes only the log groups with names This-Log-Group and Other-Log-Group .
    • LogGroupName NOT IN ('Private-Log-Group', 'Private-Log-Group-2') includes all log groups except the log groups with names Private-Log-Group and Private-Log-Group-2 .
    • LogGroupName LIKE 'aws/lambda/%' OR LogGroupName LIKE 'AWSLogs%' includes all log groups that have names that start with aws/lambda/ or AWSLogs .

    If you are updating a link that uses filters, you can specify * as the only value for the filter parameter to delete the filter and share all log groups with the monitoring account.

    Filter string

    When used in MetricConfiguration this field specifies which metric namespaces are to be shared with the monitoring account

    When used in LogGroupConfiguration this field specifies which log groups are to share their log events with the monitoring account. Use the term LogGroupName and one or more of the following operands.

    Use single quotation marks (') around log group names and metric namespaces.

    The matching of log group names and metric namespaces is case sensitive. Each filter has a limit of five conditional operands. Conditional operands are AND and OR .

    • = and !=
    • AND
    • OR
    • LIKE and NOT LIKE . These can be used only as prefix searches. Include a % at the end of the string that you want to search for and include.
    • IN and NOT IN , using parentheses ( )

    Examples:

    • Namespace NOT LIKE 'AWS/%' includes only namespaces that don't start with AWS/ , such as custom namespaces.
    • Namespace IN ('AWS/EC2', 'AWS/ELB', 'AWS/S3') includes only the metrics in the EC2, Elastic Load Balancing , and Amazon S3 namespaces.
    • Namespace = 'AWS/EC2' OR Namespace NOT LIKE 'AWS/%' includes only the EC2 namespace and your custom namespaces.
    • LogGroupName IN ('This-Log-Group', 'Other-Log-Group') includes only the log groups with names This-Log-Group and Other-Log-Group .
    • LogGroupName NOT IN ('Private-Log-Group', 'Private-Log-Group-2') includes all log groups except the log groups with names Private-Log-Group and Private-Log-Group-2 .
    • LogGroupName LIKE 'aws/lambda/%' OR LogGroupName LIKE 'AWSLogs%' includes all log groups that have names that start with aws/lambda/ or AWSLogs .

    If you are updating a link that uses filters, you can specify * as the only value for the filter parameter to delete the filter and share all log groups with the monitoring account.

    filter String

    When used in MetricConfiguration this field specifies which metric namespaces are to be shared with the monitoring account

    When used in LogGroupConfiguration this field specifies which log groups are to share their log events with the monitoring account. Use the term LogGroupName and one or more of the following operands.

    Use single quotation marks (') around log group names and metric namespaces.

    The matching of log group names and metric namespaces is case sensitive. Each filter has a limit of five conditional operands. Conditional operands are AND and OR .

    • = and !=
    • AND
    • OR
    • LIKE and NOT LIKE . These can be used only as prefix searches. Include a % at the end of the string that you want to search for and include.
    • IN and NOT IN , using parentheses ( )

    Examples:

    • Namespace NOT LIKE 'AWS/%' includes only namespaces that don't start with AWS/ , such as custom namespaces.
    • Namespace IN ('AWS/EC2', 'AWS/ELB', 'AWS/S3') includes only the metrics in the EC2, Elastic Load Balancing , and Amazon S3 namespaces.
    • Namespace = 'AWS/EC2' OR Namespace NOT LIKE 'AWS/%' includes only the EC2 namespace and your custom namespaces.
    • LogGroupName IN ('This-Log-Group', 'Other-Log-Group') includes only the log groups with names This-Log-Group and Other-Log-Group .
    • LogGroupName NOT IN ('Private-Log-Group', 'Private-Log-Group-2') includes all log groups except the log groups with names Private-Log-Group and Private-Log-Group-2 .
    • LogGroupName LIKE 'aws/lambda/%' OR LogGroupName LIKE 'AWSLogs%' includes all log groups that have names that start with aws/lambda/ or AWSLogs .

    If you are updating a link that uses filters, you can specify * as the only value for the filter parameter to delete the filter and share all log groups with the monitoring account.

    filter string

    When used in MetricConfiguration this field specifies which metric namespaces are to be shared with the monitoring account

    When used in LogGroupConfiguration this field specifies which log groups are to share their log events with the monitoring account. Use the term LogGroupName and one or more of the following operands.

    Use single quotation marks (') around log group names and metric namespaces.

    The matching of log group names and metric namespaces is case sensitive. Each filter has a limit of five conditional operands. Conditional operands are AND and OR .

    • = and !=
    • AND
    • OR
    • LIKE and NOT LIKE . These can be used only as prefix searches. Include a % at the end of the string that you want to search for and include.
    • IN and NOT IN , using parentheses ( )

    Examples:

    • Namespace NOT LIKE 'AWS/%' includes only namespaces that don't start with AWS/ , such as custom namespaces.
    • Namespace IN ('AWS/EC2', 'AWS/ELB', 'AWS/S3') includes only the metrics in the EC2, Elastic Load Balancing , and Amazon S3 namespaces.
    • Namespace = 'AWS/EC2' OR Namespace NOT LIKE 'AWS/%' includes only the EC2 namespace and your custom namespaces.
    • LogGroupName IN ('This-Log-Group', 'Other-Log-Group') includes only the log groups with names This-Log-Group and Other-Log-Group .
    • LogGroupName NOT IN ('Private-Log-Group', 'Private-Log-Group-2') includes all log groups except the log groups with names Private-Log-Group and Private-Log-Group-2 .
    • LogGroupName LIKE 'aws/lambda/%' OR LogGroupName LIKE 'AWSLogs%' includes all log groups that have names that start with aws/lambda/ or AWSLogs .

    If you are updating a link that uses filters, you can specify * as the only value for the filter parameter to delete the filter and share all log groups with the monitoring account.

    filter str

    When used in MetricConfiguration this field specifies which metric namespaces are to be shared with the monitoring account

    When used in LogGroupConfiguration this field specifies which log groups are to share their log events with the monitoring account. Use the term LogGroupName and one or more of the following operands.

    Use single quotation marks (') around log group names and metric namespaces.

    The matching of log group names and metric namespaces is case sensitive. Each filter has a limit of five conditional operands. Conditional operands are AND and OR .

    • = and !=
    • AND
    • OR
    • LIKE and NOT LIKE . These can be used only as prefix searches. Include a % at the end of the string that you want to search for and include.
    • IN and NOT IN , using parentheses ( )

    Examples:

    • Namespace NOT LIKE 'AWS/%' includes only namespaces that don't start with AWS/ , such as custom namespaces.
    • Namespace IN ('AWS/EC2', 'AWS/ELB', 'AWS/S3') includes only the metrics in the EC2, Elastic Load Balancing , and Amazon S3 namespaces.
    • Namespace = 'AWS/EC2' OR Namespace NOT LIKE 'AWS/%' includes only the EC2 namespace and your custom namespaces.
    • LogGroupName IN ('This-Log-Group', 'Other-Log-Group') includes only the log groups with names This-Log-Group and Other-Log-Group .
    • LogGroupName NOT IN ('Private-Log-Group', 'Private-Log-Group-2') includes all log groups except the log groups with names Private-Log-Group and Private-Log-Group-2 .
    • LogGroupName LIKE 'aws/lambda/%' OR LogGroupName LIKE 'AWSLogs%' includes all log groups that have names that start with aws/lambda/ or AWSLogs .

    If you are updating a link that uses filters, you can specify * as the only value for the filter parameter to delete the filter and share all log groups with the monitoring account.

    filter String

    When used in MetricConfiguration this field specifies which metric namespaces are to be shared with the monitoring account

    When used in LogGroupConfiguration this field specifies which log groups are to share their log events with the monitoring account. Use the term LogGroupName and one or more of the following operands.

    Use single quotation marks (') around log group names and metric namespaces.

    The matching of log group names and metric namespaces is case sensitive. Each filter has a limit of five conditional operands. Conditional operands are AND and OR .

    • = and !=
    • AND
    • OR
    • LIKE and NOT LIKE . These can be used only as prefix searches. Include a % at the end of the string that you want to search for and include.
    • IN and NOT IN , using parentheses ( )

    Examples:

    • Namespace NOT LIKE 'AWS/%' includes only namespaces that don't start with AWS/ , such as custom namespaces.
    • Namespace IN ('AWS/EC2', 'AWS/ELB', 'AWS/S3') includes only the metrics in the EC2, Elastic Load Balancing , and Amazon S3 namespaces.
    • Namespace = 'AWS/EC2' OR Namespace NOT LIKE 'AWS/%' includes only the EC2 namespace and your custom namespaces.
    • LogGroupName IN ('This-Log-Group', 'Other-Log-Group') includes only the log groups with names This-Log-Group and Other-Log-Group .
    • LogGroupName NOT IN ('Private-Log-Group', 'Private-Log-Group-2') includes all log groups except the log groups with names Private-Log-Group and Private-Log-Group-2 .
    • LogGroupName LIKE 'aws/lambda/%' OR LogGroupName LIKE 'AWSLogs%' includes all log groups that have names that start with aws/lambda/ or AWSLogs .

    If you are updating a link that uses filters, you can specify * as the only value for the filter parameter to delete the filter and share all log groups with the monitoring account.

    LinkResourceType

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native