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

Inherits:

Struct

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

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.

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 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 199

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

#pipeline_id ⇒ String

The ID of the pipeline.

Returns:

• (String)

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

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