awsdatapipeline

Documentation

Index

• func CfnPipeline_CFN_RESOURCE_TYPE_NAME() *string
• func CfnPipeline_IsCfnElement(x interface{}) *bool
• func CfnPipeline_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnPipeline_IsConstruct(x interface{}) *bool
• func NewCfnPipeline_Override(c CfnPipeline, scope constructs.Construct, id *string, props *CfnPipelineProps)
• type CfnPipeline
  • func NewCfnPipeline(scope constructs.Construct, id *string, props *CfnPipelineProps) CfnPipeline
• type CfnPipelineProps
• type CfnPipeline_FieldProperty
• type CfnPipeline_ParameterAttributeProperty
• type CfnPipeline_ParameterObjectProperty
• type CfnPipeline_ParameterValueProperty
• type CfnPipeline_PipelineObjectProperty
• type CfnPipeline_PipelineTagProperty

Functions

func CfnPipeline_CFN_RESOURCE_TYPE_NAME

func CfnPipeline_CFN_RESOURCE_TYPE_NAME() *string

func CfnPipeline_IsCfnElement

func CfnPipeline_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnPipeline_IsCfnResource

func CfnPipeline_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnPipeline_IsConstruct

func CfnPipeline_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnPipeline_Override

func NewCfnPipeline_Override(c CfnPipeline, scope constructs.Construct, id *string, props *CfnPipelineProps)

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

Types

type CfnPipeline

type CfnPipeline interface {
	awscdk.CfnResource
	awscdk.IInspectable
	Activate() interface{}
	SetActivate(val interface{})
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	ParameterObjects() interface{}
	SetParameterObjects(val interface{})
	ParameterValues() interface{}
	SetParameterValues(val interface{})
	PipelineObjects() interface{}
	SetPipelineObjects(val interface{})
	PipelineTags() interface{}
	SetPipelineTags(val interface{})
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

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](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-pipeline-objects.html) 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](https://docs.aws.amazon.com/datapipeline/latest/APIReference/API_PutPipelineDefinition.html) action and returned by the [GetPipelineDefinition](https://docs.aws.amazon.com/datapipeline/latest/APIReference/API_GetPipelineDefinition.html) action.

TODO: EXAMPLE

func NewCfnPipeline

func NewCfnPipeline(scope constructs.Construct, id *string, props *CfnPipelineProps) CfnPipeline

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

type CfnPipelineProps

type CfnPipelineProps struct {
	// The name of the pipeline.
	Name *string `json:"name" yaml:"name"`
	// The parameter objects used with the pipeline.
	ParameterObjects interface{} `json:"parameterObjects" yaml:"parameterObjects"`
	// Indicates whether to validate and start the pipeline or stop an active pipeline.
	//
	// By default, the value is set to `true` .
	Activate interface{} `json:"activate" yaml:"activate"`
	// A description of the pipeline.
	Description *string `json:"description" yaml:"description"`
	// The parameter values used with the pipeline.
	ParameterValues interface{} `json:"parameterValues" yaml:"parameterValues"`
	// 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](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-manage-pipeline-modify-console.html) in the *AWS Data Pipeline Developer Guide* .
	PipelineObjects interface{} `json:"pipelineObjects" yaml:"pipelineObjects"`
	// 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](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html) in the *AWS Data Pipeline Developer Guide* .
	PipelineTags interface{} `json:"pipelineTags" yaml:"pipelineTags"`
}

Properties for defining a `CfnPipeline`.

TODO: EXAMPLE

type CfnPipeline_FieldProperty

type CfnPipeline_FieldProperty struct {
	// Specifies the name of a field for a particular object.
	//
	// To view valid values for a particular field, see [Pipeline Object Reference](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-pipeline-objects.html) in the *AWS Data Pipeline Developer Guide* .
	Key *string `json:"key" yaml:"key"`
	// A field value that you specify as an identifier of another object in the same pipeline definition.
	//
	// > You can specify the field value as either a string value ( `StringValue` ) or a reference to another object ( `RefValue` ), but not both.
	//
	// Required if the key that you are using requires it.
	RefValue *string `json:"refValue" yaml:"refValue"`
	// A field value that you specify as a string.
	//
	// To view valid values for a particular field, see [Pipeline Object Reference](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-pipeline-objects.html) in the *AWS Data Pipeline Developer Guide* .
	//
	// > You can specify the field value as either a string value ( `StringValue` ) or a reference to another object ( `RefValue` ), but not both.
	//
	// Required if the key that you are using requires it.
	StringValue *string `json:"stringValue" yaml:"stringValue"`
}

A key-value pair that describes a property of a `PipelineObject` .

The value is specified as either a string value ( `StringValue` ) or a reference to another object ( `RefValue` ) but not as both. To view fields for a data pipeline object, see [Pipeline Object Reference](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-pipeline-objects.html) in the *AWS Data Pipeline Developer Guide* .

TODO: EXAMPLE

type CfnPipeline_ParameterAttributeProperty

type CfnPipeline_ParameterAttributeProperty struct {
	// The field identifier.
	Key *string `json:"key" yaml:"key"`
	// The field value, expressed as a String.
	StringValue *string `json:"stringValue" yaml:"stringValue"`
}

`Attribute` is a property of `ParameterObject` that defines the attributes of a parameter object as key-value pairs.

TODO: EXAMPLE

type CfnPipeline_ParameterObjectProperty

type CfnPipeline_ParameterObjectProperty struct {
	// The attributes of the parameter object.
	Attributes interface{} `json:"attributes" yaml:"attributes"`
	// The ID of the parameter object.
	Id *string `json:"id" yaml:"id"`
}

Contains information about a parameter object.

TODO: EXAMPLE

type CfnPipeline_ParameterValueProperty

type CfnPipeline_ParameterValueProperty struct {
	// The ID of the parameter value.
	Id *string `json:"id" yaml:"id"`
	// The field value, expressed as a String.
	StringValue *string `json:"stringValue" yaml:"stringValue"`
}

A value or list of parameter values.

TODO: EXAMPLE

type CfnPipeline_PipelineObjectProperty

type CfnPipeline_PipelineObjectProperty struct {
	// Key-value pairs that define the properties of the object.
	Fields interface{} `json:"fields" yaml:"fields"`
	// The ID of the object.
	Id *string `json:"id" yaml:"id"`
	// The name of the object.
	Name *string `json:"name" yaml:"name"`
}

PipelineObject is property of the AWS::DataPipeline::Pipeline resource that contains information about a pipeline object.

This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.

TODO: EXAMPLE

type CfnPipeline_PipelineTagProperty

type CfnPipeline_PipelineTagProperty struct {
	// The key name of a tag.
	Key *string `json:"key" yaml:"key"`
	// The value to associate with the key name.
	Value *string `json:"value" yaml:"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](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html) in the *AWS Data Pipeline Developer Guide* .

TODO: EXAMPLE