Package software.amazon.awscdk.services.iotsitewise

Class CfnPipeline

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.iotsitewise.CfnPipeline
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IPipelineRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-10T17:51:47.389Z") @Stability(Stable) public class CfnPipeline extends CfnResource implements IInspectable, IPipelineRef, ITaggableV2
Resource schema for AWS::IoTSiteWise::Pipeline.

A pipeline defines a directed acyclic graph (DAG) of compute nodes, where each node references a task definition and can declare dependencies on other nodes.

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.*;
 CfnPipeline cfnPipeline = CfnPipeline.Builder.create(this, "MyCfnPipeline")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnPipeline

      protected CfnPipeline(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnPipeline

      protected CfnPipeline(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnPipeline

      @Stability(Stable) public CfnPipeline(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPipelineProps props)
      Create a new AWS::IoTSiteWise::Pipeline.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForPipeline

      @Stability(Stable) @NotNull public static String arnForPipeline(@NotNull IPipelineRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnPipeline

      @Stability(Stable) @NotNull public static Boolean isCfnPipeline(@NotNull Object x)
      Checks whether the given object is a CfnPipeline.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrPipelineArn

      @Stability(Stable) @NotNull public String getAttrPipelineArn()
      The ARN of the pipeline.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The current lifecycle status of the pipeline.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getPipelineRef

      @Stability(Stable) @NotNull public PipelineReference getPipelineRef()
      A reference to a Pipeline resource.
      Specified by:
      getPipelineRef in interface IPipelineRef

    • getComputations

      @Stability(Stable) @NotNull public Object getComputations()
      The list of compute nodes that form the pipeline DAG.

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

    • setComputations

      @Stability(Stable) public void setComputations(@NotNull IResolvable value)
      The list of compute nodes that form the pipeline DAG.

    • setComputations

      @Stability(Stable) public void setComputations(@NotNull List<Object> value)
      The list of compute nodes that form the pipeline DAG.

    • getPipelineName

      @Stability(Stable) @NotNull public String getPipelineName()
      The name of the pipeline.

    • setPipelineName

      @Stability(Stable) public void setPipelineName(@NotNull String value)
      The name of the pipeline.

    • getWorkspaceName

      @Stability(Stable) @NotNull public String getWorkspaceName()
      The name of the workspace.

    • setWorkspaceName

      @Stability(Stable) public void setWorkspaceName(@NotNull String value)
      The name of the workspace.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the pipeline.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the pipeline.

    • getEnvironmentVariables

      @Stability(Stable) @Nullable public Object getEnvironmentVariables()
      A map of environment variable key-value pairs.

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

    • setEnvironmentVariables

      @Stability(Stable) public void setEnvironmentVariables(@Nullable IResolvable value)
      A map of environment variable key-value pairs.

    • setEnvironmentVariables

      @Stability(Stable) public void setEnvironmentVariables(@Nullable Map<String,String> value)
      A map of environment variable key-value pairs.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.