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

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

Overview

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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#abandonBoolean

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)


3939
3940
3941
3942
3943
3944
3945
3946
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3939

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

#pipeline_execution_idString

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

Returns:

  • (String)


3939
3940
3941
3942
3943
3944
3945
3946
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3939

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

#pipeline_nameString

The name of the pipeline to stop.

Returns:

  • (String)


3939
3940
3941
3942
3943
3944
3945
3946
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3939

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

#reasonString

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

Returns:

  • (String)


3939
3940
3941
3942
3943
3944
3945
3946
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3939

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