software.amazon.awscdk.services.datapipeline

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.datapipeline.CfnPipeline

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.856Z")
 @Stability(value=Stable)
public class CfnPipeline
extends CfnResource
implements IInspectable

A CloudFormation `AWS::DataPipeline::Pipeline`.

The AWS::DataPipeline::Pipeline resource specifies a data pipeline that you can use to automate the movement and transformation of data. In each pipeline, you define pipeline objects, such as activities, schedules, data nodes, and resources. For information about pipeline objects and components that you can use, see Pipeline Object Reference in the AWS Data Pipeline Developer Guide .

The AWS::DataPipeline::Pipeline resource adds tasks, schedules, and preconditions to the specified pipeline. You can use PutPipelineDefinition to populate a new pipeline.

PutPipelineDefinition also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following validation errors exist in the pipeline.

• An object is missing a name or identifier field.
• A string or reference field is empty.
• The number of objects in the pipeline exceeds the allowed maximum number of objects.
• The pipeline is in a FINISHED state.

Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action.

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.*;
 CfnPipeline cfnPipeline = CfnPipeline.Builder.create(this, "MyCfnPipeline")
         .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	Class and Description
static class	CfnPipeline.Builder A fluent builder for CfnPipeline.
static interface	CfnPipeline.FieldProperty A key-value pair that describes a property of a `PipelineObject` .
static interface	CfnPipeline.ParameterAttributeProperty `Attribute` is a property of `ParameterObject` that defines the attributes of a parameter object as key-value pairs.
static interface	CfnPipeline.ParameterObjectProperty Contains information about a parameter object.
static interface	CfnPipeline.ParameterValueProperty A value or list of parameter values.
static interface	CfnPipeline.PipelineObjectProperty PipelineObject is property of the AWS::DataPipeline::Pipeline resource that contains information about a pipeline object.
static interface	CfnPipeline.PipelineTagProperty A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnPipeline(software.constructs.Construct scope, String id, CfnPipelineProps props) Create a new `AWS::DataPipeline::Pipeline`.
protected	CfnPipeline(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPipeline(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getActivate() Indicates whether to validate and start the pipeline or stop an active pipeline.
protected Map<String,Object>	getCfnProperties()
String	getDescription() A description of the pipeline.
String	getName() The name of the pipeline.
Object	getParameterObjects() The parameter objects used with the pipeline.
Object	getParameterValues() The parameter values used with the pipeline.
Object	getPipelineObjects() The objects that define the pipeline.
Object	getPipelineTags() A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setActivate(Boolean value) Indicates whether to validate and start the pipeline or stop an active pipeline.
void	setActivate(IResolvable value) Indicates whether to validate and start the pipeline or stop an active pipeline.
void	setDescription(String value) A description of the pipeline.
void	setName(String value) The name of the pipeline.
void	setParameterObjects(IResolvable value) The parameter objects used with the pipeline.
void	setParameterObjects(List<Object> value) The parameter objects used with the pipeline.
void	setParameterValues(IResolvable value) The parameter values used with the pipeline.
void	setParameterValues(List<Object> value) The parameter values used with the pipeline.
void	setPipelineObjects(IResolvable value) The objects that define the pipeline.
void	setPipelineObjects(List<Object> value) The objects that define the pipeline.
void	setPipelineTags(IResolvable value) A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions.
void	setPipelineTags(List<Object> value) A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnPipeline

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

CfnPipeline

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

CfnPipeline

@Stability(value=Stable)
public CfnPipeline(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            CfnPipelineProps props)

Create a new `AWS::DataPipeline::Pipeline`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getName

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

The name of the pipeline.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the pipeline.

getParameterObjects

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

The parameter objects used with the pipeline.

setParameterObjects

@Stability(value=Stable)
public void setParameterObjects(@NotNull
                                                         IResolvable value)

The parameter objects used with the pipeline.

setParameterObjects

@Stability(value=Stable)
public void setParameterObjects(@NotNull
                                                         List<Object> value)

The parameter objects used with the pipeline.

getActivate

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

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

By default, the value is set to true .

setActivate

@Stability(value=Stable)
public void setActivate(@Nullable
                                                 Boolean value)

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

By default, the value is set to true .

setActivate

@Stability(value=Stable)
public void setActivate(@Nullable
                                                 IResolvable value)

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
public String getDescription()

A description of the pipeline.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description of the pipeline.

getParameterValues

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

The parameter values used with the pipeline.

setParameterValues

@Stability(value=Stable)
public void setParameterValues(@Nullable
                                                        IResolvable value)

The parameter values used with the pipeline.

setParameterValues

@Stability(value=Stable)
public void setParameterValues(@Nullable
                                                        List<Object> value)

The parameter values used with the pipeline.

getPipelineObjects

@Stability(value=Stable)
 @Nullable
public 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 .

setPipelineObjects

@Stability(value=Stable)
public void setPipelineObjects(@Nullable
                                                        IResolvable value)

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 .

setPipelineObjects

@Stability(value=Stable)
public void setPipelineObjects(@Nullable
                                                        List<Object> value)

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
public 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 .

setPipelineTags

@Stability(value=Stable)
public void setPipelineTags(@Nullable
                                                     IResolvable value)

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 .

setPipelineTags

@Stability(value=Stable)
public void setPipelineTags(@Nullable
                                                     List<Object> value)

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 .