Package software.amazon.awscdk.services.iottwinmaker

Interface CfnComponentType.PropertyDefinitionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnComponentType.PropertyDefinitionProperty.Jsii$Proxy

Enclosing class:

CfnComponentType

@Stability(Stable)
public static interface CfnComponentType.PropertyDefinitionProperty
extends software.amazon.jsii.JsiiSerializable

PropertyDefinition is an object that maps strings to the property definitions in the component type.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iottwinmaker.*;
 DataTypeProperty dataTypeProperty_;
 DataValueProperty dataValueProperty_;
 Object relationshipValue;
 PropertyDefinitionProperty propertyDefinitionProperty = PropertyDefinitionProperty.builder()
         .configurations(Map.of(
                 "configurationsKey", "configurations"))
         .dataType(DataTypeProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .allowedValues(List.of(DataValueProperty.builder()
                         .booleanValue(false)
                         .doubleValue(123)
                         .expression("expression")
                         .integerValue(123)
                         .listValue(List.of(dataValueProperty_))
                         .longValue(123)
                         .mapValue(Map.of(
                                 "mapValueKey", dataValueProperty_))
                         .relationshipValue(relationshipValue)
                         .stringValue("stringValue")
                         .build()))
                 .nestedType(dataTypeProperty_)
                 .relationship(RelationshipProperty.builder()
                         .relationshipType("relationshipType")
                         .targetComponentTypeId("targetComponentTypeId")
                         .build())
                 .unitOfMeasure("unitOfMeasure")
                 .build())
         .defaultValue(DataValueProperty.builder()
                 .booleanValue(false)
                 .doubleValue(123)
                 .expression("expression")
                 .integerValue(123)
                 .listValue(List.of(dataValueProperty_))
                 .longValue(123)
                 .mapValue(Map.of(
                         "mapValueKey", dataValueProperty_))
                 .relationshipValue(relationshipValue)
                 .stringValue("stringValue")
                 .build())
         .isExternalId(false)
         .isRequiredInEntity(false)
         .isStoredExternally(false)
         .isTimeSeries(false)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnComponentType.PropertyDefinitionProperty.Builder	A builder for CfnComponentType.PropertyDefinitionProperty
static final class	CfnComponentType.PropertyDefinitionProperty.Jsii$Proxy	An implementation for CfnComponentType.PropertyDefinitionProperty

Method Summary

Modifier and Type	Method	Description
static CfnComponentType.PropertyDefinitionProperty.Builder	builder()
default Object	getConfigurations()	A mapping that specifies configuration information about the property.
default Object	getDataType()	An object that specifies the data type of a property.
default Object	getDefaultValue()	A boolean value that specifies whether the property ID comes from an external data store.
default Object	getIsExternalId()	A Boolean value that specifies whether the property ID comes from an external data source.
default Object	getIsRequiredInEntity()	A boolean value that specifies whether the property is required in an entity.
default Object	getIsStoredExternally()	A boolean value that specifies whether the property is stored externally.
default Object	getIsTimeSeries()	A boolean value that specifies whether the property consists of time series data.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConfigurations

@Stability(Stable)
@Nullable
default Object getConfigurations()

A mapping that specifies configuration information about the property.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html#cfn-iottwinmaker-componenttype-propertydefinition-configurations

getDataType

@Stability(Stable)
@Nullable
default Object getDataType()

An object that specifies the data type of a property.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html#cfn-iottwinmaker-componenttype-propertydefinition-datatype

getDefaultValue

@Stability(Stable)
@Nullable
default Object getDefaultValue()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html#cfn-iottwinmaker-componenttype-propertydefinition-defaultvalue

getIsExternalId

@Stability(Stable)
@Nullable
default Object getIsExternalId()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html#cfn-iottwinmaker-componenttype-propertydefinition-isexternalid

getIsRequiredInEntity

@Stability(Stable)
@Nullable
default Object getIsRequiredInEntity()

A boolean value that specifies whether the property is required in an entity.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html#cfn-iottwinmaker-componenttype-propertydefinition-isrequiredinentity

getIsStoredExternally

@Stability(Stable)
@Nullable
default Object getIsStoredExternally()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html#cfn-iottwinmaker-componenttype-propertydefinition-isstoredexternally

getIsTimeSeries

@Stability(Stable)
@Nullable
default Object getIsTimeSeries()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html#cfn-iottwinmaker-componenttype-propertydefinition-istimeseries

builder

@Stability(Stable)
static CfnComponentType.PropertyDefinitionProperty.Builder builder()

Returns:

a CfnComponentType.PropertyDefinitionProperty.Builder of CfnComponentType.PropertyDefinitionProperty