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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.932Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnChannel(software.constructs.Construct scope, String id) Create a new `AWS::IoTAnalytics::Channel`.
	CfnChannel(software.constructs.Construct scope, 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
String	getAttrId()
protected Map<String,Object>	getCfnProperties()
String	getChannelName() The name of the channel.
Object	getChannelStorage() Where channel data is stored.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setChannelName(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.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=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 - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnChannel

@Stability(value=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 - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrId()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

Metadata which can be used to manage the channel.

For more information, see Tag .

getChannelName

@Stability(value=Stable)
 @Nullable
public String getChannelName()

The name of the channel.

setChannelName

@Stability(value=Stable)
public void setChannelName(@Nullable
                                                    String value)

The name of the channel.

getChannelStorage

@Stability(value=Stable)
 @Nullable
public Object getChannelStorage()

Where channel data is stored.

setChannelStorage

@Stability(value=Stable)
public void setChannelStorage(@Nullable
                                                       CfnChannel.ChannelStorageProperty value)

Where channel data is stored.

setChannelStorage

@Stability(value=Stable)
public void setChannelStorage(@Nullable
                                                       IResolvable value)

Where channel data is stored.

getRetentionPeriod

@Stability(value=Stable)
 @Nullable
public Object getRetentionPeriod()

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

setRetentionPeriod

@Stability(value=Stable)
public void setRetentionPeriod(@Nullable
                                                        CfnChannel.RetentionPeriodProperty value)

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

setRetentionPeriod

@Stability(value=Stable)
public void setRetentionPeriod(@Nullable
                                                        IResolvable value)

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