CfnChannelPropsMixin

class aws_cdk.mixins_preview.aws_cloudtrail.mixins.CfnChannelPropsMixin(props, *, strategy=None)

Bases: Mixin

Contains information about a returned CloudTrail channel.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-channel.html
CloudformationResource:: AWS::CloudTrail::Channel
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_cloudtrail import mixins as cloudtrail_mixins

cfn_channel_props_mixin = cloudtrail_mixins.CfnChannelPropsMixin(cloudtrail_mixins.CfnChannelMixinProps(
    destinations=[cloudtrail_mixins.CfnChannelPropsMixin.DestinationProperty(
        location="location",
        type="type"
    )],
    name="name",
    source="source",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::CloudTrail::Channel.

Parameters:

props (Union[CfnChannelMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['destinations', 'name', 'source', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

DestinationProperty

class CfnChannelPropsMixin.DestinationProperty(*, location=None, type=None)

Bases: object

Contains information about the destination receiving events.

Parameters:

location (Optional[str]) – For channels used for a CloudTrail Lake integration, the location is the ARN of an event data store that receives events from a channel. For service-linked channels, the location is the name of the AWS service.
type (Optional[str]) – The type of destination for events arriving from a channel. For channels used for a CloudTrail Lake integration, the value is EVENT_DATA_STORE . For service-linked channels, the value is AWS_SERVICE .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-channel-destination.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.mixins_preview.aws_cloudtrail import mixins as cloudtrail_mixins

destination_property = cloudtrail_mixins.CfnChannelPropsMixin.DestinationProperty(
    location="location",
    type="type"
)

Attributes

location

For channels used for a CloudTrail Lake integration, the location is the ARN of an event data store that receives events from a channel.

For service-linked channels, the location is the name of the AWS service.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-channel-destination.html#cfn-cloudtrail-channel-destination-location

type

The type of destination for events arriving from a channel.

For channels used for a CloudTrail Lake integration, the value is EVENT_DATA_STORE . For service-linked channels, the value is AWS_SERVICE .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-channel-destination.html#cfn-cloudtrail-channel-destination-type