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
• Struct
• Aws::CodePipeline::Types::PipelineDeclaration

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: {
    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",
        },
      ],
    },
  ],
  version: 1,
}

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

See Also:

• AWS API Documentation

Instance Attribute Summary

• #artifact_store ⇒ Types::ArtifactStore

  Represents information about the Amazon S3 bucket where artifacts are stored for the pipeline.

• #artifact_stores ⇒ Hash<String,Types::ArtifactStore>

  A mapping of artifactStore objects and their corresponding regions.

• #name ⇒ String

  The name of the action to be performed.

• #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.

• #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 Amazon S3 bucket where artifacts are stored for the pipeline.

Returns:

• (Types::ArtifactStore)

# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 2341

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

#artifact_stores ⇒ Hash<String,Types::ArtifactStore>

A mapping of artifactStore objects and their corresponding regions. There must be an artifact store for the pipeline region and for each cross-region action within the pipeline. You can only use either artifactStore or artifactStores, not both.

If you create a cross-region action in your pipeline, you must use artifactStores.

Returns:

• (Hash<String,Types::ArtifactStore>)

# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 2341

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

#name ⇒ String

The name of the action to be performed.

Returns:

• (String)

# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 2341

class PipelineDeclaration < Struct.new(
  :name,
  :role_arn,
  :artifact_store,
  :artifact_stores,
  :stages,
  :version)
  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.

Returns:

• (String)

# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 2341

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

#stages ⇒ Array<Types::StageDeclaration>

The stage in which to perform the action.

Returns:

• (Array<Types::StageDeclaration>)

# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 2341

class PipelineDeclaration < Struct.new(
  :name,
  :role_arn,
  :artifact_store,
  :artifact_stores,
  :stages,
  :version)
  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 automatically incremented when a pipeline is updated.

Returns:

• (Integer)

# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 2341

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