software.amazon.awscdk.services.iotanalytics

Class CfnChannel

java.lang.Object

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.iotanalytics.CfnChannel

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:22.558Z")
public class CfnChannel
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoTAnalytics::Channel`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnChannel.Builder A fluent builder for CfnChannel.
static interface	CfnChannel.ChannelStorageProperty Where channel data is stored.
static interface	CfnChannel.CustomerManagedS3Property Used to store channel data in an S3 bucket that you manage.
static interface	CfnChannel.RetentionPeriodProperty How long, in days, message data is kept.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnChannel(Construct scope, java.lang.String id) Create a new `AWS::IoTAnalytics::Channel`.
	CfnChannel(Construct scope, java.lang.String id, CfnChannelProps props) Create a new `AWS::IoTAnalytics::Channel`.
protected	CfnChannel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnChannel(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrId()
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getChannelName() The name of the channel.
java.lang.Object	getChannelStorage() Where channel data is stored.
java.lang.Object	getRetentionPeriod() How long, in days, message data is kept for the channel.
TagManager	getTags() Metadata which can be used to manage the channel.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setChannelName(java.lang.String value) The name of the channel.
void	setChannelStorage(CfnChannel.ChannelStorageProperty value) Where channel data is stored.
void	setChannelStorage(IResolvable value) Where channel data is stored.
void	setRetentionPeriod(CfnChannel.RetentionPeriodProperty value) How long, in days, message data is kept for the channel.
void	setRetentionPeriod(IResolvable value) How long, in days, message data is kept for the channel.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnChannel

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

CfnChannel

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

CfnChannel

public CfnChannel(Construct scope,
                  java.lang.String id,
                  CfnChannelProps props)

Create a new `AWS::IoTAnalytics::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

public CfnChannel(Construct scope,
                  java.lang.String id)

Create a new `AWS::IoTAnalytics::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 Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

public java.lang.String getAttrId()

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

Metadata which can be used to manage the channel.

For more information, see Tag .

getChannelName

public java.lang.String getChannelName()

The name of the channel.

setChannelName

public void setChannelName(java.lang.String value)

The name of the channel.

getChannelStorage

public java.lang.Object getChannelStorage()

Where channel data is stored.

setChannelStorage

public void setChannelStorage(CfnChannel.ChannelStorageProperty value)

Where channel data is stored.

setChannelStorage

public void setChannelStorage(IResolvable value)

Where channel data is stored.

getRetentionPeriod

public java.lang.Object getRetentionPeriod()

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

setRetentionPeriod

public void setRetentionPeriod(IResolvable value)

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

setRetentionPeriod

public void setRetentionPeriod(CfnChannel.RetentionPeriodProperty value)

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