CfnPipeline

class aws_cdk.aws_iotanalytics.CfnPipeline(scope, id, *, pipeline_activities, pipeline_name=None, tags=None)

Bases: CfnResource

The AWS::IoTAnalytics::Pipeline resource consumes messages from one or more channels and allows you to process the messages before storing them in a data store.

You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array. For more information, see How to Use AWS IoT Analytics in the AWS IoT Analytics User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-pipeline.html

CloudformationResource:

AWS::IoTAnalytics::Pipeline

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 import aws_iotanalytics as iotanalytics

cfn_pipeline = iotanalytics.CfnPipeline(self, "MyCfnPipeline",
    pipeline_activities=[iotanalytics.CfnPipeline.ActivityProperty(
        add_attributes=iotanalytics.CfnPipeline.AddAttributesProperty(
            attributes={
                "attributes_key": "attributes"
            },
            name="name",

            # the properties below are optional
            next="next"
        ),
        channel=iotanalytics.CfnPipeline.ChannelProperty(
            channel_name="channelName",
            name="name",

            # the properties below are optional
            next="next"
        ),
        datastore=iotanalytics.CfnPipeline.DatastoreProperty(
            datastore_name="datastoreName",
            name="name"
        ),
        device_registry_enrich=iotanalytics.CfnPipeline.DeviceRegistryEnrichProperty(
            attribute="attribute",
            name="name",
            role_arn="roleArn",
            thing_name="thingName",

            # the properties below are optional
            next="next"
        ),
        device_shadow_enrich=iotanalytics.CfnPipeline.DeviceShadowEnrichProperty(
            attribute="attribute",
            name="name",
            role_arn="roleArn",
            thing_name="thingName",

            # the properties below are optional
            next="next"
        ),
        filter=iotanalytics.CfnPipeline.FilterProperty(
            filter="filter",
            name="name",

            # the properties below are optional
            next="next"
        ),
        lambda_=iotanalytics.CfnPipeline.LambdaProperty(
            batch_size=123,
            lambda_name="lambdaName",
            name="name",

            # the properties below are optional
            next="next"
        ),
        math=iotanalytics.CfnPipeline.MathProperty(
            attribute="attribute",
            math="math",
            name="name",

            # the properties below are optional
            next="next"
        ),
        remove_attributes=iotanalytics.CfnPipeline.RemoveAttributesProperty(
            attributes=["attributes"],
            name="name",

            # the properties below are optional
            next="next"
        ),
        select_attributes=iotanalytics.CfnPipeline.SelectAttributesProperty(
            attributes=["attributes"],
            name="name",

            # the properties below are optional
            next="next"
        )
    )],

    # the properties below are optional
    pipeline_name="pipelineName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • pipeline_activities (Union[IResolvable, Sequence[Union[IResolvable, ActivityProperty, Dict[str, Any]]]]) – A list of “PipelineActivity” objects. Activities perform transformations on your messages, such as removing, renaming or adding message attributes; filtering messages based on attribute values; invoking your Lambda functions on messages for advanced processing; or performing mathematical transformations to normalize device data. The list can be 2-25 PipelineActivity objects and must contain both a channel and a datastore activity. Each entry in the list must contain only one activity, for example: pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]

  • pipeline_name (Optional[str]) – The name of the pipeline.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Metadata which can be used to manage the pipeline. For more information, see Tag .

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str) –

  • value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::IoTAnalytics::Pipeline'
attr_id

Id

Type:

cloudformationAttribute

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The tree node.

pipeline_activities

A list of “PipelineActivity” objects.

pipeline_name

The name of the pipeline.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

Tag Manager which manages the tags for this resource.

tags_raw

Metadata which can be used to manage the pipeline.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

ActivityProperty

class CfnPipeline.ActivityProperty(*, add_attributes=None, channel=None, datastore=None, device_registry_enrich=None, device_shadow_enrich=None, filter=None, lambda_=None, math=None, remove_attributes=None, select_attributes=None)

Bases: object

An activity that performs a transformation on a message.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.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 import aws_iotanalytics as iotanalytics

activity_property = iotanalytics.CfnPipeline.ActivityProperty(
    add_attributes=iotanalytics.CfnPipeline.AddAttributesProperty(
        attributes={
            "attributes_key": "attributes"
        },
        name="name",

        # the properties below are optional
        next="next"
    ),
    channel=iotanalytics.CfnPipeline.ChannelProperty(
        channel_name="channelName",
        name="name",

        # the properties below are optional
        next="next"
    ),
    datastore=iotanalytics.CfnPipeline.DatastoreProperty(
        datastore_name="datastoreName",
        name="name"
    ),
    device_registry_enrich=iotanalytics.CfnPipeline.DeviceRegistryEnrichProperty(
        attribute="attribute",
        name="name",
        role_arn="roleArn",
        thing_name="thingName",

        # the properties below are optional
        next="next"
    ),
    device_shadow_enrich=iotanalytics.CfnPipeline.DeviceShadowEnrichProperty(
        attribute="attribute",
        name="name",
        role_arn="roleArn",
        thing_name="thingName",

        # the properties below are optional
        next="next"
    ),
    filter=iotanalytics.CfnPipeline.FilterProperty(
        filter="filter",
        name="name",

        # the properties below are optional
        next="next"
    ),
    lambda_=iotanalytics.CfnPipeline.LambdaProperty(
        batch_size=123,
        lambda_name="lambdaName",
        name="name",

        # the properties below are optional
        next="next"
    ),
    math=iotanalytics.CfnPipeline.MathProperty(
        attribute="attribute",
        math="math",
        name="name",

        # the properties below are optional
        next="next"
    ),
    remove_attributes=iotanalytics.CfnPipeline.RemoveAttributesProperty(
        attributes=["attributes"],
        name="name",

        # the properties below are optional
        next="next"
    ),
    select_attributes=iotanalytics.CfnPipeline.SelectAttributesProperty(
        attributes=["attributes"],
        name="name",

        # the properties below are optional
        next="next"
    )
)

Attributes

add_attributes

Adds other attributes based on existing attributes in the message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-addattributes

channel

Determines the source of the messages to be processed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-channel

datastore

Specifies where to store the processed message data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-datastore

device_registry_enrich

Adds data from the AWS IoT device registry to your message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-deviceregistryenrich

device_shadow_enrich

Adds information from the AWS IoT Device Shadows service to a message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-deviceshadowenrich

filter

Filters a message based on its attributes.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-filter

lambda_

Runs a Lambda function to modify the message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-lambda

math

Computes an arithmetic expression using the message’s attributes and adds it to the message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-math

remove_attributes

Removes attributes from a message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-removeattributes

select_attributes

Creates a new message using only the specified attributes from the original message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-selectattributes

AddAttributesProperty

class CfnPipeline.AddAttributesProperty(*, attributes, name, next=None)

Bases: object

An activity that adds other attributes based on existing attributes in the message.

Parameters:

  • attributes (Union[IResolvable, Mapping[str, str]]) – A list of 1-50 “AttributeNameMapping” objects that map an existing attribute to a new attribute. .. epigraph:: The existing attributes remain in the message, so if you want to remove the originals, use “RemoveAttributeActivity”.

  • name (str) – The name of the ‘addAttributes’ activity.

  • next (Optional[str]) – The next activity in the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-addattributes.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 import aws_iotanalytics as iotanalytics

add_attributes_property = iotanalytics.CfnPipeline.AddAttributesProperty(
    attributes={
        "attributes_key": "attributes"
    },
    name="name",

    # the properties below are optional
    next="next"
)

Attributes

attributes

A list of 1-50 “AttributeNameMapping” objects that map an existing attribute to a new attribute.

The existing attributes remain in the message, so if you want to remove the originals, use “RemoveAttributeActivity”.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-addattributes.html#cfn-iotanalytics-pipeline-addattributes-attributes

name

The name of the ‘addAttributes’ activity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-addattributes.html#cfn-iotanalytics-pipeline-addattributes-name

next

The next activity in the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-addattributes.html#cfn-iotanalytics-pipeline-addattributes-next

ChannelProperty

class CfnPipeline.ChannelProperty(*, channel_name, name, next=None)

Bases: object

Determines the source of the messages to be processed.

Parameters:

  • channel_name (str) – The name of the channel from which the messages are processed.

  • name (str) – The name of the ‘channel’ activity.

  • next (Optional[str]) – The next activity in the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-channel.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 import aws_iotanalytics as iotanalytics

channel_property = iotanalytics.CfnPipeline.ChannelProperty(
    channel_name="channelName",
    name="name",

    # the properties below are optional
    next="next"
)

Attributes

channel_name

The name of the channel from which the messages are processed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-channel.html#cfn-iotanalytics-pipeline-channel-channelname

name

The name of the ‘channel’ activity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-channel.html#cfn-iotanalytics-pipeline-channel-name

next

The next activity in the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-channel.html#cfn-iotanalytics-pipeline-channel-next

DatastoreProperty

class CfnPipeline.DatastoreProperty(*, datastore_name, name)

Bases: object

The datastore activity that specifies where to store the processed data.

Parameters:

  • datastore_name (str) – The name of the data store where processed messages are stored.

  • name (str) – The name of the datastore activity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-datastore.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 import aws_iotanalytics as iotanalytics

datastore_property = iotanalytics.CfnPipeline.DatastoreProperty(
    datastore_name="datastoreName",
    name="name"
)

Attributes

datastore_name

The name of the data store where processed messages are stored.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-datastore.html#cfn-iotanalytics-pipeline-datastore-datastorename

name

The name of the datastore activity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-datastore.html#cfn-iotanalytics-pipeline-datastore-name

DeviceRegistryEnrichProperty

class CfnPipeline.DeviceRegistryEnrichProperty(*, attribute, name, role_arn, thing_name, next=None)

Bases: object

An activity that adds data from the AWS IoT device registry to your message.

Parameters:

  • attribute (str) – The name of the attribute that is added to the message.

  • name (str) – The name of the ‘deviceRegistryEnrich’ activity.

  • role_arn (str) – The ARN of the role that allows access to the device’s registry information.

  • thing_name (str) – The name of the IoT device whose registry information is added to the message.

  • next (Optional[str]) – The next activity in the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceregistryenrich.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 import aws_iotanalytics as iotanalytics

device_registry_enrich_property = iotanalytics.CfnPipeline.DeviceRegistryEnrichProperty(
    attribute="attribute",
    name="name",
    role_arn="roleArn",
    thing_name="thingName",

    # the properties below are optional
    next="next"
)

Attributes

attribute

The name of the attribute that is added to the message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceregistryenrich.html#cfn-iotanalytics-pipeline-deviceregistryenrich-attribute

name

The name of the ‘deviceRegistryEnrich’ activity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceregistryenrich.html#cfn-iotanalytics-pipeline-deviceregistryenrich-name

next

The next activity in the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceregistryenrich.html#cfn-iotanalytics-pipeline-deviceregistryenrich-next

role_arn

The ARN of the role that allows access to the device’s registry information.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceregistryenrich.html#cfn-iotanalytics-pipeline-deviceregistryenrich-rolearn

thing_name

The name of the IoT device whose registry information is added to the message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceregistryenrich.html#cfn-iotanalytics-pipeline-deviceregistryenrich-thingname

DeviceShadowEnrichProperty

class CfnPipeline.DeviceShadowEnrichProperty(*, attribute, name, role_arn, thing_name, next=None)

Bases: object

An activity that adds information from the AWS IoT Device Shadows service to a message.

Parameters:

  • attribute (str) – The name of the attribute that is added to the message.

  • name (str) – The name of the ‘deviceShadowEnrich’ activity.

  • role_arn (str) – The ARN of the role that allows access to the device’s shadow.

  • thing_name (str) – The name of the IoT device whose shadow information is added to the message.

  • next (Optional[str]) – The next activity in the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.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 import aws_iotanalytics as iotanalytics

device_shadow_enrich_property = iotanalytics.CfnPipeline.DeviceShadowEnrichProperty(
    attribute="attribute",
    name="name",
    role_arn="roleArn",
    thing_name="thingName",

    # the properties below are optional
    next="next"
)

Attributes

attribute

The name of the attribute that is added to the message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-attribute

name

The name of the ‘deviceShadowEnrich’ activity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-name

next

The next activity in the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-next

role_arn

The ARN of the role that allows access to the device’s shadow.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-rolearn

thing_name

The name of the IoT device whose shadow information is added to the message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-thingname

FilterProperty

class CfnPipeline.FilterProperty(*, filter, name, next=None)

Bases: object

An activity that filters a message based on its attributes.

Parameters:

  • filter (str) – An expression that looks like an SQL WHERE clause that must return a Boolean value.

  • name (str) – The name of the ‘filter’ activity.

  • next (Optional[str]) – The next activity in the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-filter.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 import aws_iotanalytics as iotanalytics

filter_property = iotanalytics.CfnPipeline.FilterProperty(
    filter="filter",
    name="name",

    # the properties below are optional
    next="next"
)

Attributes

filter

An expression that looks like an SQL WHERE clause that must return a Boolean value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-filter.html#cfn-iotanalytics-pipeline-filter-filter

name

The name of the ‘filter’ activity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-filter.html#cfn-iotanalytics-pipeline-filter-name

next

The next activity in the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-filter.html#cfn-iotanalytics-pipeline-filter-next

LambdaProperty

class CfnPipeline.LambdaProperty(*, batch_size, lambda_name, name, next=None)

Bases: object

An activity that runs a Lambda function to modify the message.

Parameters:

  • batch_size (Union[int, float]) – The number of messages passed to the Lambda function for processing. The AWS Lambda function must be able to process all of these messages within five minutes, which is the maximum timeout duration for Lambda functions.

  • lambda_name (str) – The name of the Lambda function that is run on the message.

  • name (str) – The name of the ‘lambda’ activity.

  • next (Optional[str]) – The next activity in the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-lambda.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 import aws_iotanalytics as iotanalytics

lambda_property = iotanalytics.CfnPipeline.LambdaProperty(
    batch_size=123,
    lambda_name="lambdaName",
    name="name",

    # the properties below are optional
    next="next"
)

Attributes

batch_size

The number of messages passed to the Lambda function for processing.

The AWS Lambda function must be able to process all of these messages within five minutes, which is the maximum timeout duration for Lambda functions.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-lambda.html#cfn-iotanalytics-pipeline-lambda-batchsize

lambda_name

The name of the Lambda function that is run on the message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-lambda.html#cfn-iotanalytics-pipeline-lambda-lambdaname

name

The name of the ‘lambda’ activity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-lambda.html#cfn-iotanalytics-pipeline-lambda-name

next

The next activity in the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-lambda.html#cfn-iotanalytics-pipeline-lambda-next

MathProperty

class CfnPipeline.MathProperty(*, attribute, math, name, next=None)

Bases: object

An activity that computes an arithmetic expression using the message’s attributes.

Parameters:

  • attribute (str) – The name of the attribute that contains the result of the math operation.

  • math (str) – An expression that uses one or more existing attributes and must return an integer value.

  • name (str) – The name of the ‘math’ activity.

  • next (Optional[str]) – The next activity in the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-math.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 import aws_iotanalytics as iotanalytics

math_property = iotanalytics.CfnPipeline.MathProperty(
    attribute="attribute",
    math="math",
    name="name",

    # the properties below are optional
    next="next"
)

Attributes

attribute

The name of the attribute that contains the result of the math operation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-math.html#cfn-iotanalytics-pipeline-math-attribute

math

An expression that uses one or more existing attributes and must return an integer value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-math.html#cfn-iotanalytics-pipeline-math-math

name

The name of the ‘math’ activity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-math.html#cfn-iotanalytics-pipeline-math-name

next

The next activity in the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-math.html#cfn-iotanalytics-pipeline-math-next

RemoveAttributesProperty

class CfnPipeline.RemoveAttributesProperty(*, attributes, name, next=None)

Bases: object

An activity that removes attributes from a message.

Parameters:

  • attributes (Sequence[str]) – A list of 1-50 attributes to remove from the message.

  • name (str) – The name of the ‘removeAttributes’ activity.

  • next (Optional[str]) – The next activity in the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-removeattributes.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 import aws_iotanalytics as iotanalytics

remove_attributes_property = iotanalytics.CfnPipeline.RemoveAttributesProperty(
    attributes=["attributes"],
    name="name",

    # the properties below are optional
    next="next"
)

Attributes

attributes

A list of 1-50 attributes to remove from the message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-removeattributes.html#cfn-iotanalytics-pipeline-removeattributes-attributes

name

The name of the ‘removeAttributes’ activity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-removeattributes.html#cfn-iotanalytics-pipeline-removeattributes-name

next

The next activity in the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-removeattributes.html#cfn-iotanalytics-pipeline-removeattributes-next

SelectAttributesProperty

class CfnPipeline.SelectAttributesProperty(*, attributes, name, next=None)

Bases: object

Creates a new message using only the specified attributes from the original message.

Parameters:

  • attributes (Sequence[str]) – A list of the attributes to select from the message.

  • name (str) – The name of the ‘selectAttributes’ activity.

  • next (Optional[str]) – The next activity in the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-selectattributes.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 import aws_iotanalytics as iotanalytics

select_attributes_property = iotanalytics.CfnPipeline.SelectAttributesProperty(
    attributes=["attributes"],
    name="name",

    # the properties below are optional
    next="next"
)

Attributes

attributes

A list of the attributes to select from the message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-selectattributes.html#cfn-iotanalytics-pipeline-selectattributes-attributes

name

The name of the ‘selectAttributes’ activity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-selectattributes.html#cfn-iotanalytics-pipeline-selectattributes-name

next

The next activity in the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-selectattributes.html#cfn-iotanalytics-pipeline-selectattributes-next