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

Class: Aws::DataPipeline::Types::CreatePipelineInput

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

Overview

Note:

When making an API call, you may pass CreatePipelineInput data as a hash:

{
  name: "id", # required
  unique_id: "id", # required
  description: "string",
  tags: [
    {
      key: "tagKey", # required
      value: "tagValue", # required
    },
  ],
}

Contains the parameters for CreatePipeline.

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

The description for the pipeline.

Returns:

  • (String)


148
149
150
151
152
153
154
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 148

class CreatePipelineInput < Struct.new(
  :name,
  :unique_id,
  :description,
  :tags)
  include Aws::Structure
end

#nameString

The name for the pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each pipeline a unique pipeline identifier.

Returns:

  • (String)


148
149
150
151
152
153
154
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 148

class CreatePipelineInput < Struct.new(
  :name,
  :unique_id,
  :description,
  :tags)
  include Aws::Structure
end

#tagsArray<Types::Tag>

A list of tags to associate with the pipeline at creation. Tags let you control access to pipelines. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.

Returns:



148
149
150
151
152
153
154
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 148

class CreatePipelineInput < Struct.new(
  :name,
  :unique_id,
  :description,
  :tags)
  include Aws::Structure
end

#unique_idString

A unique identifier. This identifier is not the same as the pipeline identifier assigned by AWS Data Pipeline. You are responsible for defining the format and ensuring the uniqueness of this identifier. You use this parameter to ensure idempotency during repeated calls to CreatePipeline. For example, if the first call to CreatePipeline does not succeed, you can pass in the same unique identifier and pipeline name combination on a subsequent call to CreatePipeline. CreatePipeline ensures that if a pipeline already exists with the same name and unique identifier, a new pipeline is not created. Instead, you'll receive the pipeline identifier from the previous attempt. The uniqueness of the name and unique identifier combination is scoped to the AWS account or IAM user credentials.

Returns:

  • (String)


148
149
150
151
152
153
154
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 148

class CreatePipelineInput < Struct.new(
  :name,
  :unique_id,
  :description,
  :tags)
  include Aws::Structure
end