This documentation is for the developer preview release of the AWS CDK. Do not use this version of the AWS CDK in production. Subsequent releases of the AWS CDK will likely include breaking changes.

@aws-cdk/aws-iotanalytics

AWS::IoTAnalytics Construct Library

import iotanalytics = require('@aws-cdk/aws-iotanalytics');

Reference

View in Nuget

csproj:

<PackageReference Include="Amazon.CDK.AWS.IoTAnalytics" Version="0.25.3" />

dotnet:

dotnet add package Amazon.CDK.AWS.IoTAnalytics --version 0.25.3

packages.config:

<package id="Amazon.CDK.AWS.IoTAnalytics" version="0.25.3" />

View in Maven Central

Apache Buildr:

'software.amazon.awscdk:iotanalytics:jar:0.25.3'

Apache Ivy:

<dependency groupId="software.amazon.awscdk" name="iotanalytics" rev="0.25.3"/>

Apache Maven:

<dependency>
  <groupId>software.amazon.awscdk</groupId>
  <artifactId>iotanalytics</artifactId>
  <version>0.25.3</version>
</dependency>

Gradle / Grails:

compile 'software.amazon.awscdk:iotanalytics:0.25.3'

Groovy Grape:

@Grapes(
@Grab(group='software.amazon.awscdk', module='iotanalytics', version='0.25.3')
)

View in NPM

npm:

$ npm i @aws-cdk/aws-iotanalytics@0.25.3

package.json:

{
  "@aws-cdk/aws-iotanalytics": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-iotanalytics@0.25.3

View in NPM

npm:

$ npm i @aws-cdk/aws-iotanalytics@0.25.3

package.json:

{
  "@aws-cdk/aws-iotanalytics": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-iotanalytics@0.25.3

CfnChannel

class @aws-cdk/aws-iotanalytics.CfnChannel(scope, id[, props])

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnChannel;
const { CfnChannel } = require('@aws-cdk/aws-iotanalytics');
import { CfnChannel } from '@aws-cdk/aws-iotanalytics';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
channelId
Type:string (readonly)
propertyOverrides
Type:CfnChannelProps (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
class RetentionPeriodProperty

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnChannel.RetentionPeriodProperty;
// CfnChannel.RetentionPeriodProperty is an interface
import { CfnChannel.RetentionPeriodProperty } from '@aws-cdk/aws-iotanalytics';
numberOfDays

CfnChannel.RetentionPeriodProperty.NumberOfDays

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-retentionperiod.html#cfn-iotanalytics-channel-retentionperiod-numberofdays

Type:number or @aws-cdk/cdk.Token (optional)
unlimited

CfnChannel.RetentionPeriodProperty.Unlimited

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-retentionperiod.html#cfn-iotanalytics-channel-retentionperiod-unlimited

Type:boolean or @aws-cdk/cdk.Token (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnChannelProps (interface)

class @aws-cdk/aws-iotanalytics.CfnChannelProps

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnChannelProps;
// CfnChannelProps is an interface
import { CfnChannelProps } from '@aws-cdk/aws-iotanalytics';
channelName

AWS::IoTAnalytics::Channel.ChannelName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-channel.html#cfn-iotanalytics-channel-channelname

Type:string (optional)
retentionPeriod

AWS::IoTAnalytics::Channel.RetentionPeriod

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-channel.html#cfn-iotanalytics-channel-retentionperiod

Type:RetentionPeriodProperty or @aws-cdk/cdk.Token (optional)
tags

AWS::IoTAnalytics::Channel.Tags

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-channel.html#cfn-iotanalytics-channel-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.CfnTag)[] (optional)

CfnDataset

class @aws-cdk/aws-iotanalytics.CfnDataset(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnDataset;
const { CfnDataset } = require('@aws-cdk/aws-iotanalytics');
import { CfnDataset } from '@aws-cdk/aws-iotanalytics';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
datasetId
Type:string (readonly)
propertyOverrides
Type:CfnDatasetProps (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
class ActionProperty

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnDataset.ActionProperty;
// CfnDataset.ActionProperty is an interface
import { CfnDataset.ActionProperty } from '@aws-cdk/aws-iotanalytics';
actionName

CfnDataset.ActionProperty.ActionName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-action.html#cfn-iotanalytics-dataset-action-actionname

Type:string
containerAction

CfnDataset.ActionProperty.ContainerAction

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-action.html#cfn-iotanalytics-dataset-action-containeraction

Type:@aws-cdk/cdk.Token or ContainerActionProperty (optional)
queryAction

CfnDataset.ActionProperty.QueryAction

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-action.html#cfn-iotanalytics-dataset-action-queryaction

Type:@aws-cdk/cdk.Token or QueryActionProperty (optional)
class ContainerActionProperty

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnDataset.ContainerActionProperty;
// CfnDataset.ContainerActionProperty is an interface
import { CfnDataset.ContainerActionProperty } from '@aws-cdk/aws-iotanalytics';
executionRoleArn

CfnDataset.ContainerActionProperty.ExecutionRoleArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-containeraction.html#cfn-iotanalytics-dataset-containeraction-executionrolearn

Type:string
image

CfnDataset.ContainerActionProperty.Image

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-containeraction.html#cfn-iotanalytics-dataset-containeraction-image

Type:string
resourceConfiguration

CfnDataset.ContainerActionProperty.ResourceConfiguration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-containeraction.html#cfn-iotanalytics-dataset-containeraction-resourceconfiguration

Type:@aws-cdk/cdk.Token or ResourceConfigurationProperty
variables

CfnDataset.ContainerActionProperty.Variables

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-containeraction.html#cfn-iotanalytics-dataset-containeraction-variables

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or VariableProperty)[] (optional)
class DatasetContentVersionValueProperty

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnDataset.DatasetContentVersionValueProperty;
// CfnDataset.DatasetContentVersionValueProperty is an interface
import { CfnDataset.DatasetContentVersionValueProperty } from '@aws-cdk/aws-iotanalytics';
datasetName

CfnDataset.DatasetContentVersionValueProperty.DatasetName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable-datasetcontentversionvalue.html#cfn-iotanalytics-dataset-variable-datasetcontentversionvalue-datasetname

Type:string (optional)
class DeltaTimeProperty

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnDataset.DeltaTimeProperty;
// CfnDataset.DeltaTimeProperty is an interface
import { CfnDataset.DeltaTimeProperty } from '@aws-cdk/aws-iotanalytics';
offsetSeconds

CfnDataset.DeltaTimeProperty.OffsetSeconds

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-deltatime.html#cfn-iotanalytics-dataset-deltatime-offsetseconds

Type:number or @aws-cdk/cdk.Token
timeExpression

CfnDataset.DeltaTimeProperty.TimeExpression

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-deltatime.html#cfn-iotanalytics-dataset-deltatime-timeexpression

Type:string
class FilterProperty

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnDataset.FilterProperty;
// CfnDataset.FilterProperty is an interface
import { CfnDataset.FilterProperty } from '@aws-cdk/aws-iotanalytics';
deltaTime

CfnDataset.FilterProperty.DeltaTime

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-filter.html#cfn-iotanalytics-dataset-filter-deltatime

Type:@aws-cdk/cdk.Token or DeltaTimeProperty (optional)
class OutputFileUriValueProperty

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnDataset.OutputFileUriValueProperty;
// CfnDataset.OutputFileUriValueProperty is an interface
import { CfnDataset.OutputFileUriValueProperty } from '@aws-cdk/aws-iotanalytics';
fileName

CfnDataset.OutputFileUriValueProperty.FileName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable-outputfileurivalue.html#cfn-iotanalytics-dataset-variable-outputfileurivalue-filename

Type:string (optional)
class QueryActionProperty

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnDataset.QueryActionProperty;
// CfnDataset.QueryActionProperty is an interface
import { CfnDataset.QueryActionProperty } from '@aws-cdk/aws-iotanalytics';
sqlQuery

CfnDataset.QueryActionProperty.SqlQuery

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-queryaction.html#cfn-iotanalytics-dataset-queryaction-sqlquery

Type:string
filters

CfnDataset.QueryActionProperty.Filters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-queryaction.html#cfn-iotanalytics-dataset-queryaction-filters

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or FilterProperty)[] (optional)
class ResourceConfigurationProperty

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnDataset.ResourceConfigurationProperty;
// CfnDataset.ResourceConfigurationProperty is an interface
import { CfnDataset.ResourceConfigurationProperty } from '@aws-cdk/aws-iotanalytics';
computeType

CfnDataset.ResourceConfigurationProperty.ComputeType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-resourceconfiguration.html#cfn-iotanalytics-dataset-resourceconfiguration-computetype

Type:string
volumeSizeInGb

CfnDataset.ResourceConfigurationProperty.VolumeSizeInGB

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-resourceconfiguration.html#cfn-iotanalytics-dataset-resourceconfiguration-volumesizeingb

Type:number or @aws-cdk/cdk.Token
class RetentionPeriodProperty

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnDataset.RetentionPeriodProperty;
// CfnDataset.RetentionPeriodProperty is an interface
import { CfnDataset.RetentionPeriodProperty } from '@aws-cdk/aws-iotanalytics';
numberOfDays

CfnDataset.RetentionPeriodProperty.NumberOfDays

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-retentionperiod.html#cfn-iotanalytics-dataset-retentionperiod-numberofdays

Type:number or @aws-cdk/cdk.Token
unlimited

CfnDataset.RetentionPeriodProperty.Unlimited

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-retentionperiod.html#cfn-iotanalytics-dataset-retentionperiod-unlimited

Type:boolean or @aws-cdk/cdk.Token
class ScheduleProperty

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnDataset.ScheduleProperty;
// CfnDataset.ScheduleProperty is an interface
import { CfnDataset.ScheduleProperty } from '@aws-cdk/aws-iotanalytics';
scheduleExpression

CfnDataset.ScheduleProperty.ScheduleExpression

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-trigger-schedule.html#cfn-iotanalytics-dataset-trigger-schedule-scheduleexpression

Type:string
class TriggerProperty

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnDataset.TriggerProperty;
// CfnDataset.TriggerProperty is an interface
import { CfnDataset.TriggerProperty } from '@aws-cdk/aws-iotanalytics';
schedule

CfnDataset.TriggerProperty.Schedule

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-trigger.html#cfn-iotanalytics-dataset-trigger-schedule

Type:@aws-cdk/cdk.Token or ScheduleProperty (optional)
triggeringDataset

CfnDataset.TriggerProperty.TriggeringDataset

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-trigger.html#cfn-iotanalytics-dataset-trigger-triggeringdataset

Type:@aws-cdk/cdk.Token or TriggeringDatasetProperty (optional)
class TriggeringDatasetProperty

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnDataset.TriggeringDatasetProperty;
// CfnDataset.TriggeringDatasetProperty is an interface
import { CfnDataset.TriggeringDatasetProperty } from '@aws-cdk/aws-iotanalytics';
datasetName

CfnDataset.TriggeringDatasetProperty.DatasetName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-triggeringdataset.html#cfn-iotanalytics-dataset-triggeringdataset-datasetname

Type:string
class VariableProperty

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnDataset.VariableProperty;
// CfnDataset.VariableProperty is an interface
import { CfnDataset.VariableProperty } from '@aws-cdk/aws-iotanalytics';
variableName

CfnDataset.VariableProperty.VariableName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-variablename

Type:string
datasetContentVersionValue

CfnDataset.VariableProperty.DatasetContentVersionValue

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-datasetcontentversionvalue

Type:@aws-cdk/cdk.Token or DatasetContentVersionValueProperty (optional)
doubleValue

CfnDataset.VariableProperty.DoubleValue

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-doublevalue

Type:number or @aws-cdk/cdk.Token (optional)
outputFileUriValue

CfnDataset.VariableProperty.OutputFileUriValue

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-outputfileurivalue

Type:@aws-cdk/cdk.Token or OutputFileUriValueProperty (optional)
stringValue

CfnDataset.VariableProperty.StringValue

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-stringvalue

Type:string (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnDatasetProps (interface)

class @aws-cdk/aws-iotanalytics.CfnDatasetProps

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnDatasetProps;
// CfnDatasetProps is an interface
import { CfnDatasetProps } from '@aws-cdk/aws-iotanalytics';
actions

AWS::IoTAnalytics::Dataset.Actions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-actions

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or ActionProperty)[]
datasetName

AWS::IoTAnalytics::Dataset.DatasetName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-datasetname

Type:string (optional)
retentionPeriod

AWS::IoTAnalytics::Dataset.RetentionPeriod

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-retentionperiod

Type:@aws-cdk/cdk.Token or RetentionPeriodProperty (optional)
tags

AWS::IoTAnalytics::Dataset.Tags

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.CfnTag)[] (optional)
triggers

AWS::IoTAnalytics::Dataset.Triggers

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-triggers

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or TriggerProperty)[] (optional)

CfnDatastore

class @aws-cdk/aws-iotanalytics.CfnDatastore(scope, id[, props])

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnDatastore;
const { CfnDatastore } = require('@aws-cdk/aws-iotanalytics');
import { CfnDatastore } from '@aws-cdk/aws-iotanalytics';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
datastoreId
Type:string (readonly)
propertyOverrides
Type:CfnDatastoreProps (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
class RetentionPeriodProperty

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnDatastore.RetentionPeriodProperty;
// CfnDatastore.RetentionPeriodProperty is an interface
import { CfnDatastore.RetentionPeriodProperty } from '@aws-cdk/aws-iotanalytics';
numberOfDays

CfnDatastore.RetentionPeriodProperty.NumberOfDays

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-retentionperiod.html#cfn-iotanalytics-datastore-retentionperiod-numberofdays

Type:number or @aws-cdk/cdk.Token (optional)
unlimited

CfnDatastore.RetentionPeriodProperty.Unlimited

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-retentionperiod.html#cfn-iotanalytics-datastore-retentionperiod-unlimited

Type:boolean or @aws-cdk/cdk.Token (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnDatastoreProps (interface)

class @aws-cdk/aws-iotanalytics.CfnDatastoreProps

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnDatastoreProps;
// CfnDatastoreProps is an interface
import { CfnDatastoreProps } from '@aws-cdk/aws-iotanalytics';
datastoreName

AWS::IoTAnalytics::Datastore.DatastoreName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-datastore.html#cfn-iotanalytics-datastore-datastorename

Type:string (optional)
retentionPeriod

AWS::IoTAnalytics::Datastore.RetentionPeriod

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-datastore.html#cfn-iotanalytics-datastore-retentionperiod

Type:@aws-cdk/cdk.Token or RetentionPeriodProperty (optional)
tags

AWS::IoTAnalytics::Datastore.Tags

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-datastore.html#cfn-iotanalytics-datastore-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.CfnTag)[] (optional)

CfnPipeline

class @aws-cdk/aws-iotanalytics.CfnPipeline(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnPipeline;
const { CfnPipeline } = require('@aws-cdk/aws-iotanalytics');
import { CfnPipeline } from '@aws-cdk/aws-iotanalytics';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
pipelineId
Type:string (readonly)
propertyOverrides
Type:CfnPipelineProps (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
class ActivityProperty

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnPipeline.ActivityProperty;
// CfnPipeline.ActivityProperty is an interface
import { CfnPipeline.ActivityProperty } from '@aws-cdk/aws-iotanalytics';
addAttributes

CfnPipeline.ActivityProperty.AddAttributes

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-addattributes

Type:@aws-cdk/cdk.Token or AddAttributesProperty (optional)
channel

CfnPipeline.ActivityProperty.Channel

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-channel

Type:@aws-cdk/cdk.Token or ChannelProperty (optional)
datastore

CfnPipeline.ActivityProperty.Datastore

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-datastore

Type:@aws-cdk/cdk.Token or DatastoreProperty (optional)
deviceRegistryEnrich

CfnPipeline.ActivityProperty.DeviceRegistryEnrich

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-deviceregistryenrich

Type:@aws-cdk/cdk.Token or DeviceRegistryEnrichProperty (optional)
deviceShadowEnrich

CfnPipeline.ActivityProperty.DeviceShadowEnrich

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-deviceshadowenrich

Type:@aws-cdk/cdk.Token or DeviceShadowEnrichProperty (optional)
filter

CfnPipeline.ActivityProperty.Filter

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-filter

Type:@aws-cdk/cdk.Token or FilterProperty (optional)
lambda

CfnPipeline.ActivityProperty.Lambda

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-lambda

Type:@aws-cdk/cdk.Token or LambdaProperty (optional)
math

CfnPipeline.ActivityProperty.Math

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-math

Type:@aws-cdk/cdk.Token or MathProperty (optional)
removeAttributes

CfnPipeline.ActivityProperty.RemoveAttributes

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-removeattributes

Type:@aws-cdk/cdk.Token or RemoveAttributesProperty (optional)
selectAttributes

CfnPipeline.ActivityProperty.SelectAttributes

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-selectattributes

Type:@aws-cdk/cdk.Token or SelectAttributesProperty (optional)
class AddAttributesProperty

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnPipeline.AddAttributesProperty;
// CfnPipeline.AddAttributesProperty is an interface
import { CfnPipeline.AddAttributesProperty } from '@aws-cdk/aws-iotanalytics';
attributes

CfnPipeline.AddAttributesProperty.Attributes

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-addattributes.html#cfn-iotanalytics-pipeline-addattributes-attributes

Type:json or @aws-cdk/cdk.Token (optional)
name

CfnPipeline.AddAttributesProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-addattributes.html#cfn-iotanalytics-pipeline-addattributes-name

Type:string (optional)
next

CfnPipeline.AddAttributesProperty.Next

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-addattributes.html#cfn-iotanalytics-pipeline-addattributes-next

Type:string (optional)
class ChannelProperty

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnPipeline.ChannelProperty;
// CfnPipeline.ChannelProperty is an interface
import { CfnPipeline.ChannelProperty } from '@aws-cdk/aws-iotanalytics';
channelName

CfnPipeline.ChannelProperty.ChannelName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-channel.html#cfn-iotanalytics-pipeline-channel-channelname

Type:string (optional)
name

CfnPipeline.ChannelProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-channel.html#cfn-iotanalytics-pipeline-channel-name

Type:string (optional)
next

CfnPipeline.ChannelProperty.Next

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-channel.html#cfn-iotanalytics-pipeline-channel-next

Type:string (optional)
class DatastoreProperty

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnPipeline.DatastoreProperty;
// CfnPipeline.DatastoreProperty is an interface
import { CfnPipeline.DatastoreProperty } from '@aws-cdk/aws-iotanalytics';
datastoreName

CfnPipeline.DatastoreProperty.DatastoreName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-datastore.html#cfn-iotanalytics-pipeline-datastore-datastorename

Type:string (optional)
name

CfnPipeline.DatastoreProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-datastore.html#cfn-iotanalytics-pipeline-datastore-name

Type:string (optional)
class DeviceRegistryEnrichProperty

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnPipeline.DeviceRegistryEnrichProperty;
// CfnPipeline.DeviceRegistryEnrichProperty is an interface
import { CfnPipeline.DeviceRegistryEnrichProperty } from '@aws-cdk/aws-iotanalytics';
attribute

CfnPipeline.DeviceRegistryEnrichProperty.Attribute

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceregistryenrich.html#cfn-iotanalytics-pipeline-deviceregistryenrich-attribute

Type:string (optional)
name

CfnPipeline.DeviceRegistryEnrichProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceregistryenrich.html#cfn-iotanalytics-pipeline-deviceregistryenrich-name

Type:string (optional)
next

CfnPipeline.DeviceRegistryEnrichProperty.Next

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceregistryenrich.html#cfn-iotanalytics-pipeline-deviceregistryenrich-next

Type:string (optional)
roleArn

CfnPipeline.DeviceRegistryEnrichProperty.RoleArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceregistryenrich.html#cfn-iotanalytics-pipeline-deviceregistryenrich-rolearn

Type:string (optional)
thingName

CfnPipeline.DeviceRegistryEnrichProperty.ThingName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceregistryenrich.html#cfn-iotanalytics-pipeline-deviceregistryenrich-thingname

Type:string (optional)
class DeviceShadowEnrichProperty

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnPipeline.DeviceShadowEnrichProperty;
// CfnPipeline.DeviceShadowEnrichProperty is an interface
import { CfnPipeline.DeviceShadowEnrichProperty } from '@aws-cdk/aws-iotanalytics';
attribute

CfnPipeline.DeviceShadowEnrichProperty.Attribute

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-attribute

Type:string (optional)
name

CfnPipeline.DeviceShadowEnrichProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-name

Type:string (optional)
next

CfnPipeline.DeviceShadowEnrichProperty.Next

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-next

Type:string (optional)
roleArn

CfnPipeline.DeviceShadowEnrichProperty.RoleArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-rolearn

Type:string (optional)
thingName

CfnPipeline.DeviceShadowEnrichProperty.ThingName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-thingname

Type:string (optional)
class FilterProperty

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnPipeline.FilterProperty;
// CfnPipeline.FilterProperty is an interface
import { CfnPipeline.FilterProperty } from '@aws-cdk/aws-iotanalytics';
filter

CfnPipeline.FilterProperty.Filter

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-filter.html#cfn-iotanalytics-pipeline-filter-filter

Type:string (optional)
name

CfnPipeline.FilterProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-filter.html#cfn-iotanalytics-pipeline-filter-name

Type:string (optional)
next

CfnPipeline.FilterProperty.Next

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-filter.html#cfn-iotanalytics-pipeline-filter-next

Type:string (optional)
class LambdaProperty

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnPipeline.LambdaProperty;
// CfnPipeline.LambdaProperty is an interface
import { CfnPipeline.LambdaProperty } from '@aws-cdk/aws-iotanalytics';
batchSize

CfnPipeline.LambdaProperty.BatchSize

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-lambda.html#cfn-iotanalytics-pipeline-lambda-batchsize

Type:number or @aws-cdk/cdk.Token (optional)
lambdaName

CfnPipeline.LambdaProperty.LambdaName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-lambda.html#cfn-iotanalytics-pipeline-lambda-lambdaname

Type:string (optional)
name

CfnPipeline.LambdaProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-lambda.html#cfn-iotanalytics-pipeline-lambda-name

Type:string (optional)
next

CfnPipeline.LambdaProperty.Next

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-lambda.html#cfn-iotanalytics-pipeline-lambda-next

Type:string (optional)
class MathProperty

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnPipeline.MathProperty;
// CfnPipeline.MathProperty is an interface
import { CfnPipeline.MathProperty } from '@aws-cdk/aws-iotanalytics';
attribute

CfnPipeline.MathProperty.Attribute

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-math.html#cfn-iotanalytics-pipeline-math-attribute

Type:string (optional)
math

CfnPipeline.MathProperty.Math

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-math.html#cfn-iotanalytics-pipeline-math-math

Type:string (optional)
name

CfnPipeline.MathProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-math.html#cfn-iotanalytics-pipeline-math-name

Type:string (optional)
next

CfnPipeline.MathProperty.Next

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-math.html#cfn-iotanalytics-pipeline-math-next

Type:string (optional)
class RemoveAttributesProperty

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnPipeline.RemoveAttributesProperty;
// CfnPipeline.RemoveAttributesProperty is an interface
import { CfnPipeline.RemoveAttributesProperty } from '@aws-cdk/aws-iotanalytics';
attributes

CfnPipeline.RemoveAttributesProperty.Attributes

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-removeattributes.html#cfn-iotanalytics-pipeline-removeattributes-attributes

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
name

CfnPipeline.RemoveAttributesProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-removeattributes.html#cfn-iotanalytics-pipeline-removeattributes-name

Type:string (optional)
next

CfnPipeline.RemoveAttributesProperty.Next

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-removeattributes.html#cfn-iotanalytics-pipeline-removeattributes-next

Type:string (optional)
class SelectAttributesProperty

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnPipeline.SelectAttributesProperty;
// CfnPipeline.SelectAttributesProperty is an interface
import { CfnPipeline.SelectAttributesProperty } from '@aws-cdk/aws-iotanalytics';
attributes

CfnPipeline.SelectAttributesProperty.Attributes

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-selectattributes.html#cfn-iotanalytics-pipeline-selectattributes-attributes

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
name

CfnPipeline.SelectAttributesProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-selectattributes.html#cfn-iotanalytics-pipeline-selectattributes-name

Type:string (optional)
next

CfnPipeline.SelectAttributesProperty.Next

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-selectattributes.html#cfn-iotanalytics-pipeline-selectattributes-next

Type:string (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnPipelineProps (interface)

class @aws-cdk/aws-iotanalytics.CfnPipelineProps

Language-specific names:

using Amazon.CDK.AWS.IoTAnalytics;
import software.amazon.awscdk.services.iotanalytics.CfnPipelineProps;
// CfnPipelineProps is an interface
import { CfnPipelineProps } from '@aws-cdk/aws-iotanalytics';
pipelineActivities

AWS::IoTAnalytics::Pipeline.PipelineActivities

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-pipeline.html#cfn-iotanalytics-pipeline-pipelineactivities

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or ActivityProperty)[]
pipelineName

AWS::IoTAnalytics::Pipeline.PipelineName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-pipeline.html#cfn-iotanalytics-pipeline-pipelinename

Type:string (optional)
tags

AWS::IoTAnalytics::Pipeline.Tags

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-pipeline.html#cfn-iotanalytics-pipeline-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.CfnTag)[] (optional)