1.204.0

interface CfnLinkProps

LanguageType name
.NETAmazon.CDK.AWS.Oam.CfnLinkProps
Javasoftware.amazon.awscdk.services.oam.CfnLinkProps
Pythonaws_cdk.aws_oam.CfnLinkProps
TypeScript @aws-cdk/aws-oam » CfnLinkProps

Properties for defining a CfnLink.

Example

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

  // the properties below are optional
  labelTemplate: 'labelTemplate',
  tags: {
    tagsKey: 'tags',
  },
};

Properties

NameTypeDescription
resourceTypesstring[]An array of strings that define which types of data that the source account shares with the monitoring account.
sinkIdentifierstringThe ARN of the sink in the monitoring account that you want to link to.
labelTemplate?stringSpecify a friendly human-readable name to use to identify this source account when you are viewing data from it in 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 .

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.

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

tags?

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

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

For more information, see Tag .

← PreviousNext →