Amazonka.CodePipeline.Types.PipelineDeclaration

Documentation

data PipelineDeclaration

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

See: newPipelineDeclaration smart constructor.

Constructors

PipelineDeclaration'

Fields

• artifactStore :: Maybe 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.

• artifactStores :: Maybe (HashMap Text 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.

• version :: Maybe Natural

  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.

• name :: Text

  The name of the pipeline.

• roleArn :: Text

  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 :: [StageDeclaration]

  The stage in which to perform the action.

Instances

FromJSON PipelineDeclaration

Defined in Amazonka.CodePipeline.Types.PipelineDeclaration

Methods

parseJSON :: Value -> Parser PipelineDeclaration

parseJSONList :: Value -> Parser [PipelineDeclaration]

ToJSON PipelineDeclaration

Defined in Amazonka.CodePipeline.Types.PipelineDeclaration

Methods

toJSON :: PipelineDeclaration -> Value

toEncoding :: PipelineDeclaration -> Encoding

toJSONList :: [PipelineDeclaration] -> Value

toEncodingList :: [PipelineDeclaration] -> Encoding

Generic PipelineDeclaration

Defined in Amazonka.CodePipeline.Types.PipelineDeclaration

Associated Types

type Rep PipelineDeclaration :: Type -> Type

Methods

from :: PipelineDeclaration -> Rep PipelineDeclaration x

to :: Rep PipelineDeclaration x -> PipelineDeclaration

Read PipelineDeclaration

Defined in Amazonka.CodePipeline.Types.PipelineDeclaration

Methods

readsPrec :: Int -> ReadS PipelineDeclaration

readList :: ReadS [PipelineDeclaration]

readPrec :: ReadPrec PipelineDeclaration

readListPrec :: ReadPrec [PipelineDeclaration]

Show PipelineDeclaration

Defined in Amazonka.CodePipeline.Types.PipelineDeclaration

Methods

showsPrec :: Int -> PipelineDeclaration -> ShowS

show :: PipelineDeclaration -> String

showList :: [PipelineDeclaration] -> ShowS

NFData PipelineDeclaration

Defined in Amazonka.CodePipeline.Types.PipelineDeclaration

Methods

rnf :: PipelineDeclaration -> ()

Eq PipelineDeclaration

Defined in Amazonka.CodePipeline.Types.PipelineDeclaration

Methods

(==) :: PipelineDeclaration -> PipelineDeclaration -> Bool

(/=) :: PipelineDeclaration -> PipelineDeclaration -> Bool

Hashable PipelineDeclaration

Defined in Amazonka.CodePipeline.Types.PipelineDeclaration

Methods

hashWithSalt :: Int -> PipelineDeclaration -> Int

hash :: PipelineDeclaration -> Int

type Rep PipelineDeclaration

Defined in Amazonka.CodePipeline.Types.PipelineDeclaration

type Rep PipelineDeclaration = D1 ('MetaData "PipelineDeclaration" "Amazonka.CodePipeline.Types.PipelineDeclaration" "amazonka-codepipeline-2.0-AHHPJTmnvhi1gPjRAFzjQE" 'False) (C1 ('MetaCons "PipelineDeclaration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "artifactStore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ArtifactStore)) :*: (S1 ('MetaSel ('Just "artifactStores") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text ArtifactStore))) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "stages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [StageDeclaration])))))

newPipelineDeclaration

Arguments

:: Text

PipelineDeclaration

-> Text

$sel:roleArn:PipelineDeclaration'

-> PipelineDeclaration

Create a value of PipelineDeclaration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:artifactStore:PipelineDeclaration', pipelineDeclaration_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.

$sel:artifactStores:PipelineDeclaration', pipelineDeclaration_artifactStores - 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.

$sel:version:PipelineDeclaration', pipelineDeclaration_version - 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.

PipelineDeclaration, pipelineDeclaration_name - The name of the pipeline.

$sel:roleArn:PipelineDeclaration', pipelineDeclaration_roleArn - 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.

$sel:stages:PipelineDeclaration', pipelineDeclaration_stages - The stage in which to perform the action.

pipelineDeclaration_artifactStore :: Lens' PipelineDeclaration (Maybe 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.

pipelineDeclaration_artifactStores :: Lens' PipelineDeclaration (Maybe (HashMap Text 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.

pipelineDeclaration_version :: Lens' PipelineDeclaration (Maybe Natural)

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.

pipelineDeclaration_name :: Lens' PipelineDeclaration Text

The name of the pipeline.

pipelineDeclaration_roleArn :: Lens' PipelineDeclaration Text

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.

pipelineDeclaration_stages :: Lens' PipelineDeclaration [StageDeclaration]

The stage in which to perform the action.