Skip to content
v2.275.0

CfnSinkProps Struct ​

Properties for defining a CfnSink.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_oam as oam } from 'aws-cdk-lib';

declare const policy: any;
const cfnSinkProps: oam.CfnSinkProps = {
  name: 'name',

  // the properties below are optional
  policy: policy,
  tags: {
    tagsKey: 'tags',
  },
};

Properties ​

namestringnamestrnameStringNamestringName*stringrequired#
A name for the sink.
policyoptionalanypolicyoptionalAnypolicyoptionalObjectPolicyoptionalobjectPolicyoptionalinterface{}#
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 }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#
An array of key-value pairs to apply to the sink.

For more information, see Tag .