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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.064Z")
 @Stability(value=Stable)
public class CfnComponentType
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoTTwinMaker::ComponentType`.

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
         .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()))
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnComponentType.Builder A fluent builder for CfnComponentType.
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.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.RelationshipProperty An object that specifies a relationship with another component type.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnComponentType(software.constructs.Construct scope, String id, CfnComponentTypeProps props) Create a new `AWS::IoTTwinMaker::ComponentType`.
protected	CfnComponentType(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnComponentType(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and 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.
String	getAttrUpdateDateTime() The component type the update time.
protected Map<String,Object>	getCfnProperties()
String	getComponentTypeId() The ID of the component type.
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.
TagManager	getTags() The ComponentType tags.
String	getWorkspaceId() The ID of the workspace.
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	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(IResolvable value) An object that maps strings to the functions in the component type.
void	setFunctions(Map<String,Object> 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(IResolvable value) An object that maps strings to the property definitions in the component type.
void	setPropertyDefinitions(Map<String,Object> value) An object that maps strings to the property definitions in the component type.
void	setWorkspaceId(String value) The ID of the workspace.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnComponentType

protected CfnComponentType(software.amazon.jsii.JsiiObjectRef objRef)

CfnComponentType

protected CfnComponentType(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnComponentType

@Stability(value=Stable)
public CfnComponentType(@NotNull
                                                 software.constructs.Construct scope,
                                                 @NotNull
                                                 String id,
                                                 @NotNull
                                                 CfnComponentTypeProps props)

Create a new `AWS::IoTTwinMaker::ComponentType`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrArn()

The ARN of the component type.

getAttrCreationDateTime

@Stability(value=Stable)
 @NotNull
public String getAttrCreationDateTime()

The date and time when the component type was created.

getAttrIsAbstract

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrIsAbstract()

A boolean value that specifies whether the component type is abstract.

getAttrIsSchemaInitialized

@Stability(value=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.

getAttrUpdateDateTime

@Stability(value=Stable)
 @NotNull
public String getAttrUpdateDateTime()

The component type the update time.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The ComponentType tags.

getComponentTypeId

@Stability(value=Stable)
 @NotNull
public String getComponentTypeId()

The ID of the component type.

setComponentTypeId

@Stability(value=Stable)
public void setComponentTypeId(@NotNull
                                                        String value)

The ID of the component type.

getWorkspaceId

@Stability(value=Stable)
 @NotNull
public String getWorkspaceId()

The ID of the workspace.

setWorkspaceId

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

The ID of the workspace.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

The description of the component type.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The description of the component type.

getExtendsFrom

@Stability(value=Stable)
 @Nullable
public List<String> getExtendsFrom()

The name of the parent component type that this component type extends.

setExtendsFrom

@Stability(value=Stable)
public void setExtendsFrom(@Nullable
                                                    List<String> value)

The name of the parent component type that this component type extends.

getFunctions

@Stability(value=Stable)
 @Nullable
public Object getFunctions()

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

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

For information on the FunctionResponse object see the FunctionResponse API reference.

setFunctions

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

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

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

For information on the FunctionResponse object see the FunctionResponse API reference.

setFunctions

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

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

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

For information on the FunctionResponse object see the FunctionResponse API reference.

getIsSingleton

@Stability(value=Stable)
 @Nullable
public Object getIsSingleton()

A boolean value that specifies whether an entity can have more than one component of this type.

setIsSingleton

@Stability(value=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(value=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(value=Stable)
 @Nullable
public Object getPropertyDefinitions()

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

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

For information about the PropertyDefinitionResponse object, see the PropertyDefinitionResponse API reference.

setPropertyDefinitions

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

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

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

For information about the PropertyDefinitionResponse object, see the PropertyDefinitionResponse API reference.

setPropertyDefinitions

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

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

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

For information about the PropertyDefinitionResponse object, see the PropertyDefinitionResponse API reference.