Package software.amazon.awscdk.pipelines

Interface CodeBuildStepProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, ShellStepProps

All Known Implementing Classes:

CodeBuildStepProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:49.788Z")
@Stability(Stable)
public interface CodeBuildStepProps
extends software.amazon.jsii.JsiiSerializable, ShellStepProps

Construction props for a CodeBuildStep.

Example:

 CodePipeline.Builder.create(this, "Pipeline")
         .synth(CodeBuildStep.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", "..."))
                 .rolePolicyStatements(List.of(
                     PolicyStatement.Builder.create()
                             .actions(List.of("sts:AssumeRole"))
                             .resources(List.of("*"))
                             .conditions(Map.of(
                                     "StringEquals", Map.of(
                                             "iam:ResourceTag/aws-cdk:bootstrap-role", "lookup")))
                             .build()))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CodeBuildStepProps.Builder	A builder for CodeBuildStepProps
static final class	CodeBuildStepProps.Jsii$Proxy	An implementation for CodeBuildStepProps

Method Summary

Modifier and Type	Method	Description
static CodeBuildStepProps.Builder	builder()
default IRole	getActionRole()	Custom execution role to be used for the Code Build Action.
default BuildEnvironment	getBuildEnvironment()	Changes to environment.
default BuildSpec	getPartialBuildSpec()	Additional configuration that can only be configured via BuildSpec.
default String	getProjectName()	Name for the generated CodeBuild project.
default IRole	getRole()	Custom execution role to be used for the CodeBuild project.
default List<PolicyStatement>	getRolePolicyStatements()	Policy statements to add to role used during the synth.
default List<ISecurityGroup>	getSecurityGroups()	Which security group to associate with the script's project network interfaces.
default SubnetSelection	getSubnetSelection()	Which subnets to use.
default Duration	getTimeout()	The number of minutes after which AWS CodeBuild stops the build if it's not complete.
default IVpc	getVpc()	The VPC where to execute the SimpleSynth.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.pipelines.ShellStepProps

getAdditionalInputs, getCommands, getEnv, getEnvFromCfnOutputs, getInput, getInstallCommands, getPrimaryOutputDirectory

Method Details

getActionRole

@Stability(Stable)
@Nullable
default IRole getActionRole()

Custom execution role to be used for the Code Build Action.

Default: - A role is automatically created

getBuildEnvironment

@Stability(Stable)
@Nullable
default BuildEnvironment getBuildEnvironment()

Changes to environment.

This environment will be combined with the pipeline's default environment.

Default: - Use the pipeline's default build environment

getPartialBuildSpec

@Stability(Stable)
@Nullable
default BuildSpec getPartialBuildSpec()

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.

Default: - BuildSpec completely derived from other properties

getProjectName

@Stability(Stable)
@Nullable
default String getProjectName()

Name for the generated CodeBuild project.

Default: - Automatically generated

getRole

@Stability(Stable)
@Nullable
default IRole getRole()

Custom execution role to be used for the CodeBuild project.

Default: - A role is automatically created

getRolePolicyStatements

@Stability(Stable)
@Nullable
default List<PolicyStatement> getRolePolicyStatements()

Policy statements to add to role used during the synth.

Can be used to add acces to a CodeArtifact repository etc.

Default: - No policy statements added to CodeBuild Project Role

getSecurityGroups

@Stability(Stable)
@Nullable
default List<ISecurityGroup> getSecurityGroups()

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.

Default: - Security group will be automatically created.

getSubnetSelection

@Stability(Stable)
@Nullable
default SubnetSelection getSubnetSelection()

Which subnets to use.

Only used if 'vpc' is supplied.

Default: - All private subnets.

getTimeout

@Stability(Stable)
@Nullable
default Duration getTimeout()

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.

Default: Duration.hours(1)

getVpc

@Stability(Stable)
@Nullable
default IVpc getVpc()

The VPC where to execute the SimpleSynth.

Default: - No VPC

builder

@Stability(Stable)
static CodeBuildStepProps.Builder builder()

Returns:

a CodeBuildStepProps.Builder of CodeBuildStepProps