AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Oam::Sink

CfnSink

Creates or updates a *sink* in the current account, so that it can be used as a monitoring account in CloudWatch cross-account observability. A sink is a resource that represents an attachment point in a monitoring account, which source accounts can link to to be able to send observability data. After you create a sink, you must create a sink policy that allows source accounts to attach to it. For more information, see [PutSinkPolicy](https://docs.aws.amazon.com/OAM/latest/APIReference/API_PutSinkPolicy.html) . An account can have one sink.

Import

import { CfnSink } from 'aws-cdk-lib/aws-oam';

Or use the module namespace:

import * as oam from 'aws-cdk-lib/aws-oam';
// oam.CfnSink

Properties

Configuration passed to the constructor as CfnSinkProps.

nameRequired
string

A name for the sink.

policyOptional
any

The IAM policy that grants permissions to source accounts to link to this sink. The policy can grant permission in the following ways: - Include organization IDs or organization paths to permit all accounts in an organization - Include account IDs to permit the specified accounts

tagsOptional
{ [key: string]: string }

An array of key-value pairs to apply to the sink. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-oam
CFN TypeAWS::Oam::Sink
Properties3

Related Constructs

External Links