Package software.amazon.awscdk.services.iottwinmaker

Interface CfnEntity.ComponentProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEntity.ComponentProperty.Jsii$Proxy

Enclosing class:

CfnEntity

@Stability(Stable)
public static interface CfnEntity.ComponentProperty
extends software.amazon.jsii.JsiiSerializable

The entity component.

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.*;
 DataValueProperty dataValueProperty_;
 Object definition;
 Object error;
 Object relationshipValue;
 ComponentProperty componentProperty = ComponentProperty.builder()
         .componentName("componentName")
         .componentTypeId("componentTypeId")
         .definedIn("definedIn")
         .description("description")
         .properties(Map.of(
                 "propertiesKey", PropertyProperty.builder()
                         .definition(definition)
                         .value(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())
                         .build()))
         .propertyGroups(Map.of(
                 "propertyGroupsKey", PropertyGroupProperty.builder()
                         .groupType("groupType")
                         .propertyNames(List.of("propertyNames"))
                         .build()))
         .status(StatusProperty.builder()
                 .error(error)
                 .state("state")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnEntity.ComponentProperty.Builder	builder()
default String	getComponentName()	The name of the component.
default String	getComponentTypeId()	The ID of the component type.
default String	getDefinedIn()	The name of the property definition set in the request.
default String	getDescription()	The description of the component.
default Object	getProperties()	An object that maps strings to the properties to set in the component type.
default Object	getPropertyGroups()	An object that maps strings to the property groups in the component type.
default Object	getStatus()	The status of the component.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComponentName

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

The name of the component.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-component.html#cfn-iottwinmaker-entity-component-componentname

getComponentTypeId

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

The ID of the component type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-component.html#cfn-iottwinmaker-entity-component-componenttypeid

getDefinedIn

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

The name of the property definition set in the request.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-component.html#cfn-iottwinmaker-entity-component-definedin

getDescription

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

The description of the component.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-component.html#cfn-iottwinmaker-entity-component-description

getProperties

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

An object that maps strings to the properties to set in the component type.

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

Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnEntity.PropertyProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-component.html#cfn-iottwinmaker-entity-component-properties

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.

Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnEntity.PropertyGroupProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-component.html#cfn-iottwinmaker-entity-component-propertygroups

getStatus

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

The status of the component.

Returns union: either IResolvable or CfnEntity.StatusProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-component.html#cfn-iottwinmaker-entity-component-status

builder

@Stability(Stable)
static CfnEntity.ComponentProperty.Builder builder()

Returns:

a CfnEntity.ComponentProperty.Builder of CfnEntity.ComponentProperty