software.amazon.awssdk.services.codepipeline.model

Interface PipelineDeclaration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<PipelineDeclaration.Builder,PipelineDeclaration>, SdkBuilder<PipelineDeclaration.Builder,PipelineDeclaration>, SdkPojo

Enclosing class:

PipelineDeclaration

public static interface PipelineDeclaration.Builder
extends SdkPojo, CopyableBuilder<PipelineDeclaration.Builder,PipelineDeclaration>

Method Summary

Modifier and Type	Method and Description
PipelineDeclaration.Builder	artifactStore(ArtifactStore artifactStore) Represents information about the S3 bucket where artifacts are stored for the pipeline.
default PipelineDeclaration.Builder	artifactStore(Consumer<ArtifactStore.Builder> artifactStore) Represents information about the S3 bucket where artifacts are stored for the pipeline.
PipelineDeclaration.Builder	artifactStores(Map<String,ArtifactStore> artifactStores) A mapping of artifactStore objects and their corresponding Amazon Web Services Regions.
PipelineDeclaration.Builder	name(String name) The name of the pipeline.
PipelineDeclaration.Builder	roleArn(String 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.
PipelineDeclaration.Builder	stages(Collection<StageDeclaration> stages) The stage in which to perform the action.
PipelineDeclaration.Builder	stages(Consumer<StageDeclaration.Builder>... stages) The stage in which to perform the action.
PipelineDeclaration.Builder	stages(StageDeclaration... stages) The stage in which to perform the action.
PipelineDeclaration.Builder	version(Integer version) The version number of the pipeline.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

name

PipelineDeclaration.Builder name(String name)

The name of the pipeline.

Parameters:

name - The name of the pipeline.

Returns:

Returns a reference to this object so that method calls can be chained together.

roleArn

PipelineDeclaration.Builder roleArn(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

artifactStore

PipelineDeclaration.Builder artifactStore(ArtifactStore 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

artifactStore

default PipelineDeclaration.Builder artifactStore(Consumer<ArtifactStore.Builder> 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.

This is a convenience method that creates an instance of the ArtifactStore.Builder avoiding the need to create one manually via ArtifactStore.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to artifactStore(ArtifactStore).

Parameters:

artifactStore - a consumer that will call methods on ArtifactStore.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

artifactStore(ArtifactStore)

artifactStores

PipelineDeclaration.Builder artifactStores(Map<String,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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

stages

PipelineDeclaration.Builder stages(Collection<StageDeclaration> stages)

The stage in which to perform the action.

Parameters:

stages - The stage in which to perform the action.

Returns:

Returns a reference to this object so that method calls can be chained together.

stages

PipelineDeclaration.Builder stages(StageDeclaration... stages)

The stage in which to perform the action.

Parameters:

stages - The stage in which to perform the action.

Returns:

Returns a reference to this object so that method calls can be chained together.

stages

PipelineDeclaration.Builder stages(Consumer<StageDeclaration.Builder>... stages)

The stage in which to perform the action.

This is a convenience method that creates an instance of the StageDeclaration.Builder avoiding the need to create one manually via StageDeclaration.builder() .

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #stages(List).

Parameters:

stages - a consumer that will call methods on StageDeclaration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#stages(java.util.Collection)

version

PipelineDeclaration.Builder version(Integer 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.