io.cloudshiftdev.awscdk.services.codebuild.BuildEnvironment.kt Maven / Gradle / Ivy
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.codebuild
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import io.cloudshiftdev.awscdk.common.CdkObject
import io.cloudshiftdev.awscdk.common.CdkObjectWrappers
import kotlin.Boolean
import kotlin.String
import kotlin.Unit
import kotlin.collections.Map
import kotlin.jvm.JvmName
/**
* 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());
* ```
*/
public interface BuildEnvironment {
/**
* The image used for the builds.
*
* Default: LinuxBuildImage.STANDARD_1_0
*/
public fun buildImage(): IBuildImage? = unwrap(this).getBuildImage()?.let(IBuildImage::wrap)
/**
* The location of the PEM-encoded certificate for the build project.
*
* Default: - No external certificate is added to the project
*/
public fun certificate(): BuildEnvironmentCertificate? =
unwrap(this).getCertificate()?.let(BuildEnvironmentCertificate::wrap)
/**
* The type of compute to use for this build.
*
* See the `ComputeType` enum for the possible values.
*
* Default: taken from `#buildImage#defaultComputeType`
*/
public fun computeType(): ComputeType? = unwrap(this).getComputeType()?.let(ComputeType::wrap)
/**
* The environment variables that your builds can use.
*/
public fun environmentVariables(): Map =
unwrap(this).getEnvironmentVariables()?.mapValues{BuildEnvironmentVariable.wrap(it.value)} ?:
emptyMap()
/**
* Fleet resource for a reserved capacity CodeBuild project.
*
* Fleets allow for process builds or tests to run immediately and reduces build durations,
* by reserving compute resources for your projects.
*
* You will be charged for the resources in the fleet, even if they are idle.
*
* Default: - No fleet will be attached to the project, which will remain on-demand.
*
* [Documentation](https://docs.aws.amazon.com/codebuild/latest/userguide/fleets.html)
*/
public fun fleet(): IFleet? = unwrap(this).getFleet()?.let(IFleet::wrap)
/**
* Indicates how the project builds Docker images.
*
* 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
*/
public fun privileged(): Boolean? = unwrap(this).getPrivileged()
/**
* A builder for [BuildEnvironment]
*/
@CdkDslMarker
public interface Builder {
/**
* @param buildImage The image used for the builds.
*/
public fun buildImage(buildImage: IBuildImage)
/**
* @param certificate The location of the PEM-encoded certificate for the build project.
*/
public fun certificate(certificate: BuildEnvironmentCertificate)
/**
* @param certificate The location of the PEM-encoded certificate for the build project.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("09017eab37f62dfd6f983cd063f7b91ffaaed137d75b90a84954e0ca86761e58")
public fun certificate(certificate: BuildEnvironmentCertificate.Builder.() -> Unit)
/**
* @param computeType The type of compute to use for this build.
* See the `ComputeType` enum for the possible values.
*/
public fun computeType(computeType: ComputeType)
/**
* @param environmentVariables The environment variables that your builds can use.
*/
public fun environmentVariables(environmentVariables: Map)
/**
* @param fleet Fleet resource for a reserved capacity CodeBuild project.
* Fleets allow for process builds or tests to run immediately and reduces build durations,
* by reserving compute resources for your projects.
*
* You will be charged for the resources in the fleet, even if they are idle.
*/
public fun fleet(fleet: IFleet)
/**
* @param privileged Indicates how the project builds Docker images.
* 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.
*/
public fun privileged(privileged: Boolean)
}
private class BuilderImpl : Builder {
private val cdkBuilder: software.amazon.awscdk.services.codebuild.BuildEnvironment.Builder =
software.amazon.awscdk.services.codebuild.BuildEnvironment.builder()
/**
* @param buildImage The image used for the builds.
*/
override fun buildImage(buildImage: IBuildImage) {
cdkBuilder.buildImage(buildImage.let(IBuildImage.Companion::unwrap))
}
/**
* @param certificate The location of the PEM-encoded certificate for the build project.
*/
override fun certificate(certificate: BuildEnvironmentCertificate) {
cdkBuilder.certificate(certificate.let(BuildEnvironmentCertificate.Companion::unwrap))
}
/**
* @param certificate The location of the PEM-encoded certificate for the build project.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("09017eab37f62dfd6f983cd063f7b91ffaaed137d75b90a84954e0ca86761e58")
override fun certificate(certificate: BuildEnvironmentCertificate.Builder.() -> Unit): Unit =
certificate(BuildEnvironmentCertificate(certificate))
/**
* @param computeType The type of compute to use for this build.
* See the `ComputeType` enum for the possible values.
*/
override fun computeType(computeType: ComputeType) {
cdkBuilder.computeType(computeType.let(ComputeType.Companion::unwrap))
}
/**
* @param environmentVariables The environment variables that your builds can use.
*/
override fun environmentVariables(environmentVariables: Map) {
cdkBuilder.environmentVariables(environmentVariables.mapValues{BuildEnvironmentVariable.unwrap(it.value)})
}
/**
* @param fleet Fleet resource for a reserved capacity CodeBuild project.
* Fleets allow for process builds or tests to run immediately and reduces build durations,
* by reserving compute resources for your projects.
*
* You will be charged for the resources in the fleet, even if they are idle.
*/
override fun fleet(fleet: IFleet) {
cdkBuilder.fleet(fleet.let(IFleet.Companion::unwrap))
}
/**
* @param privileged Indicates how the project builds Docker images.
* 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.
*/
override fun privileged(privileged: Boolean) {
cdkBuilder.privileged(privileged)
}
public fun build(): software.amazon.awscdk.services.codebuild.BuildEnvironment =
cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.services.codebuild.BuildEnvironment,
) : CdkObject(cdkObject),
BuildEnvironment {
/**
* The image used for the builds.
*
* Default: LinuxBuildImage.STANDARD_1_0
*/
override fun buildImage(): IBuildImage? = unwrap(this).getBuildImage()?.let(IBuildImage::wrap)
/**
* The location of the PEM-encoded certificate for the build project.
*
* Default: - No external certificate is added to the project
*/
override fun certificate(): BuildEnvironmentCertificate? =
unwrap(this).getCertificate()?.let(BuildEnvironmentCertificate::wrap)
/**
* The type of compute to use for this build.
*
* See the `ComputeType` enum for the possible values.
*
* Default: taken from `#buildImage#defaultComputeType`
*/
override fun computeType(): ComputeType? = unwrap(this).getComputeType()?.let(ComputeType::wrap)
/**
* The environment variables that your builds can use.
*/
override fun environmentVariables(): Map =
unwrap(this).getEnvironmentVariables()?.mapValues{BuildEnvironmentVariable.wrap(it.value)}
?: emptyMap()
/**
* Fleet resource for a reserved capacity CodeBuild project.
*
* Fleets allow for process builds or tests to run immediately and reduces build durations,
* by reserving compute resources for your projects.
*
* You will be charged for the resources in the fleet, even if they are idle.
*
* Default: - No fleet will be attached to the project, which will remain on-demand.
*
* [Documentation](https://docs.aws.amazon.com/codebuild/latest/userguide/fleets.html)
*/
override fun fleet(): IFleet? = unwrap(this).getFleet()?.let(IFleet::wrap)
/**
* Indicates how the project builds Docker images.
*
* 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
*/
override fun privileged(): Boolean? = unwrap(this).getPrivileged()
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}): BuildEnvironment {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal fun wrap(cdkObject: software.amazon.awscdk.services.codebuild.BuildEnvironment):
BuildEnvironment = CdkObjectWrappers.wrap(cdkObject) as? BuildEnvironment ?:
Wrapper(cdkObject)
internal fun unwrap(wrapped: BuildEnvironment):
software.amazon.awscdk.services.codebuild.BuildEnvironment = (wrapped as
CdkObject).cdkObject as software.amazon.awscdk.services.codebuild.BuildEnvironment
}
}