@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class PipelineDeclaration extends Object implements Serializable, Cloneable, StructuredPojo
Represents the structure of actions and stages to be performed in the pipeline.
Constructor and Description |
---|
PipelineDeclaration() |
Modifier and Type | Method and Description |
---|---|
PipelineDeclaration |
addArtifactStoresEntry(String key,
ArtifactStore value)
Add a single ArtifactStores entry
|
PipelineDeclaration |
clearArtifactStoresEntries()
Removes all the entries added into ArtifactStores.
|
PipelineDeclaration |
clone() |
boolean |
equals(Object obj) |
ArtifactStore |
getArtifactStore()
Represents information about the S3 bucket where artifacts are stored for the pipeline.
|
Map<String,ArtifactStore> |
getArtifactStores()
A mapping of
artifactStore objects and their corresponding Amazon Web Services Regions. |
String |
getExecutionMode()
The method that the pipeline will use to handle multiple executions.
|
String |
getName()
The name of the pipeline.
|
String |
getPipelineType()
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.
|
String |
getRoleArn()
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 . |
List<StageDeclaration> |
getStages()
The stage in which to perform the action.
|
List<PipelineTriggerDeclaration> |
getTriggers()
The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.
|
List<PipelineVariableDeclaration> |
getVariables()
A list that defines the pipeline variables for a pipeline resource.
|
Integer |
getVersion()
The version number of the pipeline.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setArtifactStore(ArtifactStore artifactStore)
Represents information about the S3 bucket where artifacts are stored for the pipeline.
|
void |
setArtifactStores(Map<String,ArtifactStore> artifactStores)
A mapping of
artifactStore objects and their corresponding Amazon Web Services Regions. |
void |
setExecutionMode(String executionMode)
The method that the pipeline will use to handle multiple executions.
|
void |
setName(String name)
The name of the pipeline.
|
void |
setPipelineType(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.
|
void |
setRoleArn(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 . |
void |
setStages(Collection<StageDeclaration> stages)
The stage in which to perform the action.
|
void |
setTriggers(Collection<PipelineTriggerDeclaration> triggers)
The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.
|
void |
setVariables(Collection<PipelineVariableDeclaration> variables)
A list that defines the pipeline variables for a pipeline resource.
|
void |
setVersion(Integer version)
The version number of the pipeline.
|
String |
toString()
Returns a string representation of this object.
|
PipelineDeclaration |
withArtifactStore(ArtifactStore artifactStore)
Represents information about the S3 bucket where artifacts are stored for the pipeline.
|
PipelineDeclaration |
withArtifactStores(Map<String,ArtifactStore> artifactStores)
A mapping of
artifactStore objects and their corresponding Amazon Web Services Regions. |
PipelineDeclaration |
withExecutionMode(ExecutionMode executionMode)
The method that the pipeline will use to handle multiple executions.
|
PipelineDeclaration |
withExecutionMode(String executionMode)
The method that the pipeline will use to handle multiple executions.
|
PipelineDeclaration |
withName(String name)
The name of the pipeline.
|
PipelineDeclaration |
withPipelineType(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 |
withPipelineType(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 |
withRoleArn(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 |
withStages(Collection<StageDeclaration> stages)
The stage in which to perform the action.
|
PipelineDeclaration |
withStages(StageDeclaration... stages)
The stage in which to perform the action.
|
PipelineDeclaration |
withTriggers(Collection<PipelineTriggerDeclaration> triggers)
The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.
|
PipelineDeclaration |
withTriggers(PipelineTriggerDeclaration... triggers)
The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.
|
PipelineDeclaration |
withVariables(Collection<PipelineVariableDeclaration> variables)
A list that defines the pipeline variables for a pipeline resource.
|
PipelineDeclaration |
withVariables(PipelineVariableDeclaration... variables)
A list that defines the pipeline variables for a pipeline resource.
|
PipelineDeclaration |
withVersion(Integer version)
The version number of the pipeline.
|
public void setName(String name)
The name of the pipeline.
name
- The name of the pipeline.public String getName()
The name of the pipeline.
public PipelineDeclaration withName(String name)
The name of the pipeline.
name
- The name of the pipeline.public void setRoleArn(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
.
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
.public String getRoleArn()
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
.
actionRoleArn
, or to use to assume roles for actions with an actionRoleArn
.public PipelineDeclaration withRoleArn(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
.
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
.public void setArtifactStore(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
.
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
.
public ArtifactStore getArtifactStore()
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
.
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
.
public PipelineDeclaration withArtifactStore(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
.
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
.
public Map<String,ArtifactStore> getArtifactStores()
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
.
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
.
public void setArtifactStores(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
.
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
.
public PipelineDeclaration withArtifactStores(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
.
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
.
public PipelineDeclaration addArtifactStoresEntry(String key, ArtifactStore value)
public PipelineDeclaration clearArtifactStoresEntries()
public List<StageDeclaration> getStages()
The stage in which to perform the action.
public void setStages(Collection<StageDeclaration> stages)
The stage in which to perform the action.
stages
- The stage in which to perform the action.public PipelineDeclaration withStages(StageDeclaration... stages)
The stage in which to perform the action.
NOTE: This method appends the values to the existing list (if any). Use
setStages(java.util.Collection)
or withStages(java.util.Collection)
if you want to override the
existing values.
stages
- The stage in which to perform the action.public PipelineDeclaration withStages(Collection<StageDeclaration> stages)
The stage in which to perform the action.
stages
- The stage in which to perform the action.public void setVersion(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.
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.public Integer getVersion()
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.
public PipelineDeclaration withVersion(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.
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.public void setExecutionMode(String executionMode)
The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
executionMode
- The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.ExecutionMode
public String getExecutionMode()
The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
ExecutionMode
public PipelineDeclaration withExecutionMode(String executionMode)
The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
executionMode
- The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.ExecutionMode
public PipelineDeclaration withExecutionMode(ExecutionMode executionMode)
The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
executionMode
- The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.ExecutionMode
public void setPipelineType(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?.
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?.
PipelineType
public String getPipelineType()
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?.
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?.
PipelineType
public PipelineDeclaration withPipelineType(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?.
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?.
PipelineType
public PipelineDeclaration withPipelineType(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?.
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?.
PipelineType
public List<PipelineVariableDeclaration> getVariables()
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@\-_]+
.
[A-Za-z0-9@\-_]+
.public void setVariables(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@\-_]+
.
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@\-_]+
.public PipelineDeclaration withVariables(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@\-_]+
.
NOTE: This method appends the values to the existing list (if any). Use
setVariables(java.util.Collection)
or withVariables(java.util.Collection)
if you want to
override the existing values.
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@\-_]+
.public PipelineDeclaration withVariables(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@\-_]+
.
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@\-_]+
.public List<PipelineTriggerDeclaration> getTriggers()
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.
When a trigger configuration is specified, default change detection for repository and branch commits is disabled.
public void setTriggers(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.
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.
public PipelineDeclaration withTriggers(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.
NOTE: This method appends the values to the existing list (if any). Use
setTriggers(java.util.Collection)
or withTriggers(java.util.Collection)
if you want to override
the existing values.
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.
public PipelineDeclaration withTriggers(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.
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.
public String toString()
toString
in class Object
Object.toString()
public PipelineDeclaration clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.