Package software.amazon.awscdk.services.cloudtrail

Class CfnChannel

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.cloudtrail.CfnChannel
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:40.868Z") @Stability(Stable) public class CfnChannel extends CfnResource implements IInspectable
A CloudFormation AWS::CloudTrail::Channel.

Contains information about a returned CloudTrail channel.

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.*;
 CfnChannel cfnChannel = CfnChannel.Builder.create(this, "MyCfnChannel")
         .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnChannel

      protected CfnChannel(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnChannel

      protected CfnChannel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnChannel

      @Stability(Stable) public CfnChannel(@NotNull Construct scope, @NotNull String id, @Nullable CfnChannelProps props)
      Create a new AWS::CloudTrail::Channel.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnChannel

      @Stability(Stable) public CfnChannel(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::CloudTrail::Channel.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrChannelArn

      @Stability(Stable) @NotNull public String getAttrChannelArn()
      Ref returns the ARN of the CloudTrail channel, such as arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890 .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      A list of tags.

    • getDestinations

      @Stability(Stable) @Nullable public Object getDestinations()
      One or more event data stores to which events arriving through a channel will be logged.

    • setDestinations

      @Stability(Stable) public void setDestinations(@Nullable IResolvable value)
      One or more event data stores to which events arriving through a channel will be logged.

    • setDestinations

      @Stability(Stable) public void setDestinations(@Nullable List<Object> value)
      One or more event data stores to which events arriving through a channel will be logged.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the channel.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the channel.

    • getSource

      @Stability(Stable) @Nullable public 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.

    • setSource

      @Stability(Stable) public void setSource(@Nullable String value)
      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.