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

Class: Aws::DataPipeline::Types::DeactivatePipelineInput

Inherits:

Struct

Object
Struct
Aws::DataPipeline::Types::DeactivatePipelineInput

show all

Defined in:: gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb

Overview

Note:

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

{
  pipeline_id: "id", # required
  cancel_active: false,
}

Contains the parameters for DeactivatePipeline.

Instance Attribute Summary collapse

#cancel_active ⇒ Boolean
Indicates whether to cancel any running objects.
#pipeline_id ⇒ String
The ID of the pipeline.

Instance Attribute Details

#cancel_active ⇒ `Boolean`

Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish.

Returns:

(Boolean)

# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 193

class DeactivatePipelineInput < Struct.new(
  :pipeline_id,
  :cancel_active)
  include Aws::Structure
end

#pipeline_id ⇒ `String`

The ID of the pipeline.