PipelineDeclaration
Represents the structure of actions and stages to be performed in the pipeline.
Contents
- name
-
The name of the pipeline.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[A-Za-z0-9.@\-_]+Required: Yes
- 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 anactionRoleArn.Type: String
Length Constraints: Maximum length of 1024.
Pattern:
arn:aws(-[\w]+)*:iam::[0-9]{12}:role/.*Required: Yes
- stages
-
The stage in which to perform the action.
Type: Array of StageDeclaration objects
Required: Yes
- artifactStore
-
Represents information about the S3 bucket where artifacts are stored for the pipeline.
Note
You must include either
artifactStoreorartifactStoresin your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must useartifactStores.Type: ArtifactStore object
Required: No
- artifactStores
-
A mapping of
artifactStoreobjects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.Note
You must include either
artifactStoreorartifactStoresin your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must useartifactStores.Type: String to ArtifactStore object map
Key Length Constraints: Minimum length of 4. Maximum length of 30.
Required: No
- executionMode
-
The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
Type: String
Valid Values:
QUEUED | SUPERSEDED | PARALLELRequired: No
- 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.
Important
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?.
Type: String
Valid Values:
V1 | V2Required: No
-
- triggers
-
The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.
Note
When a trigger configuration is specified, default change detection for repository and branch commits is disabled.
Type: Array of PipelineTriggerDeclaration objects
Array Members: Maximum number of 50 items.
Required: No
- 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@\-_]+.Type: Array of PipelineVariableDeclaration objects
Array Members: Maximum number of 50 items.
Required: No
- 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.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
