class Aws::CodePipeline::Types::StopPipelineExecutionInput
@note When making an API call, you may pass StopPipelineExecutionInput
data as a hash: { pipeline_name: "PipelineName", # required pipeline_execution_id: "PipelineExecutionId", # required abandon: false, reason: "StopPipelineExecutionReason", }
@!attribute [rw] pipeline_name
The name of the pipeline to stop. @return [String]
@!attribute [rw] pipeline_execution_id
The ID of the pipeline execution to be stopped in the current stage. Use the `GetPipelineState` action to retrieve the current pipelineExecutionId. @return [String]
@!attribute [rw] abandon
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> @return [Boolean]
@!attribute [rw] reason
Use this option to enter comments, such as the reason the pipeline was stopped. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/StopPipelineExecutionInput AWS API Documentation
Constants
- SENSITIVE