CfnInputPropsMixin

class aws_cdk.mixins_preview.aws_iotevents.mixins.CfnInputPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::IoTEvents::Input resource creates an input.

To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events . This is done by sending messages as inputs to AWS IoT Events . For more information, see How to Use AWS IoT Events in the AWS IoT Events Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html
CloudformationResource:: AWS::IoTEvents::Input
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_iotevents import mixins as iotevents_mixins

cfn_input_props_mixin = iotevents_mixins.CfnInputPropsMixin(iotevents_mixins.CfnInputMixinProps(
    input_definition=iotevents_mixins.CfnInputPropsMixin.InputDefinitionProperty(
        attributes=[iotevents_mixins.CfnInputPropsMixin.AttributeProperty(
            json_path="jsonPath"
        )]
    ),
    input_description="inputDescription",
    input_name="inputName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::IoTEvents::Input.

Parameters:

props (Union[CfnInputMixinProps, 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 = ['inputDefinition', 'inputDescription', 'inputName', '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

AttributeProperty

class CfnInputPropsMixin.AttributeProperty(*, json_path=None)

Bases: object

The attributes from the JSON payload that are made available by the input.

Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage . Each such message contains a JSON payload. Those attributes (and their paired values) specified here are available for use in the condition expressions used by detectors.

Parameters:: json_path (Optional[str]) – An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to AWS IoT Events ( BatchPutMessage ). Each such message contains a JSON payload. The attribute (and its paired value) specified here are available for use in the condition expressions used by detectors. Syntax: <field-name>.<field-name>...
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-input-attribute.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_iotevents import mixins as iotevents_mixins

attribute_property = iotevents_mixins.CfnInputPropsMixin.AttributeProperty(
    json_path="jsonPath"
)

Attributes

json_path

An expression that specifies an attribute-value pair in a JSON structure.

Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to AWS IoT Events ( BatchPutMessage ). Each such message contains a JSON payload. The attribute (and its paired value) specified here are available for use in the condition expressions used by detectors.

Syntax: <field-name>.<field-name>...

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-input-attribute.html#cfn-iotevents-input-attribute-jsonpath

InputDefinitionProperty

class CfnInputPropsMixin.InputDefinitionProperty(*, attributes=None)

Bases: object

The definition of the input.

Parameters:: attributes (Union[IResolvable, Sequence[Union[IResolvable, AttributeProperty, Dict[str, Any]]], None]) – The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage . Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the condition expressions used by detectors that monitor this input.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-input-inputdefinition.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_iotevents import mixins as iotevents_mixins

input_definition_property = iotevents_mixins.CfnInputPropsMixin.InputDefinitionProperty(
    attributes=[iotevents_mixins.CfnInputPropsMixin.AttributeProperty(
        json_path="jsonPath"
    )]
)

Attributes

attributes

The attributes from the JSON payload that are made available by the input.

Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage . Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the condition expressions used by detectors that monitor this input.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-input-inputdefinition.html#cfn-iotevents-input-inputdefinition-attributes