Package software.amazon.awscdk.services.cloudtrail

Interface CfnChannelProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnChannelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-15T21:09:15.906Z")
@Stability(Stable)
public interface CfnChannelProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnChannel.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudtrail.*;
 CfnChannelProps cfnChannelProps = CfnChannelProps.builder()
         .destinations(List.of(DestinationProperty.builder()
                 .location("location")
                 .type("type")
                 .build()))
         .name("name")
         .source("source")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-channel.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnChannelProps.Builder	A builder for CfnChannelProps
static final class	CfnChannelProps.Jsii$Proxy	An implementation for CfnChannelProps

Method Summary

Modifier and Type	Method	Description
static CfnChannelProps.Builder	builder()
default Object	getDestinations()	One or more event data stores to which events arriving through a channel will be logged.
default String	getName()	The name of the channel.
default String	getSource()	The name of the partner or external event source.
default List<CfnTag>	getTags()	A list of tags.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDestinations

@Stability(Stable)
@Nullable
default Object getDestinations()

One or more event data stores to which events arriving through a channel will be logged.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-channel.html#cfn-cloudtrail-channel-destinations

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the channel.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-channel.html#cfn-cloudtrail-channel-name

getSource

@Stability(Stable)
@Nullable
default String getSource()

The name of the partner or external event source.

You cannot change this name after you create the channel. A maximum of one channel is allowed per source.

A source can be either Custom for all valid non- AWS events, or the name of a partner event source. For information about the source names for available partners, see Additional information about integration partners in the CloudTrail User Guide.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-channel.html#cfn-cloudtrail-channel-source

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

A list of tags.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-channel.html#cfn-cloudtrail-channel-tags

builder

@Stability(Stable)
static CfnChannelProps.Builder builder()

Returns:

a CfnChannelProps.Builder of CfnChannelProps