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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-datapipeline/types.rb

Overview

Contains the parameters for DeactivatePipeline.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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 'lib/aws-sdk-datapipeline/types.rb', line 149

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

#pipeline_id ⇒ String

The ID of the pipeline.

Returns:

• (String)

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

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