Package software.amazon.awscdk.services.iottwinmaker

Class CfnComponentType

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.iottwinmaker.CfnComponentType

All Implemented Interfaces:

IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:09.780Z")
@Stability(Stable)
public class CfnComponentType
extends CfnResource
implements IInspectable, ITaggable

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
         .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	Class	Description
static final class	CfnComponentType.Builder	A fluent builder for CfnComponentType.
static interface	CfnComponentType.CompositeComponentTypeProperty	Specifies the ID of the composite component type.
static interface	CfnComponentType.DataConnectorProperty	The data connector.
static interface	CfnComponentType.DataTypeProperty	An object that specifies the data type of a property.
static interface	CfnComponentType.DataValueProperty	An object that specifies a value for a property.
static interface	CfnComponentType.ErrorProperty	The component type error.
static interface	CfnComponentType.FunctionProperty	The function body.
static interface	CfnComponentType.LambdaFunctionProperty	The Lambda function.
static interface	CfnComponentType.PropertyDefinitionProperty	PropertyDefinition is an object that maps strings to the property definitions in the component type.
static interface	CfnComponentType.PropertyGroupProperty	The property group.
static interface	CfnComponentType.RelationshipProperty	An object that specifies a relationship with another component type.
static interface	CfnComponentType.RelationshipValueProperty	The component type relationship value.
static interface	CfnComponentType.StatusProperty	The component type status.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnComponentType(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnComponentType(software.amazon.jsii.JsiiObjectRef objRef)
	CfnComponentType(software.constructs.Construct scope, String id, CfnComponentTypeProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()	The ARN of the component type.
String	getAttrCreationDateTime()	The date and time when the component type was created.
IResolvable	getAttrIsAbstract()	A boolean value that specifies whether the component type is abstract.
IResolvable	getAttrIsSchemaInitialized()	A boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
IResolvable	getAttrStatus()
IResolvable	getAttrStatusError()
String	getAttrStatusErrorCode()
String	getAttrStatusErrorMessage()
String	getAttrStatusState()
String	getAttrUpdateDateTime()	The component type the update time.
protected Map<String,Object>	getCfnProperties()
String	getComponentTypeId()	The ID of the component type.
Object	getCompositeComponentTypes()	Maps strings to compositeComponentTypes of the componentType .
String	getDescription()	The description of the component type.
List<String>	getExtendsFrom()	The name of the parent component type that this component type extends.
Object	getFunctions()	An object that maps strings to the functions in the component type.
Object	getIsSingleton()	A boolean value that specifies whether an entity can have more than one component of this type.
Object	getPropertyDefinitions()	An object that maps strings to the property definitions in the component type.
Object	getPropertyGroups()	An object that maps strings to the property groups in the component type.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
Map<String,String>	getTagsRaw()	The ComponentType tags.
String	getWorkspaceId()	The ID of the workspace that contains the component type.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setComponentTypeId(String value)	The ID of the component type.
void	setCompositeComponentTypes(Map<String,Object> value)	Maps strings to compositeComponentTypes of the componentType .
void	setCompositeComponentTypes(IResolvable value)	Maps strings to compositeComponentTypes of the componentType .
void	setDescription(String value)	The description of the component type.
void	setExtendsFrom(List<String> value)	The name of the parent component type that this component type extends.
void	setFunctions(Map<String,Object> value)	An object that maps strings to the functions in the component type.
void	setFunctions(IResolvable value)	An object that maps strings to the functions in the component type.
void	setIsSingleton(Boolean value)	A boolean value that specifies whether an entity can have more than one component of this type.
void	setIsSingleton(IResolvable value)	A boolean value that specifies whether an entity can have more than one component of this type.
void	setPropertyDefinitions(Map<String,Object> value)	An object that maps strings to the property definitions in the component type.
void	setPropertyDefinitions(IResolvable value)	An object that maps strings to the property definitions in the component type.
void	setPropertyGroups(Map<String,Object> value)	An object that maps strings to the property groups in the component type.
void	setPropertyGroups(IResolvable value)	An object that maps strings to the property groups in the component type.
void	setTagsRaw(Map<String,String> value)	The ComponentType tags.
void	setWorkspaceId(String value)	The ID of the workspace that contains the component type.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnComponentTypeProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). 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.

getAttrStatus

@Stability(Stable)
@NotNull
public IResolvable getAttrStatus()

getAttrStatusError

@Stability(Stable)
@NotNull
public IResolvable getAttrStatusError()

getAttrStatusErrorCode

@Stability(Stable)
@NotNull
public String getAttrStatusErrorCode()

getAttrStatusErrorMessage

@Stability(Stable)
@NotNull
public String getAttrStatusErrorMessage()

getAttrStatusState

@Stability(Stable)
@NotNull
public String getAttrStatusState()

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()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

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 that contains the component type.

setWorkspaceId

@Stability(Stable)
public void setWorkspaceId(@NotNull
 String value)

The ID of the workspace that contains the component type.

getCompositeComponentTypes

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

Maps strings to compositeComponentTypes of the componentType .

setCompositeComponentTypes

@Stability(Stable)
public void setCompositeComponentTypes(@Nullable
 IResolvable value)

Maps strings to compositeComponentTypes of the componentType .

setCompositeComponentTypes

@Stability(Stable)
public void setCompositeComponentTypes(@Nullable
 Map<String,Object> value)

Maps strings to compositeComponentTypes of the componentType .

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.

setFunctions

@Stability(Stable)
public void setFunctions(@Nullable
 IResolvable value)

An object that maps strings to the functions in the component type.

setFunctions

@Stability(Stable)
public void setFunctions(@Nullable
 Map<String,Object> value)

An object that maps strings to the functions in the component type.

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.

setPropertyDefinitions

@Stability(Stable)
public void setPropertyDefinitions(@Nullable
 IResolvable value)

An object that maps strings to the property definitions in the component type.

setPropertyDefinitions

@Stability(Stable)
public void setPropertyDefinitions(@Nullable
 Map<String,Object> value)

An object that maps strings to the property definitions in the component type.

getPropertyGroups

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

An object that maps strings to the property groups in the component type.

setPropertyGroups

@Stability(Stable)
public void setPropertyGroups(@Nullable
 IResolvable value)

An object that maps strings to the property groups in the component type.

setPropertyGroups

@Stability(Stable)
public void setPropertyGroups(@Nullable
 Map<String,Object> value)

An object that maps strings to the property groups in the component type.

getTagsRaw

@Stability(Stable)
@Nullable
public Map<String,String> getTagsRaw()

The ComponentType tags.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 Map<String,String> value)

The ComponentType tags.