Class CfnLink

Creates a link between a source account and a sink that you have created in a monitoring account.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnLink
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.Oam
Assembly: Amazon.CDK.Lib.dll
public class CfnLink : CfnResource, IInspectable, ILinkRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Public Class CfnLink Inherits CfnResource Implements IInspectable, ILinkRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Before you create a link, you must create a sink in the monitoring account. The sink must have a sink policy that permits the source account to link to it. You can grant permission to source accounts by granting permission to an entire organization, an organizational unit, or to individual accounts.

For more information, see CreateSink and PutSinkPolicy .

Each monitoring account can be linked to as many as 100,000 source accounts.

Each source account can be linked to as many as five monitoring accounts.

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

CloudformationResource: AWS::Oam::Link

ExampleMetadata: fixture=_generated

// 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 cfnLink = new CfnLink(this, "MyCfnLink", 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" }
                 }
             });

Constructors

CfnLink(Construct, string, ICfnLinkProps)

Create a new AWS::Oam::Link.

Properties

AttrArn

The ARN of the link.
AttrLabel

The friendly human-readable name used to identify this source account when it is viewed from the monitoring account.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties

Creates a link between a source account and a sink that you have created in a monitoring account.
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.
LinkRef

A reference to a Link resource.
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

Tag Manager which manages the tags for this resource.
TagsRaw

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

Methods

ArnForLink(ILinkRef)

Creates a link between a source account and a sink that you have created in a monitoring account.
Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
IsCfnLink(object)

Checks whether the given object is a CfnLink.
RenderProperties(IDictionary<string, object>)

Creates a link between a source account and a sink that you have created in a monitoring account.

Constructors

CfnLink(Construct, string, ICfnLinkProps)

Create a new AWS::Oam::Link.

public CfnLink(Construct scope, string id, ICfnLinkProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnLinkProps

Resource properties.

Remarks

Before you create a link, you must create a sink in the monitoring account. The sink must have a sink policy that permits the source account to link to it. You can grant permission to source accounts by granting permission to an entire organization, an organizational unit, or to individual accounts.

For more information, see CreateSink and PutSinkPolicy .

Each monitoring account can be linked to as many as 100,000 source accounts.

Each source account can be linked to as many as five monitoring accounts.

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

CloudformationResource: AWS::Oam::Link

ExampleMetadata: fixture=_generated

Properties

The ARN of the link.

public virtual string AttrArn { get; }
Property Value

string

For example, arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789

CloudformationAttribute: Arn

The friendly human-readable name used to identify this source account when it is viewed from the monitoring account.

public virtual string AttrLabel { get; }
Property Value

string

For example, my-account1 .

CloudformationAttribute: Label

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Before you create a link, you must create a sink in the monitoring account. The sink must have a sink policy that permits the source account to link to it. You can grant permission to source accounts by granting permission to an entire organization, an organizational unit, or to individual accounts.

For more information, see CreateSink and PutSinkPolicy .

Each monitoring account can be linked to as many as 100,000 source accounts.

Each source account can be linked to as many as five monitoring accounts.

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

CloudformationResource: AWS::Oam::Link

ExampleMetadata: fixture=_generated

Creates a link between a source account and a sink that you have created in a monitoring account.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides

Before you create a link, you must create a sink in the monitoring account. The sink must have a sink policy that permits the source account to link to it. You can grant permission to source accounts by granting permission to an entire organization, an organizational unit, or to individual accounts.

For more information, see CreateSink and PutSinkPolicy .

Each monitoring account can be linked to as many as 100,000 source accounts.

Each source account can be linked to as many as five monitoring accounts.

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

CloudformationResource: AWS::Oam::Link

ExampleMetadata: fixture=_generated

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

public virtual string? LabelTemplate { get; set; }
Property Value

string

Before you create a link, you must create a sink in the monitoring account. The sink must have a sink policy that permits the source account to link to it. You can grant permission to source accounts by granting permission to an entire organization, an organizational unit, or to individual accounts.

For more information, see CreateSink and PutSinkPolicy .

Each monitoring account can be linked to as many as 100,000 source accounts.

Each source account can be linked to as many as five monitoring accounts.

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

CloudformationResource: AWS::Oam::Link

ExampleMetadata: fixture=_generated

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.

public virtual object? LinkConfiguration { get; set; }
Property Value

object

Type union: either IResolvable or CfnLink.ILinkConfigurationProperty

A reference to a Link resource.

public virtual ILinkReference LinkRef { get; }
Property Value

ILinkReference

Before you create a link, you must create a sink in the monitoring account. The sink must have a sink policy that permits the source account to link to it. You can grant permission to source accounts by granting permission to an entire organization, an organizational unit, or to individual accounts.

For more information, see CreateSink and PutSinkPolicy .

Each monitoring account can be linked to as many as 100,000 source accounts.

Each source account can be linked to as many as five monitoring accounts.

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

CloudformationResource: AWS::Oam::Link

ExampleMetadata: fixture=_generated

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

public virtual string[] ResourceTypes { get; set; }
Property Value

string[]

Before you create a link, you must create a sink in the monitoring account. The sink must have a sink policy that permits the source account to link to it. You can grant permission to source accounts by granting permission to an entire organization, an organizational unit, or to individual accounts.

For more information, see CreateSink and PutSinkPolicy .

Each monitoring account can be linked to as many as 100,000 source accounts.

Each source account can be linked to as many as five monitoring accounts.

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

CloudformationResource: AWS::Oam::Link

ExampleMetadata: fixture=_generated

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

public virtual string SinkIdentifier { get; set; }
Property Value

string

Before you create a link, you must create a sink in the monitoring account. The sink must have a sink policy that permits the source account to link to it. You can grant permission to source accounts by granting permission to an entire organization, an organizational unit, or to individual accounts.

For more information, see CreateSink and PutSinkPolicy .

Each monitoring account can be linked to as many as 100,000 source accounts.

Each source account can be linked to as many as five monitoring accounts.

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

CloudformationResource: AWS::Oam::Link

ExampleMetadata: fixture=_generated

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

Before you create a link, you must create a sink in the monitoring account. The sink must have a sink policy that permits the source account to link to it. You can grant permission to source accounts by granting permission to an entire organization, an organizational unit, or to individual accounts.

For more information, see CreateSink and PutSinkPolicy .

Each monitoring account can be linked to as many as 100,000 source accounts.

Each source account can be linked to as many as five monitoring accounts.

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

CloudformationResource: AWS::Oam::Link

ExampleMetadata: fixture=_generated

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

public virtual IDictionary<string, string>? TagsRaw { get; set; }
Property Value

IDictionary<string, string>

Before you create a link, you must create a sink in the monitoring account. The sink must have a sink policy that permits the source account to link to it. You can grant permission to source accounts by granting permission to an entire organization, an organizational unit, or to individual accounts.

For more information, see CreateSink and PutSinkPolicy .

Each monitoring account can be linked to as many as 100,000 source accounts.

Each source account can be linked to as many as five monitoring accounts.

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

CloudformationResource: AWS::Oam::Link

ExampleMetadata: fixture=_generated

Methods

ArnForLink(ILinkRef)

Creates a link between a source account and a sink that you have created in a monitoring account.

public static string ArnForLink(ILinkRef resource)
Parameters
resource ILinkRef
Returns

string

Remarks

Before you create a link, you must create a sink in the monitoring account. The sink must have a sink policy that permits the source account to link to it. You can grant permission to source accounts by granting permission to an entire organization, an organizational unit, or to individual accounts.

For more information, see CreateSink and PutSinkPolicy .

Each monitoring account can be linked to as many as 100,000 source accounts.

Each source account can be linked to as many as five monitoring accounts.

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

CloudformationResource: AWS::Oam::Link

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 cfnLink = new CfnLink(this, "MyCfnLink", 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" }
                 }
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

Before you create a link, you must create a sink in the monitoring account. The sink must have a sink policy that permits the source account to link to it. You can grant permission to source accounts by granting permission to an entire organization, an organizational unit, or to individual accounts.

For more information, see CreateSink and PutSinkPolicy .

Each monitoring account can be linked to as many as 100,000 source accounts.

Each source account can be linked to as many as five monitoring accounts.

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

CloudformationResource: AWS::Oam::Link

ExampleMetadata: fixture=_generated

IsCfnLink(object)

Checks whether the given object is a CfnLink.

public static bool IsCfnLink(object x)
Parameters
x object
Returns

bool

Remarks

Before you create a link, you must create a sink in the monitoring account. The sink must have a sink policy that permits the source account to link to it. You can grant permission to source accounts by granting permission to an entire organization, an organizational unit, or to individual accounts.

For more information, see CreateSink and PutSinkPolicy .

Each monitoring account can be linked to as many as 100,000 source accounts.

Each source account can be linked to as many as five monitoring accounts.

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

CloudformationResource: AWS::Oam::Link

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a link between a source account and a sink that you have created in a monitoring account.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

Before you create a link, you must create a sink in the monitoring account. The sink must have a sink policy that permits the source account to link to it. You can grant permission to source accounts by granting permission to an entire organization, an organizational unit, or to individual accounts.

For more information, see CreateSink and PutSinkPolicy .

Each monitoring account can be linked to as many as 100,000 source accounts.

Each source account can be linked to as many as five monitoring accounts.

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

CloudformationResource: AWS::Oam::Link

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable