Package software.amazon.awscdk.services.iotanalytics

Class CfnChannel

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.iotanalytics.CfnChannel
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IChannelRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:07.535Z") @Stability(Stable) public class CfnChannel extends CfnResource implements IInspectable, IChannelRef, ITaggable
The AWS::IoTAnalytics::Channel resource collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline.

For more information, see How to Use AWS IoT Analytics in the AWS IoT Analytics User Guide .

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.iotanalytics.*;
 Object serviceManagedS3;
 CfnChannel cfnChannel = CfnChannel.Builder.create(this, "MyCfnChannel")
         .channelName("channelName")
         .channelStorage(ChannelStorageProperty.builder()
                 .customerManagedS3(CustomerManagedS3Property.builder()
                         .bucket("bucket")
                         .roleArn("roleArn")
                         // the properties below are optional
                         .keyPrefix("keyPrefix")
                         .build())
                 .serviceManagedS3(serviceManagedS3)
                 .build())
         .retentionPeriod(RetentionPeriodProperty.builder()
                 .numberOfDays(123)
                 .unlimited(false)
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • 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 software.constructs.Construct scope, @NotNull String id, @Nullable CfnChannelProps props)
      Create a new AWS::IoTAnalytics::Channel.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnChannel

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

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • fromChannelName

      @Stability(Stable) @NotNull public static IChannelRef fromChannelName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String channelName)
      Creates a new IChannelRef from a channelName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      channelName - This parameter is required.

    • 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.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getCfnProperties

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

    • getChannelRef

      @Stability(Stable) @NotNull public ChannelReference getChannelRef()
      A reference to a Channel resource.
      Specified by:
      getChannelRef in interface IChannelRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getChannelName

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

    • setChannelName

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

    • getChannelStorage

      @Stability(Stable) @Nullable public Object getChannelStorage()
      Where channel data is stored.

      Returns union: either IResolvable or CfnChannel.ChannelStorageProperty

    • setChannelStorage

      @Stability(Stable) public void setChannelStorage(@Nullable IResolvable value)
      Where channel data is stored.

    • setChannelStorage

      @Stability(Stable) public void setChannelStorage(@Nullable CfnChannel.ChannelStorageProperty value)
      Where channel data is stored.

    • getRetentionPeriod

      @Stability(Stable) @Nullable public Object getRetentionPeriod()
      How long, in days, message data is kept for the channel.

      Returns union: either IResolvable or CfnChannel.RetentionPeriodProperty

    • setRetentionPeriod

      @Stability(Stable) public void setRetentionPeriod(@Nullable IResolvable value)
      How long, in days, message data is kept for the channel.

    • setRetentionPeriod

      @Stability(Stable) public void setRetentionPeriod(@Nullable CfnChannel.RetentionPeriodProperty value)
      How long, in days, message data is kept for the channel.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Metadata which can be used to manage the channel.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Metadata which can be used to manage the channel.