Namespace Amazon.CDK.AWS.IoT
AWS IoT Construct Library
This module is part of the AWS Cloud Development Kit project.
using Amazon.CDK.AWS.IoT;
There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:
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.)
Classes
CfnAccountAuditConfiguration | Use the |
CfnAccountAuditConfiguration.AuditCheckConfigurationProperty | Which audit checks are enabled and disabled for this account. |
CfnAccountAuditConfiguration.AuditCheckConfigurationsProperty | The types of audit checks that can be performed. |
CfnAccountAuditConfiguration.AuditNotificationTargetConfigurationsProperty | The configuration of the audit notification target. |
CfnAccountAuditConfiguration.AuditNotificationTargetProperty | Information about the targets to which audit notifications are sent. |
CfnAccountAuditConfigurationProps | Properties for defining a |
CfnAuthorizer | Specifies an authorizer. |
CfnAuthorizerProps | Properties for defining a |
CfnBillingGroup | Creates a new billing group. |
CfnBillingGroup.BillingGroupPropertiesProperty | The properties of a billing group. |
CfnBillingGroupProps | Properties for defining a |
CfnCACertificate | Specifies a CA certificate. |
CfnCACertificate.RegistrationConfigProperty | The registration configuration. |
CfnCACertificateProps | Properties for defining a |
CfnCertificate | Use the |
CfnCertificateProps | Properties for defining a |
CfnCertificateProvider | Creates a certificate provider. |
CfnCertificateProviderProps | Properties for defining a |
CfnCustomMetric | Use the |
CfnCustomMetricProps | Properties for defining a |
CfnDimension | Use the |
CfnDimensionProps | Properties for defining a |
CfnDomainConfiguration | Specifies a domain configuration. |
CfnDomainConfiguration.AuthorizerConfigProperty | An object that specifies the authorization service for a domain. |
CfnDomainConfiguration.ServerCertificateConfigProperty | The server certificate configuration. |
CfnDomainConfiguration.ServerCertificateSummaryProperty | An object that contains information about a server certificate. |
CfnDomainConfiguration.TlsConfigProperty | An object that specifies the TLS configuration for a domain. |
CfnDomainConfigurationProps | Properties for defining a |
CfnFleetMetric | Use the |
CfnFleetMetric.AggregationTypeProperty | The type of aggregation queries. |
CfnFleetMetricProps | Properties for defining a |
CfnJobTemplate | Represents a job template. |
CfnJobTemplate.AbortConfigProperty | The criteria that determine when and how a job abort takes place. |
CfnJobTemplate.AbortCriteriaProperty | The criteria that determine when and how a job abort takes place. |
CfnJobTemplate.ExponentialRolloutRateProperty | Allows you to create an exponential rate of rollout for a job. |
CfnJobTemplate.JobExecutionsRetryConfigProperty | The configuration that determines how many retries are allowed for each failure type for a job. |
CfnJobTemplate.JobExecutionsRolloutConfigProperty | Allows you to create a staged rollout of a job. |
CfnJobTemplate.MaintenanceWindowProperty | An optional configuration within the |
CfnJobTemplate.PresignedUrlConfigProperty | Configuration for pre-signed S3 URLs. |
CfnJobTemplate.RateIncreaseCriteriaProperty | Allows you to define a criteria to initiate the increase in rate of rollout for a job. |
CfnJobTemplate.RetryCriteriaProperty | The criteria that determines how many retries are allowed for each failure type for a job. |
CfnJobTemplate.TimeoutConfigProperty | Specifies the amount of time each device has to finish its execution of the job. |
CfnJobTemplateProps | Properties for defining a |
CfnLogging | Configure logging. |
CfnLoggingProps | Properties for defining a |
CfnMitigationAction | Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. |
CfnMitigationAction.ActionParamsProperty | Defines the type of action and the parameters for that action. |
CfnMitigationAction.AddThingsToThingGroupParamsProperty | Parameters used when defining a mitigation action that move a set of things to a thing group. |
CfnMitigationAction.EnableIoTLoggingParamsProperty | Parameters used when defining a mitigation action that enable AWS IoT Core logging. |
CfnMitigationAction.PublishFindingToSnsParamsProperty | Parameters to define a mitigation action that publishes findings to Amazon SNS. |
CfnMitigationAction.ReplaceDefaultPolicyVersionParamsProperty | Parameters to define a mitigation action that adds a blank policy to restrict permissions. |
CfnMitigationAction.UpdateCACertificateParamsProperty | Parameters to define a mitigation action that changes the state of the CA certificate to inactive. |
CfnMitigationAction.UpdateDeviceCertificateParamsProperty | Parameters to define a mitigation action that changes the state of the device certificate to inactive. |
CfnMitigationActionProps | Properties for defining a |
CfnPolicy | Use the |
CfnPolicyPrincipalAttachment | Use the |
CfnPolicyPrincipalAttachmentProps | Properties for defining a |
CfnPolicyProps | Properties for defining a |
CfnProvisioningTemplate | Creates a fleet provisioning template. |
CfnProvisioningTemplate.ProvisioningHookProperty | Structure that contains payloadVersion and targetArn. |
CfnProvisioningTemplateProps | Properties for defining a |
CfnResourceSpecificLogging | Configure resource-specific logging. |
CfnResourceSpecificLoggingProps | Properties for defining a |
CfnRoleAlias | Specifies a role alias. |
CfnRoleAliasProps | Properties for defining a |
CfnScheduledAudit | Use the |
CfnScheduledAuditProps | Properties for defining a |
CfnSecurityProfile | Use the |
CfnSecurityProfile.AlertTargetProperty | A structure containing the alert target ARN and the role ARN. |
CfnSecurityProfile.BehaviorCriteriaProperty | The criteria by which the behavior is determined to be normal. |
CfnSecurityProfile.BehaviorProperty | A Device Defender security profile behavior. |
CfnSecurityProfile.MachineLearningDetectionConfigProperty | The |
CfnSecurityProfile.MetricDimensionProperty | The dimension of the metric. |
CfnSecurityProfile.MetricsExportConfigProperty | Specifies the MQTT topic and role ARN required for metric export. |
CfnSecurityProfile.MetricToRetainProperty | The metric you want to retain. |
CfnSecurityProfile.MetricValueProperty | The value to be compared with the |
CfnSecurityProfile.StatisticalThresholdProperty | 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 | Properties for defining a |
CfnSoftwarePackage | Use the |
CfnSoftwarePackageProps | Properties for defining a |
CfnSoftwarePackageVersion | Use the |
CfnSoftwarePackageVersionProps | Properties for defining a |
CfnThing | Use the |
CfnThing.AttributePayloadProperty | The AttributePayload property specifies up to three attributes for an AWS IoT as key-value pairs. |
CfnThingGroup | Creates a new thing group. |
CfnThingGroup.AttributePayloadProperty | The attribute payload. |
CfnThingGroup.ThingGroupPropertiesProperty | Thing group properties. |
CfnThingGroupProps | Properties for defining a |
CfnThingPrincipalAttachment | Use the |
CfnThingPrincipalAttachmentProps | Properties for defining a |
CfnThingProps | Properties for defining a |
CfnThingType | Creates a new thing type. |
CfnThingType.ThingTypePropertiesProperty | The ThingTypeProperties contains information about the thing type including: a thing type description, and a list of searchable thing attribute names. |
CfnThingTypeProps | Properties for defining a |
CfnTopicRule | Use the |
CfnTopicRule.ActionProperty | Describes the actions associated with a rule. |
CfnTopicRule.AssetPropertyTimestampProperty | An asset property timestamp entry containing the following information. |
CfnTopicRule.AssetPropertyValueProperty | An asset property value entry containing the following information. |
CfnTopicRule.AssetPropertyVariantProperty | Contains an asset property value (of a single type). |
CfnTopicRule.CloudwatchAlarmActionProperty | Describes an action that updates a CloudWatch alarm. |
CfnTopicRule.CloudwatchLogsActionProperty | Describes an action that updates a CloudWatch log. |
CfnTopicRule.CloudwatchMetricActionProperty | Describes an action that captures a CloudWatch metric. |
CfnTopicRule.DynamoDBActionProperty | Describes an action to write to a DynamoDB table. |
CfnTopicRule.DynamoDBv2ActionProperty | Describes an action to write to a DynamoDB table. |
CfnTopicRule.ElasticsearchActionProperty | Describes an action that writes data to an Amazon OpenSearch Service domain. |
CfnTopicRule.FirehoseActionProperty | Describes an action that writes data to an Amazon Kinesis Firehose stream. |
CfnTopicRule.HttpActionHeaderProperty | The HTTP action header. |
CfnTopicRule.HttpActionProperty | Send data to an HTTPS endpoint. |
CfnTopicRule.HttpAuthorizationProperty | The authorization method used to send messages. |
CfnTopicRule.IotAnalyticsActionProperty | Sends message data to an AWS IoT Analytics channel. |
CfnTopicRule.IotEventsActionProperty | Sends an input to an AWS IoT Events detector. |
CfnTopicRule.IotSiteWiseActionProperty | Describes an action to send data from an MQTT message that triggered the rule to AWS IoT SiteWise asset properties. |
CfnTopicRule.KafkaActionHeaderProperty | Specifies a Kafka header using key-value pairs when you create a Rule’s Kafka Action. |
CfnTopicRule.KafkaActionProperty | Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster. |
CfnTopicRule.KinesisActionProperty | Describes an action to write data to an Amazon Kinesis stream. |
CfnTopicRule.LambdaActionProperty | Describes an action to invoke a Lambda function. |
CfnTopicRule.LocationActionProperty | Describes an action to send device location updates from an MQTT message to an Amazon Location tracker resource. |
CfnTopicRule.OpenSearchActionProperty | Describes an action that writes data to an Amazon OpenSearch Service domain. |
CfnTopicRule.PutAssetPropertyValueEntryProperty | An asset property value entry containing the following information. |
CfnTopicRule.PutItemInputProperty | The input for the DynamoActionVS action that specifies the DynamoDB table to which the message data will be written. |
CfnTopicRule.RepublishActionHeadersProperty | Specifies MQTT Version 5.0 headers information. For more information, see MQTT in the IoT Core Developer Guide. |
CfnTopicRule.RepublishActionProperty | Describes an action to republish to another topic. |
CfnTopicRule.S3ActionProperty | Describes an action to write data to an Amazon S3 bucket. |
CfnTopicRule.SigV4AuthorizationProperty | For more information, see Signature Version 4 signing process . |
CfnTopicRule.SnsActionProperty | Describes an action to publish to an Amazon SNS topic. |
CfnTopicRule.SqsActionProperty | Describes an action to publish data to an Amazon SQS queue. |
CfnTopicRule.StepFunctionsActionProperty | Starts execution of a Step Functions state machine. |
CfnTopicRule.TimestampProperty | Describes how to interpret an application-defined timestamp value from an MQTT message payload and the precision of that value. |
CfnTopicRule.TimestreamActionProperty | Describes an action that writes records into an Amazon Timestream table. |
CfnTopicRule.TimestreamDimensionProperty | Metadata attributes of the time series that are written in each measure record. |
CfnTopicRule.TimestreamTimestampProperty | The value to use for the entry's timestamp. |
CfnTopicRule.TopicRulePayloadProperty | Describes a rule. |
CfnTopicRule.UserPropertyProperty | A key-value pair that you define in the header. |
CfnTopicRuleDestination | A topic rule destination. |
CfnTopicRuleDestination.HttpUrlDestinationSummaryProperty | HTTP URL destination properties. |
CfnTopicRuleDestination.VpcDestinationPropertiesProperty | The properties of a virtual private cloud (VPC) destination. |
CfnTopicRuleDestinationProps | Properties for defining a |
CfnTopicRuleProps | Properties for defining a |
Interfaces
CfnAccountAuditConfiguration.IAuditCheckConfigurationProperty | Which audit checks are enabled and disabled for this account. |
CfnAccountAuditConfiguration.IAuditCheckConfigurationsProperty | The types of audit checks that can be performed. |
CfnAccountAuditConfiguration.IAuditNotificationTargetConfigurationsProperty | The configuration of the audit notification target. |
CfnAccountAuditConfiguration.IAuditNotificationTargetProperty | Information about the targets to which audit notifications are sent. |
CfnBillingGroup.IBillingGroupPropertiesProperty | The properties of a billing group. |
CfnCACertificate.IRegistrationConfigProperty | The registration configuration. |
CfnDomainConfiguration.IAuthorizerConfigProperty | An object that specifies the authorization service for a domain. |
CfnDomainConfiguration.IServerCertificateConfigProperty | The server certificate configuration. |
CfnDomainConfiguration.IServerCertificateSummaryProperty | An object that contains information about a server certificate. |
CfnDomainConfiguration.ITlsConfigProperty | An object that specifies the TLS configuration for a domain. |
CfnFleetMetric.IAggregationTypeProperty | The type of aggregation queries. |
CfnJobTemplate.IAbortConfigProperty | The criteria that determine when and how a job abort takes place. |
CfnJobTemplate.IAbortCriteriaProperty | The criteria that determine when and how a job abort takes place. |
CfnJobTemplate.IExponentialRolloutRateProperty | Allows you to create an exponential rate of rollout for a job. |
CfnJobTemplate.IJobExecutionsRetryConfigProperty | The configuration that determines how many retries are allowed for each failure type for a job. |
CfnJobTemplate.IJobExecutionsRolloutConfigProperty | Allows you to create a staged rollout of a job. |
CfnJobTemplate.IMaintenanceWindowProperty | An optional configuration within the |
CfnJobTemplate.IPresignedUrlConfigProperty | Configuration for pre-signed S3 URLs. |
CfnJobTemplate.IRateIncreaseCriteriaProperty | Allows you to define a criteria to initiate the increase in rate of rollout for a job. |
CfnJobTemplate.IRetryCriteriaProperty | The criteria that determines how many retries are allowed for each failure type for a job. |
CfnJobTemplate.ITimeoutConfigProperty | Specifies the amount of time each device has to finish its execution of the job. |
CfnMitigationAction.IActionParamsProperty | Defines the type of action and the parameters for that action. |
CfnMitigationAction.IAddThingsToThingGroupParamsProperty | Parameters used when defining a mitigation action that move a set of things to a thing group. |
CfnMitigationAction.IEnableIoTLoggingParamsProperty | Parameters used when defining a mitigation action that enable AWS IoT Core logging. |
CfnMitigationAction.IPublishFindingToSnsParamsProperty | Parameters to define a mitigation action that publishes findings to Amazon SNS. |
CfnMitigationAction.IReplaceDefaultPolicyVersionParamsProperty | Parameters to define a mitigation action that adds a blank policy to restrict permissions. |
CfnMitigationAction.IUpdateCACertificateParamsProperty | Parameters to define a mitigation action that changes the state of the CA certificate to inactive. |
CfnMitigationAction.IUpdateDeviceCertificateParamsProperty | Parameters to define a mitigation action that changes the state of the device certificate to inactive. |
CfnProvisioningTemplate.IProvisioningHookProperty | Structure that contains payloadVersion and targetArn. |
CfnSecurityProfile.IAlertTargetProperty | A structure containing the alert target ARN and the role ARN. |
CfnSecurityProfile.IBehaviorCriteriaProperty | The criteria by which the behavior is determined to be normal. |
CfnSecurityProfile.IBehaviorProperty | A Device Defender security profile behavior. |
CfnSecurityProfile.IMachineLearningDetectionConfigProperty | The |
CfnSecurityProfile.IMetricDimensionProperty | The dimension of the metric. |
CfnSecurityProfile.IMetricsExportConfigProperty | Specifies the MQTT topic and role ARN required for metric export. |
CfnSecurityProfile.IMetricToRetainProperty | The metric you want to retain. |
CfnSecurityProfile.IMetricValueProperty | The value to be compared with the |
CfnSecurityProfile.IStatisticalThresholdProperty | 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. |
CfnThing.IAttributePayloadProperty | The AttributePayload property specifies up to three attributes for an AWS IoT as key-value pairs. |
CfnThingGroup.IAttributePayloadProperty | The attribute payload. |
CfnThingGroup.IThingGroupPropertiesProperty | Thing group properties. |
CfnThingType.IThingTypePropertiesProperty | The ThingTypeProperties contains information about the thing type including: a thing type description, and a list of searchable thing attribute names. |
CfnTopicRule.IActionProperty | Describes the actions associated with a rule. |
CfnTopicRule.IAssetPropertyTimestampProperty | An asset property timestamp entry containing the following information. |
CfnTopicRule.IAssetPropertyValueProperty | An asset property value entry containing the following information. |
CfnTopicRule.IAssetPropertyVariantProperty | Contains an asset property value (of a single type). |
CfnTopicRule.ICloudwatchAlarmActionProperty | Describes an action that updates a CloudWatch alarm. |
CfnTopicRule.ICloudwatchLogsActionProperty | Describes an action that updates a CloudWatch log. |
CfnTopicRule.ICloudwatchMetricActionProperty | Describes an action that captures a CloudWatch metric. |
CfnTopicRule.IDynamoDBActionProperty | Describes an action to write to a DynamoDB table. |
CfnTopicRule.IDynamoDBv2ActionProperty | Describes an action to write to a DynamoDB table. |
CfnTopicRule.IElasticsearchActionProperty | Describes an action that writes data to an Amazon OpenSearch Service domain. |
CfnTopicRule.IFirehoseActionProperty | Describes an action that writes data to an Amazon Kinesis Firehose stream. |
CfnTopicRule.IHttpActionHeaderProperty | The HTTP action header. |
CfnTopicRule.IHttpActionProperty | Send data to an HTTPS endpoint. |
CfnTopicRule.IHttpAuthorizationProperty | The authorization method used to send messages. |
CfnTopicRule.IIotAnalyticsActionProperty | Sends message data to an AWS IoT Analytics channel. |
CfnTopicRule.IIotEventsActionProperty | Sends an input to an AWS IoT Events detector. |
CfnTopicRule.IIotSiteWiseActionProperty | Describes an action to send data from an MQTT message that triggered the rule to AWS IoT SiteWise asset properties. |
CfnTopicRule.IKafkaActionHeaderProperty | Specifies a Kafka header using key-value pairs when you create a Rule’s Kafka Action. |
CfnTopicRule.IKafkaActionProperty | Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster. |
CfnTopicRule.IKinesisActionProperty | Describes an action to write data to an Amazon Kinesis stream. |
CfnTopicRule.ILambdaActionProperty | Describes an action to invoke a Lambda function. |
CfnTopicRule.ILocationActionProperty | Describes an action to send device location updates from an MQTT message to an Amazon Location tracker resource. |
CfnTopicRule.IOpenSearchActionProperty | Describes an action that writes data to an Amazon OpenSearch Service domain. |
CfnTopicRule.IPutAssetPropertyValueEntryProperty | An asset property value entry containing the following information. |
CfnTopicRule.IPutItemInputProperty | The input for the DynamoActionVS action that specifies the DynamoDB table to which the message data will be written. |
CfnTopicRule.IRepublishActionHeadersProperty | Specifies MQTT Version 5.0 headers information. For more information, see MQTT in the IoT Core Developer Guide. |
CfnTopicRule.IRepublishActionProperty | Describes an action to republish to another topic. |
CfnTopicRule.IS3ActionProperty | Describes an action to write data to an Amazon S3 bucket. |
CfnTopicRule.ISigV4AuthorizationProperty | For more information, see Signature Version 4 signing process . |
CfnTopicRule.ISnsActionProperty | Describes an action to publish to an Amazon SNS topic. |
CfnTopicRule.ISqsActionProperty | Describes an action to publish data to an Amazon SQS queue. |
CfnTopicRule.IStepFunctionsActionProperty | Starts execution of a Step Functions state machine. |
CfnTopicRule.ITimestampProperty | Describes how to interpret an application-defined timestamp value from an MQTT message payload and the precision of that value. |
CfnTopicRule.ITimestreamActionProperty | Describes an action that writes records into an Amazon Timestream table. |
CfnTopicRule.ITimestreamDimensionProperty | Metadata attributes of the time series that are written in each measure record. |
CfnTopicRule.ITimestreamTimestampProperty | The value to use for the entry's timestamp. |
CfnTopicRule.ITopicRulePayloadProperty | Describes a rule. |
CfnTopicRule.IUserPropertyProperty | A key-value pair that you define in the header. |
CfnTopicRuleDestination.IHttpUrlDestinationSummaryProperty | HTTP URL destination properties. |
CfnTopicRuleDestination.IVpcDestinationPropertiesProperty | The properties of a virtual private cloud (VPC) destination. |
ICfnAccountAuditConfigurationProps | Properties for defining a |
ICfnAuthorizerProps | Properties for defining a |
ICfnBillingGroupProps | Properties for defining a |
ICfnCACertificateProps | Properties for defining a |
ICfnCertificateProps | Properties for defining a |
ICfnCertificateProviderProps | Properties for defining a |
ICfnCustomMetricProps | Properties for defining a |
ICfnDimensionProps | Properties for defining a |
ICfnDomainConfigurationProps | Properties for defining a |
ICfnFleetMetricProps | Properties for defining a |
ICfnJobTemplateProps | Properties for defining a |
ICfnLoggingProps | Properties for defining a |
ICfnMitigationActionProps | Properties for defining a |
ICfnPolicyPrincipalAttachmentProps | Properties for defining a |
ICfnPolicyProps | Properties for defining a |
ICfnProvisioningTemplateProps | Properties for defining a |
ICfnResourceSpecificLoggingProps | Properties for defining a |
ICfnRoleAliasProps | Properties for defining a |
ICfnScheduledAuditProps | Properties for defining a |
ICfnSecurityProfileProps | Properties for defining a |
ICfnSoftwarePackageProps | Properties for defining a |
ICfnSoftwarePackageVersionProps | Properties for defining a |
ICfnThingGroupProps | Properties for defining a |
ICfnThingPrincipalAttachmentProps | Properties for defining a |
ICfnThingProps | Properties for defining a |
ICfnThingTypeProps | Properties for defining a |
ICfnTopicRuleDestinationProps | Properties for defining a |
ICfnTopicRuleProps | Properties for defining a |