PropertyDefinitionRequest - Amazon IoT TwinMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

PropertyDefinitionRequest

An object that sets information about a property.

Contents

configuration

A mapping that specifies configuration information about the property. Use this field to specify information that you read from and write to an external source.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 256.

Key Pattern: [a-zA-Z_\-0-9]+

Value Pattern: .*

Required: No

dataType

An object that contains information about the data type.

Type: DataType object

Required: No

defaultValue

An object that contains the default value.

Type: DataValue object

Required: No

displayName

A friendly name for the property.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: .*[^\u0000-\u001F\u007F]*.*

Required: No

isExternalId

A Boolean value that specifies whether the property ID comes from an external data store.

Type: Boolean

Required: No

isRequiredInEntity

A Boolean value that specifies whether the property is required.

Type: Boolean

Required: No

isStoredExternally

A Boolean value that specifies whether the property is stored externally.

Type: Boolean

Required: No

isTimeSeries

A Boolean value that specifies whether the property consists of time series data.

Type: Boolean

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: