Interface IBuildEnvironment
Namespace: Amazon.CDK.AWS.CodeBuild
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IBuildEnvironment
Syntax (vb)
Public Interface IBuildEnvironment
Remarks
ExampleMetadata: infused
Examples
var pipeline = new CodePipeline(this, "Pipeline", new CodePipelineProps {
Synth = new ShellStep("Synth", new ShellStepProps {
Input = CodePipelineSource.Connection("my-org/my-app", "main", new ConnectionSourceOptions {
ConnectionArn = "arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41"
}),
Commands = new [] { "npm ci", "npm run build", "npx cdk synth" }
}),
// Turn this on because the pipeline uses Docker image assets
DockerEnabledForSelfMutation = true
});
pipeline.AddWave("MyWave", new WaveOptions {
Post = new [] {
new CodeBuildStep("RunApproval", new CodeBuildStepProps {
Commands = new [] { "command-from-image" },
BuildEnvironment = new BuildEnvironment {
// The user of a Docker image asset in the pipeline requires turning on
// 'dockerEnabledForSelfMutation'.
BuildImage = LinuxBuildImage.FromAsset(this, "Image", new DockerImageAssetProps {
Directory = "./docker-image"
})
}
}) }
});
Synopsis
Properties
BuildImage | The image used for the builds. |
Certificate | The location of the PEM-encoded certificate for the build project. |
ComputeType | The type of compute to use for this build. |
EnvironmentVariables | The environment variables that your builds can use. |
Privileged | Indicates how the project builds Docker images. |
Properties
BuildImage
The image used for the builds.
virtual IBuildImage BuildImage { get; }
Property Value
Remarks
Default: LinuxBuildImage.STANDARD_1_0
Certificate
The location of the PEM-encoded certificate for the build project.
virtual IBuildEnvironmentCertificate Certificate { get; }
Property Value
Remarks
Default: - No external certificate is added to the project
ComputeType
The type of compute to use for this build.
virtual Nullable<ComputeType> ComputeType { get; }
Property Value
System.Nullable<ComputeType>
Remarks
See the ComputeType
enum for the possible values.
Default: taken from #buildImage#defaultComputeType
EnvironmentVariables
The environment variables that your builds can use.
virtual IDictionary<string, IBuildEnvironmentVariable> EnvironmentVariables { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, IBuildEnvironmentVariable>
Privileged
Indicates how the project builds Docker images.
virtual Nullable<bool> Privileged { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Specify true to enable running the Docker daemon inside a Docker container. This value must be set to true only if this build project will be used to build Docker images, and the specified build environment image is not one provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon will fail.
Default: false