Class: Aws::DataPipeline::Types::PipelineDescription

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-datapipeline/types.rb

Overview

Contains pipeline metadata.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

Description of the pipeline.

Returns:

  • (String) 


642
643
644
645
646
647
648
649
650
 
# File 'lib/aws-sdk-datapipeline/types.rb', line 642

class PipelineDescription < Struct.new(
  :pipeline_id,
  :name,
  :fields,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#fields ⇒ Array<Types::Field>

A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.

Returns:



642
643
644
645
646
647
648
649
650
 
# File 'lib/aws-sdk-datapipeline/types.rb', line 642

class PipelineDescription < Struct.new(
  :pipeline_id,
  :name,
  :fields,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the pipeline.

Returns:

  • (String) 


642
643
644
645
646
647
648
649
650
 
# File 'lib/aws-sdk-datapipeline/types.rb', line 642

class PipelineDescription < Struct.new(
  :pipeline_id,
  :name,
  :fields,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#pipeline_id ⇒ String

The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form ‘df-297EG78HU43EEXAMPLE`.

Returns:

  • (String) 


642
643
644
645
646
647
648
649
650
 
# File 'lib/aws-sdk-datapipeline/types.rb', line 642

class PipelineDescription < Struct.new(
  :pipeline_id,
  :name,
  :fields,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A list of tags to associated with a pipeline. Tags let you control access to pipelines. For more information, see [Controlling User Access to Pipelines] in the *AWS Data Pipeline Developer Guide*.

[1]: docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html

Returns:



642
643
644
645
646
647
648
649
650
 
# File 'lib/aws-sdk-datapipeline/types.rb', line 642

class PipelineDescription < Struct.new(
  :pipeline_id,
  :name,
  :fields,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end