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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-codepipeline/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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>

Returns:

  • (Boolean) 


5281
5282
5283
5284
5285
5286
5287
5288
 
# File 'lib/aws-sdk-codepipeline/types.rb', line 5281

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.

Returns:

  • (String) 


5281
5282
5283
5284
5285
5286
5287
5288
 
# File 'lib/aws-sdk-codepipeline/types.rb', line 5281

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.

Returns:

  • (String) 


5281
5282
5283
5284
5285
5286
5287
5288
 
# File 'lib/aws-sdk-codepipeline/types.rb', line 5281

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.

Returns:

  • (String) 


5281
5282
5283
5284
5285
5286
5287
5288
 
# File 'lib/aws-sdk-codepipeline/types.rb', line 5281

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