Package software.amazon.awscdk.services.iottwinmaker

Interface CfnComponentTypeProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnComponentTypeProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-05T03:43:44.924Z")
@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
         .compositeComponentTypes(Map.of(
                 "compositeComponentTypesKey", CompositeComponentTypeProperty.builder()
                         .componentTypeId("componentTypeId")
                         .build()))
         .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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnComponentTypeProps.Builder	builder()
String	getComponentTypeId()	The ID of the component type.
default Object	getCompositeComponentTypes()	Maps strings to compositeComponentTypes of the componentType .
default String	getDescription()	The description of the component type.
default List<String>	getExtendsFrom()	The name of the parent component type that this component type extends.
default Object	getFunctions()	An object that maps strings to the functions in the component type.
default Object	getIsSingleton()	A boolean value that specifies whether an entity can have more than one component of this type.
default Object	getPropertyDefinitions()	An object that maps strings to the property definitions in the component type.
default Object	getPropertyGroups()	An object that maps strings to the property groups in the component type.
default Map<String,String>	getTags()	The ComponentType tags.
String	getWorkspaceId()	The ID of the workspace that contains the component type.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComponentTypeId

@Stability(Stable)
@NotNull
String getComponentTypeId()

The ID of the component type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-componenttypeid

getWorkspaceId

@Stability(Stable)
@NotNull
String getWorkspaceId()

The ID of the workspace that contains the component type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-workspaceid

getCompositeComponentTypes

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

Maps strings to compositeComponentTypes of the componentType .

CompositeComponentType is referenced by componentTypeId .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-compositecomponenttypes

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the component type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-description

getExtendsFrom

@Stability(Stable)
@Nullable
default List<String> getExtendsFrom()

The name of the parent component type that this component type extends.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-extendsfrom

getFunctions

@Stability(Stable)
@Nullable
default Object 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-functions

getIsSingleton

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

A boolean value that specifies whether an entity can have more than one component of this type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-issingleton

getPropertyDefinitions

@Stability(Stable)
@Nullable
default Object 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-propertydefinitions

getPropertyGroups

@Stability(Stable)
@Nullable
default Object 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-propertygroups

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

The ComponentType tags.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-tags

builder

@Stability(Stable)
static CfnComponentTypeProps.Builder builder()

Returns:

a CfnComponentTypeProps.Builder of CfnComponentTypeProps