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::AccountAuditConfiguration
resource 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.AuditCheckConfigurationProperty
The types of audit checks that can be performed.An implementation forCfnAccountAuditConfiguration.AuditCheckConfigurationsProperty
The configuration of the audit notification target.An implementation forCfnAccountAuditConfiguration.AuditNotificationTargetConfigurationsProperty
Information about the targets to which audit notifications are sent.An implementation forCfnAccountAuditConfiguration.AuditNotificationTargetProperty
A fluent builder forCfnAccountAuditConfiguration
.Properties for defining aCfnAccountAuditConfiguration
.A builder forCfnAccountAuditConfigurationProps
An implementation forCfnAccountAuditConfigurationProps
Specifies an authorizer.A fluent builder forCfnAuthorizer
.Properties for defining aCfnAuthorizer
.A builder forCfnAuthorizerProps
An implementation forCfnAuthorizerProps
Creates a new billing group.The properties of a billing group.A builder forCfnBillingGroup.BillingGroupPropertiesProperty
An implementation forCfnBillingGroup.BillingGroupPropertiesProperty
A fluent builder forCfnBillingGroup
.Properties for defining aCfnBillingGroup
.A builder forCfnBillingGroupProps
An implementation forCfnBillingGroupProps
Specifies a CA certificate.A fluent builder forCfnCACertificate
.The registration configuration.A builder forCfnCACertificate.RegistrationConfigProperty
An implementation forCfnCACertificate.RegistrationConfigProperty
Properties for defining aCfnCACertificate
.A builder forCfnCACertificateProps
An implementation forCfnCACertificateProps
Use theAWS::IoT::Certificate
resource to declare an AWS IoT X.509 certificate.A fluent builder forCfnCertificate
.Properties for defining aCfnCertificate
.A builder forCfnCertificateProps
An implementation forCfnCertificateProps
Creates a certificate provider.A fluent builder forCfnCertificateProvider
.Properties for defining aCfnCertificateProvider
.A builder forCfnCertificateProviderProps
An implementation forCfnCertificateProviderProps
Use theAWS::IoT::CustomMetric
resource to define a custom metric published by your devices to Device Defender.A fluent builder forCfnCustomMetric
.Properties for defining aCfnCustomMetric
.A builder forCfnCustomMetricProps
An implementation forCfnCustomMetricProps
Use theAWS::IoT::Dimension
to 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 forCfnDimensionProps
An implementation forCfnDimensionProps
Specifies a domain configuration.An object that specifies the authorization service for a domain.A builder forCfnDomainConfiguration.AuthorizerConfigProperty
An implementation forCfnDomainConfiguration.AuthorizerConfigProperty
A fluent builder forCfnDomainConfiguration
.An object that specifies the client certificate configuration for a domain.A builder forCfnDomainConfiguration.ClientCertificateConfigProperty
An implementation forCfnDomainConfiguration.ClientCertificateConfigProperty
The server certificate configuration.A builder forCfnDomainConfiguration.ServerCertificateConfigProperty
An implementation forCfnDomainConfiguration.ServerCertificateConfigProperty
An object that contains information about a server certificate.A builder forCfnDomainConfiguration.ServerCertificateSummaryProperty
An implementation forCfnDomainConfiguration.ServerCertificateSummaryProperty
An object that specifies the TLS configuration for a domain.A builder forCfnDomainConfiguration.TlsConfigProperty
An implementation forCfnDomainConfiguration.TlsConfigProperty
Properties for defining aCfnDomainConfiguration
.A builder forCfnDomainConfigurationProps
An implementation forCfnDomainConfigurationProps
Use theAWS::IoT::FleetMetric
resource to declare a fleet metric.The type of aggregation queries.A builder forCfnFleetMetric.AggregationTypeProperty
An implementation forCfnFleetMetric.AggregationTypeProperty
A fluent builder forCfnFleetMetric
.Properties for defining aCfnFleetMetric
.A builder forCfnFleetMetricProps
An implementation forCfnFleetMetricProps
Represents a job template.The criteria that determine when and how a job abort takes place.A builder forCfnJobTemplate.AbortConfigProperty
An implementation forCfnJobTemplate.AbortConfigProperty
The criteria that determine when and how a job abort takes place.A builder forCfnJobTemplate.AbortCriteriaProperty
An implementation forCfnJobTemplate.AbortCriteriaProperty
A fluent builder forCfnJobTemplate
.Allows you to create an exponential rate of rollout for a job.A builder forCfnJobTemplate.ExponentialRolloutRateProperty
An implementation forCfnJobTemplate.ExponentialRolloutRateProperty
The configuration that determines how many retries are allowed for each failure type for a job.A builder forCfnJobTemplate.JobExecutionsRetryConfigProperty
An implementation forCfnJobTemplate.JobExecutionsRetryConfigProperty
Allows you to create a staged rollout of a job.A builder forCfnJobTemplate.JobExecutionsRolloutConfigProperty
An implementation forCfnJobTemplate.JobExecutionsRolloutConfigProperty
An optional configuration within theSchedulingConfig
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.A builder forCfnJobTemplate.MaintenanceWindowProperty
An implementation forCfnJobTemplate.MaintenanceWindowProperty
Configuration for pre-signed S3 URLs.A builder forCfnJobTemplate.PresignedUrlConfigProperty
An implementation forCfnJobTemplate.PresignedUrlConfigProperty
Allows you to define a criteria to initiate the increase in rate of rollout for a job.A builder forCfnJobTemplate.RateIncreaseCriteriaProperty
An implementation forCfnJobTemplate.RateIncreaseCriteriaProperty
The criteria that determines how many retries are allowed for each failure type for a job.A builder forCfnJobTemplate.RetryCriteriaProperty
An implementation forCfnJobTemplate.RetryCriteriaProperty
Specifies the amount of time each device has to finish its execution of the job.A builder forCfnJobTemplate.TimeoutConfigProperty
An implementation forCfnJobTemplate.TimeoutConfigProperty
Properties for defining aCfnJobTemplate
.A builder forCfnJobTemplateProps
An implementation forCfnJobTemplateProps
Configure logging.A fluent builder forCfnLogging
.Properties for defining aCfnLogging
.A builder forCfnLoggingProps
An implementation forCfnLoggingProps
Defines 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.ActionParamsProperty
An implementation forCfnMitigationAction.ActionParamsProperty
Parameters used when defining a mitigation action that move a set of things to a thing group.A builder forCfnMitigationAction.AddThingsToThingGroupParamsProperty
An implementation forCfnMitigationAction.AddThingsToThingGroupParamsProperty
A fluent builder forCfnMitigationAction
.Parameters used when defining a mitigation action that enable AWS IoT Core logging.A builder forCfnMitigationAction.EnableIoTLoggingParamsProperty
An implementation forCfnMitigationAction.EnableIoTLoggingParamsProperty
Parameters to define a mitigation action that publishes findings to Amazon SNS.A builder forCfnMitigationAction.PublishFindingToSnsParamsProperty
An implementation forCfnMitigationAction.PublishFindingToSnsParamsProperty
Parameters to define a mitigation action that adds a blank policy to restrict permissions.An implementation forCfnMitigationAction.ReplaceDefaultPolicyVersionParamsProperty
Parameters to define a mitigation action that changes the state of the CA certificate to inactive.A builder forCfnMitigationAction.UpdateCACertificateParamsProperty
An implementation forCfnMitigationAction.UpdateCACertificateParamsProperty
Parameters to define a mitigation action that changes the state of the device certificate to inactive.An implementation forCfnMitigationAction.UpdateDeviceCertificateParamsProperty
Properties for defining aCfnMitigationAction
.A builder forCfnMitigationActionProps
An implementation forCfnMitigationActionProps
Use theAWS::IoT::Policy
resource to declare an AWS IoT policy.A fluent builder forCfnPolicy
.Use theAWS::IoT::PolicyPrincipalAttachment
resource 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 forCfnPolicyPrincipalAttachmentProps
An implementation forCfnPolicyPrincipalAttachmentProps
Properties for defining aCfnPolicy
.A builder forCfnPolicyProps
An implementation forCfnPolicyProps
Creates a fleet provisioning template.A fluent builder forCfnProvisioningTemplate
.Structure that contains payloadVersion and targetArn.A builder forCfnProvisioningTemplate.ProvisioningHookProperty
An implementation forCfnProvisioningTemplate.ProvisioningHookProperty
Properties for defining aCfnProvisioningTemplate
.A builder forCfnProvisioningTemplateProps
An implementation forCfnProvisioningTemplateProps
Configure resource-specific logging.A fluent builder forCfnResourceSpecificLogging
.Properties for defining aCfnResourceSpecificLogging
.A builder forCfnResourceSpecificLoggingProps
An implementation forCfnResourceSpecificLoggingProps
Specifies a role alias.A fluent builder forCfnRoleAlias
.Properties for defining aCfnRoleAlias
.A builder forCfnRoleAliasProps
An implementation forCfnRoleAliasProps
Use theAWS::IoT::ScheduledAudit
resource to create a scheduled audit that is run at a specified time interval.A fluent builder forCfnScheduledAudit
.Properties for defining aCfnScheduledAudit
.A builder forCfnScheduledAuditProps
An implementation forCfnScheduledAuditProps
Use theAWS::IoT::SecurityProfile
resource to create a Device Defender security profile.A structure containing the alert target ARN and the role ARN.A builder forCfnSecurityProfile.AlertTargetProperty
An implementation forCfnSecurityProfile.AlertTargetProperty
The criteria by which the behavior is determined to be normal.A builder forCfnSecurityProfile.BehaviorCriteriaProperty
An implementation forCfnSecurityProfile.BehaviorCriteriaProperty
A Device Defender security profile behavior.A builder forCfnSecurityProfile.BehaviorProperty
An implementation forCfnSecurityProfile.BehaviorProperty
A fluent builder forCfnSecurityProfile
.TheMachineLearningDetectionConfig
property type controls confidence of the machine learning model.An implementation forCfnSecurityProfile.MachineLearningDetectionConfigProperty
The dimension of the metric.A builder forCfnSecurityProfile.MetricDimensionProperty
An implementation forCfnSecurityProfile.MetricDimensionProperty
Specifies the MQTT topic and role ARN required for metric export.A builder forCfnSecurityProfile.MetricsExportConfigProperty
An implementation forCfnSecurityProfile.MetricsExportConfigProperty
The metric you want to retain.A builder forCfnSecurityProfile.MetricToRetainProperty
An implementation forCfnSecurityProfile.MetricToRetainProperty
The value to be compared with themetric
.A builder forCfnSecurityProfile.MetricValueProperty
An implementation forCfnSecurityProfile.MetricValueProperty
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.A builder forCfnSecurityProfile.StatisticalThresholdProperty
An implementation forCfnSecurityProfile.StatisticalThresholdProperty
Properties for defining aCfnSecurityProfile
.A builder forCfnSecurityProfileProps
An implementation forCfnSecurityProfileProps
Use theAWS::IoT::SoftwarePackage
resource to create a software package.A fluent builder forCfnSoftwarePackage
.Properties for defining aCfnSoftwarePackage
.A builder forCfnSoftwarePackageProps
An implementation forCfnSoftwarePackageProps
Use theAWS::IoT::SoftwarePackageVersion
resource to create a software package version.A fluent builder forCfnSoftwarePackageVersion
.Properties for defining aCfnSoftwarePackageVersion
.A builder forCfnSoftwarePackageVersionProps
An implementation forCfnSoftwarePackageVersionProps
Use theAWS::IoT::Thing
resource 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.AttributePayloadProperty
An implementation forCfnThing.AttributePayloadProperty
A fluent builder forCfnThing
.Creates a new thing group.The attribute payload.A builder forCfnThingGroup.AttributePayloadProperty
An implementation forCfnThingGroup.AttributePayloadProperty
A fluent builder forCfnThingGroup
.Thing group properties.A builder forCfnThingGroup.ThingGroupPropertiesProperty
An implementation forCfnThingGroup.ThingGroupPropertiesProperty
Properties for defining aCfnThingGroup
.A builder forCfnThingGroupProps
An implementation forCfnThingGroupProps
Use theAWS::IoT::ThingPrincipalAttachment
resource to attach a principal (an X.509 certificate or another credential) to a thing.A fluent builder forCfnThingPrincipalAttachment
.Properties for defining aCfnThingPrincipalAttachment
.A builder forCfnThingPrincipalAttachmentProps
An implementation forCfnThingPrincipalAttachmentProps
Properties for defining aCfnThing
.A builder forCfnThingProps
An implementation forCfnThingProps
Creates a new thing type.A fluent builder forCfnThingType
.The ThingTypeProperties contains information about the thing type including: a thing type description, and a list of searchable thing attribute names.A builder forCfnThingType.ThingTypePropertiesProperty
An implementation forCfnThingType.ThingTypePropertiesProperty
Properties for defining aCfnThingType
.A builder forCfnThingTypeProps
An implementation forCfnThingTypeProps
Use theAWS::IoT::TopicRule
resource to declare an AWS IoT rule.Describes the actions associated with a rule.A builder forCfnTopicRule.ActionProperty
An implementation forCfnTopicRule.ActionProperty
An asset property timestamp entry containing the following information.A builder forCfnTopicRule.AssetPropertyTimestampProperty
An implementation forCfnTopicRule.AssetPropertyTimestampProperty
An asset property value entry containing the following information.A builder forCfnTopicRule.AssetPropertyValueProperty
An implementation forCfnTopicRule.AssetPropertyValueProperty
Contains an asset property value (of a single type).A builder forCfnTopicRule.AssetPropertyVariantProperty
An implementation forCfnTopicRule.AssetPropertyVariantProperty
A fluent builder forCfnTopicRule
.Describes an action that updates a CloudWatch alarm.A builder forCfnTopicRule.CloudwatchAlarmActionProperty
An implementation forCfnTopicRule.CloudwatchAlarmActionProperty
Describes an action that updates a CloudWatch log.A builder forCfnTopicRule.CloudwatchLogsActionProperty
An implementation forCfnTopicRule.CloudwatchLogsActionProperty
Describes an action that captures a CloudWatch metric.A builder forCfnTopicRule.CloudwatchMetricActionProperty
An implementation forCfnTopicRule.CloudwatchMetricActionProperty
Describes an action to write to a DynamoDB table.A builder forCfnTopicRule.DynamoDBActionProperty
An implementation forCfnTopicRule.DynamoDBActionProperty
Describes an action to write to a DynamoDB table.A builder forCfnTopicRule.DynamoDBv2ActionProperty
An implementation forCfnTopicRule.DynamoDBv2ActionProperty
Describes an action that writes data to an Amazon OpenSearch Service domain.A builder forCfnTopicRule.ElasticsearchActionProperty
An implementation forCfnTopicRule.ElasticsearchActionProperty
Describes an action that writes data to an Amazon Kinesis Firehose stream.A builder forCfnTopicRule.FirehoseActionProperty
An implementation forCfnTopicRule.FirehoseActionProperty
The HTTP action header.A builder forCfnTopicRule.HttpActionHeaderProperty
An implementation forCfnTopicRule.HttpActionHeaderProperty
Send data to an HTTPS endpoint.A builder forCfnTopicRule.HttpActionProperty
An implementation forCfnTopicRule.HttpActionProperty
The authorization method used to send messages.A builder forCfnTopicRule.HttpAuthorizationProperty
An implementation forCfnTopicRule.HttpAuthorizationProperty
Sends message data to an AWS IoT Analytics channel.A builder forCfnTopicRule.IotAnalyticsActionProperty
An implementation forCfnTopicRule.IotAnalyticsActionProperty
Sends an input to an AWS IoT Events detector.A builder forCfnTopicRule.IotEventsActionProperty
An implementation forCfnTopicRule.IotEventsActionProperty
Describes an action to send data from an MQTT message that triggered the rule to AWS IoT SiteWise asset properties.A builder forCfnTopicRule.IotSiteWiseActionProperty
An implementation forCfnTopicRule.IotSiteWiseActionProperty
Specifies a Kafka header using key-value pairs when you create a Rule’s Kafka Action.A builder forCfnTopicRule.KafkaActionHeaderProperty
An implementation forCfnTopicRule.KafkaActionHeaderProperty
Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.A builder forCfnTopicRule.KafkaActionProperty
An implementation forCfnTopicRule.KafkaActionProperty
Describes an action to write data to an Amazon Kinesis stream.A builder forCfnTopicRule.KinesisActionProperty
An implementation forCfnTopicRule.KinesisActionProperty
Describes an action to invoke a Lambda function.A builder forCfnTopicRule.LambdaActionProperty
An implementation forCfnTopicRule.LambdaActionProperty
Describes an action to send device location updates from an MQTT message to an Amazon Location tracker resource.A builder forCfnTopicRule.LocationActionProperty
An implementation forCfnTopicRule.LocationActionProperty
Describes an action that writes data to an Amazon OpenSearch Service domain.A builder forCfnTopicRule.OpenSearchActionProperty
An implementation forCfnTopicRule.OpenSearchActionProperty
An asset property value entry containing the following information.A builder forCfnTopicRule.PutAssetPropertyValueEntryProperty
An implementation forCfnTopicRule.PutAssetPropertyValueEntryProperty
The input for the DynamoActionVS action that specifies the DynamoDB table to which the message data will be written.A builder forCfnTopicRule.PutItemInputProperty
An implementation forCfnTopicRule.PutItemInputProperty
Specifies MQTT Version 5.0 headers information.A builder forCfnTopicRule.RepublishActionHeadersProperty
An implementation forCfnTopicRule.RepublishActionHeadersProperty
Describes an action to republish to another topic.A builder forCfnTopicRule.RepublishActionProperty
An implementation forCfnTopicRule.RepublishActionProperty
Describes an action to write data to an Amazon S3 bucket.A builder forCfnTopicRule.S3ActionProperty
An implementation forCfnTopicRule.S3ActionProperty
For more information, see Signature Version 4 signing process .A builder forCfnTopicRule.SigV4AuthorizationProperty
An implementation forCfnTopicRule.SigV4AuthorizationProperty
Describes an action to publish to an Amazon SNS topic.A builder forCfnTopicRule.SnsActionProperty
An implementation forCfnTopicRule.SnsActionProperty
Describes an action to publish data to an Amazon SQS queue.A builder forCfnTopicRule.SqsActionProperty
An implementation forCfnTopicRule.SqsActionProperty
Starts execution of a Step Functions state machine.A builder forCfnTopicRule.StepFunctionsActionProperty
An implementation forCfnTopicRule.StepFunctionsActionProperty
Describes how to interpret an application-defined timestamp value from an MQTT message payload and the precision of that value.A builder forCfnTopicRule.TimestampProperty
An implementation forCfnTopicRule.TimestampProperty
Describes an action that writes records into an Amazon Timestream table.A builder forCfnTopicRule.TimestreamActionProperty
An implementation forCfnTopicRule.TimestreamActionProperty
Metadata attributes of the time series that are written in each measure record.A builder forCfnTopicRule.TimestreamDimensionProperty
An implementation forCfnTopicRule.TimestreamDimensionProperty
The value to use for the entry's timestamp.A builder forCfnTopicRule.TimestreamTimestampProperty
An implementation forCfnTopicRule.TimestreamTimestampProperty
Describes a rule.A builder forCfnTopicRule.TopicRulePayloadProperty
An implementation forCfnTopicRule.TopicRulePayloadProperty
A key-value pair that you define in the header.A builder forCfnTopicRule.UserPropertyProperty
An implementation forCfnTopicRule.UserPropertyProperty
A topic rule destination.A fluent builder forCfnTopicRuleDestination
.HTTP URL destination properties.An implementation forCfnTopicRuleDestination.HttpUrlDestinationSummaryProperty
The properties of a virtual private cloud (VPC) destination.A builder forCfnTopicRuleDestination.VpcDestinationPropertiesProperty
An implementation forCfnTopicRuleDestination.VpcDestinationPropertiesProperty
Properties for defining aCfnTopicRuleDestination
.A builder forCfnTopicRuleDestinationProps
An implementation forCfnTopicRuleDestinationProps
Properties for defining aCfnTopicRule
.A builder forCfnTopicRuleProps
An implementation forCfnTopicRuleProps