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

Inherits:

Struct

• Object
• Struct
• Aws::CodePipeline::Types::PipelineDeclaration

Includes:

Structure

Defined in:

lib/aws-sdk-codepipeline/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

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

• #name ⇒ String

  The name of the pipeline.

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

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

<note markdown=“1”> 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`.

</note>

Returns:

• (Types::ArtifactStore)

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

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 Amazon Web Services Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.

<note markdown=“1”> 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`.

</note>

Returns:

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

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

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.

Returns:

• (String)

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

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 CodePipeline to use to either perform actions with no ‘actionRoleArn`, or to use to assume roles for actions with an `actionRoleArn`.

Returns:

• (String)

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

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.

Returns:

• (Array<Types::StageDeclaration>)

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

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.

Returns:

• (Integer)

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

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