Skip to content

/AWS1/CL_PIPPLINDECLARATION

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

CONSTRUCTOR

IMPORTING

Required arguments:

iv_name TYPE /AWS1/PIPPIPELINENAME /AWS1/PIPPIPELINENAME

The name of the pipeline.

iv_rolearn TYPE /AWS1/PIPROLEARN /AWS1/PIPROLEARN

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.

it_stages TYPE /AWS1/CL_PIPSTAGEDECLARATION=>TT_PLINSTAGEDECLARATIONLIST TT_PLINSTAGEDECLARATIONLIST

The stage in which to perform the action.

Optional arguments:

io_artifactstore TYPE REF TO /AWS1/CL_PIPARTIFACTSTORE /AWS1/CL_PIPARTIFACTSTORE

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.

it_artifactstores TYPE /AWS1/CL_PIPARTIFACTSTORE=>TT_ARTIFACTSTOREMAP TT_ARTIFACTSTOREMAP

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.

iv_version TYPE /AWS1/PIPPIPELINEVERSION /AWS1/PIPPIPELINEVERSION

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.

iv_executionmode TYPE /AWS1/PIPEXECUTIONMODE /AWS1/PIPEXECUTIONMODE

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

iv_pipelinetype TYPE /AWS1/PIPPIPELINETYPE /AWS1/PIPPIPELINETYPE

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?.

it_variables TYPE /AWS1/CL_PIPPLVARIABLEDECLAR00=>TT_PLINVARIABLEDECLARATIONLIST TT_PLINVARIABLEDECLARATIONLIST

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@-_]+.

it_triggers TYPE /AWS1/CL_PIPPLTRIGGERDECLARA00=>TT_PLINTRIGGERDECLARATIONLIST TT_PLINTRIGGERDECLARATIONLIST

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.

Queryable Attributes

name

The name of the pipeline.

Accessible with the following methods

Method Description
GET_NAME() Getter for NAME, with configurable default
ASK_NAME() Getter for NAME w/ exceptions if field has no value
HAS_NAME() Determine if NAME has a value

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.

Accessible with the following methods

Method Description
GET_ROLEARN() Getter for ROLEARN, with configurable default
ASK_ROLEARN() Getter for ROLEARN w/ exceptions if field has no value
HAS_ROLEARN() Determine if ROLEARN has a value

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.

Accessible with the following methods

Method Description
GET_ARTIFACTSTORE() Getter for ARTIFACTSTORE

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.

Accessible with the following methods

Method Description
GET_ARTIFACTSTORES() Getter for ARTIFACTSTORES, with configurable default
ASK_ARTIFACTSTORES() Getter for ARTIFACTSTORES w/ exceptions if field has no valu
HAS_ARTIFACTSTORES() Determine if ARTIFACTSTORES has a value

stages

The stage in which to perform the action.

Accessible with the following methods

Method Description
GET_STAGES() Getter for STAGES, with configurable default
ASK_STAGES() Getter for STAGES w/ exceptions if field has no value
HAS_STAGES() Determine if STAGES has a value

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.

Accessible with the following methods

Method Description
GET_VERSION() Getter for VERSION, with configurable default
ASK_VERSION() Getter for VERSION w/ exceptions if field has no value
HAS_VERSION() Determine if VERSION has a value

executionMode

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

Accessible with the following methods

Method Description
GET_EXECUTIONMODE() Getter for EXECUTIONMODE, with configurable default
ASK_EXECUTIONMODE() Getter for EXECUTIONMODE w/ exceptions if field has no value
HAS_EXECUTIONMODE() Determine if EXECUTIONMODE has a value

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?.

Accessible with the following methods

Method Description
GET_PIPELINETYPE() Getter for PIPELINETYPE, with configurable default
ASK_PIPELINETYPE() Getter for PIPELINETYPE w/ exceptions if field has no value
HAS_PIPELINETYPE() Determine if PIPELINETYPE has a value

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@-_]+.

Accessible with the following methods

Method Description
GET_VARIABLES() Getter for VARIABLES, with configurable default
ASK_VARIABLES() Getter for VARIABLES w/ exceptions if field has no value
HAS_VARIABLES() Determine if VARIABLES has a value

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.

Accessible with the following methods

Method Description
GET_TRIGGERS() Getter for TRIGGERS, with configurable default
ASK_TRIGGERS() Getter for TRIGGERS w/ exceptions if field has no value
HAS_TRIGGERS() Determine if TRIGGERS has a value