Class CfnChannel
A CloudFormation AWS::IoTAnalytics::Channel
.
Inherited Members
Namespace: Amazon.CDK.AWS.IoTAnalytics
Assembly: Amazon.CDK.AWS.IoTAnalytics.dll
Syntax (csharp)
public class CfnChannel : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnChannel
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 .
CloudformationResource: AWS::IoTAnalytics::Channel
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-channel.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoTAnalytics;
var serviceManagedS3;
var cfnChannel = new CfnChannel(this, "MyCfnChannel", new CfnChannelProps {
ChannelName = "channelName",
ChannelStorage = new ChannelStorageProperty {
CustomerManagedS3 = new CustomerManagedS3Property {
Bucket = "bucket",
RoleArn = "roleArn",
// the properties below are optional
KeyPrefix = "keyPrefix"
},
ServiceManagedS3 = serviceManagedS3
},
RetentionPeriod = new RetentionPeriodProperty {
NumberOfDays = 123,
Unlimited = false
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnChannel(Construct, String, ICfnChannelProps) | Create a new |
CfnChannel(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnChannel(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrId | |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ChannelName | The name of the channel. |
ChannelStorage | Where channel data is stored. |
RetentionPeriod | How long, in days, message data is kept for the channel. |
Tags | Metadata which can be used to manage the channel. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnChannel(Construct, String, ICfnChannelProps)
Create a new AWS::IoTAnalytics::Channel
.
public CfnChannel(Construct scope, string id, ICfnChannelProps props = null)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnChannelProps
- resource properties.
CfnChannel(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnChannel(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnChannel(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnChannel(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ChannelName
The name of the channel.
public virtual string ChannelName { get; set; }
Property Value
System.String
Remarks
ChannelStorage
Where channel data is stored.
public virtual object ChannelStorage { get; set; }
Property Value
System.Object
Remarks
RetentionPeriod
How long, in days, message data is kept for the channel.
public virtual object RetentionPeriod { get; set; }
Property Value
System.Object
Remarks
Tags
Metadata which can be used to manage the channel.
public virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Tag .
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>