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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing PipelineDeclaration as input to an Aws::Client method, you can use a vanilla 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.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#artifact_store ⇒ Types::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.

Returns:

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

Returns:

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

    A mapping of artifactStore objects and their corresponding AWS Regions.

#name ⇒ String

The name of the pipeline.

Returns:

  • (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 an actionRoleArn.

Returns:

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

Returns:

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

Returns:

  • (Integer) —

    The version number of the pipeline.