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
- 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:
