software.amazon.awscdk.services.codebuild

Class BuildSpec

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.codebuild.BuildSpec

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:55.331Z")
public abstract class BuildSpec
extends software.amazon.jsii.JsiiObject

BuildSpec for CodeBuild projects.

Example:

 // later:
 PipelineProject project;
 Artifact sourceOutput = new Artifact();
 CodeBuildAction buildAction = CodeBuildAction.Builder.create()
         .actionName("Build1")
         .input(sourceOutput)
         .project(PipelineProject.Builder.create(this, "Project")
                 .buildSpec(BuildSpec.fromObject(Map.of(
                         "version", "0.2",
                         "env", Map.of(
                                 "exported-variables", List.of("MY_VAR")),
                         "phases", Map.of(
                                 "build", Map.of(
                                         "commands", "export MY_VAR=\"some value\"")))))
                 .build())
         .variablesNamespace("MyNamespace")
         .build();
 CodeBuildAction.Builder.create()
         .actionName("CodeBuild")
         .project(project)
         .input(sourceOutput)
         .environmentVariables(Map.of(
                 "MyVar", BuildEnvironmentVariable.builder()
                         .value(buildAction.variable("MY_VAR"))
                         .build()))
         .build();
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BuildSpec()
protected	BuildSpec(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	BuildSpec(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static BuildSpec	fromObject(java.util.Map<java.lang.String,? extends java.lang.Object> value)
static BuildSpec	fromObjectToYaml(java.util.Map<java.lang.String,? extends java.lang.Object> value) Create a buildspec from an object that will be rendered as YAML in the resulting CloudFormation template.
static BuildSpec	fromSourceFilename(java.lang.String filename) Use a file from the source as buildspec.
abstract java.lang.Boolean	getIsImmediate() Whether the buildspec is directly available or deferred until build-time.
abstract java.lang.String	toBuildSpec() Render the represented BuildSpec.

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildSpec

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

BuildSpec

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

BuildSpec

protected BuildSpec()

Method Detail

fromObject

public static BuildSpec fromObject(java.util.Map<java.lang.String,? extends java.lang.Object> value)

Parameters:

value - This parameter is required.

fromObjectToYaml

public static BuildSpec fromObjectToYaml(java.util.Map<java.lang.String,? extends java.lang.Object> value)

Create a buildspec from an object that will be rendered as YAML in the resulting CloudFormation template.

Parameters:

value - the object containing the buildspec that will be rendered as YAML. This parameter is required.

fromSourceFilename

public static BuildSpec fromSourceFilename(java.lang.String filename)

Use a file from the source as buildspec.

Use this if you want to use a file different from 'buildspec.yml'`

Parameters:

filename - This parameter is required.

toBuildSpec

public abstract java.lang.String toBuildSpec()

Render the represented BuildSpec.

getIsImmediate

public abstract java.lang.Boolean getIsImmediate()

Whether the buildspec is directly available or deferred until build-time.