software.amazon.awscdk.pipelines

Class CodeBuildStep

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.pipelines.Step

software.amazon.awscdk.pipelines.ShellStep

software.amazon.awscdk.pipelines.CodeBuildStep

All Implemented Interfaces:

IFileSetProducer, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:16.608Z")
 @Stability(value=Experimental)
public class CodeBuildStep
extends ShellStep

(experimental) Run a script as a CodeBuild Project.

Example:

 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());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CodeBuildStep.Builder (experimental) A fluent builder for CodeBuildStep.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.pipelines.IFileSetProducer

IFileSetProducer.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CodeBuildStep(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CodeBuildStep(software.amazon.jsii.JsiiObjectRef objRef)
	CodeBuildStep(String id, CodeBuildStepProps props)

Method Summary

Modifier and Type	Method and Description
BuildEnvironment	getBuildEnvironment() (experimental) Build environment.
IPrincipal	getGrantPrincipal() (experimental) The CodeBuild Project's principal.
BuildSpec	getPartialBuildSpec() (experimental) Additional configuration that can only be configured via BuildSpec.
IProject	getProject() (experimental) CodeBuild Project generated for the pipeline.
String	getProjectName() (experimental) Name for the generated CodeBuild project.
IRole	getRole() (experimental) Custom execution role to be used for the CodeBuild project.
List<PolicyStatement>	getRolePolicyStatements() (experimental) Policy statements to add to role used during the synth.
List<ISecurityGroup>	getSecurityGroups() (experimental) Which security group to associate with the script's project network interfaces.
SubnetSelection	getSubnetSelection() (experimental) Which subnets to use.
IVpc	getVpc() (experimental) The VPC where to execute the SimpleSynth.

Methods inherited from class software.amazon.awscdk.pipelines.ShellStep

addOutputDirectory, getCommands, getEnv, getEnvFromCfnOutputs, getInputs, getInstallCommands, getOutputs, primaryOutputDirectory

Methods inherited from class software.amazon.awscdk.pipelines.Step

addDependencyFileSet, configurePrimaryOutput, getDependencies, getDependencyFileSets, getId, getIsSource, getPrimaryOutput, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

CodeBuildStep

protected CodeBuildStep(software.amazon.jsii.JsiiObjectRef objRef)

CodeBuildStep

protected CodeBuildStep(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CodeBuildStep

@Stability(value=Experimental)
public CodeBuildStep(@NotNull
                                                    String id,
                                                    @NotNull
                                                    CodeBuildStepProps props)

Parameters:

id - This parameter is required.

props - This parameter is required.

Method Detail

getGrantPrincipal

@Stability(value=Experimental)
 @NotNull
public IPrincipal getGrantPrincipal()

(experimental) The CodeBuild Project's principal.

getProject

@Stability(value=Experimental)
 @NotNull
public IProject getProject()

(experimental) CodeBuild Project generated for the pipeline.

Will only be available after the pipeline has been built.

getBuildEnvironment

@Stability(value=Experimental)
 @Nullable
public BuildEnvironment getBuildEnvironment()

(experimental) Build environment.

Default: - No value specified at construction time, use defaults

getPartialBuildSpec

@Stability(value=Experimental)
 @Nullable
public BuildSpec getPartialBuildSpec()

(experimental) Additional configuration that can only be configured via BuildSpec.

Default: - No value specified at construction time, use defaults

getProjectName

@Stability(value=Experimental)
 @Nullable
public String getProjectName()

(experimental) Name for the generated CodeBuild project.

Default: - No value specified at construction time, use defaults

getRole

@Stability(value=Experimental)
 @Nullable
public IRole getRole()

(experimental) Custom execution role to be used for the CodeBuild project.

Default: - No value specified at construction time, use defaults

getRolePolicyStatements

@Stability(value=Experimental)
 @Nullable
public List<PolicyStatement> getRolePolicyStatements()

(experimental) Policy statements to add to role used during the synth.

Default: - No value specified at construction time, use defaults

getSecurityGroups

@Stability(value=Experimental)
 @Nullable
public List<ISecurityGroup> getSecurityGroups()

(experimental) Which security group to associate with the script's project network interfaces.

Default: - No value specified at construction time, use defaults

getSubnetSelection

@Stability(value=Experimental)
 @Nullable
public SubnetSelection getSubnetSelection()

(experimental) Which subnets to use.

Default: - No value specified at construction time, use defaults

getVpc

@Stability(value=Experimental)
 @Nullable
public IVpc getVpc()

(experimental) The VPC where to execute the SimpleSynth.

Default: - No value specified at construction time, use defaults