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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing StopPipelineExecutionInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  pipeline_name: "PipelineName", # required
  pipeline_execution_id: "PipelineExecutionId", # required
  abandon: false,
  reason: "StopPipelineExecutionReason",
}

See Also:

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.

This option can lead to failed or out-of-sequence tasks.

Returns:

  • (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. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

Returns:

  • (String) —

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

#pipeline_name ⇒ String

The name of the pipeline to stop.

Returns:

  • (String) —

    The name of the pipeline to stop.

#reason ⇒ String

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

Returns:

  • (String) —

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