Skip to content

Latest commit

 

History

History
984 lines (837 loc) · 40.1 KB

File metadata and controls

984 lines (837 loc) · 40.1 KB

AWS.IoT @ default

Resource AWS.IoT/AccountAuditConfiguration@default

  • Valid Scope(s): Unknown

Properties

Resource AWS.IoT/Authorizer@default

  • Valid Scope(s): Unknown

Properties

  • alias: string (Required): the resource alias
  • name: string: the resource name
  • properties: AWS.IoT/AuthorizerProperties (Required): properties of the resource

Resource AWS.IoT/BillingGroup@default

  • Valid Scope(s): Unknown

Properties

Resource AWS.IoT/CACertificate@default

  • Valid Scope(s): Unknown

Properties

  • alias: string (Required): the resource alias
  • name: string: the resource name
  • properties: AWS.IoT/CACertificateProperties (Required): properties of the resource

Resource AWS.IoT/Certificate@default

  • Valid Scope(s): Unknown

Properties

  • alias: string (Required): the resource alias
  • name: string: the resource name
  • properties: AWS.IoT/CertificateProperties (Required): properties of the resource

Resource AWS.IoT/CertificateProvider@default

  • Valid Scope(s): Unknown

Properties

Resource AWS.IoT/CustomMetric@default

  • Valid Scope(s): Unknown

Properties

  • alias: string (Required): the resource alias
  • name: string: the resource name
  • properties: AWS.IoT/CustomMetricProperties (Required): properties of the resource

Resource AWS.IoT/Dimension@default

  • Valid Scope(s): Unknown

Properties

  • alias: string (Required): the resource alias
  • name: string: the resource name
  • properties: AWS.IoT/DimensionProperties (Required): properties of the resource

Resource AWS.IoT/DomainConfiguration@default

  • Valid Scope(s): Unknown

Properties

Resource AWS.IoT/FleetMetric@default

  • Valid Scope(s): Unknown

Properties

  • alias: string (Required): the resource alias
  • name: string: the resource name
  • properties: AWS.IoT/FleetMetricProperties (Required): properties of the resource

Resource AWS.IoT/Logging@default

  • Valid Scope(s): Unknown

Properties

  • alias: string (Required): the resource alias
  • name: string: the resource name
  • properties: AWS.IoT/LoggingProperties (Required): properties of the resource

Resource AWS.IoT/MitigationAction@default

  • Valid Scope(s): Unknown

Properties

Resource AWS.IoT/Policy@default

  • Valid Scope(s): Unknown

Properties

  • alias: string (Required): the resource alias
  • name: string: the resource name
  • properties: AWS.IoT/PolicyProperties (Required): properties of the resource

Resource AWS.IoT/ProvisioningTemplate@default

  • Valid Scope(s): Unknown

Properties

Resource AWS.IoT/ResourceSpecificLogging@default

  • Valid Scope(s): Unknown

Properties

Resource AWS.IoT/RoleAlias@default

  • Valid Scope(s): Unknown

Properties

  • alias: string (Required): the resource alias
  • name: string: the resource name
  • properties: AWS.IoT/RoleAliasProperties (Required): properties of the resource

Resource AWS.IoT/ScheduledAudit@default

  • Valid Scope(s): Unknown

Properties

  • alias: string (Required): the resource alias
  • name: string: the resource name
  • properties: AWS.IoT/ScheduledAuditProperties (Required): properties of the resource

Resource AWS.IoT/SecurityProfile@default

  • Valid Scope(s): Unknown

Properties

Resource AWS.IoT/SoftwarePackage@default

  • Valid Scope(s): Unknown

Properties

Resource AWS.IoT/SoftwarePackageVersion@default

  • Valid Scope(s): Unknown

Properties

Resource AWS.IoT/Thing@default

  • Valid Scope(s): Unknown

Properties

  • alias: string (Required): the resource alias
  • name: string: the resource name
  • properties: AWS.IoT/ThingProperties: properties of the resource

Resource AWS.IoT/ThingGroup@default

  • Valid Scope(s): Unknown

Properties

  • alias: string (Required): the resource alias
  • name: string: the resource name
  • properties: AWS.IoT/ThingGroupProperties: properties of the resource

Resource AWS.IoT/ThingType@default

  • Valid Scope(s): Unknown

Properties

  • alias: string (Required): the resource alias
  • name: string: the resource name
  • properties: AWS.IoT/ThingTypeProperties: properties of the resource

Resource AWS.IoT/TopicRule@default

  • Valid Scope(s): Unknown

Properties

  • alias: string (Required): the resource alias
  • name: string: the resource name
  • properties: AWS.IoT/TopicRuleProperties (Required): properties of the resource

Resource AWS.IoT/TopicRuleDestination@default

  • Valid Scope(s): Unknown

Properties

AWS.IoT/AccountAuditConfigurationProperties

Properties

  • AccountId: string (Required, Identifier): Your 12-digit account ID (used as the primary identifier for the CloudFormation resource).
  • AuditCheckConfigurations: AuditCheckConfigurations (Required)
  • AuditNotificationTargetConfigurations: AuditNotificationTargetConfigurations
  • RoleArn: string (Required): The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as required when performing an audit.

AuditCheckConfigurations

Properties

AuditCheckConfiguration

Properties

  • Enabled: bool: True if the check is enabled.

AuditNotificationTargetConfigurations

Properties

AuditNotificationTarget

Properties

  • Enabled: bool: True if notifications to the target are enabled.
  • RoleArn: string: The ARN of the role that grants permission to send notifications to the target.
  • TargetArn: string: The ARN of the target (SNS topic) to which audit notifications are sent.

AWS.IoT/AuthorizerProperties

Properties

  • Arn: string (ReadOnly)
  • AuthorizerFunctionArn: string (Required)
  • AuthorizerName: string (Identifier)
  • EnableCachingForHttp: bool
  • SigningDisabled: bool
  • Status: string
  • Tags: Tag[]
  • TokenKeyName: string
  • TokenSigningPublicKeys: Authorizer_TokenSigningPublicKeys

Tag

Properties

  • Key: string (Required)
  • Value: string (Required)

Authorizer_TokenSigningPublicKeys

Properties

AWS.IoT/BillingGroupProperties

Properties

  • Arn: string (ReadOnly)
  • BillingGroupName: string (Identifier)
  • BillingGroupProperties: BillingGroup_BillingGroupProperties
  • Id: string (ReadOnly)
  • Tags: Tag[]: An array of key-value pairs to apply to this resource.

BillingGroup_BillingGroupProperties

Properties

  • BillingGroupDescription: string

Tag

Properties

  • Key: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
  • Value: string (Required): The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

AWS.IoT/CACertificateProperties

Properties

  • Arn: string (ReadOnly)
  • AutoRegistrationStatus: string
  • CACertificatePem: string (Required)
  • CertificateMode: string
  • Id: string (ReadOnly, Identifier)
  • RegistrationConfig: RegistrationConfig
  • RemoveAutoRegistration: bool (WriteOnly)
  • Status: string (Required)
  • Tags: Tag[]: An array of key-value pairs to apply to this resource.
  • VerificationCertificatePem: string (WriteOnly): The private key verification certificate.

RegistrationConfig

Properties

  • RoleArn: string
  • TemplateBody: string
  • TemplateName: string

Tag

Properties

  • Key: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
  • Value: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

AWS.IoT/CertificateProperties

Properties

  • Arn: string (ReadOnly)
  • CACertificatePem: string (WriteOnly)
  • CertificateMode: string
  • CertificatePem: string
  • CertificateSigningRequest: string (WriteOnly)
  • Id: string (ReadOnly, Identifier)
  • Status: string (Required)

AWS.IoT/CertificateProviderProperties

Properties

  • AccountDefaultForOperations: string[] (Required)
  • Arn: string (ReadOnly)
  • CertificateProviderName: string (Identifier)
  • LambdaFunctionArn: string (Required)
  • Tags: Tag[]: An array of key-value pairs to apply to this resource.

Tag

Properties

  • Key: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
  • Value: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

AWS.IoT/CustomMetricProperties

Properties

  • DisplayName: string: Field represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined.
  • MetricArn: string (ReadOnly): The Amazon Resource Number (ARN) of the custom metric.
  • MetricName: string (Identifier): The name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws: . Cannot be updated once defined.
  • MetricType: string (Required): The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.
  • Tags: Tag[]: An array of key-value pairs to apply to this resource.

Tag

Properties

  • Key: string (Required): The tag's key.
  • Value: string (Required): The tag's value.

AWS.IoT/DimensionProperties

Properties

  • Arn: string (ReadOnly): The ARN (Amazon resource name) of the created dimension.
  • Name: string (Identifier): A unique identifier for the dimension.
  • StringValues: string[] (Required): Specifies the value or list of values for the dimension.
  • Tags: Tag[]: Metadata that can be used to manage the dimension.
  • Type: string (Required): Specifies the type of the dimension.

Tag

Properties

  • Key: string (Required): The tag's key.
  • Value: string (Required): The tag's value.

AWS.IoT/DomainConfigurationProperties

Properties

  • Arn: string (ReadOnly)
  • AuthorizerConfig: AuthorizerConfig
  • DomainConfigurationName: string (Identifier)
  • DomainConfigurationStatus: string
  • DomainName: string
  • DomainType: string (ReadOnly)
  • ServerCertificateArns: string[] (WriteOnly)
  • ServerCertificateConfig: ServerCertificateConfig
  • ServerCertificates: ServerCertificateSummary[] (ReadOnly)
  • ServiceType: string
  • Tags: Tag[]
  • TlsConfig: TlsConfig
  • ValidationCertificateArn: string (WriteOnly)

AuthorizerConfig

Properties

  • AllowAuthorizerOverride: bool
  • DefaultAuthorizerName: string

ServerCertificateConfig

Properties

  • EnableOCSPCheck: bool

ServerCertificateSummary

Properties

  • ServerCertificateArn: string
  • ServerCertificateStatus: string
  • ServerCertificateStatusDetail: string

Tag

Properties

  • Key: string (Required)
  • Value: string (Required)

TlsConfig

Properties

  • SecurityPolicy: string

AWS.IoT/FleetMetricProperties

Properties

  • AggregationField: string: The aggregation field to perform aggregation and metric emission
  • AggregationType: AggregationType
  • CreationDate: int (ReadOnly): The creation date of a fleet metric
  • Description: string: The description of a fleet metric
  • IndexName: string: The index name of a fleet metric
  • LastModifiedDate: int (ReadOnly): The last modified date of a fleet metric
  • MetricArn: string (ReadOnly): The Amazon Resource Number (ARN) of a fleet metric metric
  • MetricName: string (Required, Identifier): The name of the fleet metric
  • Period: int: The period of metric emission in seconds
  • QueryString: string: The Fleet Indexing query used by a fleet metric
  • QueryVersion: string: The version of a Fleet Indexing query used by a fleet metric
  • Tags: Tag[]: An array of key-value pairs to apply to this resource
  • Unit: string: The unit of data points emitted by a fleet metric
  • Version: int (ReadOnly): The version of a fleet metric

AggregationType

Properties

  • Name: string (Required): Fleet Indexing aggregation type names such as Statistics, Percentiles and Cardinality
  • Values: string[] (Required): Fleet Indexing aggregation type values

Tag

Properties

  • Key: string (Required): The tag's key
  • Value: string (Required): The tag's value

AWS.IoT/LoggingProperties

Properties

  • AccountId: string (Required, Identifier): Your 12-digit account ID (used as the primary identifier for the CloudFormation resource).
  • DefaultLogLevel: string (Required): The log level to use. Valid values are: ERROR, WARN, INFO, DEBUG, or DISABLED.
  • RoleArn: string (Required): The ARN of the role that allows IoT to write to Cloudwatch logs.

AWS.IoT/MitigationActionProperties

Properties

  • ActionName: string (Identifier): A unique identifier for the mitigation action.
  • ActionParams: ActionParams (Required)
  • MitigationActionArn: string (ReadOnly)
  • MitigationActionId: string (ReadOnly)
  • RoleArn: string (Required)
  • Tags: Tag[]: An array of key-value pairs to apply to this resource.

ActionParams

Properties

AddThingsToThingGroupParams

Properties

  • OverrideDynamicGroups: bool: Specifies if this mitigation action can move the things that triggered the mitigation action out of one or more dynamic thing groups.
  • ThingGroupNames: string[] (Required): The list of groups to which you want to add the things that triggered the mitigation action.

EnableIoTLoggingParams

Properties

  • LogLevel: string (Required): Specifies which types of information are logged.
  • RoleArnForLogging: string (Required): The ARN of the IAM role used for logging.

PublishFindingToSnsParams

Properties

  • TopicArn: string (Required): The ARN of the topic to which you want to publish the findings.

ReplaceDefaultPolicyVersionParams

Properties

  • TemplateName: string (Required)

UpdateCACertificateParams

Properties

  • Action: string (Required)

UpdateDeviceCertificateParams

Properties

  • Action: string (Required)

Tag

Properties

  • Key: string (Required): The tag's key.
  • Value: string (Required): The tag's value.

AWS.IoT/PolicyProperties

Properties

  • Arn: string (ReadOnly)
  • Id: string (ReadOnly, Identifier)
  • PolicyDocument: Policy_PolicyDocument | string (Required)
  • PolicyName: string
  • Tags: Tag[]

Tag

Properties

  • Key: string (Required)
  • Value: string (Required)

AWS.IoT/ProvisioningTemplateProperties

Properties

  • Description: string
  • Enabled: bool
  • PreProvisioningHook: ProvisioningHook
  • ProvisioningRoleArn: string (Required)
  • Tags: Tag[]
  • TemplateArn: string (ReadOnly)
  • TemplateBody: string (Required)
  • TemplateName: string (Identifier)
  • TemplateType: string

ProvisioningHook

Properties

  • PayloadVersion: string
  • TargetArn: string

Tag

Properties

  • Key: string (Required)
  • Value: string (Required)

AWS.IoT/ResourceSpecificLoggingProperties

Properties

  • LogLevel: string (Required): The log level for a specific target. Valid values are: ERROR, WARN, INFO, DEBUG, or DISABLED.
  • TargetId: string (ReadOnly, Identifier): Unique Id for a Target (TargetType:TargetName), this will be internally built to serve as primary identifier for a log target.
  • TargetName: string (Required): The target name.
  • TargetType: string (Required): The target type. Value must be THING_GROUP, CLIENT_ID, SOURCE_IP, PRINCIPAL_ID, or EVENT_TYPE.

AWS.IoT/RoleAliasProperties

Properties

  • CredentialDurationSeconds: int
  • RoleAlias: string (Identifier)
  • RoleAliasArn: string (ReadOnly)
  • RoleArn: string (Required)
  • Tags: Tag[]

Tag

Properties

  • Key: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
  • Value: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

AWS.IoT/ScheduledAuditProperties

Properties

  • DayOfMonth: string: The day of the month on which the scheduled audit takes place. Can be 1 through 31 or LAST. This field is required if the frequency parameter is set to MONTHLY.
  • DayOfWeek: string: The day of the week on which the scheduled audit takes place. Can be one of SUN, MON, TUE,WED, THU, FRI, or SAT. This field is required if the frequency parameter is set to WEEKLY or BIWEEKLY.
  • Frequency: string (Required): How often the scheduled audit takes place. Can be one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY.
  • ScheduledAuditArn: string (ReadOnly): The ARN (Amazon resource name) of the scheduled audit.
  • ScheduledAuditName: string (Identifier): The name you want to give to the scheduled audit.
  • Tags: Tag[]: An array of key-value pairs to apply to this resource.
  • TargetCheckNames: string[] (Required): Which checks are performed during the scheduled audit. Checks must be enabled for your account.

Tag

Properties

  • Key: string (Required): The tag's key.
  • Value: string (Required): The tag's value.

AWS.IoT/SecurityProfileProperties

Properties

  • AdditionalMetricsToRetainV2: MetricToRetain[]: A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.
  • AlertTargets: SecurityProfile_AlertTargets: Specifies the destinations to which alerts are sent.
  • Behaviors: Behavior[]: Specifies the behaviors that, when violated by a device (thing), cause an alert.
  • MetricsExportConfig: SecurityProfile_MetricsExportConfig: A structure containing the mqtt topic for metrics export.
  • SecurityProfileArn: string (ReadOnly): The ARN (Amazon resource name) of the created security profile.
  • SecurityProfileDescription: string: A description of the security profile.
  • SecurityProfileName: string (Identifier): A unique identifier for the security profile.
  • Tags: Tag[]: Metadata that can be used to manage the security profile.
  • TargetArns: string[]: A set of target ARNs that the security profile is attached to.

MetricToRetain

Properties

  • ExportMetric: bool
  • Metric: string (Required): What is measured by the behavior.
  • MetricDimension: MetricDimension

MetricDimension

Properties

  • DimensionName: string (Required): A unique identifier for the dimension.
  • Operator: string: Defines how the dimensionValues of a dimension are interpreted.

SecurityProfile_AlertTargets

Properties

Behavior

Properties

  • Criteria: BehaviorCriteria
  • ExportMetric: bool
  • Metric: string: What is measured by the behavior.
  • MetricDimension: MetricDimension
  • Name: string (Required): The name for the behavior.
  • SuppressAlerts: bool: Manage Detect alarm SNS notifications by setting behavior notification to on or suppressed. Detect will continue to performing device behavior evaluations. However, suppressed alarms wouldn't be forwarded for SNS notification.

BehaviorCriteria

Properties

  • ComparisonOperator: string: The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold).
  • ConsecutiveDatapointsToAlarm: int: If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.
  • ConsecutiveDatapointsToClear: int: If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.
  • DurationSeconds: int: Use this to specify the time duration over which the behavior is evaluated.
  • MlDetectionConfig: MachineLearningDetectionConfig
  • StatisticalThreshold: StatisticalThreshold
  • Value: MetricValue

MachineLearningDetectionConfig

Properties

  • ConfidenceLevel: string: The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High.

StatisticalThreshold

Properties

  • Statistic: string: The percentile which resolves to a threshold value by which compliance with a behavior is determined

MetricValue

Properties

  • Cidrs: string[]: If the ComparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric.
  • Count: string: If the ComparisonOperator calls for a numeric value, use this to specify that (integer) numeric value to be compared with the metric.
  • Number: int: The numeral value of a metric.
  • Numbers: int[]: The numeral values of a metric.
  • Ports: int[]: If the ComparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric.
  • Strings: string[]: The string values of a metric.

SecurityProfile_MetricsExportConfig

Properties

  • MqttTopic: string (Required): The topic for metrics export.
  • RoleArn: string (Required): The ARN of the role that grants permission to publish to mqtt topic.

Tag

Properties

  • Key: string (Required): The tag's key.
  • Value: string (Required): The tag's value.

AWS.IoT/SoftwarePackageProperties

Properties

  • Description: string
  • PackageArn: string (ReadOnly)
  • PackageName: string (Identifier)
  • Tags: Tag[]: An array of key-value pairs to apply to this resource.

Tag

Properties

  • Key: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
  • Value: string (Required): The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

AWS.IoT/SoftwarePackageVersionProperties

Properties

  • Attributes: ResourceAttributes
  • Description: string
  • ErrorReason: string (ReadOnly)
  • PackageName: string (Required, Identifier)
  • PackageVersionArn: string (ReadOnly)
  • Status: string (ReadOnly)
  • Tags: Tag[]: An array of key-value pairs to apply to this resource.
  • VersionName: string (Identifier)

ResourceAttributes

Properties

Tag

Properties

  • Key: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
  • Value: string (Required): The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

AWS.IoT/ThingProperties

Properties

  • Arn: string (ReadOnly)
  • AttributePayload: AttributePayload
  • Id: string (ReadOnly)
  • ThingName: string (Identifier)

AttributePayload

Properties

Thing_Attributes

Properties

AWS.IoT/ThingGroupProperties

Properties

  • Arn: string (ReadOnly)
  • Id: string (ReadOnly)
  • ParentGroupName: string
  • QueryString: string
  • Tags: Tag[]: An array of key-value pairs to apply to this resource.
  • ThingGroupName: string (Identifier)
  • ThingGroupProperties: ThingGroup_ThingGroupProperties

Tag

Properties

  • Key: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
  • Value: string (Required): The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

ThingGroup_ThingGroupProperties

Properties

AttributePayload

Properties

ThingGroup_Attributes

Properties

AWS.IoT/ThingTypeProperties

Properties

  • Arn: string (ReadOnly)
  • DeprecateThingType: bool
  • Id: string (ReadOnly)
  • Tags: Tag[]: An array of key-value pairs to apply to this resource.
  • ThingTypeName: string (Identifier)
  • ThingTypeProperties: ThingType_ThingTypeProperties

Tag

Properties

  • Key: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
  • Value: string (Required): The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

ThingType_ThingTypeProperties

Properties

  • SearchableAttributes: string[]
  • ThingTypeDescription: string

AWS.IoT/TopicRuleProperties

Properties

  • Arn: string (ReadOnly)
  • RuleName: string (Identifier)
  • Tags: Tag[]
  • TopicRulePayload: TopicRulePayload (Required)

Tag

Properties

  • Key: string (Required)
  • Value: string (Required)

TopicRulePayload

Properties

  • Actions: Action[] (Required)
  • AwsIotSqlVersion: string
  • Description: string
  • ErrorAction: Action
  • RuleDisabled: bool
  • Sql: string (Required)

Action

Properties

CloudwatchAlarmAction

Properties

  • AlarmName: string (Required)
  • RoleArn: string (Required)
  • StateReason: string (Required)
  • StateValue: string (Required)

CloudwatchLogsAction

Properties

  • BatchMode: bool
  • LogGroupName: string (Required)
  • RoleArn: string (Required)

CloudwatchMetricAction

Properties

  • MetricName: string (Required)
  • MetricNamespace: string (Required)
  • MetricTimestamp: string
  • MetricUnit: string (Required)
  • MetricValue: string (Required)
  • RoleArn: string (Required)

DynamoDBAction

Properties

  • HashKeyField: string (Required)
  • HashKeyType: string
  • HashKeyValue: string (Required)
  • PayloadField: string
  • RangeKeyField: string
  • RangeKeyType: string
  • RangeKeyValue: string
  • RoleArn: string (Required)
  • TableName: string (Required)

DynamoDBv2Action

Properties

PutItemInput

Properties

  • TableName: string (Required)

ElasticsearchAction

Properties

  • Endpoint: string (Required)
  • Id: string (Required)
  • Index: string (Required)
  • RoleArn: string (Required)
  • Type: string (Required)

FirehoseAction

Properties

  • BatchMode: bool
  • DeliveryStreamName: string (Required)
  • RoleArn: string (Required)
  • Separator: string

HttpAction

Properties

HttpAuthorization

Properties

SigV4Authorization

Properties

  • RoleArn: string (Required)
  • ServiceName: string (Required)
  • SigningRegion: string (Required)

HttpActionHeader

Properties

  • Key: string (Required)
  • Value: string (Required)

IotAnalyticsAction

Properties

  • BatchMode: bool
  • ChannelName: string (Required)
  • RoleArn: string (Required)

IotEventsAction

Properties

  • BatchMode: bool
  • InputName: string (Required)
  • MessageId: string
  • RoleArn: string (Required)

IotSiteWiseAction

Properties

PutAssetPropertyValueEntry

Properties

  • AssetId: string
  • EntryId: string
  • PropertyAlias: string
  • PropertyId: string
  • PropertyValues: AssetPropertyValue[] (Required)

AssetPropertyValue

Properties

AssetPropertyTimestamp

Properties

  • OffsetInNanos: string
  • TimeInSeconds: string (Required)

AssetPropertyVariant

Properties

  • BooleanValue: string
  • DoubleValue: string
  • IntegerValue: string
  • StringValue: string

KafkaAction

Properties

TopicRule_ClientProperties

Properties

KafkaActionHeader

Properties

  • Key: string (Required)
  • Value: string (Required)

KinesisAction

Properties

  • PartitionKey: string
  • RoleArn: string (Required)
  • StreamName: string (Required)

LambdaAction

Properties

  • FunctionArn: string

LocationAction

Properties

  • DeviceId: string (Required)
  • Latitude: string (Required)
  • Longitude: string (Required)
  • RoleArn: string (Required)
  • Timestamp: Timestamp
  • TrackerName: string (Required)

Timestamp

Properties

  • Unit: string
  • Value: string (Required)

OpenSearchAction

Properties

  • Endpoint: string (Required)
  • Id: string (Required)
  • Index: string (Required)
  • RoleArn: string (Required)
  • Type: string (Required)

RepublishAction

Properties

RepublishActionHeaders

Properties

  • ContentType: string
  • CorrelationData: string
  • MessageExpiry: string
  • PayloadFormatIndicator: string
  • ResponseTopic: string
  • UserProperties: UserProperty[]

UserProperty

Properties

  • Key: string (Required)
  • Value: string (Required)

S3Action

Properties

  • BucketName: string (Required)
  • CannedAcl: string
  • Key: string (Required)
  • RoleArn: string (Required)

SnsAction

Properties

  • MessageFormat: string
  • RoleArn: string (Required)
  • TargetArn: string (Required)

SqsAction

Properties

  • QueueUrl: string (Required)
  • RoleArn: string (Required)
  • UseBase64: bool

StepFunctionsAction

Properties

  • ExecutionNamePrefix: string
  • RoleArn: string (Required)
  • StateMachineName: string (Required)

TimestreamAction

Properties

TimestreamDimension

Properties

  • Name: string (Required)
  • Value: string (Required)

TimestreamTimestamp

Properties

  • Unit: string (Required)
  • Value: string (Required)

AWS.IoT/TopicRuleDestinationProperties

Properties

  • Arn: string (ReadOnly, Identifier): Amazon Resource Name (ARN).
  • HttpUrlProperties: HttpUrlDestinationSummary: HTTP URL destination properties.
  • Status: string: The status of the TopicRuleDestination.
  • StatusReason: string (ReadOnly): The reasoning for the current status of the TopicRuleDestination.
  • VpcProperties: VpcDestinationProperties: VPC destination properties.

HttpUrlDestinationSummary

Properties

  • ConfirmationUrl: string

VpcDestinationProperties

Properties

  • RoleArn: string
  • SecurityGroups: string[]
  • SubnetIds: string[]
  • VpcId: string