CfnLink

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.oam.CfnLink

All Implemented Interfaces:

IConstruct, IDependable, IInspectable
```
@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:38.977Z")
public class CfnLink
extends CfnResource
implements IInspectable
```
A CloudFormation `AWS::Oam::Link`.
Creates a link between a source account and a sink that you have created in a monitoring account.
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.
Example:
```
 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.oam.*;
 CfnLink cfnLink = CfnLink.Builder.create(this, "MyCfnLink")
         .resourceTypes(List.of("resourceTypes"))
         .sinkIdentifier("sinkIdentifier")
         // the properties below are optional
         .labelTemplate("labelTemplate")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CfnLink.Builder
A fluent builder for CfnLink.
- Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
  IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
- Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
  IConstruct.Jsii$Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnLink.Builder` A fluent builder for `CfnLink`.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnLink(Construct scope, java.lang.String id, CfnLinkProps props)` Create a new `AWS::Oam::Link`.
`protected`	`CfnLink(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnLink(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttrArn()` The ARN of the link.
`java.lang.String`	`getAttrLabel()` The friendly human-readable name used to identify this source account when it is viewed from the monitoring account.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getLabelTemplate()` Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.
`java.util.List<java.lang.String>`	`getResourceTypes()` An array of strings that define which types of data that the source account shares with the monitoring account.
`java.lang.String`	`getSinkIdentifier()` The ARN of the sink in the monitoring account that you want to link to.
`TagManager`	`getTags()` An array of key-value pairs to apply to the link.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setLabelTemplate(java.lang.String value)` Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.
`void`	`setResourceTypes(java.util.List<java.lang.String> value)` An array of strings that define which types of data that the source account shares with the monitoring account.
`void`	`setSinkIdentifier(java.lang.String value)` The ARN of the sink in the monitoring account that you want to link to.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnLink
```
protected CfnLink(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnLink
```
protected CfnLink(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnLink
```
public CfnLink(Construct scope,
               java.lang.String id,
               CfnLinkProps props)
```
    Create a new `AWS::Oam::Link`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
public void inspect(TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes.
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
public java.lang.String getAttrArn()
```
    The ARN of the link.
    For example, arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789
  - getAttrLabel
```
public java.lang.String getAttrLabel()
```
    The friendly human-readable name used to identify this source account when it is viewed from the monitoring account.
    For example, my-account1 .
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    An array of key-value pairs to apply to the link.
    For more information, see Tag .
  - getResourceTypes
```
public java.util.List<java.lang.String> getResourceTypes()
```
    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 .
  - setResourceTypes
```
public void setResourceTypes(java.util.List<java.lang.String> value)
```
    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 .
  - getSinkIdentifier
```
public java.lang.String getSinkIdentifier()
```
    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.
  - setSinkIdentifier
```
public void setSinkIdentifier(java.lang.String value)
```
    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.
  - getLabelTemplate
```
public java.lang.String getLabelTemplate()
```
    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
  - setLabelTemplate
```
public void setLabelTemplate(java.lang.String value)
```
    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

Class CfnLink

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnLink

CfnLink

CfnLink

Method Detail

inspect

renderProperties

getAttrArn

getAttrLabel

getCfnProperties

getTags

getResourceTypes

setResourceTypes

getSinkIdentifier

setSinkIdentifier

getLabelTemplate

setLabelTemplate