Package software.amazon.awscdk.services.codebuild

Interface IBindableBuildImage.Jsii$Default

All Superinterfaces:

IBindableBuildImage, IBuildImage, IBuildImage.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IBindableBuildImage.Jsii$Proxy

Enclosing interface:

IBindableBuildImage

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

Internal default implementation for IBindableBuildImage.

Nested Class Summary

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

IBindableBuildImage.Jsii$Default, IBindableBuildImage.Jsii$Proxy

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 BuildImageConfig	bind(software.constructs.Construct scope, IProject project, BuildImageBindOptions options)	Function that allows the build image access to the construct tree.
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

Specified by:

getDefaultComputeType in interface IBuildImage.Jsii$Default

getImageId

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

The Docker image identifier that the build environment uses.

Specified by:

getImageId in interface IBuildImage

Specified by:

getImageId in interface IBuildImage.Jsii$Default

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

Specified by:

getType in interface IBuildImage.Jsii$Default

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

Specified by:

getImagePullPrincipalType in interface IBuildImage.Jsii$Default

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

Specified by:

getRepository in interface IBuildImage.Jsii$Default

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

Specified by:

getSecretsManagerCredentials in interface IBuildImage.Jsii$Default

runScriptBuildspec

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

Make a buildspec to run the indicated script.

Specified by:

runScriptBuildspec in interface IBuildImage

Specified by:

runScriptBuildspec in interface IBuildImage.Jsii$Default

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

Specified by:

validate in interface IBuildImage.Jsii$Default

Parameters:

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

bind

@Stability(Stable)
@NotNull
default BuildImageConfig bind(@NotNull
 software.constructs.Construct scope,
 @NotNull
 IProject project,
 @NotNull
 BuildImageBindOptions options)

Function that allows the build image access to the construct tree.

Specified by:

bind in interface IBindableBuildImage

Parameters:

scope - This parameter is required.

project - This parameter is required.

options - This parameter is required.