CfnChannelPropsMixin

class aws_cdk.cfn_property_mixins.aws_cloudtrail.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:

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

# merge_strategy: cdk.IMergeStrategy

cfn_channel_props_mixin = cloudtrail.CfnChannelPropsMixin(cloudtrail.CfnChannelMixinProps(
    destinations=[cloudtrail.CfnChannelPropsMixin.DestinationProperty(
        location="location",
        type="type"
    )],
    name="name",
    source="source",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

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

Parameters:

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

Methods

apply_to(construct)

Apply the mixin properties to the construct.

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

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)

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.

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.cfn_property_mixins import aws_cloudtrail as cloudtrail

destination_property = cloudtrail.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