class CfnPipelinePropsMixin

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

Implements IMixin

Extends Mixin

The AWS::CodePipeline::Pipeline resource creates a CodePipeline pipeline that describes how software changes go through a release process.

For more information, see What Is CodePipeline? in the CodePipeline User Guide .

For an example in YAML and JSON that contains the parameters in this reference, see Examples .

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

Example

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

declare const configuration: any;
const cfnPipelinePropsMixin = new codepipeline_mixins.CfnPipelinePropsMixin({
  artifactStore: {
    encryptionKey: {
      id: 'id',
      type: 'type',
    },
    location: 'location',
    type: 'type',
  },
  artifactStores: [{
    artifactStore: {
      encryptionKey: {
        id: 'id',
        type: 'type',
      },
      location: 'location',
      type: 'type',
    },
    region: 'region',
  }],
  disableInboundStageTransitions: [{
    reason: 'reason',
    stageName: 'stageName',
  }],
  executionMode: 'executionMode',
  name: 'name',
  pipelineType: 'pipelineType',
  restartExecutionOnUpdate: false,
  roleArn: 'roleArn',
  stages: [{
    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',
          },
        }],
      }],
    },
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  triggers: [{
    gitConfiguration: {
      pullRequest: [{
        branches: {
          excludes: ['excludes'],
          includes: ['includes'],
        },
        events: ['events'],
        filePaths: {
          excludes: ['excludes'],
          includes: ['includes'],
        },
      }],
      push: [{
        branches: {
          excludes: ['excludes'],
          includes: ['includes'],
        },
        filePaths: {
          excludes: ['excludes'],
          includes: ['includes'],
        },
        tags: {
          excludes: ['excludes'],
          includes: ['includes'],
        },
      }],
      sourceActionName: 'sourceActionName',
    },
    providerType: 'providerType',
  }],
  variables: [{
    defaultValue: 'defaultValue',
    description: 'description',
    name: 'name',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnPipelinePropsMixin(props: CfnPipelineMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnPipelineMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::CodePipeline::Pipeline.

Properties

Name	Type	Description
props	CfnPipelineMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnPipelineMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.