Package software.amazon.awscdk.cfnpropertymixins.services.iotfleetwise

Class CfnStateTemplatePropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.iotfleetwise.CfnStateTemplatePropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnStateTemplatePropsMixin>

Enclosing class:

CfnStateTemplatePropsMixin

@Stability(Stable)
public static final class CfnStateTemplatePropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnStateTemplatePropsMixin>

A fluent builder for CfnStateTemplatePropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnStateTemplatePropsMixin	build()
static CfnStateTemplatePropsMixin.Builder	create()
static CfnStateTemplatePropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnStateTemplatePropsMixin.Builder	dataExtraDimensions(List<String> dataExtraDimensions)	A list of vehicle attributes associated with the payload published on the state template's MQTT topic.
CfnStateTemplatePropsMixin.Builder	description(String description)	A brief description of the state template.
CfnStateTemplatePropsMixin.Builder	metadataExtraDimensions(List<String> metadataExtraDimensions)	A list of vehicle attributes to associate with the user properties of the messages published on the state template's MQTT topic.
CfnStateTemplatePropsMixin.Builder	name(String name)	The unique alias of the state template.
CfnStateTemplatePropsMixin.Builder	signalCatalogArn(String signalCatalogArn)	The Amazon Resource Name (ARN) of the signal catalog associated with the state template.
CfnStateTemplatePropsMixin.Builder	stateTemplateProperties(List<String> stateTemplateProperties)	A list of signals from which data is collected.
CfnStateTemplatePropsMixin.Builder	tags(List<? extends CfnTag> tags)	Metadata that can be used to manage the state template.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnStateTemplatePropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnStateTemplatePropsMixin.Builder.

create

@Stability(Stable)
public static CfnStateTemplatePropsMixin.Builder create()

Returns:

a new instance of CfnStateTemplatePropsMixin.Builder.

dataExtraDimensions

@Stability(Stable)
public CfnStateTemplatePropsMixin.Builder dataExtraDimensions(List<String> dataExtraDimensions)

A list of vehicle attributes associated with the payload published on the state template's MQTT topic.

Parameters:

dataExtraDimensions - A list of vehicle attributes associated with the payload published on the state template's MQTT topic. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-dataextradimensions

description

@Stability(Stable)
public CfnStateTemplatePropsMixin.Builder description(String description)

A brief description of the state template.

Parameters:

description - A brief description of the state template. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-description

metadataExtraDimensions

@Stability(Stable)
public CfnStateTemplatePropsMixin.Builder metadataExtraDimensions(List<String> 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 add Vehicle.Attributes.Make and Vehicle.Attributes.Model attributes, these attributes are included as user properties with the MQTT message.

Parameters:

metadataExtraDimensions - A list of vehicle attributes to associate with the user properties of the messages published on the state template's MQTT topic. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-metadataextradimensions

name

@Stability(Stable)
public CfnStateTemplatePropsMixin.Builder name(String name)

The unique alias of the state template.

Parameters:

name - The unique alias of the state template. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-name

signalCatalogArn

@Stability(Stable)
public CfnStateTemplatePropsMixin.Builder signalCatalogArn(String signalCatalogArn)

The Amazon Resource Name (ARN) of the signal catalog associated with the state template.

Parameters:

signalCatalogArn - The Amazon Resource Name (ARN) of the signal catalog associated with the state template. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-signalcatalogarn

stateTemplateProperties

@Stability(Stable)
public CfnStateTemplatePropsMixin.Builder stateTemplateProperties(List<String> stateTemplateProperties)

A list of signals from which data is collected.

The state template properties contain the fully qualified names of the signals.

Parameters:

stateTemplateProperties - A list of signals from which data is collected. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-statetemplateproperties

tags

@Stability(Stable)
public CfnStateTemplatePropsMixin.Builder tags(List<? extends CfnTag> tags)

Metadata that can be used to manage the state template.

Parameters:

tags - Metadata that can be used to manage the state template. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-tags

build

@Stability(Stable)
public CfnStateTemplatePropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnStateTemplatePropsMixin>

Returns:

a newly built instance of CfnStateTemplatePropsMixin.