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

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

Inherits:

Struct

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

show all

Defined in:: (unknown)

Overview

Note:

When passing DeactivatePipelineInput as input to an Aws::Client method, you can use a vanilla 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) —
Indicates whether to cancel any running objects.

#pipeline_id ⇒ `String`

The ID of the pipeline.