@Stability(value=Stable) public static final class CodeBuildStepProps.Builder extends Object implements software.amazon.jsii.Builder<CodeBuildStepProps>
CodeBuildStepProps| Constructor and Description |
|---|
Builder() |
@Stability(value=Stable) public CodeBuildStepProps.Builder actionRole(IRole actionRole)
CodeBuildStepProps.getActionRole()actionRole - Custom execution role to be used for the Code Build Action.this@Stability(value=Stable) public CodeBuildStepProps.Builder buildEnvironment(BuildEnvironment buildEnvironment)
CodeBuildStepProps.getBuildEnvironment()buildEnvironment - Changes to environment.
This environment will be combined with the pipeline's default
environment.this@Stability(value=Stable) public CodeBuildStepProps.Builder cache(Cache cache)
CodeBuildStepProps.getCache()cache - Caching strategy to use.this@Stability(value=Stable) public CodeBuildStepProps.Builder partialBuildSpec(BuildSpec partialBuildSpec)
CodeBuildStepProps.getPartialBuildSpec()partialBuildSpec - Additional configuration that can only be configured via BuildSpec.
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.
this@Stability(value=Stable) public CodeBuildStepProps.Builder projectName(String projectName)
CodeBuildStepProps.getProjectName()projectName - Name for the generated CodeBuild project.this@Stability(value=Stable) public CodeBuildStepProps.Builder role(IRole role)
CodeBuildStepProps.getRole()role - Custom execution role to be used for the CodeBuild project.this@Stability(value=Stable) public CodeBuildStepProps.Builder rolePolicyStatements(List<? extends PolicyStatement> rolePolicyStatements)
CodeBuildStepProps.getRolePolicyStatements()rolePolicyStatements - Policy statements to add to role used during the synth.
Can be used to add acces to a CodeArtifact repository etc.this@Stability(value=Stable) public CodeBuildStepProps.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)
CodeBuildStepProps.getSecurityGroups()securityGroups - Which security group to associate with the script's project network interfaces.
If no security group is identified, one will be created automatically.
Only used if 'vpc' is supplied.
this@Stability(value=Stable) public CodeBuildStepProps.Builder subnetSelection(SubnetSelection subnetSelection)
CodeBuildStepProps.getSubnetSelection()subnetSelection - Which subnets to use.
Only used if 'vpc' is supplied.this@Stability(value=Stable) public CodeBuildStepProps.Builder timeout(Duration timeout)
CodeBuildStepProps.getTimeout()timeout - The number of minutes after which AWS CodeBuild stops the build if it's not complete.
For valid values, see the timeoutInMinutes field in the AWS
CodeBuild User Guide.this@Stability(value=Stable) public CodeBuildStepProps.Builder vpc(IVpc vpc)
CodeBuildStepProps.getVpc()vpc - The VPC where to execute the SimpleSynth.this@Stability(value=Stable) public CodeBuildStepProps.Builder commands(List<String> commands)
ShellStepProps.getCommands()commands - Commands to run. This parameter is required.this@Stability(value=Stable) public CodeBuildStepProps.Builder additionalInputs(Map<String,? extends IFileSetProducer> additionalInputs)
ShellStepProps.getAdditionalInputs()additionalInputs - Additional FileSets to put in other directories.
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:
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();
this@Stability(value=Stable) public CodeBuildStepProps.Builder env(Map<String,String> env)
ShellStepProps.getEnv()env - Environment variables to set.this@Stability(value=Stable) public CodeBuildStepProps.Builder envFromCfnOutputs(Map<String,? extends CfnOutput> envFromCfnOutputs)
ShellStepProps.getEnvFromCfnOutputs()envFromCfnOutputs - Set environment variables based on 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.this@Stability(value=Stable) public CodeBuildStepProps.Builder input(IFileSetProducer input)
ShellStepProps.getInput()input - FileSet to run these scripts on.
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.this@Stability(value=Stable) public CodeBuildStepProps.Builder installCommands(List<String> installCommands)
ShellStepProps.getInstallCommands()installCommands - Installation commands to run before the regular commands.
For deployment engines that support it, install commands will be classified
differently in the job history from the regular commands.this@Stability(value=Stable) public CodeBuildStepProps.Builder primaryOutputDirectory(String primaryOutputDirectory)
ShellStepProps.getPrimaryOutputDirectory()primaryOutputDirectory - The directory that will contain the primary output fileset.
After running the script, the contents of the given directory
will be treated as the primary output of this Step.this@Stability(value=Stable) public CodeBuildStepProps build()
build in interface software.amazon.jsii.Builder<CodeBuildStepProps>CodeBuildStepPropsNullPointerException - if any required attribute was not providedCopyright © 2022. All rights reserved.