Struct PipelineDeclaration

#[non_exhaustive]
pub struct PipelineDeclaration {
    pub name: String,
    pub role_arn: String,
    pub artifact_store: Option<ArtifactStore>,
    pub artifact_stores: Option<HashMap<String, ArtifactStore>>,
    pub stages: Vec<StageDeclaration>,
    pub version: Option<i32>,
    pub execution_mode: Option<ExecutionMode>,
    pub pipeline_type: Option<PipelineType>,
    pub variables: Option<Vec<PipelineVariableDeclaration>>,
    pub triggers: Option<Vec<PipelineTriggerDeclaration>>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

The name of the pipeline.

role_arn: String

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.

artifact_store: Option<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.

artifact_stores: Option<HashMap<String, ArtifactStore>>

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.

stages: Vec<StageDeclaration>

The stage in which to perform the action.

version: Option<i32>

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.

execution_mode: Option<ExecutionMode>

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

pipeline_type: Option<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?.

variables: Option<Vec<PipelineVariableDeclaration>>

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

triggers: Option<Vec<PipelineTriggerDeclaration>>

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.

Implementations

impl PipelineDeclaration

pub fn name(&self) -> &str

The name of the pipeline.

pub fn role_arn(&self) -> &str

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.

pub fn artifact_store(&self) -> Option<&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.

pub fn artifact_stores(&self) -> Option<&HashMap<String, ArtifactStore>>

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.

pub fn stages(&self) -> &[StageDeclaration]

The stage in which to perform the action.

pub fn version(&self) -> Option<i32>

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.

pub fn execution_mode(&self) -> Option<&ExecutionMode>

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

pub fn pipeline_type(&self) -> Option<&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?.

pub fn variables(&self) -> &[PipelineVariableDeclaration]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .variables.is_none().

pub fn triggers(&self) -> &[PipelineTriggerDeclaration]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .triggers.is_none().

impl PipelineDeclaration

pub fn builder() -> PipelineDeclarationBuilder

Creates a new builder-style object to manufacture PipelineDeclaration.

Trait Implementations

impl Clone for PipelineDeclaration

fn clone(&self) -> PipelineDeclaration

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PipelineDeclaration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for PipelineDeclaration

fn eq(&self, other: &PipelineDeclaration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PipelineDeclaration