# README
AWS IoT Construct Library
This module is part of the AWS Cloud Development Kit project.
import iot "github.com/aws/aws-cdk-go/awscdk"
There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:
- Search Construct Hub for IoT construct libraries
- Use the automatically generated L1 constructs, in the same way you would use the CloudFormation AWS::IoT resources directly.
An experimental construct library for this service is available in preview. Since it is not stable yet, it is distributed as a separate package so that you can pin its version independently of the rest of the CDK. See the package:
@aws-cdk/aws-iot-alpha
There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.
For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::IoT.
(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)
# Functions
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given object is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given object is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given object is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given object is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given object is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given object is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given object is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given object is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given object is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given object is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given object is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given object is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given object is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given object is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given object is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given object is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given object is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given object is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given object is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given object is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given object is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given object is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given object is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given object is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given object is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given object is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given object is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given object is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
Which audit checks are enabled and disabled for this account.
The types of audit checks that can be performed.
The configuration of the audit notification target.
Information about the targets to which audit notifications are sent.
Properties for defining a `CfnAccountAuditConfiguration`.
Properties for defining a `CfnAuthorizer`.
The properties of a billing group.
Properties for defining a `CfnBillingGroup`.
The registration configuration.
Properties for defining a `CfnCACertificate`.
Properties for defining a `CfnCertificate`.
Properties for defining a `CfnCertificateProvider`.
Properties for defining a `CfnCustomMetric`.
Properties for defining a `CfnDimension`.
An object that specifies the authorization service for a domain.
An object that specifies the client certificate configuration for a domain.
The server certificate configuration.
An object that contains information about a server certificate.
An object that specifies the TLS configuration for a domain.
Properties for defining a `CfnDomainConfiguration`.
The type of aggregation queries.
Properties for defining a `CfnFleetMetric`.
The criteria that determine when and how a job abort takes place.
The criteria that determine when and how a job abort takes place.
Allows you to create an exponential rate of rollout for a job.
The configuration that determines how many retries are allowed for each failure type for a job.
Allows you to create a staged rollout of a job.
An optional configuration within the `SchedulingConfig` to setup a recurring maintenance window with a predetermined start time and duration for the rollout of a job document to all devices in a target group for a job.
Configuration for pre-signed S3 URLs.
Allows you to define a criteria to initiate the increase in rate of rollout for a job.
The criteria that determines how many retries are allowed for each failure type for a job.
Specifies the amount of time each device has to finish its execution of the job.
Properties for defining a `CfnJobTemplate`.
Properties for defining a `CfnLogging`.
Defines the type of action and the parameters for that action.
Parameters used when defining a mitigation action that move a set of things to a thing group.
Parameters used when defining a mitigation action that enable AWS IoT Core logging.
Parameters to define a mitigation action that publishes findings to Amazon SNS.
Parameters to define a mitigation action that adds a blank policy to restrict permissions.
Parameters to define a mitigation action that changes the state of the CA certificate to inactive.
Parameters to define a mitigation action that changes the state of the device certificate to inactive.
Properties for defining a `CfnMitigationAction`.
Properties for defining a `CfnPolicyPrincipalAttachment`.
Properties for defining a `CfnPolicy`.
Structure that contains payloadVersion and targetArn.
Properties for defining a `CfnProvisioningTemplate`.
Properties for defining a `CfnResourceSpecificLogging`.
Properties for defining a `CfnRoleAlias`.
Properties for defining a `CfnScheduledAudit`.
A structure containing the alert target ARN and the role ARN.
The criteria by which the behavior is determined to be normal.
A Device Defender security profile behavior.
The `MachineLearningDetectionConfig` property type controls confidence of the machine learning model.
The dimension of the metric.
Specifies the MQTT topic and role ARN required for metric export.
The metric you want to retain.
The value to be compared with the `metric` .
A statistical ranking (percentile) that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.
Properties for defining a `CfnSecurityProfile`.
Properties for defining a `CfnSoftwarePackage`.
Properties for defining a `CfnSoftwarePackageVersion`.
The AttributePayload property specifies up to three attributes for an AWS IoT as key-value pairs.
The attribute payload.
Thing group properties.
Properties for defining a `CfnThingGroup`.
Properties for defining a `CfnThingPrincipalAttachment`.
Properties for defining a `CfnThing`.
The ThingTypeProperties contains information about the thing type including: a thing type description, and a list of searchable thing attribute names.
Properties for defining a `CfnThingType`.
Describes the actions associated with a rule.
An asset property timestamp entry containing the following information.
An asset property value entry containing the following information.
Contains an asset property value (of a single type).
Describes an action that updates a CloudWatch alarm.
Describes an action that updates a CloudWatch log.
Describes an action that captures a CloudWatch metric.
Describes an action to write to a DynamoDB table.
Describes an action to write to a DynamoDB table.
Describes an action that writes data to an Amazon OpenSearch Service domain.
Describes an action that writes data to an Amazon Kinesis Firehose stream.
The HTTP action header.
Send data to an HTTPS endpoint.
The authorization method used to send messages.
Sends message data to an AWS IoT Analytics channel.
Sends an input to an AWS IoT Events detector.
Describes an action to send data from an MQTT message that triggered the rule to AWS IoT SiteWise asset properties.
Specifies a Kafka header using key-value pairs when you create a Rule’s Kafka Action.
Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
Describes an action to write data to an Amazon Kinesis stream.
Describes an action to invoke a Lambda function.
Describes an action to send device location updates from an MQTT message to an Amazon Location tracker resource.
Describes an action that writes data to an Amazon OpenSearch Service domain.
An asset property value entry containing the following information.
The input for the DynamoActionVS action that specifies the DynamoDB table to which the message data will be written.
Specifies MQTT Version 5.0 headers information.
Describes an action to republish to another topic.
Describes an action to write data to an Amazon S3 bucket.
For more information, see [Signature Version 4 signing process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) .
Describes an action to publish to an Amazon SNS topic.
Describes an action to publish data to an Amazon SQS queue.
Starts execution of a Step Functions state machine.
Describes how to interpret an application-defined timestamp value from an MQTT message payload and the precision of that value.
Describes an action that writes records into an Amazon Timestream table.
Metadata attributes of the time series that are written in each measure record.
The value to use for the entry's timestamp.
Describes a rule.
A key-value pair that you define in the header.
HTTP URL destination properties.
The properties of a virtual private cloud (VPC) destination.
Properties for defining a `CfnTopicRuleDestination`.
Properties for defining a `CfnTopicRule`.
# Interfaces
Use the `AWS::IoT::AccountAuditConfiguration` resource to configure or reconfigure the Device Defender audit settings for your account.
Specifies an authorizer.
Creates a new billing group.
Specifies a CA certificate.
Use the `AWS::IoT::Certificate` resource to declare an AWS IoT X.509 certificate.
Creates a certificate provider.
Use the `AWS::IoT::CustomMetric` resource to define a custom metric published by your devices to Device Defender.
Use the `AWS::IoT::Dimension` to limit the scope of a metric used in a security profile for AWS IoT Device Defender .
Specifies a domain configuration.
Use the `AWS::IoT::FleetMetric` resource to declare a fleet metric.
Represents a job template.
Configure logging.
Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask.
Use the `AWS::IoT::Policy` resource to declare an AWS IoT policy.
Use the `AWS::IoT::PolicyPrincipalAttachment` resource to attach an AWS IoT policy to a principal (an X.509 certificate or other credential).
Creates a fleet provisioning template.
Configure resource-specific logging.
Specifies a role alias.
Use the `AWS::IoT::ScheduledAudit` resource to create a scheduled audit that is run at a specified time interval.
Use the `AWS::IoT::SecurityProfile` resource to create a Device Defender security profile.
Use the `AWS::IoT::SoftwarePackage` resource to create a software package.
Use the `AWS::IoT::SoftwarePackageVersion` resource to create a software package version.
Use the `AWS::IoT::Thing` resource to declare an AWS IoT thing.
Creates a new thing group.
Use the `AWS::IoT::ThingPrincipalAttachment` resource to attach a principal (an X.509 certificate or another credential) to a thing.
Creates a new thing type.
Use the `AWS::IoT::TopicRule` resource to declare an AWS IoT rule.
A topic rule destination.