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
When making an API call, you may pass PipelineDeclaration data as a hash:
{
name: "PipelineName", # required
role_arn: "RoleArn", # required
artifact_store: {
type: "S3", # required, accepts S3
location: "ArtifactStoreLocation", # required
encryption_key: {
id: "EncryptionKeyId", # required
type: "KMS", # required, accepts KMS
},
},
artifact_stores: {
"AWSRegionName" => {
type: "S3", # required, accepts S3
location: "ArtifactStoreLocation", # required
encryption_key: {
id: "EncryptionKeyId", # required
type: "KMS", # required, accepts KMS
},
},
},
stages: [ # required
{
name: "StageName", # required
blockers: [
{
name: "BlockerName", # required
type: "Schedule", # required, accepts Schedule
},
],
actions: [ # required
{
name: "ActionName", # required
action_type_id: { # required
category: "Source", # required, accepts Source, Build, Deploy, Test, Invoke, Approval
owner: "AWS", # required, accepts AWS, ThirdParty, Custom
provider: "ActionProvider", # required
version: "Version", # required
},
run_order: 1,
configuration: {
"ActionConfigurationKey" => "ActionConfigurationValue",
},
output_artifacts: [
{
name: "ArtifactName", # required
},
],
input_artifacts: [
{
name: "ArtifactName", # required
},
],
role_arn: "RoleArn",
region: "AWSRegionName",
namespace: "ActionNamespace",
},
],
},
],
version: 1,
}
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 AWS Regions. -
#name ⇒ String
The name of the pipeline.
-
#role_arn ⇒ String
The Amazon Resource Name (ARN) for AWS 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.
-
#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
.
3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 |
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3404 class PipelineDeclaration < Struct.new( :name, :role_arn, :artifact_store, :artifact_stores, :stages, :version) SENSITIVE = [] include Aws::Structure end |
#artifact_stores ⇒ Hash<String,Types::ArtifactStore>
A mapping of artifactStore
objects and their corresponding AWS
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
.
3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 |
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3404 class PipelineDeclaration < Struct.new( :name, :role_arn, :artifact_store, :artifact_stores, :stages, :version) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the pipeline.
3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 |
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3404 class PipelineDeclaration < Struct.new( :name, :role_arn, :artifact_store, :artifact_stores, :stages, :version) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ String
The Amazon Resource Name (ARN) for AWS CodePipeline to use to either
perform actions with no actionRoleArn
, or to use to assume roles
for actions with an actionRoleArn
.
3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 |
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3404 class PipelineDeclaration < Struct.new( :name, :role_arn, :artifact_store, :artifact_stores, :stages, :version) SENSITIVE = [] include Aws::Structure end |
#stages ⇒ Array<Types::StageDeclaration>
The stage in which to perform the action.
3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 |
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3404 class PipelineDeclaration < Struct.new( :name, :role_arn, :artifact_store, :artifact_stores, :stages, :version) 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.
3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 |
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3404 class PipelineDeclaration < Struct.new( :name, :role_arn, :artifact_store, :artifact_stores, :stages, :version) SENSITIVE = [] include Aws::Structure end |