You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Contains pipeline metadata.

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

Description of the pipeline.

Returns:

  • (String)


725
726
727
728
729
730
731
732
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 725

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

#fieldsArray<Types::Field>

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

Returns:



725
726
727
728
729
730
731
732
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 725

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

#nameString

The name of the pipeline.

Returns:

  • (String)


725
726
727
728
729
730
731
732
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 725

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

#pipeline_idString

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

Returns:

  • (String)


725
726
727
728
729
730
731
732
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 725

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

#tagsArray<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.

Returns:



725
726
727
728
729
730
731
732
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 725

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