class CfnChannelPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.IoTAnalytics.Mixins.CfnChannelPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsiotanalytics/mixins#CfnChannelPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.iotanalytics.mixins.CfnChannelPropsMixin
Python	aws_cdk.mixins_preview.aws_iotanalytics.mixins.CfnChannelPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_iotanalytics » mixins » CfnChannelPropsMixin

Implements IMixin

Extends Mixin

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-channel.html

Example

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

declare const serviceManagedS3: any;
const cfnChannelPropsMixin = new iotanalytics_mixins.CfnChannelPropsMixin({
  channelName: 'channelName',
  channelStorage: {
    customerManagedS3: {
      bucket: 'bucket',
      keyPrefix: 'keyPrefix',
      roleArn: 'roleArn',
    },
    serviceManagedS3: serviceManagedS3,
  },
  retentionPeriod: {
    numberOfDays: 123,
    unlimited: false,
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnChannelPropsMixin(props: CfnChannelMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnChannelMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::IoTAnalytics::Channel.

Properties

Name	Type	Description
props	CfnChannelMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnChannelMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.