Interface ICfnLinkProps

Properties for defining a CfnLink.

Namespace: Amazon.CDK.AWS.Oam

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnLinkProps

Syntax (vb)

Public Interface ICfnLinkProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Oam;

             var cfnLinkProps = new CfnLinkProps {
                 ResourceTypes = new [] { "resourceTypes" },
                 SinkIdentifier = "sinkIdentifier",

                 // the properties below are optional
                 LabelTemplate = "labelTemplate",
                 LinkConfiguration = new LinkConfigurationProperty {
                     LogGroupConfiguration = new LinkFilterProperty {
                         Filter = "filter"
                     },
                     MetricConfiguration = new LinkFilterProperty {
                         Filter = "filter"
                     }
                 },
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 }
             };

Synopsis

Properties

LabelTemplate	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	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	An array of strings that define which types of data that the source account shares with the monitoring account.
SinkIdentifier	The ARN of the sink in the monitoring account that you want to link to.
Tags	An array of key-value pairs to apply to the link.

Properties

LabelTemplate

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

string? LabelTemplate { get; }

Property Value

string

Remarks

You can include the following variables in your template:

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

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

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.

object? LinkConfiguration { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnLink.ILinkConfigurationProperty

ResourceTypes

An array of strings that define which types of data that the source account shares with the monitoring account.

string[] ResourceTypes { get; }

Property Value

string[]

Remarks

Valid values are AWS::CloudWatch::Metric | AWS::Logs::LogGroup | AWS::XRay::Trace | AWS::ApplicationInsights::Application | AWS::InternetMonitor::Monitor .

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

SinkIdentifier

The ARN of the sink in the monitoring account that you want to link to.

string SinkIdentifier { get; }

Property Value

string

Remarks

You can use ListSinks to find the ARNs of sinks.

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