aws-cdk-lib.aws_iot

AWS IoT Construct Library

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

import * as iot from 'aws-cdk-lib/aws-iot';

import aws_cdk.aws_iot as iot

import software.amazon.awscdk.services.iot.*;

using Amazon.CDK.AWS.IoT;

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:

<span class="package-reference">@aws-cdk/aws-iot-alpha</span>

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.)

Types

Name	Kind	Summary
CfnAccountAuditConfiguration	Construct (L1)	Use the AWS::IoT::AccountAuditConfiguration resource to configure or reconfigure the Device Defender audit settings for your account.
CfnAuthorizer	Construct (L1)	Specifies an authorizer.
CfnBillingGroup	Construct (L1)	Creates a new billing group.
CfnCACertificate	Construct (L1)	Specifies a CA certificate.
CfnCertificate	Construct (L1)	Use the AWS::IoT::Certificate resource to declare an AWS IoT X.509 certificate. For information about working with X.509 certificates, see X.509 Client Certificates in the AWS IoT Developer Guide .
CfnCertificateProvider	Construct (L1)	Creates a certificate provider.
CfnCommand	Construct (L1)	Represents the resource definition of AWS IoT Command.
CfnCustomMetric	Construct (L1)	Use the AWS::IoT::CustomMetric resource to define a custom metric published by your devices to Device Defender.
CfnDimension	Construct (L1)	Use the AWS::IoT::Dimension to limit the scope of a metric used in a security profile for AWS IoT Device Defender .
CfnDomainConfiguration	Construct (L1)	Specifies a domain configuration.
CfnEncryptionConfiguration	Construct (L1)	Retrieves the encryption configuration for resources and data of your AWS account in AWS IoT Core .
CfnFleetMetric	Construct (L1)	Use the AWS::IoT::FleetMetric resource to declare a fleet metric.
CfnJob	Construct (L1)	Use the AWS::IoT::Job resource to declare an AWS IoT job.
CfnJobTemplate	Construct (L1)	Represents a job template.
CfnLogging	Construct (L1)	Configure logging.
CfnMitigationAction	Construct (L1)	Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask.
CfnPolicy	Construct (L1)	Use the AWS::IoT::Policy resource to declare an AWS IoT policy.
CfnPolicyPrincipalAttachment	Construct (L1)	Use the AWS::IoT::PolicyPrincipalAttachment resource to attach an AWS IoT policy to a principal (an X.509 certificate or other credential).
CfnProvisioningTemplate	Construct (L1)	Creates a fleet provisioning template.
CfnResourceSpecificLogging	Construct (L1)	Configure resource-specific logging.
CfnRoleAlias	Construct (L1)	Specifies a role alias.
CfnScheduledAudit	Construct (L1)	Use the AWS::IoT::ScheduledAudit resource to create a scheduled audit that is run at a specified time interval.
CfnSecurityProfile	Construct (L1)	Use the AWS::IoT::SecurityProfile resource to create a Device Defender security profile.
CfnSoftwarePackage	Construct (L1)	Use the AWS::IoT::SoftwarePackage resource to create a software package.
CfnSoftwarePackageVersion	Construct (L1)	Use the AWS::IoT::SoftwarePackageVersion resource to create a software package version.
CfnStream	Construct (L1)	Resource Type definition for AWS IoT Stream.
CfnThing	Construct (L1)	Use the AWS::IoT::Thing resource to declare an AWS IoT thing.
CfnThingGroup	Construct (L1)	Creates a new thing group.
CfnThingPrincipalAttachment	Construct (L1)	Use the AWS::IoT::ThingPrincipalAttachment resource to attach a principal (an X.509 certificate or another credential) to a thing.
CfnThingType	Construct (L1)	Creates a new thing type.
CfnTopicRule	Construct (L1)	Use the AWS::IoT::TopicRule resource to declare an AWS IoT rule.
CfnTopicRuleDestination	Construct (L1)	A topic rule destination.
CfnAccountAuditConfiguration.AuditCheckConfigurationProperty	Struct	Which audit checks are enabled and disabled for this account.
CfnAccountAuditConfiguration.AuditCheckConfigurationsProperty	Struct	The types of audit checks that can be performed.
CfnAccountAuditConfiguration.AuditNotificationTargetConfigurationsProperty	Struct	The configuration of the audit notification target.
CfnAccountAuditConfiguration.AuditNotificationTargetProperty	Struct	Information about the targets to which audit notifications are sent.
CfnAccountAuditConfiguration.CertAgeCheckCustomConfigurationProperty	Struct	Configuration structure containing settings for the device certificate age check.
CfnAccountAuditConfiguration.DeviceCertAgeAuditCheckConfigurationProperty	Struct	Configuration for the device certificate age audit check.
CfnAccountAuditConfigurationProps	Struct	Properties for defining a CfnAccountAuditConfiguration.
CfnAuthorizerProps	Struct	Properties for defining a CfnAuthorizer.
CfnBillingGroup.BillingGroupPropertiesProperty	Struct	The properties of a billing group.
CfnBillingGroupProps	Struct	Properties for defining a CfnBillingGroup.
CfnCACertificate.RegistrationConfigProperty	Struct	The registration configuration.
CfnCACertificateProps	Struct	Properties for defining a CfnCACertificate.
CfnCertificateProps	Struct	Properties for defining a CfnCertificate.
CfnCertificateProviderProps	Struct	Properties for defining a CfnCertificateProvider.
CfnCommand.AwsJsonSubstitutionCommandPreprocessorConfigProperty	Struct
CfnCommand.CommandParameterProperty	Struct
CfnCommand.CommandParameterValueComparisonOperandProperty	Struct
CfnCommand.CommandParameterValueConditionProperty	Struct
CfnCommand.CommandParameterValueNumberRangeProperty	Struct
CfnCommand.CommandParameterValueProperty	Struct
CfnCommand.CommandPayloadProperty	Struct
CfnCommand.CommandPreprocessorProperty	Struct
CfnCommandProps	Struct	Properties for defining a CfnCommand.
CfnCustomMetricProps	Struct	Properties for defining a CfnCustomMetric.
CfnDimensionProps	Struct	Properties for defining a CfnDimension.
CfnDomainConfiguration.AuthorizerConfigProperty	Struct	An object that specifies the authorization service for a domain.
CfnDomainConfiguration.ClientCertificateConfigProperty	Struct	An object that specifies the client certificate configuration for a domain.
CfnDomainConfiguration.ServerCertificateConfigProperty	Struct	The server certificate configuration.
CfnDomainConfiguration.ServerCertificateSummaryProperty	Struct	An object that contains information about a server certificate.
CfnDomainConfiguration.TlsConfigProperty	Struct	An object that specifies the TLS configuration for a domain.
CfnDomainConfigurationProps	Struct	Properties for defining a CfnDomainConfiguration.
CfnEncryptionConfiguration.ConfigurationDetailsProperty	Struct	The encryption configuration details that include the status information of the AWS Key Management Service ( AWS ) key and the AWS access role.
CfnEncryptionConfigurationProps	Struct	Properties for defining a CfnEncryptionConfiguration.
CfnFleetMetric.AggregationTypeProperty	Struct	The type of aggregation queries.
CfnFleetMetricProps	Struct	Properties for defining a CfnFleetMetric.
CfnJob.AbortConfigProperty	Struct	The criteria that determine when and how a job abort takes place.
CfnJob.AbortCriteriaProperty	Struct	The criteria that determine when and how a job abort takes place.
CfnJob.ExponentialRolloutRateProperty	Struct	Allows you to create an exponential rate of rollout for a job.
CfnJob.JobExecutionsRetryConfigProperty	Struct	The configuration that determines how many retries are allowed for each failure type for a job.
CfnJob.JobExecutionsRolloutConfigProperty	Struct	Allows you to create a staged rollout of a job.
CfnJob.MaintenanceWindowProperty	Struct	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.
CfnJob.PresignedUrlConfigProperty	Struct	Configuration for pre-signed S3 URLs.
CfnJob.RateIncreaseCriteriaProperty	Struct	Allows you to define a criteria to initiate the increase in rate of rollout for a job.
CfnJob.RetryCriteriaProperty	Struct	The criteria that determines how many retries are allowed for each failure type for a job.
CfnJob.SchedulingConfigProperty	Struct	Specifies the date and time that a job will begin the rollout of the job document to all devices in the target group.
CfnJob.TimeoutConfigProperty	Struct	Specifies the amount of time each device has to finish its execution of the job.
CfnJobProps	Struct	Properties for defining a CfnJob.
CfnJobTemplate.AbortConfigProperty	Struct	The criteria that determine when and how a job abort takes place.
CfnJobTemplate.AbortCriteriaProperty	Struct	The criteria that determine when and how a job abort takes place.
CfnJobTemplate.ExponentialRolloutRateProperty	Struct	Allows you to create an exponential rate of rollout for a job.
CfnJobTemplate.JobExecutionsRetryConfigProperty	Struct	The configuration that determines how many retries are allowed for each failure type for a job.
CfnJobTemplate.JobExecutionsRolloutConfigProperty	Struct	Allows you to create a staged rollout of a job.
CfnJobTemplate.MaintenanceWindowProperty	Struct	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.
CfnJobTemplate.PresignedUrlConfigProperty	Struct	Configuration for pre-signed S3 URLs.
CfnJobTemplate.RateIncreaseCriteriaProperty	Struct	Allows you to define a criteria to initiate the increase in rate of rollout for a job.
CfnJobTemplate.RetryCriteriaProperty	Struct	The criteria that determines how many retries are allowed for each failure type for a job.
CfnJobTemplate.TimeoutConfigProperty	Struct	Specifies the amount of time each device has to finish its execution of the job.
CfnJobTemplateProps	Struct	Properties for defining a CfnJobTemplate.
CfnLogging.EventConfigurationProperty	Struct	Configuration for event-based logging that specifies which event types to log and their logging settings.
CfnLoggingProps	Struct	Properties for defining a CfnLogging.
CfnMitigationAction.ActionParamsProperty	Struct	Defines the type of action and the parameters for that action.
CfnMitigationAction.AddThingsToThingGroupParamsProperty	Struct	Parameters used when defining a mitigation action that move a set of things to a thing group.
CfnMitigationAction.EnableIoTLoggingParamsProperty	Struct	Parameters used when defining a mitigation action that enable AWS IoT Core logging.
CfnMitigationAction.PublishFindingToSnsParamsProperty	Struct	Parameters to define a mitigation action that publishes findings to Amazon SNS.
CfnMitigationAction.ReplaceDefaultPolicyVersionParamsProperty	Struct	Parameters to define a mitigation action that adds a blank policy to restrict permissions.
CfnMitigationAction.UpdateCACertificateParamsProperty	Struct	Parameters to define a mitigation action that changes the state of the CA certificate to inactive.
CfnMitigationAction.UpdateDeviceCertificateParamsProperty	Struct	Parameters to define a mitigation action that changes the state of the device certificate to inactive.
CfnMitigationActionProps	Struct	Properties for defining a CfnMitigationAction.
CfnPolicyPrincipalAttachmentProps	Struct	Properties for defining a CfnPolicyPrincipalAttachment.
CfnPolicyProps	Struct	Properties for defining a CfnPolicy.
CfnProvisioningTemplate.ProvisioningHookProperty	Struct	Structure that contains payloadVersion and targetArn.
CfnProvisioningTemplateProps	Struct	Properties for defining a CfnProvisioningTemplate.
CfnResourceSpecificLoggingProps	Struct	Properties for defining a CfnResourceSpecificLogging.
CfnRoleAliasProps	Struct	Properties for defining a CfnRoleAlias.
CfnScheduledAuditProps	Struct	Properties for defining a CfnScheduledAudit.
CfnSecurityProfile.AlertTargetProperty	Struct	A structure containing the alert target ARN and the role ARN.
CfnSecurityProfile.BehaviorCriteriaProperty	Struct	The criteria by which the behavior is determined to be normal.
CfnSecurityProfile.BehaviorProperty	Struct	A Device Defender security profile behavior.
CfnSecurityProfile.MachineLearningDetectionConfigProperty	Struct	The MachineLearningDetectionConfig property type controls confidence of the machine learning model.
CfnSecurityProfile.MetricDimensionProperty	Struct	The dimension of the metric.
CfnSecurityProfile.MetricsExportConfigProperty	Struct	Specifies the MQTT topic and role ARN required for metric export.
CfnSecurityProfile.MetricToRetainProperty	Struct	The metric you want to retain.
CfnSecurityProfile.MetricValueProperty	Struct	The value to be compared with the metric .
CfnSecurityProfile.StatisticalThresholdProperty	Struct	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.
CfnSecurityProfileProps	Struct	Properties for defining a CfnSecurityProfile.
CfnSoftwarePackageProps	Struct	Properties for defining a CfnSoftwarePackage.
CfnSoftwarePackageVersion.PackageVersionArtifactProperty	Struct	The artifact location of the package version.
CfnSoftwarePackageVersion.S3LocationProperty	Struct	The Amazon S3 location.
CfnSoftwarePackageVersion.SbomProperty	Struct	The sbom zip archive location of the package version.
CfnSoftwarePackageVersionProps	Struct	Properties for defining a CfnSoftwarePackageVersion.
CfnStream.S3LocationProperty	Struct	The location of the file in S3.
CfnStream.StreamFileProperty	Struct	Represents a file to stream.
CfnStreamProps	Struct	Properties for defining a CfnStream.
CfnThing.AttributePayloadProperty	Struct	The AttributePayload property specifies up to three attributes for an AWS IoT as key-value pairs.
CfnThingGroup.AttributePayloadProperty	Struct	The attribute payload.
CfnThingGroup.ThingGroupPropertiesProperty	Struct	Thing group properties.
CfnThingGroupProps	Struct	Properties for defining a CfnThingGroup.
CfnThingPrincipalAttachmentProps	Struct	Properties for defining a CfnThingPrincipalAttachment.
CfnThingProps	Struct	Properties for defining a CfnThing.
CfnThingType.Mqtt5ConfigurationProperty	Struct	The configuration to add user-defined properties to enrich MQTT 5 messages.
CfnThingType.PropagatingAttributeProperty	Struct	An object that represents the connection attribute, the thing attribute, and the MQTT 5 user property key.
CfnThingType.ThingTypePropertiesProperty	Struct	The ThingTypeProperties contains information about the thing type including: a thing type description, and a list of searchable thing attribute names.
CfnThingTypeProps	Struct	Properties for defining a CfnThingType.
CfnTopicRule.ActionProperty	Struct	Describes the actions associated with a rule.
CfnTopicRule.AssetPropertyTimestampProperty	Struct	An asset property timestamp entry containing the following information.
CfnTopicRule.AssetPropertyValueProperty	Struct	An asset property value entry containing the following information.
CfnTopicRule.AssetPropertyVariantProperty	Struct	Contains an asset property value (of a single type).
CfnTopicRule.BatchConfigProperty	Struct
CfnTopicRule.CloudwatchAlarmActionProperty	Struct	Describes an action that updates a CloudWatch alarm.
CfnTopicRule.CloudwatchLogsActionProperty	Struct	Describes an action that updates a CloudWatch log.
CfnTopicRule.CloudwatchMetricActionProperty	Struct	Describes an action that captures a CloudWatch metric.
CfnTopicRule.DynamoDBActionProperty	Struct	Describes an action to write to a DynamoDB table.
CfnTopicRule.DynamoDBv2ActionProperty	Struct	Describes an action to write to a DynamoDB table.
CfnTopicRule.ElasticsearchActionProperty	Struct	Describes an action that writes data to an Amazon OpenSearch Service domain.
CfnTopicRule.FirehoseActionProperty	Struct	Describes an action that writes data to an Amazon Kinesis Firehose stream.
CfnTopicRule.HttpActionHeaderProperty	Struct	The HTTP action header.
CfnTopicRule.HttpActionProperty	Struct	Send data to an HTTPS endpoint.
CfnTopicRule.HttpAuthorizationProperty	Struct	The authorization method used to send messages.
CfnTopicRule.InfluxDBActionProperty	Struct
CfnTopicRule.InfluxDBBatchConfigProperty	Struct
CfnTopicRule.IotAnalyticsActionProperty	Struct	Sends message data to an AWS IoT Analytics channel.
CfnTopicRule.IotEventsActionProperty	Struct	Sends an input to an AWS IoT Events detector.
CfnTopicRule.IotSiteWiseActionProperty	Struct	Describes an action to send data from an MQTT message that triggered the rule to AWS IoT SiteWise asset properties.
CfnTopicRule.KafkaActionHeaderProperty	Struct	Specifies a Kafka header using key-value pairs when you create a Rule’s Kafka Action.
CfnTopicRule.KafkaActionProperty	Struct	Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
CfnTopicRule.KinesisActionProperty	Struct	Describes an action to write data to an Amazon Kinesis stream.
CfnTopicRule.LambdaActionProperty	Struct	Describes an action to invoke a Lambda function.
CfnTopicRule.LocationActionProperty	Struct	Describes an action to send device location updates from an MQTT message to an Amazon Location tracker resource.
CfnTopicRule.OpenSearchActionProperty	Struct	Describes an action that writes data to an Amazon OpenSearch Service domain.
CfnTopicRule.PutAssetPropertyValueEntryProperty	Struct	An asset property value entry containing the following information.
CfnTopicRule.PutItemInputProperty	Struct	The input for the DynamoActionVS action that specifies the DynamoDB table to which the message data will be written.
CfnTopicRule.RepublishActionHeadersProperty	Struct	Specifies MQTT Version 5.0 headers information. For more information, see MQTT in the IoT Core Developer Guide.
CfnTopicRule.RepublishActionProperty	Struct	Describes an action to republish to another topic.
CfnTopicRule.S3ActionProperty	Struct	Describes an action to write data to an Amazon S3 bucket.
CfnTopicRule.SigV4AuthorizationProperty	Struct	For more information, see Signature Version 4 signing process .
CfnTopicRule.SnsActionProperty	Struct	Describes an action to publish to an Amazon SNS topic.
CfnTopicRule.SqsActionProperty	Struct	Describes an action to publish data to an Amazon SQS queue.
CfnTopicRule.StepFunctionsActionProperty	Struct	Starts execution of a Step Functions state machine.
CfnTopicRule.TimestampProperty	Struct	Describes how to interpret an application-defined timestamp value from an MQTT message payload and the precision of that value.
CfnTopicRule.TimestreamActionProperty	Struct	Describes an action that writes records into an Amazon Timestream table.
CfnTopicRule.TimestreamDimensionProperty	Struct	Metadata attributes of the time series that are written in each measure record.
CfnTopicRule.TimestreamTimestampProperty	Struct	The value to use for the entry's timestamp.
CfnTopicRule.TopicRulePayloadProperty	Struct	Describes a rule.
CfnTopicRule.UserPropertyProperty	Struct	A key-value pair that you define in the header.
CfnTopicRuleDestination.HttpUrlDestinationSummaryProperty	Struct	HTTP URL destination properties.
CfnTopicRuleDestination.InfluxDBDestinationPropertiesProperty	Struct
CfnTopicRuleDestination.VpcDestinationPropertiesProperty	Struct	The properties of a virtual private cloud (VPC) destination.
CfnTopicRuleDestinationProps	Struct	Properties for defining a CfnTopicRuleDestination.
CfnTopicRuleProps	Struct	Properties for defining a CfnTopicRule.