interface CfnLinkProps

Language	Type name
.NET	Amazon.CDK.AWS.Oam.CfnLinkProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsoam#CfnLinkProps
Java	software.amazon.awscdk.services.oam.CfnLinkProps
Python	aws_cdk.aws_oam.CfnLinkProps
TypeScript	aws-cdk-lib » aws_oam » CfnLinkProps

Properties for defining a CfnLink.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-oam-link.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_oam as oam } from 'aws-cdk-lib';
const cfnLinkProps: oam.CfnLinkProps = {
  resourceTypes: ['resourceTypes'],
  sinkIdentifier: 'sinkIdentifier',

  // the properties below are optional
  labelTemplate: 'labelTemplate',
  linkConfiguration: {
    logGroupConfiguration: {
      filter: 'filter',
    },
    metricConfiguration: {
      filter: 'filter',
    },
  },
  tags: {
    tagsKey: 'tags',
  },
};

Properties

Name	Type	Description
resourceTypes	string[]	An array of strings that define which types of data that the source account shares with the monitoring account.
sinkIdentifier	string	The ARN of the sink in the monitoring account that you want to link to.
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.
linkConfiguration?	IResolvable | LinkConfigurationProperty	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?	{ [string]: string }	An array of key-value pairs to apply to the link.

---

resourceTypes

Type: string[]

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-oam-link.html#cfn-oam-link-resourcetypes

---

sinkIdentifier

Type: 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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-oam-link.html#cfn-oam-link-sinkidentifier

---

labelTemplate?

Type: string (optional)

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

In the and Regions, the only supported option is to use custom labels, and the $AccountName , $AccountEmail , and $AccountEmailNoDomain variables all resolve as account-id instead of the specified variable.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-oam-link.html#cfn-oam-link-labeltemplate

---

linkConfiguration?

Type: IResolvable | LinkConfigurationProperty (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-oam-link.html#cfn-oam-link-linkconfiguration

---

tags?

Type: { [string]: string } (optional)

An array of key-value pairs to apply to the link.

For more information, see Tag .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-oam-link.html#cfn-oam-link-tags