Package software.amazon.awscdk.services.iottwinmaker

Interface CfnEntity.CompositeComponentProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEntity.CompositeComponentProperty.Jsii$Proxy

Enclosing class:

CfnEntity

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

Information about a composite 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;
 CompositeComponentProperty compositeComponentProperty = CompositeComponentProperty.builder()
         .componentName("componentName")
         .componentPath("componentPath")
         .componentTypeId("componentTypeId")
         .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-compositecomponent.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnEntity.CompositeComponentProperty.Builder	builder()
default String	getComponentName()	The name of the component.
default String	getComponentPath()	The path to the composite component, starting from the top-level component.
default String	getComponentTypeId()	The ID of the composite component type.
default String	getDescription()	The description of the component type.
default Object	getProperties()	Map of strings to the properties in the component type.
default Object	getPropertyGroups()	The property groups.
default Object	getStatus()	The current status of the composite 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-compositecomponent.html#cfn-iottwinmaker-entity-compositecomponent-componentname

getComponentPath

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

The path to the composite component, starting from the top-level component.

See Also:

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

getComponentTypeId

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

The ID of the composite component type.

See Also:

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

getDescription

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

The description of the component type.

See Also:

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

getProperties

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

Map of strings to the properties in the component type.

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

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-compositecomponent.html#cfn-iottwinmaker-entity-compositecomponent-properties

getPropertyGroups

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

The property groups.

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-compositecomponent.html#cfn-iottwinmaker-entity-compositecomponent-propertygroups

getStatus

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

The current status of the composite component.

Returns union: either IResolvable or CfnEntity.StatusProperty

See Also:

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

builder

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

Returns:

a CfnEntity.CompositeComponentProperty.Builder of CfnEntity.CompositeComponentProperty