Class CfnStateTemplateProps.Builder
java.lang.Object
software.amazon.awscdk.services.iotfleetwise.CfnStateTemplateProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnStateTemplateProps>
- Enclosing interface:
CfnStateTemplateProps
@Stability(Stable)
public static final class CfnStateTemplateProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnStateTemplateProps>
A builder for
CfnStateTemplateProps-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the configured instance.dataExtraDimensions(List<String> dataExtraDimensions) Sets the value ofCfnStateTemplateProps.getDataExtraDimensions()description(String description) Sets the value ofCfnStateTemplateProps.getDescription()metadataExtraDimensions(List<String> metadataExtraDimensions) Sets the value ofCfnStateTemplateProps.getMetadataExtraDimensions()Sets the value ofCfnStateTemplateProps.getName()signalCatalogArn(String signalCatalogArn) Sets the value ofCfnStateTemplateProps.getSignalCatalogArn()stateTemplateProperties(List<String> stateTemplateProperties) Sets the value ofCfnStateTemplateProps.getStateTemplateProperties()Sets the value ofCfnStateTemplateProps.getTags()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
name
Sets the value ofCfnStateTemplateProps.getName()- Parameters:
name- The unique alias of the state template. This parameter is required.- Returns:
this
-
signalCatalogArn
Sets the value ofCfnStateTemplateProps.getSignalCatalogArn()- Parameters:
signalCatalogArn- The Amazon Resource Name (ARN) of the signal catalog associated with the state template. This parameter is required.- Returns:
this
-
stateTemplateProperties
@Stability(Stable) public CfnStateTemplateProps.Builder stateTemplateProperties(List<String> stateTemplateProperties) Sets the value ofCfnStateTemplateProps.getStateTemplateProperties()- Parameters:
stateTemplateProperties- A list of signals from which data is collected. This parameter is required. The state template properties contain the fully qualified names of the signals.- Returns:
this
-
dataExtraDimensions
@Stability(Stable) public CfnStateTemplateProps.Builder dataExtraDimensions(List<String> dataExtraDimensions) Sets the value ofCfnStateTemplateProps.getDataExtraDimensions()- Parameters:
dataExtraDimensions- A list of vehicle attributes associated with the payload published on the state template's MQTT topic.- Returns:
this
-
description
Sets the value ofCfnStateTemplateProps.getDescription()- Parameters:
description- A brief description of the state template.- Returns:
this
-
metadataExtraDimensions
@Stability(Stable) public CfnStateTemplateProps.Builder metadataExtraDimensions(List<String> metadataExtraDimensions) Sets the value ofCfnStateTemplateProps.getMetadataExtraDimensions()- Parameters:
metadataExtraDimensions- A list of vehicle attributes to associate with the user properties of the messages published on the state template's MQTT topic. For example, if you addVehicle.Attributes.MakeandVehicle.Attributes.Modelattributes, these attributes are included as user properties with the MQTT message.- Returns:
this
-
tags
Sets the value ofCfnStateTemplateProps.getTags()- Parameters:
tags- Metadata that can be used to manage the state template.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnStateTemplateProps>- Returns:
- a new instance of
CfnStateTemplateProps - Throws:
NullPointerException- if any required attribute was not provided
-