Package software.amazon.awscdk.services.iot
package software.amazon.awscdk.services.iot
AWS IoT Construct Library
This module is part of the AWS Cloud Development Kit project.
import software.amazon.awscdk.services.iot.*;
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.)
-
ClassDescriptionUse the
AWS::IoT::AccountAuditConfigurationresource to configure or reconfigure the Device Defender audit settings for your account.Which audit checks are enabled and disabled for this account.An implementation forCfnAccountAuditConfiguration.AuditCheckConfigurationPropertyThe types of audit checks that can be performed.An implementation forCfnAccountAuditConfiguration.AuditCheckConfigurationsPropertyThe configuration of the audit notification target.An implementation forCfnAccountAuditConfiguration.AuditNotificationTargetConfigurationsPropertyInformation about the targets to which audit notifications are sent.An implementation forCfnAccountAuditConfiguration.AuditNotificationTargetPropertyA fluent builder forCfnAccountAuditConfiguration.Properties for defining aCfnAccountAuditConfiguration.A builder forCfnAccountAuditConfigurationPropsAn implementation forCfnAccountAuditConfigurationPropsSpecifies an authorizer.A fluent builder forCfnAuthorizer.Properties for defining aCfnAuthorizer.A builder forCfnAuthorizerPropsAn implementation forCfnAuthorizerPropsCreates a new billing group.The properties of a billing group.A builder forCfnBillingGroup.BillingGroupPropertiesPropertyAn implementation forCfnBillingGroup.BillingGroupPropertiesPropertyA fluent builder forCfnBillingGroup.Properties for defining aCfnBillingGroup.A builder forCfnBillingGroupPropsAn implementation forCfnBillingGroupPropsSpecifies a CA certificate.A fluent builder forCfnCACertificate.The registration configuration.A builder forCfnCACertificate.RegistrationConfigPropertyAn implementation forCfnCACertificate.RegistrationConfigPropertyProperties for defining aCfnCACertificate.A builder forCfnCACertificatePropsAn implementation forCfnCACertificatePropsUse theAWS::IoT::Certificateresource to declare an AWS IoT X.509 certificate.A fluent builder forCfnCertificate.Properties for defining aCfnCertificate.A builder forCfnCertificatePropsAn implementation forCfnCertificatePropsCreates a certificate provider.A fluent builder forCfnCertificateProvider.Properties for defining aCfnCertificateProvider.A builder forCfnCertificateProviderPropsAn implementation forCfnCertificateProviderPropsUse theAWS::IoT::CustomMetricresource to define a custom metric published by your devices to Device Defender.A fluent builder forCfnCustomMetric.Properties for defining aCfnCustomMetric.A builder forCfnCustomMetricPropsAn implementation forCfnCustomMetricPropsUse theAWS::IoT::Dimensionto limit the scope of a metric used in a security profile for AWS IoT Device Defender .A fluent builder forCfnDimension.Properties for defining aCfnDimension.A builder forCfnDimensionPropsAn implementation forCfnDimensionPropsSpecifies a domain configuration.An object that specifies the authorization service for a domain.A builder forCfnDomainConfiguration.AuthorizerConfigPropertyAn implementation forCfnDomainConfiguration.AuthorizerConfigPropertyA fluent builder forCfnDomainConfiguration.An object that specifies the client certificate configuration for a domain.A builder forCfnDomainConfiguration.ClientCertificateConfigPropertyAn implementation forCfnDomainConfiguration.ClientCertificateConfigPropertyThe server certificate configuration.A builder forCfnDomainConfiguration.ServerCertificateConfigPropertyAn implementation forCfnDomainConfiguration.ServerCertificateConfigPropertyAn object that contains information about a server certificate.A builder forCfnDomainConfiguration.ServerCertificateSummaryPropertyAn implementation forCfnDomainConfiguration.ServerCertificateSummaryPropertyAn object that specifies the TLS configuration for a domain.A builder forCfnDomainConfiguration.TlsConfigPropertyAn implementation forCfnDomainConfiguration.TlsConfigPropertyProperties for defining aCfnDomainConfiguration.A builder forCfnDomainConfigurationPropsAn implementation forCfnDomainConfigurationPropsUse theAWS::IoT::FleetMetricresource to declare a fleet metric.The type of aggregation queries.A builder forCfnFleetMetric.AggregationTypePropertyAn implementation forCfnFleetMetric.AggregationTypePropertyA fluent builder forCfnFleetMetric.Properties for defining aCfnFleetMetric.A builder forCfnFleetMetricPropsAn implementation forCfnFleetMetricPropsRepresents a job template.The criteria that determine when and how a job abort takes place.A builder forCfnJobTemplate.AbortConfigPropertyAn implementation forCfnJobTemplate.AbortConfigPropertyThe criteria that determine when and how a job abort takes place.A builder forCfnJobTemplate.AbortCriteriaPropertyAn implementation forCfnJobTemplate.AbortCriteriaPropertyA fluent builder forCfnJobTemplate.Allows you to create an exponential rate of rollout for a job.A builder forCfnJobTemplate.ExponentialRolloutRatePropertyAn implementation forCfnJobTemplate.ExponentialRolloutRatePropertyThe configuration that determines how many retries are allowed for each failure type for a job.A builder forCfnJobTemplate.JobExecutionsRetryConfigPropertyAn implementation forCfnJobTemplate.JobExecutionsRetryConfigPropertyAllows you to create a staged rollout of a job.A builder forCfnJobTemplate.JobExecutionsRolloutConfigPropertyAn implementation forCfnJobTemplate.JobExecutionsRolloutConfigPropertyAn optional configuration within theSchedulingConfigto 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.A builder forCfnJobTemplate.MaintenanceWindowPropertyAn implementation forCfnJobTemplate.MaintenanceWindowPropertyConfiguration for pre-signed S3 URLs.A builder forCfnJobTemplate.PresignedUrlConfigPropertyAn implementation forCfnJobTemplate.PresignedUrlConfigPropertyAllows you to define a criteria to initiate the increase in rate of rollout for a job.A builder forCfnJobTemplate.RateIncreaseCriteriaPropertyAn implementation forCfnJobTemplate.RateIncreaseCriteriaPropertyThe criteria that determines how many retries are allowed for each failure type for a job.A builder forCfnJobTemplate.RetryCriteriaPropertyAn implementation forCfnJobTemplate.RetryCriteriaPropertySpecifies the amount of time each device has to finish its execution of the job.A builder forCfnJobTemplate.TimeoutConfigPropertyAn implementation forCfnJobTemplate.TimeoutConfigPropertyProperties for defining aCfnJobTemplate.A builder forCfnJobTemplatePropsAn implementation forCfnJobTemplatePropsConfigure logging.A fluent builder forCfnLogging.Properties for defining aCfnLogging.A builder forCfnLoggingPropsAn implementation forCfnLoggingPropsDefines an action that can be applied to audit findings by using StartAuditMitigationActionsTask.Defines the type of action and the parameters for that action.A builder forCfnMitigationAction.ActionParamsPropertyAn implementation forCfnMitigationAction.ActionParamsPropertyParameters used when defining a mitigation action that move a set of things to a thing group.A builder forCfnMitigationAction.AddThingsToThingGroupParamsPropertyAn implementation forCfnMitigationAction.AddThingsToThingGroupParamsPropertyA fluent builder forCfnMitigationAction.Parameters used when defining a mitigation action that enable AWS IoT Core logging.A builder forCfnMitigationAction.EnableIoTLoggingParamsPropertyAn implementation forCfnMitigationAction.EnableIoTLoggingParamsPropertyParameters to define a mitigation action that publishes findings to Amazon SNS.A builder forCfnMitigationAction.PublishFindingToSnsParamsPropertyAn implementation forCfnMitigationAction.PublishFindingToSnsParamsPropertyParameters to define a mitigation action that adds a blank policy to restrict permissions.An implementation forCfnMitigationAction.ReplaceDefaultPolicyVersionParamsPropertyParameters to define a mitigation action that changes the state of the CA certificate to inactive.A builder forCfnMitigationAction.UpdateCACertificateParamsPropertyAn implementation forCfnMitigationAction.UpdateCACertificateParamsPropertyParameters to define a mitigation action that changes the state of the device certificate to inactive.An implementation forCfnMitigationAction.UpdateDeviceCertificateParamsPropertyProperties for defining aCfnMitigationAction.A builder forCfnMitigationActionPropsAn implementation forCfnMitigationActionPropsUse theAWS::IoT::Policyresource to declare an AWS IoT policy.A fluent builder forCfnPolicy.Use theAWS::IoT::PolicyPrincipalAttachmentresource to attach an AWS IoT policy to a principal (an X.509 certificate or other credential).A fluent builder forCfnPolicyPrincipalAttachment.Properties for defining aCfnPolicyPrincipalAttachment.A builder forCfnPolicyPrincipalAttachmentPropsAn implementation forCfnPolicyPrincipalAttachmentPropsProperties for defining aCfnPolicy.A builder forCfnPolicyPropsAn implementation forCfnPolicyPropsCreates a fleet provisioning template.A fluent builder forCfnProvisioningTemplate.Structure that contains payloadVersion and targetArn.A builder forCfnProvisioningTemplate.ProvisioningHookPropertyAn implementation forCfnProvisioningTemplate.ProvisioningHookPropertyProperties for defining aCfnProvisioningTemplate.A builder forCfnProvisioningTemplatePropsAn implementation forCfnProvisioningTemplatePropsConfigure resource-specific logging.A fluent builder forCfnResourceSpecificLogging.Properties for defining aCfnResourceSpecificLogging.A builder forCfnResourceSpecificLoggingPropsAn implementation forCfnResourceSpecificLoggingPropsSpecifies a role alias.A fluent builder forCfnRoleAlias.Properties for defining aCfnRoleAlias.A builder forCfnRoleAliasPropsAn implementation forCfnRoleAliasPropsUse theAWS::IoT::ScheduledAuditresource to create a scheduled audit that is run at a specified time interval.A fluent builder forCfnScheduledAudit.Properties for defining aCfnScheduledAudit.A builder forCfnScheduledAuditPropsAn implementation forCfnScheduledAuditPropsUse theAWS::IoT::SecurityProfileresource to create a Device Defender security profile.A structure containing the alert target ARN and the role ARN.A builder forCfnSecurityProfile.AlertTargetPropertyAn implementation forCfnSecurityProfile.AlertTargetPropertyThe criteria by which the behavior is determined to be normal.A builder forCfnSecurityProfile.BehaviorCriteriaPropertyAn implementation forCfnSecurityProfile.BehaviorCriteriaPropertyA Device Defender security profile behavior.A builder forCfnSecurityProfile.BehaviorPropertyAn implementation forCfnSecurityProfile.BehaviorPropertyA fluent builder forCfnSecurityProfile.TheMachineLearningDetectionConfigproperty type controls confidence of the machine learning model.An implementation forCfnSecurityProfile.MachineLearningDetectionConfigPropertyThe dimension of the metric.A builder forCfnSecurityProfile.MetricDimensionPropertyAn implementation forCfnSecurityProfile.MetricDimensionPropertySpecifies the MQTT topic and role ARN required for metric export.A builder forCfnSecurityProfile.MetricsExportConfigPropertyAn implementation forCfnSecurityProfile.MetricsExportConfigPropertyThe metric you want to retain.A builder forCfnSecurityProfile.MetricToRetainPropertyAn implementation forCfnSecurityProfile.MetricToRetainPropertyThe value to be compared with themetric.A builder forCfnSecurityProfile.MetricValuePropertyAn implementation forCfnSecurityProfile.MetricValuePropertyA statistical ranking (percentile) that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.A builder forCfnSecurityProfile.StatisticalThresholdPropertyAn implementation forCfnSecurityProfile.StatisticalThresholdPropertyProperties for defining aCfnSecurityProfile.A builder forCfnSecurityProfilePropsAn implementation forCfnSecurityProfilePropsUse theAWS::IoT::SoftwarePackageresource to create a software package.A fluent builder forCfnSoftwarePackage.Properties for defining aCfnSoftwarePackage.A builder forCfnSoftwarePackagePropsAn implementation forCfnSoftwarePackagePropsUse theAWS::IoT::SoftwarePackageVersionresource to create a software package version.A fluent builder forCfnSoftwarePackageVersion.Properties for defining aCfnSoftwarePackageVersion.A builder forCfnSoftwarePackageVersionPropsAn implementation forCfnSoftwarePackageVersionPropsUse theAWS::IoT::Thingresource to declare an AWS IoT thing.The AttributePayload property specifies up to three attributes for an AWS IoT as key-value pairs.A builder forCfnThing.AttributePayloadPropertyAn implementation forCfnThing.AttributePayloadPropertyA fluent builder forCfnThing.Creates a new thing group.The attribute payload.A builder forCfnThingGroup.AttributePayloadPropertyAn implementation forCfnThingGroup.AttributePayloadPropertyA fluent builder forCfnThingGroup.Thing group properties.A builder forCfnThingGroup.ThingGroupPropertiesPropertyAn implementation forCfnThingGroup.ThingGroupPropertiesPropertyProperties for defining aCfnThingGroup.A builder forCfnThingGroupPropsAn implementation forCfnThingGroupPropsUse theAWS::IoT::ThingPrincipalAttachmentresource to attach a principal (an X.509 certificate or another credential) to a thing.A fluent builder forCfnThingPrincipalAttachment.Properties for defining aCfnThingPrincipalAttachment.A builder forCfnThingPrincipalAttachmentPropsAn implementation forCfnThingPrincipalAttachmentPropsProperties for defining aCfnThing.A builder forCfnThingPropsAn implementation forCfnThingPropsCreates a new thing type.A fluent builder forCfnThingType.The configuration to add user-defined properties to enrich MQTT 5 messages.A builder forCfnThingType.Mqtt5ConfigurationPropertyAn implementation forCfnThingType.Mqtt5ConfigurationPropertyAn object that represents the connection attribute, the thing attribute, and the MQTT 5 user property key.A builder forCfnThingType.PropagatingAttributePropertyAn implementation forCfnThingType.PropagatingAttributePropertyThe ThingTypeProperties contains information about the thing type including: a thing type description, and a list of searchable thing attribute names.A builder forCfnThingType.ThingTypePropertiesPropertyAn implementation forCfnThingType.ThingTypePropertiesPropertyProperties for defining aCfnThingType.A builder forCfnThingTypePropsAn implementation forCfnThingTypePropsUse theAWS::IoT::TopicRuleresource to declare an AWS IoT rule.Describes the actions associated with a rule.A builder forCfnTopicRule.ActionPropertyAn implementation forCfnTopicRule.ActionPropertyAn asset property timestamp entry containing the following information.A builder forCfnTopicRule.AssetPropertyTimestampPropertyAn implementation forCfnTopicRule.AssetPropertyTimestampPropertyAn asset property value entry containing the following information.A builder forCfnTopicRule.AssetPropertyValuePropertyAn implementation forCfnTopicRule.AssetPropertyValuePropertyContains an asset property value (of a single type).A builder forCfnTopicRule.AssetPropertyVariantPropertyAn implementation forCfnTopicRule.AssetPropertyVariantPropertyA fluent builder forCfnTopicRule.Describes an action that updates a CloudWatch alarm.A builder forCfnTopicRule.CloudwatchAlarmActionPropertyAn implementation forCfnTopicRule.CloudwatchAlarmActionPropertyDescribes an action that updates a CloudWatch log.A builder forCfnTopicRule.CloudwatchLogsActionPropertyAn implementation forCfnTopicRule.CloudwatchLogsActionPropertyDescribes an action that captures a CloudWatch metric.A builder forCfnTopicRule.CloudwatchMetricActionPropertyAn implementation forCfnTopicRule.CloudwatchMetricActionPropertyDescribes an action to write to a DynamoDB table.A builder forCfnTopicRule.DynamoDBActionPropertyAn implementation forCfnTopicRule.DynamoDBActionPropertyDescribes an action to write to a DynamoDB table.A builder forCfnTopicRule.DynamoDBv2ActionPropertyAn implementation forCfnTopicRule.DynamoDBv2ActionPropertyDescribes an action that writes data to an Amazon OpenSearch Service domain.A builder forCfnTopicRule.ElasticsearchActionPropertyAn implementation forCfnTopicRule.ElasticsearchActionPropertyDescribes an action that writes data to an Amazon Kinesis Firehose stream.A builder forCfnTopicRule.FirehoseActionPropertyAn implementation forCfnTopicRule.FirehoseActionPropertyThe HTTP action header.A builder forCfnTopicRule.HttpActionHeaderPropertyAn implementation forCfnTopicRule.HttpActionHeaderPropertySend data to an HTTPS endpoint.A builder forCfnTopicRule.HttpActionPropertyAn implementation forCfnTopicRule.HttpActionPropertyThe authorization method used to send messages.A builder forCfnTopicRule.HttpAuthorizationPropertyAn implementation forCfnTopicRule.HttpAuthorizationPropertySends message data to an AWS IoT Analytics channel.A builder forCfnTopicRule.IotAnalyticsActionPropertyAn implementation forCfnTopicRule.IotAnalyticsActionPropertySends an input to an AWS IoT Events detector.A builder forCfnTopicRule.IotEventsActionPropertyAn implementation forCfnTopicRule.IotEventsActionPropertyDescribes an action to send data from an MQTT message that triggered the rule to AWS IoT SiteWise asset properties.A builder forCfnTopicRule.IotSiteWiseActionPropertyAn implementation forCfnTopicRule.IotSiteWiseActionPropertySpecifies a Kafka header using key-value pairs when you create a Rule’s Kafka Action.A builder forCfnTopicRule.KafkaActionHeaderPropertyAn implementation forCfnTopicRule.KafkaActionHeaderPropertySend messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.A builder forCfnTopicRule.KafkaActionPropertyAn implementation forCfnTopicRule.KafkaActionPropertyDescribes an action to write data to an Amazon Kinesis stream.A builder forCfnTopicRule.KinesisActionPropertyAn implementation forCfnTopicRule.KinesisActionPropertyDescribes an action to invoke a Lambda function.A builder forCfnTopicRule.LambdaActionPropertyAn implementation forCfnTopicRule.LambdaActionPropertyDescribes an action to send device location updates from an MQTT message to an Amazon Location tracker resource.A builder forCfnTopicRule.LocationActionPropertyAn implementation forCfnTopicRule.LocationActionPropertyDescribes an action that writes data to an Amazon OpenSearch Service domain.A builder forCfnTopicRule.OpenSearchActionPropertyAn implementation forCfnTopicRule.OpenSearchActionPropertyAn asset property value entry containing the following information.A builder forCfnTopicRule.PutAssetPropertyValueEntryPropertyAn implementation forCfnTopicRule.PutAssetPropertyValueEntryPropertyThe input for the DynamoActionVS action that specifies the DynamoDB table to which the message data will be written.A builder forCfnTopicRule.PutItemInputPropertyAn implementation forCfnTopicRule.PutItemInputPropertySpecifies MQTT Version 5.0 headers information.A builder forCfnTopicRule.RepublishActionHeadersPropertyAn implementation forCfnTopicRule.RepublishActionHeadersPropertyDescribes an action to republish to another topic.A builder forCfnTopicRule.RepublishActionPropertyAn implementation forCfnTopicRule.RepublishActionPropertyDescribes an action to write data to an Amazon S3 bucket.A builder forCfnTopicRule.S3ActionPropertyAn implementation forCfnTopicRule.S3ActionPropertyFor more information, see Signature Version 4 signing process .A builder forCfnTopicRule.SigV4AuthorizationPropertyAn implementation forCfnTopicRule.SigV4AuthorizationPropertyDescribes an action to publish to an Amazon SNS topic.A builder forCfnTopicRule.SnsActionPropertyAn implementation forCfnTopicRule.SnsActionPropertyDescribes an action to publish data to an Amazon SQS queue.A builder forCfnTopicRule.SqsActionPropertyAn implementation forCfnTopicRule.SqsActionPropertyStarts execution of a Step Functions state machine.A builder forCfnTopicRule.StepFunctionsActionPropertyAn implementation forCfnTopicRule.StepFunctionsActionPropertyDescribes how to interpret an application-defined timestamp value from an MQTT message payload and the precision of that value.A builder forCfnTopicRule.TimestampPropertyAn implementation forCfnTopicRule.TimestampPropertyDescribes an action that writes records into an Amazon Timestream table.A builder forCfnTopicRule.TimestreamActionPropertyAn implementation forCfnTopicRule.TimestreamActionPropertyMetadata attributes of the time series that are written in each measure record.A builder forCfnTopicRule.TimestreamDimensionPropertyAn implementation forCfnTopicRule.TimestreamDimensionPropertyThe value to use for the entry's timestamp.A builder forCfnTopicRule.TimestreamTimestampPropertyAn implementation forCfnTopicRule.TimestreamTimestampPropertyDescribes a rule.A builder forCfnTopicRule.TopicRulePayloadPropertyAn implementation forCfnTopicRule.TopicRulePayloadPropertyA key-value pair that you define in the header.A builder forCfnTopicRule.UserPropertyPropertyAn implementation forCfnTopicRule.UserPropertyPropertyA topic rule destination.A fluent builder forCfnTopicRuleDestination.HTTP URL destination properties.An implementation forCfnTopicRuleDestination.HttpUrlDestinationSummaryPropertyThe properties of a virtual private cloud (VPC) destination.A builder forCfnTopicRuleDestination.VpcDestinationPropertiesPropertyAn implementation forCfnTopicRuleDestination.VpcDestinationPropertiesPropertyProperties for defining aCfnTopicRuleDestination.A builder forCfnTopicRuleDestinationPropsAn implementation forCfnTopicRuleDestinationPropsProperties for defining aCfnTopicRule.A builder forCfnTopicRulePropsAn implementation forCfnTopicRuleProps