Class: Aws::CodePipeline::Types::StopPipelineExecutionInput

Inherits:

Struct

• Object
• Struct
• Aws::CodePipeline::Types::StopPipelineExecutionInput

Includes:

Structure

Defined in:

lib/aws-sdk-codepipeline/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #abandon ⇒ Boolean

  Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.

• #pipeline_execution_id ⇒ String

  The ID of the pipeline execution to be stopped in the current stage.

• #pipeline_name ⇒ String

  The name of the pipeline to stop.

• #reason ⇒ String

  Use this option to enter comments, such as the reason the pipeline was stopped.

Instance Attribute Details

#abandon ⇒ Boolean

Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.

<note markdown=“1”> This option can lead to failed or out-of-sequence tasks.

</note>

# File 'lib/aws-sdk-codepipeline/types.rb', line 5536

class StopPipelineExecutionInput < Struct.new(
  :pipeline_name,
  :pipeline_execution_id,
  :abandon,
  :reason)
  SENSITIVE = []
  include Aws::Structure
end

#pipeline_execution_id ⇒ String

The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

# File 'lib/aws-sdk-codepipeline/types.rb', line 5536

class StopPipelineExecutionInput < Struct.new(
  :pipeline_name,
  :pipeline_execution_id,
  :abandon,
  :reason)
  SENSITIVE = []
  include Aws::Structure
end

#pipeline_name ⇒ String

The name of the pipeline to stop.

# File 'lib/aws-sdk-codepipeline/types.rb', line 5536

class StopPipelineExecutionInput < Struct.new(
  :pipeline_name,
  :pipeline_execution_id,
  :abandon,
  :reason)
  SENSITIVE = []
  include Aws::Structure
end

#reason ⇒ String

Use this option to enter comments, such as the reason the pipeline was stopped.

# File 'lib/aws-sdk-codepipeline/types.rb', line 5536

class StopPipelineExecutionInput < Struct.new(
  :pipeline_name,
  :pipeline_execution_id,
  :abandon,
  :reason)
  SENSITIVE = []
  include Aws::Structure
end