You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CodePipeline::Types::PipelineDeclaration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb

Overview

Note:

When making an API call, you may pass PipelineDeclaration data as a hash:

{
  name: "PipelineName", # required
  role_arn: "RoleArn", # required
  artifact_store: { # required
    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",
        },
      ],
    },
  ],
  version: 1,
}

Represents the structure of actions and stages to be performed in the pipeline.

Instance Attribute Summary collapse

Instance Attribute Details

#artifact_storeTypes::ArtifactStore

Represents the context of an action within the stage of a pipeline to a job worker.



1908
1909
1910
1911
1912
1913
1914
1915
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 1908

class PipelineDeclaration < Struct.new(
  :name,
  :role_arn,
  :artifact_store,
  :stages,
  :version)
  include Aws::Structure
end

#nameString

The name of the action to be performed.

Returns:

  • (String)


1908
1909
1910
1911
1912
1913
1914
1915
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 1908

class PipelineDeclaration < Struct.new(
  :name,
  :role_arn,
  :artifact_store,
  :stages,
  :version)
  include Aws::Structure
end

#role_arnString

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.

Returns:

  • (String)


1908
1909
1910
1911
1912
1913
1914
1915
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 1908

class PipelineDeclaration < Struct.new(
  :name,
  :role_arn,
  :artifact_store,
  :stages,
  :version)
  include Aws::Structure
end

#stagesArray<Types::StageDeclaration>

The stage in which to perform the action.

Returns:



1908
1909
1910
1911
1912
1913
1914
1915
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 1908

class PipelineDeclaration < Struct.new(
  :name,
  :role_arn,
  :artifact_store,
  :stages,
  :version)
  include Aws::Structure
end

#versionInteger

The version number of the pipeline. A new pipeline always has a version number of 1. This number is automatically incremented when a pipeline is updated.

Returns:

  • (Integer)


1908
1909
1910
1911
1912
1913
1914
1915
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 1908

class PipelineDeclaration < Struct.new(
  :name,
  :role_arn,
  :artifact_store,
  :stages,
  :version)
  include Aws::Structure
end