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.

Represents the structure of actions and stages to be performed in the pipeline.

Inheritance Hierarchy

System.Object
  Amazon.CodePipeline.Model.PipelineDeclaration

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

Syntax

C#
public class PipelineDeclaration

The PipelineDeclaration type exposes the following members

Constructors

NameDescription
Public Method PipelineDeclaration()

Properties

NameTypeDescription
Public Property ArtifactStore Amazon.CodePipeline.Model.ArtifactStore

Gets and sets the property ArtifactStore.

Represents information about the S3 bucket where artifacts are stored for the pipeline.

You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

Public Property ArtifactStores System.Collections.Generic.Dictionary<System.String, Amazon.CodePipeline.Model.ArtifactStore>

Gets and sets the property ArtifactStores.

A mapping of artifactStore objects and their corresponding Amazon Web Services Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.

You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

Public Property ExecutionMode Amazon.CodePipeline.ExecutionMode

Gets and sets the property ExecutionMode.

The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.

Public Property Name System.String

Gets and sets the property Name.

The name of the pipeline.

Public Property PipelineType Amazon.CodePipeline.PipelineType

Gets and sets the property PipelineType.

CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.

  • V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters.

  • V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration.

Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when creating or updating a pipeline will result in the pipeline having the V2 type of pipeline and the associated costs.

For information about pricing for CodePipeline, see Pricing.

For information about which type of pipeline to choose, see What type of pipeline is right for me?.

Public Property RoleArn System.String

Gets and sets the property RoleArn.

The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.

Public Property Stages System.Collections.Generic.List<Amazon.CodePipeline.Model.StageDeclaration>

Gets and sets the property Stages.

The stage in which to perform the action.

Public Property Triggers System.Collections.Generic.List<Amazon.CodePipeline.Model.PipelineTriggerDeclaration>

Gets and sets the property Triggers.

The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.

When a trigger configuration is specified, default change detection for repository and branch commits is disabled.

Public Property Variables System.Collections.Generic.List<Amazon.CodePipeline.Model.PipelineVariableDeclaration>

Gets and sets the property Variables.

A list that defines the pipeline variables for a pipeline resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9@\-_]+.

Public Property Version System.Int32

Gets and sets the property Version.

The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.

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