Package software.amazon.awscdk.services.iottwinmaker

Class CfnComponentType

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.iottwinmaker.CfnComponentType
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.936Z") @Stability(Stable) public class CfnComponentType extends CfnResource implements IInspectable
A CloudFormation AWS::IoTTwinMaker::ComponentType.

Use the AWS::IoTTwinMaker::ComponentType resource to declare a 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;
 CfnComponentType cfnComponentType = CfnComponentType.Builder.create(this, "MyCfnComponentType")
         .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnComponentType

      protected CfnComponentType(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnComponentType

      protected CfnComponentType(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnComponentType

      @Stability(Stable) public CfnComponentType(@NotNull Construct scope, @NotNull String id, @NotNull CfnComponentTypeProps props)
      Create a new AWS::IoTTwinMaker::ComponentType.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the component type.

    • getAttrCreationDateTime

      @Stability(Stable) @NotNull public String getAttrCreationDateTime()
      The date and time when the component type was created.

    • getAttrIsAbstract

      @Stability(Stable) @NotNull public IResolvable getAttrIsAbstract()
      A boolean value that specifies whether the component type is abstract.

    • getAttrIsSchemaInitialized

      @Stability(Stable) @NotNull public IResolvable getAttrIsSchemaInitialized()
      A boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.

    • getAttrStatusErrorCode

      @Stability(Stable) @NotNull public String getAttrStatusErrorCode()
      component type error code.

    • getAttrStatusErrorMessage

      @Stability(Stable) @NotNull public String getAttrStatusErrorMessage()
      The component type error message.

    • getAttrStatusState

      @Stability(Stable) @NotNull public String getAttrStatusState()
      The component type state.

    • getAttrUpdateDateTime

      @Stability(Stable) @NotNull public String getAttrUpdateDateTime()
      The component type the update time.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The ComponentType tags.

    • getComponentTypeId

      @Stability(Stable) @NotNull public String getComponentTypeId()
      The ID of the component type.

    • setComponentTypeId

      @Stability(Stable) public void setComponentTypeId(@NotNull String value)
      The ID of the component type.

    • getWorkspaceId

      @Stability(Stable) @NotNull public String getWorkspaceId()
      The ID of the workspace.

    • setWorkspaceId

      @Stability(Stable) public void setWorkspaceId(@NotNull String value)
      The ID of the workspace.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the component type.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the component type.

    • getExtendsFrom

      @Stability(Stable) @Nullable public List<String> getExtendsFrom()
      The name of the parent component type that this component type extends.

    • setExtendsFrom

      @Stability(Stable) public void setExtendsFrom(@Nullable List<String> value)
      The name of the parent component type that this component type extends.

    • getFunctions

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

    • setFunctions

      @Stability(Stable) public void setFunctions(@Nullable IResolvable value)
      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.

    • setFunctions

      @Stability(Stable) public void setFunctions(@Nullable Map<String,Object> value)
      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

      @Stability(Stable) @Nullable public Object getIsSingleton()
      A boolean value that specifies whether an entity can have more than one component of this type.

    • setIsSingleton

      @Stability(Stable) public void setIsSingleton(@Nullable Boolean value)
      A boolean value that specifies whether an entity can have more than one component of this type.

    • setIsSingleton

      @Stability(Stable) public void setIsSingleton(@Nullable IResolvable value)
      A boolean value that specifies whether an entity can have more than one component of this type.

    • getPropertyDefinitions

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

    • setPropertyDefinitions

      @Stability(Stable) public void setPropertyDefinitions(@Nullable IResolvable value)
      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.

    • setPropertyDefinitions

      @Stability(Stable) public void setPropertyDefinitions(@Nullable Map<String,Object> value)
      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

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

    • setPropertyGroups

      @Stability(Stable) public void setPropertyGroups(@Nullable IResolvable value)
      An object that maps strings to the property groups in the component type.

      Each string in the mapping must be unique to this object.

    • setPropertyGroups

      @Stability(Stable) public void setPropertyGroups(@Nullable Map<String,Object> value)
      An object that maps strings to the property groups in the component type.

      Each string in the mapping must be unique to this object.