Package software.amazon.awscdk.services.iotsitewise

Interface CfnPipelineProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipelineProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-10T17:51:47.391Z")
@Stability(Stable)
public interface CfnPipelineProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnPipeline.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iotsitewise.*;
 CfnPipelineProps cfnPipelineProps = CfnPipelineProps.builder()
         .computations(List.of(ComputeNodeProperty.builder()
                 .computeNodeName("computeNodeName")
                 .taskName("taskName")
                 // the properties below are optional
                 .dependsOn(List.of("dependsOn"))
                 .environmentVariables(Map.of(
                         "environmentVariablesKey", "environmentVariables"))
                 .build()))
         .pipelineName("pipelineName")
         .workspaceName("workspaceName")
         // the properties below are optional
         .description("description")
         .environmentVariables(Map.of(
                 "environmentVariablesKey", "environmentVariables"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPipelineProps.Builder	A builder for CfnPipelineProps
static final class	CfnPipelineProps.Jsii$Proxy	An implementation for CfnPipelineProps

Method Summary

Modifier and Type	Method	Description
static CfnPipelineProps.Builder	builder()
Object	getComputations()	The list of compute nodes that form the pipeline DAG.
default String	getDescription()	A description of the pipeline.
default Object	getEnvironmentVariables()	A map of environment variable key-value pairs.
String	getPipelineName()	The name of the pipeline.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.
String	getWorkspaceName()	The name of the workspace.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComputations

@Stability(Stable)
@NotNull
Object getComputations()

The list of compute nodes that form the pipeline DAG.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnPipeline.ComputeNodeProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-pipeline.html#cfn-iotsitewise-pipeline-computations

getPipelineName

@Stability(Stable)
@NotNull
String getPipelineName()

The name of the pipeline.

Must be unique within the workspace.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-pipeline.html#cfn-iotsitewise-pipeline-pipelinename

getWorkspaceName

@Stability(Stable)
@NotNull
String getWorkspaceName()

The name of the workspace.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-pipeline.html#cfn-iotsitewise-pipeline-workspacename

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the pipeline.

See Also:

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

getEnvironmentVariables

@Stability(Stable)
@Nullable
default Object getEnvironmentVariables()

A map of environment variable key-value pairs.

Returns union: either IResolvable or Mapinvalid input: '<'String, String>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-pipeline.html#cfn-iotsitewise-pipeline-environmentvariables

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An array of key-value pairs to apply to this resource.

See Also:

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

builder

@Stability(Stable)
static CfnPipelineProps.Builder builder()

Returns:

a CfnPipelineProps.Builder of CfnPipelineProps