CfnVehiclePropsMixin

class aws_cdk.mixins_preview.aws_iotfleetwise.mixins.CfnVehiclePropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a vehicle, which is an instance of a vehicle model (model manifest).

Vehicles created from the same vehicle model consist of the same signals inherited from the vehicle model. .. epigraph:

If you have an existing AWS IoT thing, you can use AWS IoT FleetWise to create a vehicle and collect data from your thing.

For more information, see Vehicles in the AWS IoT FleetWise Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html
CloudformationResource:: AWS::IoTFleetWise::Vehicle
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_iotfleetwise import mixins as iotfleetwise_mixins

# on_change: Any

cfn_vehicle_props_mixin = iotfleetwise_mixins.CfnVehiclePropsMixin(iotfleetwise_mixins.CfnVehicleMixinProps(
    association_behavior="associationBehavior",
    attributes={
        "attributes_key": "attributes"
    },
    decoder_manifest_arn="decoderManifestArn",
    model_manifest_arn="modelManifestArn",
    name="name",
    state_templates=[iotfleetwise_mixins.CfnVehiclePropsMixin.StateTemplateAssociationProperty(
        identifier="identifier",
        state_template_update_strategy=iotfleetwise_mixins.CfnVehiclePropsMixin.StateTemplateUpdateStrategyProperty(
            on_change=on_change,
            periodic=iotfleetwise_mixins.CfnVehiclePropsMixin.PeriodicStateTemplateUpdateStrategyProperty(
                state_template_update_rate=iotfleetwise_mixins.CfnVehiclePropsMixin.TimePeriodProperty(
                    unit="unit",
                    value=123
                )
            )
        )
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::IoTFleetWise::Vehicle.

Parameters:

props (Union[CfnVehicleMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['associationBehavior', 'attributes', 'decoderManifestArn', 'modelManifestArn', 'name', 'stateTemplates', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

PeriodicStateTemplateUpdateStrategyProperty

class CfnVehiclePropsMixin.PeriodicStateTemplateUpdateStrategyProperty(*, state_template_update_rate=None)

Bases: object

Vehicles associated with the state template will stream telemetry data during a specified time period.

Parameters:: state_template_update_rate (Union[IResolvable, TimePeriodProperty, Dict[str, Any], None])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-periodicstatetemplateupdatestrategy.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iotfleetwise import mixins as iotfleetwise_mixins

periodic_state_template_update_strategy_property = iotfleetwise_mixins.CfnVehiclePropsMixin.PeriodicStateTemplateUpdateStrategyProperty(
    state_template_update_rate=iotfleetwise_mixins.CfnVehiclePropsMixin.TimePeriodProperty(
        unit="unit",
        value=123
    )
)

Attributes

state_template_update_rate

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-periodicstatetemplateupdatestrategy.html#cfn-iotfleetwise-vehicle-periodicstatetemplateupdatestrategy-statetemplateupdaterate

Type:: see

StateTemplateAssociationProperty

class CfnVehiclePropsMixin.StateTemplateAssociationProperty(*, identifier=None, state_template_update_strategy=None)

Bases: object

The state template associated with a vehicle.

State templates contain state properties, which are signals that belong to a signal catalog that is synchronized between the AWS IoT FleetWise Edge and the AWS Cloud . .. epigraph:

Access to certain AWS IoT FleetWise features is currently gated. For more information, see `AWS Region and feature availability <https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html>`_ in the *AWS IoT FleetWise Developer Guide* .

Parameters:

identifier (Optional[str]) – The unique ID of the state template.
state_template_update_strategy (Union[IResolvable, StateTemplateUpdateStrategyProperty, Dict[str, Any], None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-statetemplateassociation.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iotfleetwise import mixins as iotfleetwise_mixins

# on_change: Any

state_template_association_property = iotfleetwise_mixins.CfnVehiclePropsMixin.StateTemplateAssociationProperty(
    identifier="identifier",
    state_template_update_strategy=iotfleetwise_mixins.CfnVehiclePropsMixin.StateTemplateUpdateStrategyProperty(
        on_change=on_change,
        periodic=iotfleetwise_mixins.CfnVehiclePropsMixin.PeriodicStateTemplateUpdateStrategyProperty(
            state_template_update_rate=iotfleetwise_mixins.CfnVehiclePropsMixin.TimePeriodProperty(
                unit="unit",
                value=123
            )
        )
    )
)

Attributes

identifier

The unique ID of the state template.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-statetemplateassociation.html#cfn-iotfleetwise-vehicle-statetemplateassociation-identifier

state_template_update_strategy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-statetemplateassociation.html#cfn-iotfleetwise-vehicle-statetemplateassociation-statetemplateupdatestrategy

Type:: see

StateTemplateUpdateStrategyProperty

class CfnVehiclePropsMixin.StateTemplateUpdateStrategyProperty(*, on_change=None, periodic=None)

Bases: object

The update strategy for the state template.

Vehicles associated with the state template can stream telemetry data with either an onChange or periodic update strategy. .. epigraph:

Access to certain AWS IoT FleetWise features is currently gated. For more information, see `AWS Region and feature availability <https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html>`_ in the *AWS IoT FleetWise Developer Guide* .

Parameters:

on_change (Any)
periodic (Union[IResolvable, PeriodicStateTemplateUpdateStrategyProperty, Dict[str, Any], None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-statetemplateupdatestrategy.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iotfleetwise import mixins as iotfleetwise_mixins

# on_change: Any

state_template_update_strategy_property = iotfleetwise_mixins.CfnVehiclePropsMixin.StateTemplateUpdateStrategyProperty(
    on_change=on_change,
    periodic=iotfleetwise_mixins.CfnVehiclePropsMixin.PeriodicStateTemplateUpdateStrategyProperty(
        state_template_update_rate=iotfleetwise_mixins.CfnVehiclePropsMixin.TimePeriodProperty(
            unit="unit",
            value=123
        )
    )
)

Attributes

on_change

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-statetemplateupdatestrategy.html#cfn-iotfleetwise-vehicle-statetemplateupdatestrategy-onchange

Type:: see

periodic

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-statetemplateupdatestrategy.html#cfn-iotfleetwise-vehicle-statetemplateupdatestrategy-periodic

Type:: see

TimePeriodProperty

class CfnVehiclePropsMixin.TimePeriodProperty(*, unit=None, value=None)

Bases: object

The length of time between state template updates.

Parameters:

unit (Optional[str]) – A unit of time.
value (Union[int, float, None]) – A number of time units.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-timeperiod.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iotfleetwise import mixins as iotfleetwise_mixins

time_period_property = iotfleetwise_mixins.CfnVehiclePropsMixin.TimePeriodProperty(
    unit="unit",
    value=123
)

Attributes

unit

A unit of time.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-timeperiod.html#cfn-iotfleetwise-vehicle-timeperiod-unit

value

A number of time units.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-timeperiod.html#cfn-iotfleetwise-vehicle-timeperiod-value