interface CodeCommitSourceOptions

Language	Type name
.NET	`Amazon.CDK.Pipelines.CodeCommitSourceOptions`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/pipelines#CodeCommitSourceOptions`
Java	`software.amazon.awscdk.pipelines.CodeCommitSourceOptions`
Python	`aws_cdk.pipelines.CodeCommitSourceOptions`
TypeScript (source)	`aws-cdk-lib` » `pipelines` » `CodeCommitSourceOptions`

Configuration options for a CodeCommit source.

Example

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

declare const role: iam.Role;
const codeCommitSourceOptions: pipelines.CodeCommitSourceOptions = {
  actionName: 'actionName',
  codeBuildCloneOutput: false,
  eventRole: role,
  trigger: codepipeline_actions.CodeCommitTrigger.NONE,
};

Properties

Name	Type	Description
actionName?	`string`	The action name used for this source in the CodePipeline.
codeBuildCloneOutput?	`boolean`	If this is set, the next CodeBuild job clones the repository (instead of CodePipeline downloading the files).
eventRole?	`IRole`	Role to be used by on commit event rule.
trigger?	`CodeCommitTrigger`	How should CodePipeline detect source changes for this Action.

actionName?

Type: string (optional, default: The repository name)

The action name used for this source in the CodePipeline.

codeBuildCloneOutput?

Type: boolean (optional, default: false)

If this is set, the next CodeBuild job clones the repository (instead of CodePipeline downloading the files).

This provides access to repository history, and retains symlinks (symlinks would otherwise be removed by CodePipeline).

Note: if this option is true, only CodeBuild jobs can use the output artifact.

eventRole?

Type: IRole (optional, default: a new role will be created.)

Role to be used by on commit event rule.

Used only when trigger value is CodeCommitTrigger.EVENTS.

trigger?

Type: CodeCommitTrigger (optional, default: CodeCommitTrigger.EVENTS)

How should CodePipeline detect source changes for this Action.