software.amazon.awscdk.services.datapipeline

Interface CfnPipelineProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipelineProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.859Z")
 @Stability(value=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.datapipeline.*;
 CfnPipelineProps cfnPipelineProps = CfnPipelineProps.builder()
         .name("name")
         .parameterObjects(List.of(ParameterObjectProperty.builder()
                 .attributes(List.of(ParameterAttributeProperty.builder()
                         .key("key")
                         .stringValue("stringValue")
                         .build()))
                 .id("id")
                 .build()))
         // the properties below are optional
         .activate(false)
         .description("description")
         .parameterValues(List.of(ParameterValueProperty.builder()
                 .id("id")
                 .stringValue("stringValue")
                 .build()))
         .pipelineObjects(List.of(PipelineObjectProperty.builder()
                 .fields(List.of(FieldProperty.builder()
                         .key("key")
                         // the properties below are optional
                         .refValue("refValue")
                         .stringValue("stringValue")
                         .build()))
                 .id("id")
                 .name("name")
                 .build()))
         .pipelineTags(List.of(PipelineTagProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnPipelineProps.Builder	builder()
default Object	getActivate() Indicates whether to validate and start the pipeline or stop an active pipeline.
default String	getDescription() A description of the pipeline.
String	getName() The name of the pipeline.
Object	getParameterObjects() The parameter objects used with the pipeline.
default Object	getParameterValues() The parameter values used with the pipeline.
default Object	getPipelineObjects() The objects that define the pipeline.
default Object	getPipelineTags() A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getName

@Stability(value=Stable)
 @NotNull
String getName()

The name of the pipeline.

getParameterObjects

@Stability(value=Stable)
 @NotNull
Object getParameterObjects()

The parameter objects used with the pipeline.

getActivate

@Stability(value=Stable)
 @Nullable
default Object getActivate()

Indicates whether to validate and start the pipeline or stop an active pipeline.

By default, the value is set to true .

getDescription

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

A description of the pipeline.

getParameterValues

@Stability(value=Stable)
 @Nullable
default Object getParameterValues()

The parameter values used with the pipeline.

getPipelineObjects

@Stability(value=Stable)
 @Nullable
default Object getPipelineObjects()

The objects that define the pipeline.

These objects overwrite the existing pipeline definition. Not all objects, fields, and values can be updated. For information about restrictions, see Editing Your Pipeline in the AWS Data Pipeline Developer Guide .

getPipelineTags

@Stability(value=Stable)
 @Nullable
default Object getPipelineTags()

A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions.

For more information, see Controlling Access to Pipelines and Resources in the AWS Data Pipeline Developer Guide .

builder

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

Returns:

a CfnPipelineProps.Builder of CfnPipelineProps