interface StageDeclarationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.CodePipeline.CfnPipeline.StageDeclarationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscodepipeline#CfnPipeline_StageDeclarationProperty`
Java	`software.amazon.awscdk.services.codepipeline.CfnPipeline.StageDeclarationProperty`
Python	`aws_cdk.aws_codepipeline.CfnPipeline.StageDeclarationProperty`
TypeScript	`aws-cdk-lib` » `aws_codepipeline` » `CfnPipeline` » `StageDeclarationProperty`

Represents information about a stage and its definition.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codepipeline as codepipeline } from 'aws-cdk-lib';

declare const configuration: any;
const stageDeclarationProperty: codepipeline.CfnPipeline.StageDeclarationProperty = {
  actions: [{
    actionTypeId: {
      category: 'category',
      owner: 'owner',
      provider: 'provider',
      version: 'version',
    },
    name: 'name',

    // the properties below are optional
    commands: ['commands'],
    configuration: configuration,
    inputArtifacts: [{
      name: 'name',
    }],
    namespace: 'namespace',
    outputArtifacts: [{
      name: 'name',

      // the properties below are optional
      files: ['files'],
    }],
    outputVariables: ['outputVariables'],
    region: 'region',
    roleArn: 'roleArn',
    runOrder: 123,
    timeoutInMinutes: 123,
  }],
  name: 'name',

  // the properties below are optional
  beforeEntry: {
    conditions: [{
      result: 'result',
      rules: [{
        commands: ['commands'],
        configuration: configuration,
        inputArtifacts: [{
          name: 'name',
        }],
        name: 'name',
        region: 'region',
        roleArn: 'roleArn',
        ruleTypeId: {
          category: 'category',
          owner: 'owner',
          provider: 'provider',
          version: 'version',
        },
      }],
    }],
  },
  blockers: [{
    name: 'name',
    type: 'type',
  }],
  onFailure: {
    conditions: [{
      result: 'result',
      rules: [{
        commands: ['commands'],
        configuration: configuration,
        inputArtifacts: [{
          name: 'name',
        }],
        name: 'name',
        region: 'region',
        roleArn: 'roleArn',
        ruleTypeId: {
          category: 'category',
          owner: 'owner',
          provider: 'provider',
          version: 'version',
        },
      }],
    }],
    result: 'result',
    retryConfiguration: {
      retryMode: 'retryMode',
    },
  },
  onSuccess: {
    conditions: [{
      result: 'result',
      rules: [{
        commands: ['commands'],
        configuration: configuration,
        inputArtifacts: [{
          name: 'name',
        }],
        name: 'name',
        region: 'region',
        roleArn: 'roleArn',
        ruleTypeId: {
          category: 'category',
          owner: 'owner',
          provider: 'provider',
          version: 'version',
        },
      }],
    }],
  },
};

Properties

Name	Type	Description
actions	`IResolvable` `\|` `IResolvable` `\|` `ActionDeclarationProperty[]`	The actions included in a stage.
name	`string`	The name of the stage.
beforeEntry?	`IResolvable` `\|` `BeforeEntryConditionsProperty`	The method to use when a stage allows entry.
blockers?	`IResolvable` `\|` `IResolvable` `\|` `BlockerDeclarationProperty[]`	Reserved for future use.
onFailure?	`IResolvable` `\|` `FailureConditionsProperty`	The method to use when a stage has not completed successfully.
onSuccess?	`IResolvable` `\|` `SuccessConditionsProperty`	The method to use when a stage has succeeded.