Construction props for a CodeBuildStep.
pipelines/lib/codepipeline/codebuild-step.tsconst pipeline = new pipelines.CodePipeline(this, 'Pipeline', {
synth: new pipelines.ShellStep('Synth', {
input: pipelines.CodePipelineSource.connection('my-org/my-app', 'main', {
connectionArn:
'arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41', // Created using the AWS console * });',
}),
commands: ['npm ci', 'npm run build', 'npx cdk synth'],
}),
// Turn this on because the pipeline uses Docker image assets
dockerEnabledForSelfMutation: true,
});
pipeline.addWave('MyWave', {
post: [
new pipelines.CodeBuildStep('RunApproval', {
commands: ['command-from-image'],
buildEnvironment: {
// The user of a Docker image asset in the pipeline requires turning on
// 'dockerEnabledForSelfMutation'.
buildImage: codebuild.LinuxBuildImage.fromAsset(this, 'Image', {
directory: './docker-image',
}),
},
}),
],
});
actionRole?optionalIRoleaction_role?optionalIRoleactionRole?optionalIRoleActionRole?optionalIRoleActionRole?optionalIRole#Default: A role is automatically created
additionalInputs?optional{ [key: string]: IFileSetProducer }additional_inputs?optionaltyping.Mapping[str, IFileSetProducer]additionalInputs?optionalMap<String, IFileSetProducer>AdditionalInputs?optionalIDictionary<string, IFileSetProducer>AdditionalInputs?optional*map[string]IFileSetProducer#Default: No additional inputs
Specifies a mapping from directory name to FileSets. During the script execution, the FileSets will be available in the directories indicated.
The directory names may be relative. For example, you can put the main input and an additional input side-by-side with the following configuration:
const script = new pipelines.ShellStep('MainScript', {
commands: ['npm ci','npm run build','npx cdk synth'],
input: pipelines.CodePipelineSource.gitHub('org/source1', 'main'),
additionalInputs: {
'../siblingdir': pipelines.CodePipelineSource.gitHub('org/source2', 'main'),
}
});
buildEnvironment?optionalBuildEnvironmentbuild_environment?optionalBuildEnvironmentbuildEnvironment?optionalBuildEnvironmentBuildEnvironment?optionalBuildEnvironmentBuildEnvironment?optionalBuildEnvironment#Default: Use the pipeline's default build environment
This environment will be combined with the pipeline's default environment.
Default: No cache
commandsstring[]commandstyping.List[str]commandsList<String>Commandsstring[]Commands*[]*stringrequired#env?optional{ [key: string]: string }env?optionaltyping.Mapping[str, str]env?optionalMap<String, String>Env?optionalIDictionary<string, string>Env?optional*map[string]*string#Default: No environment variables
envFromCfnOutputs?optional{ [key: string]: CfnOutput }env_from_cfn_outputs?optionaltyping.Mapping[str, CfnOutput]envFromCfnOutputs?optionalMap<String, CfnOutput>EnvFromCfnOutputs?optionalIDictionary<string, CfnOutput>EnvFromCfnOutputs?optional*map[string]CfnOutput#Default: No environment variables created from stack outputs
ShellSteps following stack or stage deployments may access the CfnOutputs of those stacks to get access to --for example--automatically generated resource names or endpoint URLs.
fileSystemLocations?optionalIFileSystemLocation[]file_system_locations?optionaltyping.List[IFileSystemLocation]fileSystemLocations?optionalList<IFileSystemLocation>FileSystemLocations?optionalIFileSystemLocation[]FileSystemLocations?optional*[]IFileSystemLocation#Default: no file system locations
A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.
input?optionalIFileSetProducerinput?optionalIFileSetProducerinput?optionalIFileSetProducerInput?optionalIFileSetProducerInput?optionalIFileSetProducer#Default: No input specified
The files in the FileSet will be placed in the working directory when the script is executed. Use additionalInputs to download file sets to other directories as well.
installCommands?optionalstring[]install_commands?optionaltyping.List[str]installCommands?optionalList<String>InstallCommands?optionalstring[]InstallCommands?optional*[]*string#Default: No installation commands
For deployment engines that support it, install commands will be classified differently in the job history from the regular commands.
logging?optionalLoggingOptionslogging?optionalLoggingOptionslogging?optionalLoggingOptionsLogging?optionalLoggingOptionsLogging?optionalLoggingOptions#Default: no log configuration is set
A CodeBuild project can create logs in Amazon CloudWatch Logs, an S3 bucket, or both.
partialBuildSpec?optionalBuildSpecpartial_build_spec?optionalBuildSpecpartialBuildSpec?optionalBuildSpecPartialBuildSpec?optionalBuildSpecPartialBuildSpec?optionalBuildSpec#Default: BuildSpec completely derived from other properties
You should not use this to specify output artifacts; those should be supplied via the other properties of this class, otherwise CDK Pipelines won't be able to inspect the artifacts.
Set the commands to an empty array if you want to fully specify the BuildSpec using this field.
The BuildSpec must be available inline--it cannot reference a file on disk.
primaryOutputDirectory?optionalstringprimary_output_directory?optionalstrprimaryOutputDirectory?optionalStringPrimaryOutputDirectory?optionalstringPrimaryOutputDirectory?optional*string#Default: No primary output
After running the script, the contents of the given directory will be treated as the primary output of this Step.
projectName?optionalstringproject_name?optionalstrprojectName?optionalStringProjectName?optionalstringProjectName?optional*string#Default: Automatically generated
Default: A role is automatically created
rolePolicyStatements?optionalPolicyStatement[]role_policy_statements?optionaltyping.List[PolicyStatement]rolePolicyStatements?optionalList<PolicyStatement>RolePolicyStatements?optionalPolicyStatement[]RolePolicyStatements?optional*[]PolicyStatement#Default: No policy statements added to CodeBuild Project Role
Can be used to add access to a CodeArtifact repository etc.
securityGroups?optionalISecurityGroup[]security_groups?optionaltyping.List[ISecurityGroup]securityGroups?optionalList<ISecurityGroup>SecurityGroups?optionalISecurityGroup[]SecurityGroups?optional*[]ISecurityGroup#Default: Security group will be automatically created.
If no security group is identified, one will be created automatically.
Only used if 'vpc' is supplied.
subnetSelection?optionalSubnetSelectionsubnet_selection?optionalSubnetSelectionsubnetSelection?optionalSubnetSelectionSubnetSelection?optionalSubnetSelectionSubnetSelection?optionalSubnetSelection#Default: All private subnets.
Only used if 'vpc' is supplied.
timeout?optionalDurationtimeout?optionalDurationtimeout?optionalDurationTimeout?optionalDurationTimeout?optionalDuration= Duration.hours(1)#For valid values, see the timeoutInMinutes field in the AWS CodeBuild User Guide.