Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. oam
  5. Link

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.oam.Link

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::Oam::Link Resource Type

    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,
         resource_types: Optional[Sequence[LinkResourceType]] = None,
         sink_identifier: Optional[str] = None,
         label_template: Optional[str] = None,
         link_configuration: Optional[LinkConfigurationArgs] = 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-native: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.

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Link resource accepts the following input properties:

    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 | AWS::ApplicationSignals::Service | AWS::ApplicationSignals::ServiceLevelObjective .
    SinkIdentifier string
    The ARN of the sink in the monitoring account that you want to link to. You can use ListSinks to find the ARNs of sinks.
    LabelTemplate string

    Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.

    You can include the following variables in your template:

    • $AccountName is the name of the account
    • $AccountEmail is a globally-unique email address, which includes the email domain, such as mariagarcia@example.com
    • $AccountEmailNoDomain is an email address without the domain name, such as mariagarcia
    LinkConfiguration Pulumi.AwsNative.Oam.Inputs.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.
    Tags Dictionary<string, string>
    Tags to apply to the link
    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 | AWS::ApplicationSignals::Service | AWS::ApplicationSignals::ServiceLevelObjective .
    SinkIdentifier string
    The ARN of the sink in the monitoring account that you want to link to. You can use ListSinks to find the ARNs of sinks.
    LabelTemplate string

    Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.

    You can include the following variables in your template:

    • $AccountName is the name of the account
    • $AccountEmail is a globally-unique email address, which includes the email domain, such as mariagarcia@example.com
    • $AccountEmailNoDomain is an email address without the domain name, such as mariagarcia
    LinkConfiguration LinkConfigurationArgs
    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.
    Tags map[string]string
    Tags to apply to the link
    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 | AWS::ApplicationSignals::Service | AWS::ApplicationSignals::ServiceLevelObjective .
    sinkIdentifier String
    The ARN of the sink in the monitoring account that you want to link to. You can use ListSinks to find the ARNs of sinks.
    labelTemplate String

    Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.

    You can include the following variables in your template:

    • $AccountName is the name of the account
    • $AccountEmail is a globally-unique email address, which includes the email domain, such as mariagarcia@example.com
    • $AccountEmailNoDomain is an email address without the domain name, such as mariagarcia
    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.
    tags Map<String,String>
    Tags to apply to the link
    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 | AWS::ApplicationSignals::Service | AWS::ApplicationSignals::ServiceLevelObjective .
    sinkIdentifier string
    The ARN of the sink in the monitoring account that you want to link to. You can use ListSinks to find the ARNs of sinks.
    labelTemplate string

    Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.

    You can include the following variables in your template:

    • $AccountName is the name of the account
    • $AccountEmail is a globally-unique email address, which includes the email domain, such as mariagarcia@example.com
    • $AccountEmailNoDomain is an email address without the domain name, such as mariagarcia
    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.
    tags {[key: string]: string}
    Tags to apply to the link
    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 | AWS::ApplicationSignals::Service | AWS::ApplicationSignals::ServiceLevelObjective .
    sink_identifier str
    The ARN of the sink in the monitoring account that you want to link to. You can use ListSinks to find the ARNs of sinks.
    label_template str

    Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.

    You can include the following variables in your template:

    • $AccountName is the name of the account
    • $AccountEmail is a globally-unique email address, which includes the email domain, such as mariagarcia@example.com
    • $AccountEmailNoDomain is an email address without the domain name, such as mariagarcia
    link_configuration LinkConfigurationArgs
    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.
    tags Mapping[str, str]
    Tags to apply to the link
    resourceTypes List<"AWS::CloudWatch::Metric" | "AWS::Logs::LogGroup" | "AWS::XRay::Trace" | "AWS::ApplicationInsights::Application" | "AWS::InternetMonitor::Monitor" | "AWS::ApplicationSignals::Service" | "AWS::ApplicationSignals::ServiceLevelObjective">
    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 | AWS::ApplicationSignals::Service | AWS::ApplicationSignals::ServiceLevelObjective .
    sinkIdentifier String
    The ARN of the sink in the monitoring account that you want to link to. You can use ListSinks to find the ARNs of sinks.
    labelTemplate String

    Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.

    You can include the following variables in your template:

    • $AccountName is the name of the account
    • $AccountEmail is a globally-unique email address, which includes the email domain, such as mariagarcia@example.com
    • $AccountEmailNoDomain is an email address without the domain name, such as mariagarcia
    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.
    tags Map<String>
    Tags to apply to the link

    Outputs

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

    Arn string
    The ARN of the link. For example, arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789
    Id string
    The provider-assigned unique ID for this managed resource.
    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 .
    Arn string
    The ARN of the link. For example, arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789
    Id string
    The provider-assigned unique ID for this managed resource.
    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 .
    arn String
    The ARN of the link. For example, arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789
    id String
    The provider-assigned unique ID for this managed resource.
    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 .
    arn string
    The ARN of the link. For example, arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789
    id string
    The provider-assigned unique ID for this managed resource.
    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 .
    arn str
    The ARN of the link. For example, arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789
    id str
    The provider-assigned unique ID for this managed resource.
    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 .
    arn String
    The ARN of the link. For example, arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789
    id String
    The provider-assigned unique ID for this managed resource.
    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 .

    Supporting Types

    LinkConfiguration, LinkConfigurationArgs

    LogGroupConfiguration Pulumi.AwsNative.Oam.Inputs.LinkFilter
    Use this structure to filter which log groups are to send log events from the 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 send log events from the 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 send log events from the 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 send log events from the 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 send log events from the 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 send log events from the 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, LinkFilterArgs

    Filter string
    Filter string
    filter String
    filter string
    filter str
    filter String

    LinkResourceType, LinkResourceTypeArgs

    AwsCloudWatchMetric
    AWS::CloudWatch::Metric
    AwsLogsLogGroup
    AWS::Logs::LogGroup
    AwsxRayTrace
    AWS::XRay::Trace
    AwsApplicationInsightsApplication
    AWS::ApplicationInsights::Application
    AwsInternetMonitorMonitor
    AWS::InternetMonitor::Monitor
    AwsApplicationSignalsService
    AWS::ApplicationSignals::Service
    AwsApplicationSignalsServiceLevelObjective
    AWS::ApplicationSignals::ServiceLevelObjective
    LinkResourceTypeAwsCloudWatchMetric
    AWS::CloudWatch::Metric
    LinkResourceTypeAwsLogsLogGroup
    AWS::Logs::LogGroup
    LinkResourceTypeAwsxRayTrace
    AWS::XRay::Trace
    LinkResourceTypeAwsApplicationInsightsApplication
    AWS::ApplicationInsights::Application
    LinkResourceTypeAwsInternetMonitorMonitor
    AWS::InternetMonitor::Monitor
    LinkResourceTypeAwsApplicationSignalsService
    AWS::ApplicationSignals::Service
    LinkResourceTypeAwsApplicationSignalsServiceLevelObjective
    AWS::ApplicationSignals::ServiceLevelObjective
    AwsCloudWatchMetric
    AWS::CloudWatch::Metric
    AwsLogsLogGroup
    AWS::Logs::LogGroup
    AwsxRayTrace
    AWS::XRay::Trace
    AwsApplicationInsightsApplication
    AWS::ApplicationInsights::Application
    AwsInternetMonitorMonitor
    AWS::InternetMonitor::Monitor
    AwsApplicationSignalsService
    AWS::ApplicationSignals::Service
    AwsApplicationSignalsServiceLevelObjective
    AWS::ApplicationSignals::ServiceLevelObjective
    AwsCloudWatchMetric
    AWS::CloudWatch::Metric
    AwsLogsLogGroup
    AWS::Logs::LogGroup
    AwsxRayTrace
    AWS::XRay::Trace
    AwsApplicationInsightsApplication
    AWS::ApplicationInsights::Application
    AwsInternetMonitorMonitor
    AWS::InternetMonitor::Monitor
    AwsApplicationSignalsService
    AWS::ApplicationSignals::Service
    AwsApplicationSignalsServiceLevelObjective
    AWS::ApplicationSignals::ServiceLevelObjective
    AWS_CLOUD_WATCH_METRIC
    AWS::CloudWatch::Metric
    AWS_LOGS_LOG_GROUP
    AWS::Logs::LogGroup
    AWSX_RAY_TRACE
    AWS::XRay::Trace
    AWS_APPLICATION_INSIGHTS_APPLICATION
    AWS::ApplicationInsights::Application
    AWS_INTERNET_MONITOR_MONITOR
    AWS::InternetMonitor::Monitor
    AWS_APPLICATION_SIGNALS_SERVICE
    AWS::ApplicationSignals::Service
    AWS_APPLICATION_SIGNALS_SERVICE_LEVEL_OBJECTIVE
    AWS::ApplicationSignals::ServiceLevelObjective
    "AWS::CloudWatch::Metric"
    AWS::CloudWatch::Metric
    "AWS::Logs::LogGroup"
    AWS::Logs::LogGroup
    "AWS::XRay::Trace"
    AWS::XRay::Trace
    "AWS::ApplicationInsights::Application"
    AWS::ApplicationInsights::Application
    "AWS::InternetMonitor::Monitor"
    AWS::InternetMonitor::Monitor
    "AWS::ApplicationSignals::Service"
    AWS::ApplicationSignals::Service
    "AWS::ApplicationSignals::ServiceLevelObjective"
    AWS::ApplicationSignals::ServiceLevelObjective

    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 Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-aws-native