PipelineDeclaration.Builder (AWS Java SDK :: Services

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

All Methods Instance Methods Abstract Methods Default Methods
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`	`pipelineType(PipelineType 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.
`PipelineDeclaration.Builder`	`pipelineType(String 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.
`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`	`triggers(Collection<PipelineTriggerDeclaration> triggers)` The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.
`PipelineDeclaration.Builder`	`triggers(Consumer<PipelineTriggerDeclaration.Builder>... triggers)` The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.
`PipelineDeclaration.Builder`	`triggers(PipelineTriggerDeclaration... triggers)` The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.
`PipelineDeclaration.Builder`	`variables(Collection<PipelineVariableDeclaration> variables)` A list that defines the pipeline variables for a pipeline resource.
`PipelineDeclaration.Builder`	`variables(Consumer<PipelineVariableDeclaration.Builder>... variables)` A list that defines the pipeline variables for a pipeline resource.
`PipelineDeclaration.Builder`	`variables(PipelineVariableDeclaration... variables)` A list that defines the pipeline variables for a pipeline resource.
`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.
  - pipelineType
```
PipelineDeclaration.Builder pipelineType(String 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?.
    Parameters:
    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?.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PipelineType, PipelineType
  - pipelineType
```
PipelineDeclaration.Builder pipelineType(PipelineType 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?.
    Parameters:
    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?.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PipelineType, PipelineType
  - triggers
```
PipelineDeclaration.Builder triggers(Collection<PipelineTriggerDeclaration> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - triggers
```
PipelineDeclaration.Builder triggers(PipelineTriggerDeclaration... 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - triggers
```
PipelineDeclaration.Builder triggers(Consumer<PipelineTriggerDeclaration.Builder>... 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.
    This is a convenience method that creates an instance of the PipelineTriggerDeclaration.Builder avoiding the need to create one manually via PipelineTriggerDeclaration.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #triggers(List).
    
    Parameters:
    
    triggers - a consumer that will call methods on PipelineTriggerDeclaration.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #triggers(java.util.Collection)
  - variables
```
PipelineDeclaration.Builder variables(Collection<PipelineVariableDeclaration> 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@\-_]+.
    
    Parameters:
    
    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@\-_]+.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - variables
```
PipelineDeclaration.Builder variables(PipelineVariableDeclaration... 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@\-_]+.
    
    Parameters:
    
    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@\-_]+.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - variables
```
PipelineDeclaration.Builder variables(Consumer<PipelineVariableDeclaration.Builder>... 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@\-_]+.
    This is a convenience method that creates an instance of the PipelineVariableDeclaration.Builder avoiding the need to create one manually via PipelineVariableDeclaration.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #variables(List).
    
    Parameters:
    
    variables - a consumer that will call methods on PipelineVariableDeclaration.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #variables(java.util.Collection)

Interface PipelineDeclaration.Builder

Method Summary

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

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

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

Method Detail

name

roleArn

artifactStore

artifactStore

artifactStores

stages

stages

stages

version

pipelineType

pipelineType

triggers

triggers

triggers

variables

variables

variables