Package software.amazon.awscdk.services.codebuild

Interface IBuildImage.Jsii$Default

All Superinterfaces:

IBuildImage, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IBindableBuildImage.Jsii$Default

All Known Implementing Classes:

IBindableBuildImage.Jsii$Proxy, IBuildImage.Jsii$Proxy

Enclosing interface:

IBuildImage

@Internal
public static interface IBuildImage.Jsii$Default
extends IBuildImage

Internal default implementation for IBuildImage.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.codebuild.IBuildImage

IBuildImage.Jsii$Default, IBuildImage.Jsii$Proxy

Method Summary

Modifier and Type	Method	Description
default ComputeType	getDefaultComputeType()	The default ComputeType to use with this image, if one was not specified in BuildEnvironment#computeType explicitly.
default String	getImageId()	The Docker image identifier that the build environment uses.
default ImagePullPrincipalType	getImagePullPrincipalType()	The type of principal that CodeBuild will use to pull this build Docker image.
default IRepository	getRepository()	An optional ECR repository that the image is hosted in.
default ISecret	getSecretsManagerCredentials()	The secretsManagerCredentials for access to a private registry.
default String	getType()	The type of build environment.
default BuildSpec	runScriptBuildspec(String entrypoint)	Make a buildspec to run the indicated script.
default List<String>	validate(BuildEnvironment buildEnvironment)	Allows the image a chance to validate whether the passed configuration is correct.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDefaultComputeType

@Stability(Stable)
@NotNull
default ComputeType getDefaultComputeType()

The default ComputeType to use with this image, if one was not specified in BuildEnvironment#computeType explicitly.

Specified by:

getDefaultComputeType in interface IBuildImage

getImageId

@Stability(Stable)
@NotNull
default String getImageId()

The Docker image identifier that the build environment uses.

Specified by:

getImageId in interface IBuildImage

See Also:

• https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html

getType

@Stability(Stable)
@NotNull
default String getType()

The type of build environment.

Specified by:

getType in interface IBuildImage

getImagePullPrincipalType

@Stability(Stable)
@Nullable
default ImagePullPrincipalType getImagePullPrincipalType()

The type of principal that CodeBuild will use to pull this build Docker image.

Default: ImagePullPrincipalType.SERVICE_ROLE

Specified by:

getImagePullPrincipalType in interface IBuildImage

getRepository

@Stability(Stable)
@Nullable
default IRepository getRepository()

An optional ECR repository that the image is hosted in.

Default: no repository

Specified by:

getRepository in interface IBuildImage

getSecretsManagerCredentials

@Stability(Stable)
@Nullable
default ISecret getSecretsManagerCredentials()

The secretsManagerCredentials for access to a private registry.

Default: no credentials will be used

Specified by:

getSecretsManagerCredentials in interface IBuildImage

runScriptBuildspec

@Stability(Stable)
@NotNull
default BuildSpec runScriptBuildspec(@NotNull
 String entrypoint)

Make a buildspec to run the indicated script.

Specified by:

runScriptBuildspec in interface IBuildImage

Parameters:

entrypoint - This parameter is required.

validate

@Stability(Stable)
@NotNull
default List<String> validate(@NotNull
 BuildEnvironment buildEnvironment)

Allows the image a chance to validate whether the passed configuration is correct.

Specified by:

validate in interface IBuildImage

Parameters:

buildEnvironment - the current build environment. This parameter is required.