Interface CfnComponentTypeProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnComponentTypeProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:29:57.944Z")
@Stability(Stable)
public interface CfnComponentTypeProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnComponentType
.
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; CfnComponentTypeProps cfnComponentTypeProps = CfnComponentTypeProps.builder() .componentTypeId("componentTypeId") .workspaceId("workspaceId") // the properties below are optional .description("description") .extendsFrom(List.of("extendsFrom")) .functions(Map.of( "functionsKey", FunctionProperty.builder() .implementedBy(DataConnectorProperty.builder() .isNative(false) .lambda(LambdaFunctionProperty.builder() .arn("arn") .build()) .build()) .requiredProperties(List.of("requiredProperties")) .scope("scope") .build())) .isSingleton(false) .propertyDefinitions(Map.of( "propertyDefinitionsKey", 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())) .propertyGroups(Map.of( "propertyGroupsKey", PropertyGroupProperty.builder() .groupType("groupType") .propertyNames(List.of("propertyNames")) .build())) .tags(Map.of( "tagsKey", "tags")) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnComponentTypeProps
static final class
An implementation forCfnComponentTypeProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
The ID of the component type.default String
The description of the component type.The name of the parent component type that this component type extends.default Object
An object that maps strings to the functions in the component type.default Object
A boolean value that specifies whether an entity can have more than one component of this type.default Object
An object that maps strings to the property definitions in the component type.default Object
An object that maps strings to the property groups in the component type.getTags()
The ComponentType tags.The ID of the workspace.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getComponentTypeId
The ID of the component type. -
getWorkspaceId
The ID of the workspace. -
getDescription
The description of the component type. -
getExtendsFrom
The name of the parent component type that this component type extends. -
getFunctions
An object that maps strings to the functions in the component type.Each string in the mapping must be unique to this object.
For information on the FunctionResponse object see the FunctionResponse API reference.
-
getIsSingleton
A boolean value that specifies whether an entity can have more than one component of this type. -
getPropertyDefinitions
An object that maps strings to the property definitions in the component type.Each string in the mapping must be unique to this object.
For information about the PropertyDefinitionResponse object, see the PropertyDefinitionResponse API reference.
-
getPropertyGroups
An object that maps strings to the property groups in the component type.Each string in the mapping must be unique to this object.
-
getTags
The ComponentType tags. -
builder
- Returns:
- a
CfnComponentTypeProps.Builder
ofCfnComponentTypeProps
-