Class CfnEntity.Builder
java.lang.Object
software.amazon.awscdk.services.iottwinmaker.CfnEntity.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnEntity>
- Enclosing class:
CfnEntity
@Stability(Stable)
public static final class CfnEntity.Builder
extends Object
implements software.amazon.jsii.Builder<CfnEntity>
A fluent builder for
CfnEntity
.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
components
(Map<String, ? extends Object> components) An object that maps strings to the components in the entity.components
(IResolvable components) An object that maps strings to the components in the entity.compositeComponents
(Map<String, ? extends Object> compositeComponents) Maps string tocompositeComponent
updates in the request.compositeComponents
(IResolvable compositeComponents) Maps string tocompositeComponent
updates in the request.static CfnEntity.Builder
description
(String description) The description of the entity.The ID of the entity.entityName
(String entityName) The entity name.parentEntityId
(String parentEntityId) The ID of the parent entity.Metadata that you can use to manage the entity.workspaceId
(String workspaceId) The ID of the workspace that contains the entity.
-
Method Details
-
create
@Stability(Stable) public static CfnEntity.Builder create(software.constructs.Construct scope, String id) - 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.- Returns:
- a new instance of
CfnEntity.Builder
.
-
entityName
The entity name.- Parameters:
entityName
- The entity name. This parameter is required.- Returns:
this
- See Also:
-
workspaceId
The ID of the workspace that contains the entity.- Parameters:
workspaceId
- The ID of the workspace that contains the entity. This parameter is required.- Returns:
this
- See Also:
-
components
An object that maps strings to the components in the entity.Each string in the mapping must be unique to this object.
For information on the component object see the component API reference.
- Parameters:
components
- An object that maps strings to the components in the entity. This parameter is required.- Returns:
this
- See Also:
-
components
An object that maps strings to the components in the entity.Each string in the mapping must be unique to this object.
For information on the component object see the component API reference.
- Parameters:
components
- An object that maps strings to the components in the entity. This parameter is required.- Returns:
this
- See Also:
-
compositeComponents
Maps string tocompositeComponent
updates in the request.Each key of the map represents the
componentPath
of thecompositeComponent
.- Parameters:
compositeComponents
- Maps string tocompositeComponent
updates in the request. This parameter is required.- Returns:
this
- See Also:
-
compositeComponents
@Stability(Stable) public CfnEntity.Builder compositeComponents(Map<String, ? extends Object> compositeComponents) Maps string tocompositeComponent
updates in the request.Each key of the map represents the
componentPath
of thecompositeComponent
.- Parameters:
compositeComponents
- Maps string tocompositeComponent
updates in the request. This parameter is required.- Returns:
this
- See Also:
-
description
The description of the entity.- Parameters:
description
- The description of the entity. This parameter is required.- Returns:
this
- See Also:
-
entityId
The ID of the entity.- Parameters:
entityId
- The ID of the entity. This parameter is required.- Returns:
this
- See Also:
-
parentEntityId
The ID of the parent entity.- Parameters:
parentEntityId
- The ID of the parent entity. This parameter is required.- Returns:
this
- See Also:
-
tags
Metadata that you can use to manage the entity.- Parameters:
tags
- Metadata that you can use to manage the entity. This parameter is required.- Returns:
this
- See Also:
-
build
-