software.amazon.awscdk.services.iottwinmaker

Class CfnComponentType

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.iottwinmaker.CfnComponentType

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-11T19:24:32.781Z")
 @Stability(value=Stable)
public class CfnComponentType
extends CfnResource
implements IInspectable

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

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 Example:
static interface	CfnComponentType.DataTypeProperty Example:
static interface	CfnComponentType.DataValueProperty Example:
static interface	CfnComponentType.FunctionProperty Example:
static interface	CfnComponentType.LambdaFunctionProperty Example:
static interface	CfnComponentType.PropertyDefinitionProperty Example:
static interface	CfnComponentType.RelationshipProperty Example:

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

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(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()
String	getAttrCreationDateTime()
IResolvable	getAttrIsAbstract()
IResolvable	getAttrIsSchemaInitialized()
String	getAttrUpdateDateTime()
protected Map<String,Object>	getCfnProperties()
String	getComponentTypeId() `AWS::IoTTwinMaker::ComponentType.ComponentTypeId`.
String	getDescription() `AWS::IoTTwinMaker::ComponentType.Description`.
List<String>	getExtendsFrom() `AWS::IoTTwinMaker::ComponentType.ExtendsFrom`.
Object	getFunctions() `AWS::IoTTwinMaker::ComponentType.Functions`.
Object	getIsSingleton() `AWS::IoTTwinMaker::ComponentType.IsSingleton`.
Object	getPropertyDefinitions() `AWS::IoTTwinMaker::ComponentType.PropertyDefinitions`.
TagManager	getTags() `AWS::IoTTwinMaker::ComponentType.Tags`.
String	getWorkspaceId() `AWS::IoTTwinMaker::ComponentType.WorkspaceId`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setComponentTypeId(String value) `AWS::IoTTwinMaker::ComponentType.ComponentTypeId`.
void	setDescription(String value) `AWS::IoTTwinMaker::ComponentType.Description`.
void	setExtendsFrom(List<String> value) `AWS::IoTTwinMaker::ComponentType.ExtendsFrom`.
void	setFunctions(IResolvable value) `AWS::IoTTwinMaker::ComponentType.Functions`.
void	setFunctions(Map<String,Object> value) `AWS::IoTTwinMaker::ComponentType.Functions`.
void	setIsSingleton(Boolean value) `AWS::IoTTwinMaker::ComponentType.IsSingleton`.
void	setIsSingleton(IResolvable value) `AWS::IoTTwinMaker::ComponentType.IsSingleton`.
void	setPropertyDefinitions(IResolvable value) `AWS::IoTTwinMaker::ComponentType.PropertyDefinitions`.
void	setPropertyDefinitions(Map<String,Object> value) `AWS::IoTTwinMaker::ComponentType.PropertyDefinitions`.
void	setWorkspaceId(String value) `AWS::IoTTwinMaker::ComponentType.WorkspaceId`.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

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

getAttrCreationDateTime

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

getAttrIsAbstract

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

getAttrIsSchemaInitialized

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

getAttrUpdateDateTime

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

`AWS::IoTTwinMaker::ComponentType.Tags`.

getComponentTypeId

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

`AWS::IoTTwinMaker::ComponentType.ComponentTypeId`.

setComponentTypeId

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

`AWS::IoTTwinMaker::ComponentType.ComponentTypeId`.

getWorkspaceId

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

`AWS::IoTTwinMaker::ComponentType.WorkspaceId`.

setWorkspaceId

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

`AWS::IoTTwinMaker::ComponentType.WorkspaceId`.

getDescription

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

`AWS::IoTTwinMaker::ComponentType.Description`.

setDescription

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

`AWS::IoTTwinMaker::ComponentType.Description`.

getExtendsFrom

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

`AWS::IoTTwinMaker::ComponentType.ExtendsFrom`.

setExtendsFrom

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

`AWS::IoTTwinMaker::ComponentType.ExtendsFrom`.

getFunctions

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

`AWS::IoTTwinMaker::ComponentType.Functions`.

setFunctions

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

`AWS::IoTTwinMaker::ComponentType.Functions`.

setFunctions

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

`AWS::IoTTwinMaker::ComponentType.Functions`.

getIsSingleton

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

`AWS::IoTTwinMaker::ComponentType.IsSingleton`.

setIsSingleton

@Stability(value=Stable)
public void setIsSingleton(@Nullable
                                                    Boolean value)

`AWS::IoTTwinMaker::ComponentType.IsSingleton`.

setIsSingleton

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

`AWS::IoTTwinMaker::ComponentType.IsSingleton`.

getPropertyDefinitions

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

`AWS::IoTTwinMaker::ComponentType.PropertyDefinitions`.

setPropertyDefinitions

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

`AWS::IoTTwinMaker::ComponentType.PropertyDefinitions`.

setPropertyDefinitions

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

`AWS::IoTTwinMaker::ComponentType.PropertyDefinitions`.