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.46.0 (build cd08c55)",
           date="2021-11-25T20:11:05.763Z")
 @Stability(value=Stable)
public interface CfnPipelineProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::DataPipeline::Pipeline`.

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() `AWS::DataPipeline::Pipeline.Activate`.
default String	getDescription() `AWS::DataPipeline::Pipeline.Description`.
String	getName() `AWS::DataPipeline::Pipeline.Name`.
Object	getParameterObjects() `AWS::DataPipeline::Pipeline.ParameterObjects`.
default Object	getParameterValues() `AWS::DataPipeline::Pipeline.ParameterValues`.
default Object	getPipelineObjects() `AWS::DataPipeline::Pipeline.PipelineObjects`.
default Object	getPipelineTags() `AWS::DataPipeline::Pipeline.PipelineTags`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getActivate

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

`AWS::DataPipeline::Pipeline.Activate`.

getDescription

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

`AWS::DataPipeline::Pipeline.Description`.

getName

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

`AWS::DataPipeline::Pipeline.Name`.

getParameterObjects

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

`AWS::DataPipeline::Pipeline.ParameterObjects`.

getParameterValues

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

`AWS::DataPipeline::Pipeline.ParameterValues`.

getPipelineObjects

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

`AWS::DataPipeline::Pipeline.PipelineObjects`.

getPipelineTags

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

`AWS::DataPipeline::Pipeline.PipelineTags`.

builder

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

Returns:

a CfnPipelineProps.Builder of CfnPipelineProps