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
- Struct
- Aws::CodePipeline::Types::StopPipelineExecutionInput
- Defined in:
- (unknown)
Overview
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",
}
Instance Attribute Summary collapse
-
#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.
#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.
#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.