AWS CDK Reference

Appearance

v2.276.0

CfnChannelProps Struct ​

Properties for defining a CfnChannel.

Source
Generated code

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iotanalytics as iotanalytics } from 'aws-cdk-lib';

declare const serviceManagedS3: any;
const cfnChannelProps: iotanalytics.CfnChannelProps = {
  channelName: 'channelName',
  channelStorage: {
    customerManagedS3: {
      bucket: 'bucket',
      roleArn: 'roleArn',

      // the properties below are optional
      keyPrefix: 'keyPrefix',
    },
    serviceManagedS3: serviceManagedS3,
  },
  retentionPeriod: {
    numberOfDays: 123,
    unlimited: false,
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iotanalytics as iotanalytics

# service_managed_s3: Any

cfn_channel_props = iotanalytics.CfnChannelProps(
    channel_name="channelName",
    channel_storage=iotanalytics.CfnChannel.ChannelStorageProperty(
        customer_managed_s3=iotanalytics.CfnChannel.CustomerManagedS3Property(
            bucket="bucket",
            role_arn="roleArn",

            # the properties below are optional
            key_prefix="keyPrefix"
        ),
        service_managed_s3=service_managed_s3
    ),
    retention_period=iotanalytics.CfnChannel.RetentionPeriodProperty(
        number_of_days=123,
        unlimited=False
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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 cfnChannelProps = 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"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var serviceManagedS3 interface{}

cfnChannelProps := &CfnChannelProps{
	ChannelName: jsii.String("channelName"),
	ChannelStorage: &ChannelStorageProperty{
		CustomerManagedS3: &CustomerManagedS3Property{
			Bucket: jsii.String("bucket"),
			RoleArn: jsii.String("roleArn"),

			// the properties below are optional
			KeyPrefix: jsii.String("keyPrefix"),
		},
		ServiceManagedS3: serviceManagedS3,
	},
	RetentionPeriod: &RetentionPeriodProperty{
		NumberOfDays: jsii.Number(123),
		Unlimited: jsii.Boolean(false),
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

channelNameoptionalstringchannel_nameoptionalstrchannelNameoptionalStringChannelNameoptionalstringChannelNameoptional*string#
The name of the channel.
channelStorageoptionalIResolvable | CfnChannel.ChannelStoragePropertychannel_storageoptionaltyping.Union[IResolvable, ChannelStorageProperty]channelStorageoptionalIResolvableChannelStorageoptionalIResolvableChannelStorageoptionalinterface{}#
Where channel data is stored.
retentionPeriodoptionalIResolvable | CfnChannel.RetentionPeriodPropertyretention_periodoptionaltyping.Union[IResolvable, RetentionPeriodProperty]retentionPeriodoptionalIResolvableRetentionPeriodoptionalIResolvableRetentionPeriodoptionalinterface{}#
How long, in days, message data is kept for the channel.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
Metadata which can be used to manage the channel.

For more information, see Tag .