We recommend new projects start with resources from the AWS provider.
aws-native.iotanalytics.getPipeline
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Resource Type definition for AWS::IoTAnalytics::Pipeline
Using getPipeline
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getPipeline(args: GetPipelineArgs, opts?: InvokeOptions): Promise<GetPipelineResult>
function getPipelineOutput(args: GetPipelineOutputArgs, opts?: InvokeOptions): Output<GetPipelineResult>
def get_pipeline(pipeline_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetPipelineResult
def get_pipeline_output(pipeline_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetPipelineResult]
func LookupPipeline(ctx *Context, args *LookupPipelineArgs, opts ...InvokeOption) (*LookupPipelineResult, error)
func LookupPipelineOutput(ctx *Context, args *LookupPipelineOutputArgs, opts ...InvokeOption) LookupPipelineResultOutput
> Note: This function is named LookupPipeline
in the Go SDK.
public static class GetPipeline
{
public static Task<GetPipelineResult> InvokeAsync(GetPipelineArgs args, InvokeOptions? opts = null)
public static Output<GetPipelineResult> Invoke(GetPipelineInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetPipelineResult> getPipeline(GetPipelineArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:iotanalytics:getPipeline
arguments:
# arguments dictionary
The following arguments are supported:
- Pipeline
Name string - The name of the pipeline.
- Pipeline
Name string - The name of the pipeline.
- pipeline
Name String - The name of the pipeline.
- pipeline
Name string - The name of the pipeline.
- pipeline_
name str - The name of the pipeline.
- pipeline
Name String - The name of the pipeline.
getPipeline Result
The following output properties are available:
- Id string
- Pipeline
Activities List<Pulumi.Aws Native. Io TAnalytics. Outputs. Pipeline Activity> 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 adatastore
activity. Each entry in the list must contain only one activity, for example:pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]
- List<Pulumi.
Aws Native. Outputs. Tag> Metadata which can be used to manage the pipeline.
For more information, see Tag .
- Id string
- Pipeline
Activities []PipelineActivity 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 adatastore
activity. Each entry in the list must contain only one activity, for example:pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]
- Tag
Metadata which can be used to manage the pipeline.
For more information, see Tag .
- id String
- pipeline
Activities List<PipelineActivity> 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 adatastore
activity. Each entry in the list must contain only one activity, for example:pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]
- List<Tag>
Metadata which can be used to manage the pipeline.
For more information, see Tag .
- id string
- pipeline
Activities PipelineActivity[] 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 adatastore
activity. Each entry in the list must contain only one activity, for example:pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]
- Tag[]
Metadata which can be used to manage the pipeline.
For more information, see Tag .
- id str
- pipeline_
activities Sequence[PipelineActivity] 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 adatastore
activity. Each entry in the list must contain only one activity, for example:pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]
- Sequence[root_Tag]
Metadata which can be used to manage the pipeline.
For more information, see Tag .
- id String
- pipeline
Activities List<Property Map> 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 adatastore
activity. Each entry in the list must contain only one activity, for example:pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]
- List<Property Map>
Metadata which can be used to manage the pipeline.
For more information, see Tag .
Supporting Types
PipelineActivity
- Add
Attributes Pulumi.Aws Native. Io TAnalytics. Inputs. Pipeline Add Attributes - Adds other attributes based on existing attributes in the message.
- Channel
Pulumi.
Aws Native. Io TAnalytics. Inputs. Pipeline Channel - Determines the source of the messages to be processed.
- Datastore
Pulumi.
Aws Native. Io TAnalytics. Inputs. Pipeline Datastore - Specifies where to store the processed message data.
- Device
Registry Pulumi.Enrich Aws Native. Io TAnalytics. Inputs. Pipeline Device Registry Enrich - Adds data from the AWS IoT device registry to your message.
- Device
Shadow Pulumi.Enrich Aws Native. Io TAnalytics. Inputs. Pipeline Device Shadow Enrich - Adds information from the AWS IoT Device Shadows service to a message.
- Filter
Pulumi.
Aws Native. Io TAnalytics. Inputs. Pipeline Filter - Filters a message based on its attributes.
- Lambda
Pulumi.
Aws Native. Io TAnalytics. Inputs. Pipeline Lambda - Runs a Lambda function to modify the message.
- Math
Pulumi.
Aws Native. Io TAnalytics. Inputs. Pipeline Math - Computes an arithmetic expression using the message's attributes and adds it to the message.
- Remove
Attributes Pulumi.Aws Native. Io TAnalytics. Inputs. Pipeline Remove Attributes - Removes attributes from a message.
- Select
Attributes Pulumi.Aws Native. Io TAnalytics. Inputs. Pipeline Select Attributes - Creates a new message using only the specified attributes from the original message.
- Add
Attributes PipelineAdd Attributes - Adds other attributes based on existing attributes in the message.
- Channel
Pipeline
Channel - Determines the source of the messages to be processed.
- Datastore
Pipeline
Datastore - Specifies where to store the processed message data.
- Device
Registry PipelineEnrich Device Registry Enrich - Adds data from the AWS IoT device registry to your message.
- Device
Shadow PipelineEnrich Device Shadow Enrich - Adds information from the AWS IoT Device Shadows service to a message.
- Filter
Pipeline
Filter - Filters a message based on its attributes.
- Lambda
Pipeline
Lambda - Runs a Lambda function to modify the message.
- Math
Pipeline
Math - Computes an arithmetic expression using the message's attributes and adds it to the message.
- Remove
Attributes PipelineRemove Attributes - Removes attributes from a message.
- Select
Attributes PipelineSelect Attributes - Creates a new message using only the specified attributes from the original message.
- add
Attributes PipelineAdd Attributes - Adds other attributes based on existing attributes in the message.
- channel
Pipeline
Channel - Determines the source of the messages to be processed.
- datastore
Pipeline
Datastore - Specifies where to store the processed message data.
- device
Registry PipelineEnrich Device Registry Enrich - Adds data from the AWS IoT device registry to your message.
- device
Shadow PipelineEnrich Device Shadow Enrich - Adds information from the AWS IoT Device Shadows service to a message.
- filter
Pipeline
Filter - Filters a message based on its attributes.
- lambda
Pipeline
Lambda - Runs a Lambda function to modify the message.
- math
Pipeline
Math - Computes an arithmetic expression using the message's attributes and adds it to the message.
- remove
Attributes PipelineRemove Attributes - Removes attributes from a message.
- select
Attributes PipelineSelect Attributes - Creates a new message using only the specified attributes from the original message.
- add
Attributes PipelineAdd Attributes - Adds other attributes based on existing attributes in the message.
- channel
Pipeline
Channel - Determines the source of the messages to be processed.
- datastore
Pipeline
Datastore - Specifies where to store the processed message data.
- device
Registry PipelineEnrich Device Registry Enrich - Adds data from the AWS IoT device registry to your message.
- device
Shadow PipelineEnrich Device Shadow Enrich - Adds information from the AWS IoT Device Shadows service to a message.
- filter
Pipeline
Filter - Filters a message based on its attributes.
- lambda
Pipeline
Lambda - Runs a Lambda function to modify the message.
- math
Pipeline
Math - Computes an arithmetic expression using the message's attributes and adds it to the message.
- remove
Attributes PipelineRemove Attributes - Removes attributes from a message.
- select
Attributes PipelineSelect Attributes - Creates a new message using only the specified attributes from the original message.
- add_
attributes PipelineAdd Attributes - Adds other attributes based on existing attributes in the message.
- channel
Pipeline
Channel - Determines the source of the messages to be processed.
- datastore
Pipeline
Datastore - Specifies where to store the processed message data.
- device_
registry_ Pipelineenrich Device Registry Enrich - Adds data from the AWS IoT device registry to your message.
- device_
shadow_ Pipelineenrich Device Shadow Enrich - Adds information from the AWS IoT Device Shadows service to a message.
- filter
Pipeline
Filter - Filters a message based on its attributes.
- lambda_
Pipeline
Lambda - Runs a Lambda function to modify the message.
- math
Pipeline
Math - Computes an arithmetic expression using the message's attributes and adds it to the message.
- remove_
attributes PipelineRemove Attributes - Removes attributes from a message.
- select_
attributes PipelineSelect Attributes - Creates a new message using only the specified attributes from the original message.
- add
Attributes Property Map - Adds other attributes based on existing attributes in the message.
- channel Property Map
- Determines the source of the messages to be processed.
- datastore Property Map
- Specifies where to store the processed message data.
- device
Registry Property MapEnrich - Adds data from the AWS IoT device registry to your message.
- device
Shadow Property MapEnrich - Adds information from the AWS IoT Device Shadows service to a message.
- filter Property Map
- Filters a message based on its attributes.
- lambda Property Map
- Runs a Lambda function to modify the message.
- math Property Map
- Computes an arithmetic expression using the message's attributes and adds it to the message.
- remove
Attributes Property Map - Removes attributes from a message.
- select
Attributes Property Map - Creates a new message using only the specified attributes from the original message.
PipelineAddAttributes
- Attributes Dictionary<string, string>
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".
- Name string
- The name of the 'addAttributes' activity.
- Next string
- The next activity in the pipeline.
- Attributes map[string]string
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".
- Name string
- The name of the 'addAttributes' activity.
- Next string
- The next activity in the pipeline.
- attributes Map<String,String>
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".
- name String
- The name of the 'addAttributes' activity.
- next String
- The next activity in the pipeline.
- attributes {[key: string]: string}
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".
- name string
- The name of the 'addAttributes' activity.
- next string
- The next activity in the pipeline.
- attributes Mapping[str, str]
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".
- name str
- The name of the 'addAttributes' activity.
- next str
- The next activity in the pipeline.
- attributes Map<String>
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".
- name String
- The name of the 'addAttributes' activity.
- next String
- The next activity in the pipeline.
PipelineChannel
- Channel
Name string - The name of the channel from which the messages are processed.
- Name string
- The name of the 'channel' activity.
- Next string
- The next activity in the pipeline.
- Channel
Name string - The name of the channel from which the messages are processed.
- Name string
- The name of the 'channel' activity.
- Next string
- The next activity in the pipeline.
- channel
Name String - The name of the channel from which the messages are processed.
- name String
- The name of the 'channel' activity.
- next String
- The next activity in the pipeline.
- channel
Name string - The name of the channel from which the messages are processed.
- name string
- The name of the 'channel' activity.
- next string
- The next activity in the pipeline.
- channel_
name str - The name of the channel from which the messages are processed.
- name str
- The name of the 'channel' activity.
- next str
- The next activity in the pipeline.
- channel
Name String - The name of the channel from which the messages are processed.
- name String
- The name of the 'channel' activity.
- next String
- The next activity in the pipeline.
PipelineDatastore
- Datastore
Name string - The name of the data store where processed messages are stored.
- Name string
- The name of the datastore activity.
- Datastore
Name string - The name of the data store where processed messages are stored.
- Name string
- The name of the datastore activity.
- datastore
Name String - The name of the data store where processed messages are stored.
- name String
- The name of the datastore activity.
- datastore
Name string - The name of the data store where processed messages are stored.
- name string
- The name of the datastore activity.
- datastore_
name str - The name of the data store where processed messages are stored.
- name str
- The name of the datastore activity.
- datastore
Name String - The name of the data store where processed messages are stored.
- name String
- The name of the datastore activity.
PipelineDeviceRegistryEnrich
- Attribute string
- The name of the attribute that is added to the message.
- Name string
- The name of the 'deviceRegistryEnrich' activity.
- Role
Arn string - The ARN of the role that allows access to the device's registry information.
- Thing
Name string - The name of the IoT device whose registry information is added to the message.
- Next string
- The next activity in the pipeline.
- Attribute string
- The name of the attribute that is added to the message.
- Name string
- The name of the 'deviceRegistryEnrich' activity.
- Role
Arn string - The ARN of the role that allows access to the device's registry information.
- Thing
Name string - The name of the IoT device whose registry information is added to the message.
- Next string
- The next activity in the pipeline.
- attribute String
- The name of the attribute that is added to the message.
- name String
- The name of the 'deviceRegistryEnrich' activity.
- role
Arn String - The ARN of the role that allows access to the device's registry information.
- thing
Name String - The name of the IoT device whose registry information is added to the message.
- next String
- The next activity in the pipeline.
- attribute string
- The name of the attribute that is added to the message.
- name string
- The name of the 'deviceRegistryEnrich' activity.
- role
Arn string - The ARN of the role that allows access to the device's registry information.
- thing
Name string - The name of the IoT device whose registry information is added to the message.
- next string
- The next activity in the pipeline.
- 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 str
- The next activity in the pipeline.
- attribute String
- The name of the attribute that is added to the message.
- name String
- The name of the 'deviceRegistryEnrich' activity.
- role
Arn String - The ARN of the role that allows access to the device's registry information.
- thing
Name String - The name of the IoT device whose registry information is added to the message.
- next String
- The next activity in the pipeline.
PipelineDeviceShadowEnrich
- Attribute string
- The name of the attribute that is added to the message.
- Name string
- The name of the 'deviceShadowEnrich' activity.
- Role
Arn string - The ARN of the role that allows access to the device's shadow.
- Thing
Name string - The name of the IoT device whose shadow information is added to the message.
- Next string
- The next activity in the pipeline.
- Attribute string
- The name of the attribute that is added to the message.
- Name string
- The name of the 'deviceShadowEnrich' activity.
- Role
Arn string - The ARN of the role that allows access to the device's shadow.
- Thing
Name string - The name of the IoT device whose shadow information is added to the message.
- Next string
- The next activity in the pipeline.
- attribute String
- The name of the attribute that is added to the message.
- name String
- The name of the 'deviceShadowEnrich' activity.
- role
Arn String - The ARN of the role that allows access to the device's shadow.
- thing
Name String - The name of the IoT device whose shadow information is added to the message.
- next String
- The next activity in the pipeline.
- attribute string
- The name of the attribute that is added to the message.
- name string
- The name of the 'deviceShadowEnrich' activity.
- role
Arn string - The ARN of the role that allows access to the device's shadow.
- thing
Name string - The name of the IoT device whose shadow information is added to the message.
- next string
- The next activity in the pipeline.
- 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 str
- The next activity in the pipeline.
- attribute String
- The name of the attribute that is added to the message.
- name String
- The name of the 'deviceShadowEnrich' activity.
- role
Arn String - The ARN of the role that allows access to the device's shadow.
- thing
Name String - The name of the IoT device whose shadow information is added to the message.
- next String
- The next activity in the pipeline.
PipelineFilter
PipelineLambda
- Batch
Size int 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 string - The name of the Lambda function that is run on the message.
- Name string
- The name of the 'lambda' activity.
- Next string
- The next activity in the pipeline.
- Batch
Size int 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 string - The name of the Lambda function that is run on the message.
- Name string
- The name of the 'lambda' activity.
- Next string
- The next activity in the pipeline.
- batch
Size Integer 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 String - The name of the Lambda function that is run on the message.
- name String
- The name of the 'lambda' activity.
- next String
- The next activity in the pipeline.
- batch
Size number 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 string - The name of the Lambda function that is run on the message.
- name string
- The name of the 'lambda' activity.
- next string
- The next activity in the pipeline.
- batch_
size int 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 str
- The next activity in the pipeline.
- batch
Size Number 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 String - The name of the Lambda function that is run on the message.
- name String
- The name of the 'lambda' activity.
- next String
- The next activity in the pipeline.
PipelineMath
PipelineRemoveAttributes
- Attributes List<string>
- A list of 1-50 attributes to remove from the message.
- Name string
- The name of the 'removeAttributes' activity.
- Next string
- The next activity in the pipeline.
- Attributes []string
- A list of 1-50 attributes to remove from the message.
- Name string
- The name of the 'removeAttributes' activity.
- Next string
- The next activity in the pipeline.
- attributes List<String>
- A list of 1-50 attributes to remove from the message.
- name String
- The name of the 'removeAttributes' activity.
- next String
- The next activity in the pipeline.
- attributes string[]
- A list of 1-50 attributes to remove from the message.
- name string
- The name of the 'removeAttributes' activity.
- next string
- The next activity in the pipeline.
- attributes Sequence[str]
- A list of 1-50 attributes to remove from the message.
- name str
- The name of the 'removeAttributes' activity.
- next str
- The next activity in the pipeline.
- attributes List<String>
- A list of 1-50 attributes to remove from the message.
- name String
- The name of the 'removeAttributes' activity.
- next String
- The next activity in the pipeline.
PipelineSelectAttributes
- Attributes List<string>
- A list of the attributes to select from the message.
- Name string
- The name of the 'selectAttributes' activity.
- Next string
- The next activity in the pipeline.
- Attributes []string
- A list of the attributes to select from the message.
- Name string
- The name of the 'selectAttributes' activity.
- Next string
- The next activity in the pipeline.
- attributes List<String>
- A list of the attributes to select from the message.
- name String
- The name of the 'selectAttributes' activity.
- next String
- The next activity in the pipeline.
- attributes string[]
- A list of the attributes to select from the message.
- name string
- The name of the 'selectAttributes' activity.
- next string
- The next activity in the pipeline.
- attributes Sequence[str]
- A list of the attributes to select from the message.
- name str
- The name of the 'selectAttributes' activity.
- next str
- The next activity in the pipeline.
- attributes List<String>
- A list of the attributes to select from the message.
- name String
- The name of the 'selectAttributes' activity.
- next String
- The next activity in the pipeline.
Tag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.