class Aws::IoTTwinMaker::Types::PropertyDefinitionRequest
An object that sets information about a property.
@note When making an API call, you may pass PropertyDefinitionRequest
data as a hash: { configuration: { "Name" => "Value", }, data_type: { allowed_values: [ { boolean_value: false, double_value: 1.0, expression: "Expression", integer_value: 1, list_value: { # recursive DataValueList }, long_value: 1, map_value: { "String" => { # recursive DataValue }, }, relationship_value: { target_component_name: "Name", target_entity_id: "EntityId", }, string_value: "String", }, ], nested_type: { # recursive DataType }, relationship: { relationship_type: "String", target_component_type_id: "ComponentTypeId", }, type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP unit_of_measure: "String", }, default_value: { boolean_value: false, double_value: 1.0, expression: "Expression", integer_value: 1, list_value: [ { # recursive DataValue }, ], long_value: 1, map_value: { "String" => { # recursive DataValue }, }, relationship_value: { target_component_name: "Name", target_entity_id: "EntityId", }, string_value: "String", }, is_external_id: false, is_required_in_entity: false, is_stored_externally: false, is_time_series: false, }
@!attribute [rw] 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. @return [Hash<String,String>]
@!attribute [rw] data_type
An object that contains information about the data type. @return [Types::DataType]
@!attribute [rw] default_value
An object that contains the default value. @return [Types::DataValue]
@!attribute [rw] is_external_id
A Boolean value that specifies whether the property ID comes from an external data store. @return [Boolean]
@!attribute [rw] is_required_in_entity
A Boolean value that specifies whether the property is required. @return [Boolean]
@!attribute [rw] is_stored_externally
A Boolean value that specifies whether the property is stored externally. @return [Boolean]
@!attribute [rw] is_time_series
A Boolean value that specifies whether the property consists of time series data. @return [Boolean]
Constants
- SENSITIVE