Package software.amazon.awscdk.services.iotanalytics

Interface CfnChannelProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnChannelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:41.591Z")
@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.iotanalytics.*;
 Object serviceManagedS3;
 CfnChannelProps cfnChannelProps = CfnChannelProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-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 String	getChannelName()	The name of the channel.
default Object	getChannelStorage()	Where channel data is stored.
default Object	getRetentionPeriod()	How long, in days, message data is kept for the channel.
default List<CfnTag>	getTags()	Metadata which can be used to manage the channel.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getChannelName

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

The name of the channel.

See Also:

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

getChannelStorage

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

Where channel data is stored.

Returns union: either IResolvable or CfnChannel.ChannelStorageProperty

See Also:

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

getRetentionPeriod

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

How long, in days, message data is kept for the channel.

Returns union: either IResolvable or CfnChannel.RetentionPeriodProperty

See Also:

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

getTags

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

Metadata which can be used to manage the channel.

For more information, see Tag .

See Also:

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

builder

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

Returns:

a CfnChannelProps.Builder of CfnChannelProps