interface CfnSinkProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Oam.CfnSinkProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsoam#CfnSinkProps |
 Java | software.amazon.awscdk.services.oam.CfnSinkProps |
 Python | aws_cdk.aws_oam.CfnSinkProps |
 TypeScript | aws-cdk-lib » aws_oam » CfnSinkProps |
Properties for defining a CfnSink.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-oam-sink.html
Example
// 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
| Name | Type | Description |
|---|---|---|
| name | string | A name for the sink. |
| policy? | any | The IAM policy that grants permissions to source accounts to link to this sink. |
| tags? | { [string]: string } | An array of key-value pairs to apply to the sink. |
name
Type:
string
A name for the sink.
policy?
Type:
any
(optional)
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
tags?
Type:
{ [string]: string }
(optional)
An array of key-value pairs to apply to the sink.
For more information, see Tag .