Run a script as a CodeBuild Project.
The BuildSpec must be available inline--it cannot reference a file on disk. If your current build instructions are in a file like buildspec.yml in your repository, extract them to a script (say, build.sh) and invoke that script as part of the build:
new pipelines.CodeBuildStep('Synth', {
commands: ['./build.sh'],
});
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',
}),
},
}),
],
});
pipeline = pipelines.CodePipeline(self, "Pipeline",
synth=pipelines.ShellStep("Synth",
input=pipelines.CodePipelineSource.connection("my-org/my-app", "main",
connection_arn="arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41"
),
commands=["npm ci", "npm run build", "npx cdk synth"]
),
# Turn this on because the pipeline uses Docker image assets
docker_enabled_for_self_mutation=True
)
pipeline.add_wave("MyWave",
post=[
pipelines.CodeBuildStep("RunApproval",
commands=["command-from-image"],
build_environment=codebuild.BuildEnvironment(
# The user of a Docker image asset in the pipeline requires turning on
# 'dockerEnabledForSelfMutation'.
build_image=codebuild.LinuxBuildImage.from_asset(self, "Image",
directory="./docker-image"
)
)
)
]
)
CodePipeline pipeline = CodePipeline.Builder.create(this, "Pipeline")
.synth(ShellStep.Builder.create("Synth")
.input(CodePipelineSource.connection("my-org/my-app", "main", ConnectionSourceOptions.builder()
.connectionArn("arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41")
.build()))
.commands(List.of("npm ci", "npm run build", "npx cdk synth"))
.build())
// Turn this on because the pipeline uses Docker image assets
.dockerEnabledForSelfMutation(true)
.build();
pipeline.addWave("MyWave", WaveOptions.builder()
.post(List.of(
CodeBuildStep.Builder.create("RunApproval")
.commands(List.of("command-from-image"))
.buildEnvironment(BuildEnvironment.builder()
// The user of a Docker image asset in the pipeline requires turning on
// 'dockerEnabledForSelfMutation'.
.buildImage(LinuxBuildImage.fromAsset(this, "Image", DockerImageAssetProps.builder()
.directory("./docker-image")
.build()))
.build())
.build()))
.build());
// Install: dotnet add package Amazon.CDK.Lib
var pipeline = new CodePipeline(this, "Pipeline", new CodePipelineProps {
Synth = new ShellStep("Synth", new ShellStepProps {
Input = CodePipelineSource.Connection("my-org/my-app", "main", new ConnectionSourceOptions {
ConnectionArn = "arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41"
}),
Commands = new [] { "npm ci", "npm run build", "npx cdk synth" }
}),
// Turn this on because the pipeline uses Docker image assets
DockerEnabledForSelfMutation = true
});
pipeline.AddWave("MyWave", new WaveOptions {
Post = new [] {
new CodeBuildStep("RunApproval", new CodeBuildStepProps {
Commands = new [] { "command-from-image" },
BuildEnvironment = new BuildEnvironment {
// The user of a Docker image asset in the pipeline requires turning on
// 'dockerEnabledForSelfMutation'.
BuildImage = LinuxBuildImage.FromAsset(this, "Image", new DockerImageAssetProps {
Directory = "./docker-image"
})
}
}) }
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
pipeline := pipelines.NewCodePipeline(this, jsii.String("Pipeline"), &CodePipelineProps{
Synth: pipelines.NewShellStep(jsii.String("Synth"), &ShellStepProps{
Input: pipelines.CodePipelineSource_Connection(jsii.String("my-org/my-app"), jsii.String("main"), &ConnectionSourceOptions{
ConnectionArn: jsii.String("arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41"),
}),
Commands: []*string{
jsii.String("npm ci"),
jsii.String("npm run build"),
jsii.String("npx cdk synth"),
},
}),
// Turn this on because the pipeline uses Docker image assets
DockerEnabledForSelfMutation: jsii.Boolean(true),
})
pipeline.AddWave(jsii.String("MyWave"), &WaveOptions{
Post: []Step{
pipelines.NewCodeBuildStep(jsii.String("RunApproval"), &CodeBuildStepProps{
Commands: []*string{
jsii.String("command-from-image"),
},
BuildEnvironment: &BuildEnvironment{
// The user of a Docker image asset in the pipeline requires turning on
// 'dockerEnabledForSelfMutation'.
BuildImage: codebuild.LinuxBuildImage_FromAsset(this, jsii.String("Image"), &DockerImageAssetProps{
Directory: jsii.String("./docker-image"),
}),
},
}),
},
})
new CodeBuildStep(id: string, props: CodeBuildStepProps)
CodeBuildStep(id: str, props: CodeBuildStepProps)
new CodeBuildStep(String id, CodeBuildStepProps props)
new CodeBuildStep(string id, CodeBuildStepProps props)
NewCodeBuildStep(Id *string, Props CodeBuildStepProps)
actionRole?may be undefinedIRoleaction_role?may be undefinedIRoleactionRole?may be undefinedIRoleActionRole?may be undefinedIRoleActionRole?may be undefinedIRole#Default: A role is automatically created
buildEnvironment?may be undefinedBuildEnvironmentbuild_environment?may be undefinedBuildEnvironmentbuildEnvironment?may be undefinedBuildEnvironmentBuildEnvironment?may be undefinedBuildEnvironmentBuildEnvironment?may be undefinedBuildEnvironment#Default: No value specified at construction time, use defaults
cache?may be undefinedCachecache?may be undefinedCachecache?may be undefinedCacheCache?may be undefinedCacheCache?may be undefinedCache#Default: No cache
consumedStackOutputsStackOutputReference[]consumed_stack_outputstyping.List[StackOutputReference]consumedStackOutputsList<StackOutputReference>ConsumedStackOutputsStackOutputReference[]ConsumedStackOutputs*[]StackOutputReference#dependenciesStep[]dependenciestyping.List[Step]dependenciesList<Step>DependenciesStep[]Dependencies*[]Step#dependencyFileSetsFileSet[]dependency_file_setstyping.List[FileSet]dependencyFileSetsList<FileSet>DependencyFileSetsFileSet[]DependencyFileSets*[]FileSet#env{ [key: string]: string }envtyping.Mapping[str, str]envMap<String, String>EnvIDictionary<string, string>Env*map[string]*string#Default: No environment variables
envFromCfnOutputs{ [key: string]: StackOutputReference }env_from_cfn_outputstyping.Mapping[str, StackOutputReference]envFromCfnOutputsMap<String, StackOutputReference>EnvFromCfnOutputsIDictionary<string, StackOutputReference>EnvFromCfnOutputs*map[string]StackOutputReference#Default: No environment variables created from stack outputs
fileSystemLocations?may be undefinedIFileSystemLocation[]file_system_locations?may be undefinedtyping.List[IFileSystemLocation]fileSystemLocations?may be undefinedList<IFileSystemLocation>FileSystemLocations?may be undefinedIFileSystemLocation[]FileSystemLocations?may be undefined*[]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.
grantPrincipalIPrincipalgrant_principalIPrincipalgrantPrincipalIPrincipalGrantPrincipalIPrincipalGrantPrincipalIPrincipal#inputsFileSetLocation[]inputstyping.List[FileSetLocation]inputsList<FileSetLocation>InputsFileSetLocation[]Inputs*[]FileSetLocation#A list of (FileSet, directory) pairs, which are a copy of the input properties. This list should not be modified directly.
installCommandsstring[]install_commandstyping.List[str]installCommandsList<String>InstallCommandsstring[]InstallCommands*[]*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.
What it means to be a Source step depends on the engine.
logging?may be undefinedLoggingOptionslogging?may be undefinedLoggingOptionslogging?may be undefinedLoggingOptionsLogging?may be undefinedLoggingOptionsLogging?may be undefinedLoggingOptions#Default: no log configuration is set
A CodeBuilde project can create logs in Amazon CloudWatch Logs, an S3 bucket, or both.
outputsFileSetLocation[]outputstyping.List[FileSetLocation]outputsList<FileSetLocation>OutputsFileSetLocation[]Outputs*[]FileSetLocation#A list of (FileSet, directory) pairs, which are a copy of the input properties. This list should not be modified directly.
partialBuildSpec?may be undefinedBuildSpecpartial_build_spec?may be undefinedBuildSpecpartialBuildSpec?may be undefinedBuildSpecPartialBuildSpec?may be undefinedBuildSpecPartialBuildSpec?may be undefinedBuildSpec#Default: Contains the exported variables
Contains exported variables
primaryOutput?may be undefinedFileSetprimary_output?may be undefinedFileSetprimaryOutput?may be undefinedFileSetPrimaryOutput?may be undefinedFileSetPrimaryOutput?may be undefinedFileSet#Not all steps produce an output FileSet--if they do you can substitute the Step object for the FileSet object.
Will only be available after the pipeline has been built.
projectName?may be undefinedstringproject_name?may be undefinedstrprojectName?may be undefinedStringProjectName?may be undefinedstringProjectName?may be undefined*string#Default: No value specified at construction time, use defaults
role?may be undefinedIRolerole?may be undefinedIRolerole?may be undefinedIRoleRole?may be undefinedIRoleRole?may be undefinedIRole#Default: No value specified at construction time, use defaults
rolePolicyStatements?may be undefinedPolicyStatement[]role_policy_statements?may be undefinedtyping.List[PolicyStatement]rolePolicyStatements?may be undefinedList<PolicyStatement>RolePolicyStatements?may be undefinedPolicyStatement[]RolePolicyStatements?may be undefined*[]PolicyStatement#Default: No value specified at construction time, use defaults
securityGroups?may be undefinedISecurityGroup[]security_groups?may be undefinedtyping.List[ISecurityGroup]securityGroups?may be undefinedList<ISecurityGroup>SecurityGroups?may be undefinedISecurityGroup[]SecurityGroups?may be undefined*[]ISecurityGroup#Default: No value specified at construction time, use defaults
subnetSelection?may be undefinedSubnetSelectionsubnet_selection?may be undefinedSubnetSelectionsubnetSelection?may be undefinedSubnetSelectionSubnetSelection?may be undefinedSubnetSelectionSubnetSelection?may be undefinedSubnetSelection#Default: No value specified at construction time, use defaults
timeout?may be undefinedDurationtimeout?may be undefinedDurationtimeout?may be undefinedDurationTimeout?may be undefinedDurationTimeout?may be undefinedDuration= Duration.hours(1)#For valid values, see the timeoutInMinutes field in the AWS CodeBuild User Guide.
addOutputDirectory(directory: string): FileSetdef add_output_directory(self, directory: str) -> FileSetpublic FileSet addOutputDirectory(String directory)public FileSet AddOutputDirectory(string directory)func AddOutputDirectory(Directory *string) FileSet#After running the script, the contents of the given directory will be exported as a FileSet. Use the FileSet as the input to another step.
Multiple calls with the exact same directory name string (not normalized) will return the same FileSet.
addStepDependency(step: Step): voiddef add_step_dependency(self, step: Step) -> Nonepublic void addStepDependency(Step step)public void AddStepDependency(Step step)func AddStepDependency(Step Step)#exportedVariable(variableName: string): stringdef exported_variable(self, variable_name: str) -> strpublic String exportedVariable(String variableName)public string ExportedVariable(string variableName)func ExportedVariable(VariableName *string) *string#The variable must be set in the shell of the CodeBuild step when it finishes its post_build phase.
Parameters
variableNamevariable_namevariableNamevariableNameVariableName — the name of the variable for reference.// Access the output of one CodeBuildStep in another CodeBuildStep
declare const pipeline: pipelines.CodePipeline;
const step1 = new pipelines.CodeBuildStep('Step1', {
commands: ['export MY_VAR=hello'],
});
const step2 = new pipelines.CodeBuildStep('Step2', {
env: {
IMPORTED_VAR: step1.exportedVariable('MY_VAR'),
},
commands: ['echo $IMPORTED_VAR'],
});
primaryOutputDirectory(directory: string): FileSetdef primary_output_directory(self, directory: str) -> FileSetpublic FileSet primaryOutputDirectory(String directory)public FileSet PrimaryOutputDirectory(string directory)func PrimaryOutputDirectory(Directory *string) FileSet#If no primary output has been configured yet, this directory will become the primary output of this ShellStep, otherwise this method will throw if the given directory is different than the currently configured primary output directory.
sequence(steps: Step[]): Step[]@staticmethod def sequence(steps: typing.List[Step]) -> typing.List[Step]public static List<Step> sequence(List<Step> steps)public static Step[] Sequence(Step[] steps)func Sequence(Steps *[]Step) *[]Stepstatic#If you need more fine-grained step ordering, use the addStepDependency() API. For example, if you want secondStep to occur after firstStep, call secondStep.addStepDependency(firstStep).
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#