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-iot

The CDK Construct Library for AWS IoT

This module is part of the AWS Cloud Development Kit project.

Reference

View in Nuget

csproj:

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

dotnet:

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

packages.config:

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

View in Maven Central

Apache Buildr:

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

Apache Ivy:

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

Apache Maven:

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

Gradle / Grails:

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

Groovy Grape:

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

View in NPM

npm:

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

package.json:

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

yarn:

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

View in NPM

npm:

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

package.json:

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

yarn:

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

CfnCertificate

class @aws-cdk/aws-iot.CfnCertificate(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.IoT;
import software.amazon.awscdk.services.iot.CfnCertificate;
const { CfnCertificate } = require('@aws-cdk/aws-iot');
import { CfnCertificate } from '@aws-cdk/aws-iot';
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)
certificateArn
Type:string (readonly)
certificateId
Type:string (readonly)
propertyOverrides
Type:CfnCertificateProps (readonly)
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)

CfnCertificateProps (interface)

class @aws-cdk/aws-iot.CfnCertificateProps

Language-specific names:

using Amazon.CDK.AWS.IoT;
import software.amazon.awscdk.services.iot.CfnCertificateProps;
// CfnCertificateProps is an interface
import { CfnCertificateProps } from '@aws-cdk/aws-iot';
certificateSigningRequest

AWS::IoT::Certificate.CertificateSigningRequest

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-certificate.html#cfn-iot-certificate-certificatesigningrequest

Type:string
status

AWS::IoT::Certificate.Status

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-certificate.html#cfn-iot-certificate-status

Type:string

CfnPolicy

class @aws-cdk/aws-iot.CfnPolicy(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.IoT;
import software.amazon.awscdk.services.iot.CfnPolicy;
const { CfnPolicy } = require('@aws-cdk/aws-iot');
import { CfnPolicy } from '@aws-cdk/aws-iot';
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)
policyArn
Type:string (readonly)
policyName
Type:string (readonly)
propertyOverrides
Type:CfnPolicyProps (readonly)
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)

CfnPolicyPrincipalAttachment

class @aws-cdk/aws-iot.CfnPolicyPrincipalAttachment(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.IoT;
import software.amazon.awscdk.services.iot.CfnPolicyPrincipalAttachment;
const { CfnPolicyPrincipalAttachment } = require('@aws-cdk/aws-iot');
import { CfnPolicyPrincipalAttachment } from '@aws-cdk/aws-iot';
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)
propertyOverrides
Type:CfnPolicyPrincipalAttachmentProps (readonly)
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)

CfnPolicyPrincipalAttachmentProps (interface)

class @aws-cdk/aws-iot.CfnPolicyPrincipalAttachmentProps

Language-specific names:

using Amazon.CDK.AWS.IoT;
import software.amazon.awscdk.services.iot.CfnPolicyPrincipalAttachmentProps;
// CfnPolicyPrincipalAttachmentProps is an interface
import { CfnPolicyPrincipalAttachmentProps } from '@aws-cdk/aws-iot';
policyName

AWS::IoT::PolicyPrincipalAttachment.PolicyName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-policyprincipalattachment.html#cfn-iot-policyprincipalattachment-policyname

Type:string
principal

AWS::IoT::PolicyPrincipalAttachment.Principal

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-policyprincipalattachment.html#cfn-iot-policyprincipalattachment-principal

Type:string

CfnPolicyProps (interface)

class @aws-cdk/aws-iot.CfnPolicyProps

Language-specific names:

using Amazon.CDK.AWS.IoT;
import software.amazon.awscdk.services.iot.CfnPolicyProps;
// CfnPolicyProps is an interface
import { CfnPolicyProps } from '@aws-cdk/aws-iot';
policyDocument

AWS::IoT::Policy.PolicyDocument

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-policy.html#cfn-iot-policy-policydocument

Type:json or @aws-cdk/cdk.Token
policyName

AWS::IoT::Policy.PolicyName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-policy.html#cfn-iot-policy-policyname

Type:string (optional)

CfnThing

class @aws-cdk/aws-iot.CfnThing(scope, id[, props])

Language-specific names:

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

@aws-cdk/cdk.Resource

Parameters:
  • scope (@aws-cdk/cdk.Construct) – scope in which this resource is defined
  • id (string) – scoped id of the resource
  • props (CfnThingProps (optional)) – resource properties
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)
propertyOverrides
Type:CfnThingProps (readonly)
thingName
Type:string (readonly)
class AttributePayloadProperty

Language-specific names:

using Amazon.CDK.AWS.IoT;
import software.amazon.awscdk.services.iot.CfnThing.AttributePayloadProperty;
// CfnThing.AttributePayloadProperty is an interface
import { CfnThing.AttributePayloadProperty } from '@aws-cdk/aws-iot';
attributes

CfnThing.AttributePayloadProperty.Attributes

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thing-attributepayload.html#cfn-iot-thing-attributepayload-attributes

Type:@aws-cdk/cdk.Token or string => (string 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)

CfnThingPrincipalAttachment

class @aws-cdk/aws-iot.CfnThingPrincipalAttachment(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.IoT;
import software.amazon.awscdk.services.iot.CfnThingPrincipalAttachment;
const { CfnThingPrincipalAttachment } = require('@aws-cdk/aws-iot');
import { CfnThingPrincipalAttachment } from '@aws-cdk/aws-iot';
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)
propertyOverrides
Type:CfnThingPrincipalAttachmentProps (readonly)
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)

CfnThingPrincipalAttachmentProps (interface)

class @aws-cdk/aws-iot.CfnThingPrincipalAttachmentProps

Language-specific names:

using Amazon.CDK.AWS.IoT;
import software.amazon.awscdk.services.iot.CfnThingPrincipalAttachmentProps;
// CfnThingPrincipalAttachmentProps is an interface
import { CfnThingPrincipalAttachmentProps } from '@aws-cdk/aws-iot';
principal

AWS::IoT::ThingPrincipalAttachment.Principal

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thingprincipalattachment.html#cfn-iot-thingprincipalattachment-principal

Type:string
thingName

AWS::IoT::ThingPrincipalAttachment.ThingName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thingprincipalattachment.html#cfn-iot-thingprincipalattachment-thingname

Type:string

CfnThingProps (interface)

class @aws-cdk/aws-iot.CfnThingProps

Language-specific names:

using Amazon.CDK.AWS.IoT;
import software.amazon.awscdk.services.iot.CfnThingProps;
// CfnThingProps is an interface
import { CfnThingProps } from '@aws-cdk/aws-iot';
attributePayload

AWS::IoT::Thing.AttributePayload

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html#cfn-iot-thing-attributepayload

Type:@aws-cdk/cdk.Token or AttributePayloadProperty (optional)
thingName

AWS::IoT::Thing.ThingName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html#cfn-iot-thing-thingname

Type:string (optional)

CfnTopicRule

class @aws-cdk/aws-iot.CfnTopicRule(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.IoT;
import software.amazon.awscdk.services.iot.CfnTopicRule;
const { CfnTopicRule } = require('@aws-cdk/aws-iot');
import { CfnTopicRule } from '@aws-cdk/aws-iot';
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)
propertyOverrides
Type:CfnTopicRuleProps (readonly)
topicRuleArn
Type:string (readonly)
topicRuleName
Type:string (readonly)
class ActionProperty

Language-specific names:

using Amazon.CDK.AWS.IoT;
import software.amazon.awscdk.services.iot.CfnTopicRule.ActionProperty;
// CfnTopicRule.ActionProperty is an interface
import { CfnTopicRule.ActionProperty } from '@aws-cdk/aws-iot';
cloudwatchAlarm

CfnTopicRule.ActionProperty.CloudwatchAlarm

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-cloudwatchalarm

Type:@aws-cdk/cdk.Token or CloudwatchAlarmActionProperty (optional)
cloudwatchMetric

CfnTopicRule.ActionProperty.CloudwatchMetric

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-cloudwatchmetric

Type:@aws-cdk/cdk.Token or CloudwatchMetricActionProperty (optional)
dynamoDb

CfnTopicRule.ActionProperty.DynamoDB

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-dynamodb

Type:@aws-cdk/cdk.Token or DynamoDBActionProperty (optional)
dynamoDBv2

CfnTopicRule.ActionProperty.DynamoDBv2

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-dynamodbv2

Type:@aws-cdk/cdk.Token or DynamoDBv2ActionProperty (optional)
elasticsearch

CfnTopicRule.ActionProperty.Elasticsearch

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-elasticsearch

Type:@aws-cdk/cdk.Token or ElasticsearchActionProperty (optional)
firehose

CfnTopicRule.ActionProperty.Firehose

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-firehose

Type:@aws-cdk/cdk.Token or FirehoseActionProperty (optional)
iotAnalytics

CfnTopicRule.ActionProperty.IotAnalytics

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

Type:@aws-cdk/cdk.Token or IotAnalyticsActionProperty (optional)
kinesis

CfnTopicRule.ActionProperty.Kinesis

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-kinesis

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

CfnTopicRule.ActionProperty.Lambda

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-lambda

Type:@aws-cdk/cdk.Token or LambdaActionProperty (optional)
republish

CfnTopicRule.ActionProperty.Republish

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-republish

Type:@aws-cdk/cdk.Token or RepublishActionProperty (optional)
s3

CfnTopicRule.ActionProperty.S3

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-s3

Type:@aws-cdk/cdk.Token or S3ActionProperty (optional)
sns

CfnTopicRule.ActionProperty.Sns

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-sns

Type:@aws-cdk/cdk.Token or SnsActionProperty (optional)
sqs

CfnTopicRule.ActionProperty.Sqs

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-sqs

Type:@aws-cdk/cdk.Token or SqsActionProperty (optional)
stepFunctions

CfnTopicRule.ActionProperty.StepFunctions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-stepfunctions

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

Language-specific names:

using Amazon.CDK.AWS.IoT;
import software.amazon.awscdk.services.iot.CfnTopicRule.CloudwatchAlarmActionProperty;
// CfnTopicRule.CloudwatchAlarmActionProperty is an interface
import { CfnTopicRule.CloudwatchAlarmActionProperty } from '@aws-cdk/aws-iot';
alarmName

CfnTopicRule.CloudwatchAlarmActionProperty.AlarmName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchalarmaction.html#cfn-iot-topicrule-cloudwatchalarmaction-alarmname

Type:string
roleArn

CfnTopicRule.CloudwatchAlarmActionProperty.RoleArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchalarmaction.html#cfn-iot-topicrule-cloudwatchalarmaction-rolearn

Type:string
stateReason

CfnTopicRule.CloudwatchAlarmActionProperty.StateReason

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchalarmaction.html#cfn-iot-topicrule-cloudwatchalarmaction-statereason

Type:string
stateValue

CfnTopicRule.CloudwatchAlarmActionProperty.StateValue

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchalarmaction.html#cfn-iot-topicrule-cloudwatchalarmaction-statevalue

Type:string
class CloudwatchMetricActionProperty

Language-specific names:

using Amazon.CDK.AWS.IoT;
import software.amazon.awscdk.services.iot.CfnTopicRule.CloudwatchMetricActionProperty;
// CfnTopicRule.CloudwatchMetricActionProperty is an interface
import { CfnTopicRule.CloudwatchMetricActionProperty } from '@aws-cdk/aws-iot';
metricName

CfnTopicRule.CloudwatchMetricActionProperty.MetricName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metricname

Type:string
metricNamespace

CfnTopicRule.CloudwatchMetricActionProperty.MetricNamespace

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metricnamespace

Type:string
metricUnit

CfnTopicRule.CloudwatchMetricActionProperty.MetricUnit

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metricunit

Type:string
metricValue

CfnTopicRule.CloudwatchMetricActionProperty.MetricValue

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metricvalue

Type:string
roleArn

CfnTopicRule.CloudwatchMetricActionProperty.RoleArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-rolearn

Type:string
metricTimestamp

CfnTopicRule.CloudwatchMetricActionProperty.MetricTimestamp

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metrictimestamp

Type:string (optional)
class DynamoDBActionProperty

Language-specific names:

using Amazon.CDK.AWS.IoT;
import software.amazon.awscdk.services.iot.CfnTopicRule.DynamoDBActionProperty;
// CfnTopicRule.DynamoDBActionProperty is an interface
import { CfnTopicRule.DynamoDBActionProperty } from '@aws-cdk/aws-iot';
hashKeyField

CfnTopicRule.DynamoDBActionProperty.HashKeyField

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-hashkeyfield

Type:string
hashKeyValue

CfnTopicRule.DynamoDBActionProperty.HashKeyValue

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-hashkeyvalue

Type:string
roleArn

CfnTopicRule.DynamoDBActionProperty.RoleArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-rolearn

Type:string
tableName

CfnTopicRule.DynamoDBActionProperty.TableName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-tablename

Type:string
hashKeyType

CfnTopicRule.DynamoDBActionProperty.HashKeyType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-hashkeytype

Type:string (optional)
payloadField

CfnTopicRule.DynamoDBActionProperty.PayloadField

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-payloadfield

Type:string (optional)
rangeKeyField

CfnTopicRule.DynamoDBActionProperty.RangeKeyField

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-rangekeyfield

Type:string (optional)
rangeKeyType

CfnTopicRule.DynamoDBActionProperty.RangeKeyType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-rangekeytype

Type:string (optional)
rangeKeyValue

CfnTopicRule.DynamoDBActionProperty.RangeKeyValue

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-rangekeyvalue

Type:string (optional)
class DynamoDBv2ActionProperty

Language-specific names:

using Amazon.CDK.AWS.IoT;
import software.amazon.awscdk.services.iot.CfnTopicRule.DynamoDBv2ActionProperty;
// CfnTopicRule.DynamoDBv2ActionProperty is an interface
import { CfnTopicRule.DynamoDBv2ActionProperty } from '@aws-cdk/aws-iot';
putItem

CfnTopicRule.DynamoDBv2ActionProperty.PutItem

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbv2action.html#cfn-iot-topicrule-dynamodbv2action-putitem

Type:@aws-cdk/cdk.Token or PutItemInputProperty (optional)
roleArn

CfnTopicRule.DynamoDBv2ActionProperty.RoleArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbv2action.html#cfn-iot-topicrule-dynamodbv2action-rolearn

Type:string (optional)
class ElasticsearchActionProperty

Language-specific names:

using Amazon.CDK.AWS.IoT;
import software.amazon.awscdk.services.iot.CfnTopicRule.ElasticsearchActionProperty;
// CfnTopicRule.ElasticsearchActionProperty is an interface
import { CfnTopicRule.ElasticsearchActionProperty } from '@aws-cdk/aws-iot';
endpoint

CfnTopicRule.ElasticsearchActionProperty.Endpoint

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-elasticsearchaction.html#cfn-iot-topicrule-elasticsearchaction-endpoint

Type:string
id

CfnTopicRule.ElasticsearchActionProperty.Id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-elasticsearchaction.html#cfn-iot-topicrule-elasticsearchaction-id

Type:string
index

CfnTopicRule.ElasticsearchActionProperty.Index

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-elasticsearchaction.html#cfn-iot-topicrule-elasticsearchaction-index

Type:string
roleArn

CfnTopicRule.ElasticsearchActionProperty.RoleArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-elasticsearchaction.html#cfn-iot-topicrule-elasticsearchaction-rolearn

Type:string
type

CfnTopicRule.ElasticsearchActionProperty.Type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-elasticsearchaction.html#cfn-iot-topicrule-elasticsearchaction-type

Type:string
class FirehoseActionProperty

Language-specific names:

using Amazon.CDK.AWS.IoT;
import software.amazon.awscdk.services.iot.CfnTopicRule.FirehoseActionProperty;
// CfnTopicRule.FirehoseActionProperty is an interface
import { CfnTopicRule.FirehoseActionProperty } from '@aws-cdk/aws-iot';
deliveryStreamName

CfnTopicRule.FirehoseActionProperty.DeliveryStreamName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-firehoseaction.html#cfn-iot-topicrule-firehoseaction-deliverystreamname

Type:string
roleArn

CfnTopicRule.FirehoseActionProperty.RoleArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-firehoseaction.html#cfn-iot-topicrule-firehoseaction-rolearn

Type:string
separator

CfnTopicRule.FirehoseActionProperty.Separator

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-firehoseaction.html#cfn-iot-topicrule-firehoseaction-separator

Type:string (optional)
class IotAnalyticsActionProperty

Language-specific names:

using Amazon.CDK.AWS.IoT;
import software.amazon.awscdk.services.iot.CfnTopicRule.IotAnalyticsActionProperty;
// CfnTopicRule.IotAnalyticsActionProperty is an interface
import { CfnTopicRule.IotAnalyticsActionProperty } from '@aws-cdk/aws-iot';
channelName

CfnTopicRule.IotAnalyticsActionProperty.ChannelName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-iotanalyticsaction.html#cfn-iot-topicrule-iotanalyticsaction-channelname

Type:string
roleArn

CfnTopicRule.IotAnalyticsActionProperty.RoleArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-iotanalyticsaction.html#cfn-iot-topicrule-iotanalyticsaction-rolearn

Type:string
class KinesisActionProperty

Language-specific names:

using Amazon.CDK.AWS.IoT;
import software.amazon.awscdk.services.iot.CfnTopicRule.KinesisActionProperty;
// CfnTopicRule.KinesisActionProperty is an interface
import { CfnTopicRule.KinesisActionProperty } from '@aws-cdk/aws-iot';
roleArn

CfnTopicRule.KinesisActionProperty.RoleArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kinesisaction.html#cfn-iot-topicrule-kinesisaction-rolearn

Type:string
streamName

CfnTopicRule.KinesisActionProperty.StreamName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kinesisaction.html#cfn-iot-topicrule-kinesisaction-streamname

Type:string
partitionKey

CfnTopicRule.KinesisActionProperty.PartitionKey

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kinesisaction.html#cfn-iot-topicrule-kinesisaction-partitionkey

Type:string (optional)
class LambdaActionProperty

Language-specific names:

using Amazon.CDK.AWS.IoT;
import software.amazon.awscdk.services.iot.CfnTopicRule.LambdaActionProperty;
// CfnTopicRule.LambdaActionProperty is an interface
import { CfnTopicRule.LambdaActionProperty } from '@aws-cdk/aws-iot';
functionArn

CfnTopicRule.LambdaActionProperty.FunctionArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-lambdaaction.html#cfn-iot-topicrule-lambdaaction-functionarn

Type:string (optional)
class PutItemInputProperty

Language-specific names:

using Amazon.CDK.AWS.IoT;
import software.amazon.awscdk.services.iot.CfnTopicRule.PutItemInputProperty;
// CfnTopicRule.PutItemInputProperty is an interface
import { CfnTopicRule.PutItemInputProperty } from '@aws-cdk/aws-iot';
tableName

CfnTopicRule.PutItemInputProperty.TableName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-putiteminput.html#cfn-iot-topicrule-putiteminput-tablename

Type:string
class RepublishActionProperty

Language-specific names:

using Amazon.CDK.AWS.IoT;
import software.amazon.awscdk.services.iot.CfnTopicRule.RepublishActionProperty;
// CfnTopicRule.RepublishActionProperty is an interface
import { CfnTopicRule.RepublishActionProperty } from '@aws-cdk/aws-iot';
roleArn

CfnTopicRule.RepublishActionProperty.RoleArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishaction.html#cfn-iot-topicrule-republishaction-rolearn

Type:string
topic

CfnTopicRule.RepublishActionProperty.Topic

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishaction.html#cfn-iot-topicrule-republishaction-topic

Type:string
class S3ActionProperty

Language-specific names:

using Amazon.CDK.AWS.IoT;
import software.amazon.awscdk.services.iot.CfnTopicRule.S3ActionProperty;
// CfnTopicRule.S3ActionProperty is an interface
import { CfnTopicRule.S3ActionProperty } from '@aws-cdk/aws-iot';
bucketName

CfnTopicRule.S3ActionProperty.BucketName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-s3action.html#cfn-iot-topicrule-s3action-bucketname

Type:string
key

CfnTopicRule.S3ActionProperty.Key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-s3action.html#cfn-iot-topicrule-s3action-key

Type:string
roleArn

CfnTopicRule.S3ActionProperty.RoleArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-s3action.html#cfn-iot-topicrule-s3action-rolearn

Type:string
class SnsActionProperty

Language-specific names:

using Amazon.CDK.AWS.IoT;
import software.amazon.awscdk.services.iot.CfnTopicRule.SnsActionProperty;
// CfnTopicRule.SnsActionProperty is an interface
import { CfnTopicRule.SnsActionProperty } from '@aws-cdk/aws-iot';
roleArn

CfnTopicRule.SnsActionProperty.RoleArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-snsaction.html#cfn-iot-topicrule-snsaction-rolearn

Type:string
targetArn

CfnTopicRule.SnsActionProperty.TargetArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-snsaction.html#cfn-iot-topicrule-snsaction-targetarn

Type:string
messageFormat

CfnTopicRule.SnsActionProperty.MessageFormat

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-snsaction.html#cfn-iot-topicrule-snsaction-messageformat

Type:string (optional)
class SqsActionProperty

Language-specific names:

using Amazon.CDK.AWS.IoT;
import software.amazon.awscdk.services.iot.CfnTopicRule.SqsActionProperty;
// CfnTopicRule.SqsActionProperty is an interface
import { CfnTopicRule.SqsActionProperty } from '@aws-cdk/aws-iot';
queueUrl

CfnTopicRule.SqsActionProperty.QueueUrl

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-sqsaction.html#cfn-iot-topicrule-sqsaction-queueurl

Type:string
roleArn

CfnTopicRule.SqsActionProperty.RoleArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-sqsaction.html#cfn-iot-topicrule-sqsaction-rolearn

Type:string
useBase64

CfnTopicRule.SqsActionProperty.UseBase64

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-sqsaction.html#cfn-iot-topicrule-sqsaction-usebase64

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

Language-specific names:

using Amazon.CDK.AWS.IoT;
import software.amazon.awscdk.services.iot.CfnTopicRule.StepFunctionsActionProperty;
// CfnTopicRule.StepFunctionsActionProperty is an interface
import { CfnTopicRule.StepFunctionsActionProperty } from '@aws-cdk/aws-iot';
roleArn

CfnTopicRule.StepFunctionsActionProperty.RoleArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-stepfunctionsaction.html#cfn-iot-topicrule-stepfunctionsaction-rolearn

Type:string
stateMachineName

CfnTopicRule.StepFunctionsActionProperty.StateMachineName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-stepfunctionsaction.html#cfn-iot-topicrule-stepfunctionsaction-statemachinename

Type:string
executionNamePrefix

CfnTopicRule.StepFunctionsActionProperty.ExecutionNamePrefix

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-stepfunctionsaction.html#cfn-iot-topicrule-stepfunctionsaction-executionnameprefix

Type:string (optional)
class TopicRulePayloadProperty

Language-specific names:

using Amazon.CDK.AWS.IoT;
import software.amazon.awscdk.services.iot.CfnTopicRule.TopicRulePayloadProperty;
// CfnTopicRule.TopicRulePayloadProperty is an interface
import { CfnTopicRule.TopicRulePayloadProperty } from '@aws-cdk/aws-iot';
actions

CfnTopicRule.TopicRulePayloadProperty.Actions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-actions

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

CfnTopicRule.TopicRulePayloadProperty.RuleDisabled

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-ruledisabled

Type:boolean or @aws-cdk/cdk.Token
sql

CfnTopicRule.TopicRulePayloadProperty.Sql

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-sql

Type:string
awsIotSqlVersion

CfnTopicRule.TopicRulePayloadProperty.AwsIotSqlVersion

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-awsiotsqlversion

Type:string (optional)
description

CfnTopicRule.TopicRulePayloadProperty.Description

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-description

Type:string (optional)
errorAction

CfnTopicRule.TopicRulePayloadProperty.ErrorAction

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-erroraction

Type:@aws-cdk/cdk.Token or ActionProperty (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)

CfnTopicRuleProps (interface)

class @aws-cdk/aws-iot.CfnTopicRuleProps

Language-specific names:

using Amazon.CDK.AWS.IoT;
import software.amazon.awscdk.services.iot.CfnTopicRuleProps;
// CfnTopicRuleProps is an interface
import { CfnTopicRuleProps } from '@aws-cdk/aws-iot';
topicRulePayload

AWS::IoT::TopicRule.TopicRulePayload

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-topicrule.html#cfn-iot-topicrule-topicrulepayload

Type:@aws-cdk/cdk.Token or TopicRulePayloadProperty
ruleName

AWS::IoT::TopicRule.RuleName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-topicrule.html#cfn-iot-topicrule-rulename

Type:string (optional)