software.amazon.jsii.Builder<CodeBuildStep>CodeBuildStepCodeBuildStep.actionRole(IRole actionRole) additionalInputs(Map<String,? extends IFileSetProducer> additionalInputs) build()buildEnvironment(BuildEnvironment buildEnvironment) static CodeBuildStep.BuilderenvFromCfnOutputs(Map<String,? extends CfnOutput> envFromCfnOutputs) fileSystemLocations(List<? extends IFileSystemLocation> fileSystemLocations) input(IFileSetProducer input) installCommands(List<String> installCommands) logging(LoggingOptions logging) partialBuildSpec(BuildSpec partialBuildSpec) primaryOutputDirectory(String primaryOutputDirectory) projectName(String projectName) rolePolicyStatements(List<? extends PolicyStatement> rolePolicyStatements) securityGroups(List<? extends ISecurityGroup> securityGroups) subnetSelection(SubnetSelection subnetSelection) id - Identifier for this step. This parameter is required.CodeBuildStep.Builder.commands - Commands to run. This parameter is required.thisSpecifies 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:
ShellStep script = ShellStep.Builder.create("MainScript")
.commands(List.of("npm ci", "npm run build", "npx cdk synth"))
.input(CodePipelineSource.gitHub("org/source1", "main"))
.additionalInputs(Map.of(
"../siblingdir", CodePipelineSource.gitHub("org/source2", "main")))
.build();
Default: - No additional inputs
additionalInputs - Additional FileSets to put in other directories. This parameter is required.thisDefault: - No environment variables
env - Environment variables to set. This parameter is required.this
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.
Default: - No environment variables created from stack outputs
envFromCfnOutputs - Set environment variables based on Stack Outputs. This parameter is required.this
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.
Default: - No input specified
input - FileSet to run these scripts on. This parameter is required.this
For deployment engines that support it, install commands will be classified
differently in the job history from the regular commands.
Default: - No installation commands
installCommands - Installation commands to run before the regular commands. This parameter is required.thisAfter running the script, the contents of the given directory will be treated as the primary output of this Step.
Default: - No primary output
primaryOutputDirectory - The directory that will contain the primary output fileset. This parameter is required.thisDefault: - A role is automatically created
actionRole - Custom execution role to be used for the Code Build Action. This parameter is required.thisThis environment will be combined with the pipeline's default environment.
Default: - Use the pipeline's default build environment
buildEnvironment - Changes to environment. This parameter is required.thisDefault: - No cache
cache - Caching strategy to use. This parameter is required.thisA ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.
Default: - no file system locations
fileSystemLocations - ProjectFileSystemLocation objects for CodeBuild build projects. This parameter is required.thisA CodeBuild project can create logs in Amazon CloudWatch Logs, an S3 bucket, or both.
Default: - no log configuration is set
logging - Information about logs for CodeBuild projects. This parameter is required.thisYou 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.
Default: - BuildSpec completely derived from other properties
partialBuildSpec - Additional configuration that can only be configured via BuildSpec. This parameter is required.thisDefault: - Automatically generated
projectName - Name for the generated CodeBuild project. This parameter is required.thisDefault: - A role is automatically created
role - Custom execution role to be used for the CodeBuild project. This parameter is required.thisCan be used to add acces to a CodeArtifact repository etc.
Default: - No policy statements added to CodeBuild Project Role
rolePolicyStatements - Policy statements to add to role used during the synth. This parameter is required.thisIf no security group is identified, one will be created automatically.
Only used if 'vpc' is supplied.
Default: - Security group will be automatically created.
securityGroups - Which security group to associate with the script's project network interfaces. This parameter is required.thisOnly used if 'vpc' is supplied.
Default: - All private subnets.
subnetSelection - Which subnets to use. This parameter is required.thisFor valid values, see the timeoutInMinutes field in the AWS CodeBuild User Guide.
Default: Duration.hours(1)
timeout - The number of minutes after which AWS CodeBuild stops the build if it's not complete. This parameter is required.thisDefault: - No VPC
vpc - The VPC where to execute the SimpleSynth. This parameter is required.thisbuild in interface software.amazon.jsii.Builder<CodeBuildStep>CodeBuildStep.