Skip to content
v2.277.0

ComponentProperty Struct ​

The entity component.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iottwinmaker as iottwinmaker } from 'aws-cdk-lib';

declare const dataValueProperty_: iottwinmaker.CfnEntity.DataValueProperty;
declare const definition: any;
declare const error: any;
declare const relationshipValue: any;
const componentProperty: iottwinmaker.CfnEntity.ComponentProperty = {
  componentName: 'componentName',
  componentTypeId: 'componentTypeId',
  definedIn: 'definedIn',
  description: 'description',
  properties: {
    propertiesKey: {
      definition: definition,
      value: {
        booleanValue: false,
        doubleValue: 123,
        expression: 'expression',
        integerValue: 123,
        listValue: [dataValueProperty_],
        longValue: 123,
        mapValue: {
          mapValueKey: dataValueProperty_,
        },
        relationshipValue: relationshipValue,
        stringValue: 'stringValue',
      },
    },
  },
  propertyGroups: {
    propertyGroupsKey: {
      groupType: 'groupType',
      propertyNames: ['propertyNames'],
    },
  },
  status: {
    error: error,
    state: 'state',
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iottwinmaker as iottwinmaker

# data_value_property_: iottwinmaker.CfnEntity.DataValueProperty
# definition: Any
# error: Any
# relationship_value: Any

component_property = iottwinmaker.CfnEntity.ComponentProperty(
    component_name="componentName",
    component_type_id="componentTypeId",
    defined_in="definedIn",
    description="description",
    properties={
        "properties_key": iottwinmaker.CfnEntity.PropertyProperty(
            definition=definition,
            value=iottwinmaker.CfnEntity.DataValueProperty(
                boolean_value=False,
                double_value=123,
                expression="expression",
                integer_value=123,
                list_value=[data_value_property_],
                long_value=123,
                map_value={
                    "map_value_key": data_value_property_
                },
                relationship_value=relationship_value,
                string_value="stringValue"
            )
        )
    },
    property_groups={
        "property_groups_key": iottwinmaker.CfnEntity.PropertyGroupProperty(
            group_type="groupType",
            property_names=["propertyNames"]
        )
    },
    status=iottwinmaker.CfnEntity.StatusProperty(
        error=error,
        state="state"
    )
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoTTwinMaker;

DataValueProperty dataValueProperty_;
var definition;
var error;
var relationshipValue;

var componentProperty = new ComponentProperty {
    ComponentName = "componentName",
    ComponentTypeId = "componentTypeId",
    DefinedIn = "definedIn",
    Description = "description",
    Properties = new Dictionary<string, object> {
        { "propertiesKey", new PropertyProperty {
            Definition = definition,
            Value = new DataValueProperty {
                BooleanValue = false,
                DoubleValue = 123,
                Expression = "expression",
                IntegerValue = 123,
                ListValue = new [] { dataValueProperty_ },
                LongValue = 123,
                MapValue = new Dictionary<string, object> {
                    { "mapValueKey", dataValueProperty_ }
                },
                RelationshipValue = relationshipValue,
                StringValue = "stringValue"
            }
        } }
    },
    PropertyGroups = new Dictionary<string, object> {
        { "propertyGroupsKey", new PropertyGroupProperty {
            GroupType = "groupType",
            PropertyNames = new [] { "propertyNames" }
        } }
    },
    Status = new StatusProperty {
        Error = error,
        State = "state"
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var dataValueProperty_ DataValueProperty
var definition interface{}
var error interface{}
var relationshipValue interface{}

componentProperty := &ComponentProperty{
	ComponentName: jsii.String("componentName"),
	ComponentTypeId: jsii.String("componentTypeId"),
	DefinedIn: jsii.String("definedIn"),
	Description: jsii.String("description"),
	Properties: map[string]interface{}{
		"propertiesKey": &PropertyProperty{
			"definition": definition,
			"value": &DataValueProperty{
				"booleanValue": jsii.Boolean(false),
				"doubleValue": jsii.Number(123),
				"expression": jsii.String("expression"),
				"integerValue": jsii.Number(123),
				"listValue": []interface{}{
					dataValueProperty_,
				},
				"longValue": jsii.Number(123),
				"mapValue": map[string]interface{}{
					"mapValueKey": dataValueProperty_,
				},
				"relationshipValue": relationshipValue,
				"stringValue": jsii.String("stringValue"),
			},
		},
	},
	PropertyGroups: map[string]interface{}{
		"propertyGroupsKey": &PropertyGroupProperty{
			"groupType": jsii.String("groupType"),
			"propertyNames": []*string{
				jsii.String("propertyNames"),
			},
		},
	},
	Status: &StatusProperty{
		Error: error,
		State: jsii.String("state"),
	},
}

Properties ​

componentNameoptionalstringcomponent_nameoptionalstrcomponentNameoptionalStringComponentNameoptionalstringComponentNameoptional*string#
The name of the component.
componentTypeIdoptionalstringcomponent_type_idoptionalstrcomponentTypeIdoptionalStringComponentTypeIdoptionalstringComponentTypeIdoptional*string#
The ID of the component type.
definedInoptionalstringdefined_inoptionalstrdefinedInoptionalStringDefinedInoptionalstringDefinedInoptional*string#
The name of the property definition set in the request.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description of the component.
propertiesoptionalIResolvable | { [key: string]: IResolvable | CfnEntity.PropertyProperty }propertiesoptionaltyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, PropertyProperty]]]propertiesoptionalIResolvablePropertiesoptionalIResolvablePropertiesoptionalinterface{}#
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.

propertyGroupsoptionalIResolvable | { [key: string]: IResolvable | CfnEntity.PropertyGroupProperty }property_groupsoptionaltyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, PropertyGroupProperty]]]propertyGroupsoptionalIResolvablePropertyGroupsoptionalIResolvablePropertyGroupsoptionalinterface{}#
An object that maps strings to the property groups in the component type.

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

statusoptionalIResolvable | CfnEntity.StatusPropertystatusoptionaltyping.Union[IResolvable, StatusProperty]statusoptionalIResolvableStatusoptionalIResolvableStatusoptionalinterface{}#
The status of the component.