interface StageDeclarationProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.CodePipeline.Mixins.CfnPipelinePropsMixin.StageDeclarationProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscodepipeline/mixins#CfnPipelinePropsMixin_StageDeclarationProperty
Java	software.amazon.awscdk.mixins.preview.services.codepipeline.mixins.CfnPipelinePropsMixin.StageDeclarationProperty
Python	aws_cdk.mixins_preview.aws_codepipeline.mixins.CfnPipelinePropsMixin.StageDeclarationProperty
TypeScript	@aws-cdk/mixins-preview » aws_codepipeline » mixins » CfnPipelinePropsMixin » StageDeclarationProperty

Represents information about a stage and its definition.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagedeclaration.html

Example

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

declare const configuration: any;
const stageDeclarationProperty: codepipeline_mixins.CfnPipelinePropsMixin.StageDeclarationProperty = {
  actions: [{
    actionTypeId: {
      category: 'category',
      owner: 'owner',
      provider: 'provider',
      version: 'version',
    },
    commands: ['commands'],
    configuration: configuration,
    environmentVariables: [{
      name: 'name',
      type: 'type',
      value: 'value',
    }],
    inputArtifacts: [{
      name: 'name',
    }],
    name: 'name',
    namespace: 'namespace',
    outputArtifacts: [{
      files: ['files'],
      name: 'name',
    }],
    outputVariables: ['outputVariables'],
    region: 'region',
    roleArn: 'roleArn',
    runOrder: 123,
    timeoutInMinutes: 123,
  }],
  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',
  }],
  name: 'name',
  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.
beforeEntry?	IResolvable | BeforeEntryConditionsProperty	The method to use when a stage allows entry.
blockers?	IResolvable | (IResolvable | BlockerDeclarationProperty)[]	Reserved for future use.
name?	string	The name of the stage.
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.

---

actions?

Type: IResolvable | (IResolvable | ActionDeclarationProperty)[] (optional)

The actions included in a stage.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagedeclaration.html#cfn-codepipeline-pipeline-stagedeclaration-actions

---

beforeEntry?

Type: IResolvable | BeforeEntryConditionsProperty (optional)

The method to use when a stage allows entry.

For example, configuring this field for conditions will allow entry to the stage when the conditions are met.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagedeclaration.html#cfn-codepipeline-pipeline-stagedeclaration-beforeentry

---

blockers?

Type: IResolvable | (IResolvable | BlockerDeclarationProperty)[] (optional)

Reserved for future use.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagedeclaration.html#cfn-codepipeline-pipeline-stagedeclaration-blockers

---

name?

Type: string (optional)

The name of the stage.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagedeclaration.html#cfn-codepipeline-pipeline-stagedeclaration-name

---

onFailure?

Type: IResolvable | FailureConditionsProperty (optional)

The method to use when a stage has not completed successfully.

For example, configuring this field for rollback will roll back a failed stage automatically to the last successful pipeline execution in the stage.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagedeclaration.html#cfn-codepipeline-pipeline-stagedeclaration-onfailure

---

onSuccess?

Type: IResolvable | SuccessConditionsProperty (optional)

The method to use when a stage has succeeded.

For example, configuring this field for conditions will allow the stage to succeed when the conditions are met.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagedeclaration.html#cfn-codepipeline-pipeline-stagedeclaration-onsuccess