CfnSinkProps

class aws_cdk.aws_oam.CfnSinkProps(*, name, policy=None, tags=None)

Bases: object

Properties for defining a CfnSink.

Parameters:
  • name (str) – A name for the sink.

  • policy (Optional[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

  • tags (Optional[Mapping[str, str]]) – An array of key-value pairs to apply to the sink. For more information, see Tag .

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

# policy: Any

cfn_sink_props = oam.CfnSinkProps(
    name="name",

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

Attributes

name

A name for the sink.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-oam-sink.html#cfn-oam-sink-name

policy

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-oam-sink.html#cfn-oam-sink-policy

tags

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

For more information, see Tag .

See:

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