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

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

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

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



3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3064

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

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

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:



3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3064

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

#execution_modeString

The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.

Returns:

  • (String)


3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3064

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

#nameString

The name of the pipeline.

Returns:

  • (String)


3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3064

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

#pipeline_typeString

CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.

  • V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters.

  • V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration.

Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when creating or updating a pipeline will result in the pipeline having the V2 type of pipeline and the associated costs.

For information about pricing for CodePipeline, see Pricing.

For information about which type of pipeline to choose, see What type of pipeline is right for me?.

Returns:

  • (String)


3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3064

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

#role_arnString

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)


3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3064

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

#stagesArray<Types::StageDeclaration>

The stage in which to perform the action.

Returns:



3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3064

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

#triggersArray<Types::PipelineTriggerDeclaration>

The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.

When a trigger configuration is specified, default change detection for repository and branch commits is disabled.



3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3064

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

#variablesArray<Types::PipelineVariableDeclaration>

A list that defines the pipeline variables for a pipeline resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9@\-_]+.



3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3064

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

#versionInteger

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)


3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3064

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