class CfnProjectPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.CodeBuild.Mixins.CfnProjectPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscodebuild/mixins#CfnProjectPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.codebuild.mixins.CfnProjectPropsMixin
Python	aws_cdk.mixins_preview.aws_codebuild.mixins.CfnProjectPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_codebuild » mixins » CfnProjectPropsMixin

Implements IMixin

Extends Mixin

The AWS::CodeBuild::Project resource configures how AWS CodeBuild builds your source code.

For example, it tells CodeBuild where to get the source code and which build environment to use.

To unset or remove a project value via CFN, explicitly provide the attribute with value as empty input.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.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 codebuild_mixins } from '@aws-cdk/mixins-preview/aws-codebuild';
const cfnProjectPropsMixin = new codebuild_mixins.CfnProjectPropsMixin({
  artifacts: {
    artifactIdentifier: 'artifactIdentifier',
    encryptionDisabled: false,
    location: 'location',
    name: 'name',
    namespaceType: 'namespaceType',
    overrideArtifactName: false,
    packaging: 'packaging',
    path: 'path',
    type: 'type',
  },
  autoRetryLimit: 123,
  badgeEnabled: false,
  buildBatchConfig: {
    batchReportMode: 'batchReportMode',
    combineArtifacts: false,
    restrictions: {
      computeTypesAllowed: ['computeTypesAllowed'],
      maximumBuildsAllowed: 123,
    },
    serviceRole: 'serviceRole',
    timeoutInMins: 123,
  },
  cache: {
    cacheNamespace: 'cacheNamespace',
    location: 'location',
    modes: ['modes'],
    type: 'type',
  },
  concurrentBuildLimit: 123,
  description: 'description',
  encryptionKey: 'encryptionKey',
  environment: {
    certificate: 'certificate',
    computeType: 'computeType',
    dockerServer: {
      computeType: 'computeType',
      securityGroupIds: ['securityGroupIds'],
    },
    environmentVariables: [{
      name: 'name',
      type: 'type',
      value: 'value',
    }],
    fleet: {
      fleetArn: 'fleetArn',
    },
    image: 'image',
    imagePullCredentialsType: 'imagePullCredentialsType',
    privilegedMode: false,
    registryCredential: {
      credential: 'credential',
      credentialProvider: 'credentialProvider',
    },
    type: 'type',
  },
  fileSystemLocations: [{
    identifier: 'identifier',
    location: 'location',
    mountOptions: 'mountOptions',
    mountPoint: 'mountPoint',
    type: 'type',
  }],
  logsConfig: {
    cloudWatchLogs: {
      groupName: 'groupName',
      status: 'status',
      streamName: 'streamName',
    },
    s3Logs: {
      encryptionDisabled: false,
      location: 'location',
      status: 'status',
    },
  },
  name: 'name',
  queuedTimeoutInMinutes: 123,
  resourceAccessRole: 'resourceAccessRole',
  secondaryArtifacts: [{
    artifactIdentifier: 'artifactIdentifier',
    encryptionDisabled: false,
    location: 'location',
    name: 'name',
    namespaceType: 'namespaceType',
    overrideArtifactName: false,
    packaging: 'packaging',
    path: 'path',
    type: 'type',
  }],
  secondarySources: [{
    auth: {
      resource: 'resource',
      type: 'type',
    },
    buildSpec: 'buildSpec',
    buildStatusConfig: {
      context: 'context',
      targetUrl: 'targetUrl',
    },
    gitCloneDepth: 123,
    gitSubmodulesConfig: {
      fetchSubmodules: false,
    },
    insecureSsl: false,
    location: 'location',
    reportBuildStatus: false,
    sourceIdentifier: 'sourceIdentifier',
    type: 'type',
  }],
  secondarySourceVersions: [{
    sourceIdentifier: 'sourceIdentifier',
    sourceVersion: 'sourceVersion',
  }],
  serviceRole: 'serviceRole',
  source: {
    auth: {
      resource: 'resource',
      type: 'type',
    },
    buildSpec: 'buildSpec',
    buildStatusConfig: {
      context: 'context',
      targetUrl: 'targetUrl',
    },
    gitCloneDepth: 123,
    gitSubmodulesConfig: {
      fetchSubmodules: false,
    },
    insecureSsl: false,
    location: 'location',
    reportBuildStatus: false,
    sourceIdentifier: 'sourceIdentifier',
    type: 'type',
  },
  sourceVersion: 'sourceVersion',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  timeoutInMinutes: 123,
  triggers: {
    buildType: 'buildType',
    filterGroups: [[{
      excludeMatchedPattern: false,
      pattern: 'pattern',
      type: 'type',
    }]],
    pullRequestBuildPolicy: {
      approverRoles: ['approverRoles'],
      requiresCommentApproval: 'requiresCommentApproval',
    },
    scopeConfiguration: {
      domain: 'domain',
      name: 'name',
      scope: 'scope',
    },
    webhook: false,
  },
  visibility: 'visibility',
  vpcConfig: {
    securityGroupIds: ['securityGroupIds'],
    subnets: ['subnets'],
    vpcId: 'vpcId',
  },
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnProjectPropsMixin(props: CfnProjectMixinProps, options?: CfnPropertyMixinOptions)

Parameters

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

Create a mixin to apply properties to AWS::CodeBuild::Project.

Properties

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

---

props

Type: CfnProjectMixinProps

---

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.