Class: Aws::CodePipeline::Types::PipelineDeclaration
- Inherits:
-
Struct
- Object
- Struct
- Aws::CodePipeline::Types::PipelineDeclaration
- Defined in:
- gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb
Overview
Represents the structure of actions and stages to be performed in the pipeline.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#artifact_store ⇒ Types::ArtifactStore
Represents information about the S3 bucket where artifacts are stored for the pipeline.
-
#artifact_stores ⇒ Hash<String,Types::ArtifactStore>
A mapping of
artifactStore
objects and their corresponding Amazon Web Services Regions. -
#execution_mode ⇒ String
The method that the pipeline will use to handle multiple executions.
-
#name ⇒ String
The name of the pipeline.
-
#pipeline_type ⇒ String
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.
-
#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 anactionRoleArn
. -
#stages ⇒ Array<Types::StageDeclaration>
The stage in which to perform the action.
-
#triggers ⇒ Array<Types::PipelineTriggerDeclaration>
The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.
-
#variables ⇒ Array<Types::PipelineVariableDeclaration>
A list that defines the pipeline variables for a pipeline resource.
-
#version ⇒ Integer
The version number of the pipeline.
Instance Attribute Details
#artifact_store ⇒ Types::ArtifactStore
Represents information about the S3 bucket where artifacts are stored for the pipeline.
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
.
3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 |
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3271 class PipelineDeclaration < Struct.new( :name, :role_arn, :artifact_store, :artifact_stores, :stages, :version, :execution_mode, :pipeline_type, :variables, :triggers) SENSITIVE = [] include Aws::Structure end |
#artifact_stores ⇒ Hash<String,Types::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.
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
.
3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 |
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3271 class PipelineDeclaration < Struct.new( :name, :role_arn, :artifact_store, :artifact_stores, :stages, :version, :execution_mode, :pipeline_type, :variables, :triggers) SENSITIVE = [] include Aws::Structure end |
#execution_mode ⇒ String
The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 |
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3271 class PipelineDeclaration < Struct.new( :name, :role_arn, :artifact_store, :artifact_stores, :stages, :version, :execution_mode, :pipeline_type, :variables, :triggers) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the pipeline.
3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 |
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3271 class PipelineDeclaration < Struct.new( :name, :role_arn, :artifact_store, :artifact_stores, :stages, :version, :execution_mode, :pipeline_type, :variables, :triggers) SENSITIVE = [] include Aws::Structure end |
#pipeline_type ⇒ String
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?.
3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 |
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3271 class PipelineDeclaration < Struct.new( :name, :role_arn, :artifact_store, :artifact_stores, :stages, :version, :execution_mode, :pipeline_type, :variables, :triggers) SENSITIVE = [] include Aws::Structure end |
#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
.
3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 |
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3271 class PipelineDeclaration < Struct.new( :name, :role_arn, :artifact_store, :artifact_stores, :stages, :version, :execution_mode, :pipeline_type, :variables, :triggers) SENSITIVE = [] include Aws::Structure end |
#stages ⇒ Array<Types::StageDeclaration>
The stage in which to perform the action.
3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 |
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3271 class PipelineDeclaration < Struct.new( :name, :role_arn, :artifact_store, :artifact_stores, :stages, :version, :execution_mode, :pipeline_type, :variables, :triggers) SENSITIVE = [] include Aws::Structure end |
#triggers ⇒ Array<Types::PipelineTriggerDeclaration>
The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.
3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 |
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3271 class PipelineDeclaration < Struct.new( :name, :role_arn, :artifact_store, :artifact_stores, :stages, :version, :execution_mode, :pipeline_type, :variables, :triggers) SENSITIVE = [] include Aws::Structure end |
#variables ⇒ Array<Types::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@\-_]+
.
3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 |
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3271 class PipelineDeclaration < Struct.new( :name, :role_arn, :artifact_store, :artifact_stores, :stages, :version, :execution_mode, :pipeline_type, :variables, :triggers) SENSITIVE = [] include Aws::Structure end |
#version ⇒ Integer
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.
3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 |
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3271 class PipelineDeclaration < Struct.new( :name, :role_arn, :artifact_store, :artifact_stores, :stages, :version, :execution_mode, :pipeline_type, :variables, :triggers) SENSITIVE = [] include Aws::Structure end |