AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the DeactivatePipeline operation. Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING state until the deactivation process completes.

To resume a deactivated pipeline, use ActivatePipeline. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.DataPipeline.AmazonDataPipelineRequest
      Amazon.DataPipeline.Model.DeactivatePipelineRequest

Namespace: Amazon.DataPipeline.Model
Assembly: AWSSDK.DataPipeline.dll
Version: 3.x.y.z

Syntax

C# 
public class DeactivatePipelineRequest : AmazonDataPipelineRequest
         IAmazonWebServiceRequest

The DeactivatePipelineRequest type exposes the following members

Constructors

NameDescription
Public Method DeactivatePipelineRequest()

Properties

NameTypeDescription
Public Property CancelActive System.Boolean

Gets and sets the property CancelActive.

Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish.

Public Property PipelineId System.String

Gets and sets the property PipelineId.

The ID of the pipeline.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5