CfnLinkProps

class aws_cdk.aws_oam.CfnLinkProps(*, resource_types, sink_identifier, label_template=None, tags=None)

Bases: object

Properties for defining a CfnLink.

Parameters:

resource_types (Sequence[str]) – 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 .
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 (Optional[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
tags (Optional[Mapping[str, str]]) – An array of key-value pairs to apply to the link. For more information, see Tag .

Link:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_oam as oam

cfn_link_props = oam.CfnLinkProps(
    resource_types=["resourceTypes"],
    sink_identifier="sinkIdentifier",

    # the properties below are optional
    label_template="labelTemplate",
    tags={
        "tags_key": "tags"
    }
)

Attributes

label_template

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-oam-link.html#cfn-oam-link-labeltemplate

resource_types

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 .

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

sink_identifier

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.

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

tags

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

For more information, see Tag .

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