Struct aws_sdk_codepipeline::types::builders::PipelineDeclarationBuilder

#[non_exhaustive]
pub struct PipelineDeclarationBuilder { /* private fields */ }

A builder for PipelineDeclaration.

Implementations

impl PipelineDeclarationBuilder

pub fn name(self, input: impl Into<String>) -> Self

The name of the pipeline.

This field is required.

pub fn set_name(self, input: Option<String>) -> Self

The name of the pipeline.

pub fn get_name(&self) -> &Option<String>

The name of the pipeline.

pub fn role_arn(self, input: impl Into<String>) -> Self

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.

This field is required.

pub fn set_role_arn(self, input: Option<String>) -> Self

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 get_role_arn(&self) -> &Option<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.

pub fn artifact_store(self, input: ArtifactStore) -> Self

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 set_artifact_store(self, input: Option<ArtifactStore>) -> Self

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 get_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, k: impl Into<String>, v: ArtifactStore) -> Self

Adds a key-value pair to artifact_stores.

To override the contents of this collection use set_artifact_stores.

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 set_artifact_stores( self, input: Option<HashMap<String, ArtifactStore>> ) -> Self

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 get_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, input: StageDeclaration) -> Self

Appends an item to stages.

To override the contents of this collection use set_stages.

The stage in which to perform the action.

pub fn set_stages(self, input: Option<Vec<StageDeclaration>>) -> Self

The stage in which to perform the action.

pub fn get_stages(&self) -> &Option<Vec<StageDeclaration>>

The stage in which to perform the action.

pub fn version(self, input: i32) -> Self

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 set_version(self, input: Option<i32>) -> Self

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 get_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 pipeline_type(self, input: PipelineType) -> Self

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

V2 type pipelines, along with triggers on Git tags and pipeline-level variables, are not currently supported for CloudFormation and CDK resources in CodePipeline. For more information about V2 type pipelines, see Pipeline types in the CodePipeline User Guide.

pub fn set_pipeline_type(self, input: Option<PipelineType>) -> Self

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

V2 type pipelines, along with triggers on Git tags and pipeline-level variables, are not currently supported for CloudFormation and CDK resources in CodePipeline. For more information about V2 type pipelines, see Pipeline types in the CodePipeline User Guide.

pub fn get_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?.

V2 type pipelines, along with triggers on Git tags and pipeline-level variables, are not currently supported for CloudFormation and CDK resources in CodePipeline. For more information about V2 type pipelines, see Pipeline types in the CodePipeline User Guide.

pub fn triggers(self, input: PipelineTriggerDeclaration) -> Self

Appends an item to triggers.

To override the contents of this collection use set_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.

pub fn set_triggers( self, input: Option<Vec<PipelineTriggerDeclaration>> ) -> Self

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.

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

pub fn variables(self, input: PipelineVariableDeclaration) -> Self

Appends an item to variables.

To override the contents of this collection use set_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@\-_]+.

pub fn set_variables( self, input: Option<Vec<PipelineVariableDeclaration>> ) -> Self

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

pub fn get_variables(&self) -> &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@\-_]+.

pub fn build(self) -> Result<PipelineDeclaration, BuildError>

Consumes the builder and constructs a PipelineDeclaration. This method will fail if any of the following fields are not set:

• name
• role_arn
• stages

Trait Implementations

impl Clone for PipelineDeclarationBuilder

fn clone(&self) -> PipelineDeclarationBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PipelineDeclarationBuilder

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

Formats the value using the given formatter.

impl Default for PipelineDeclarationBuilder

fn default() -> PipelineDeclarationBuilder

Returns the “default value” for a type.

impl PartialEq for PipelineDeclarationBuilder

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for PipelineDeclarationBuilder