Interface IBuildImage
Represents a Docker image used for the CodeBuild Project builds.
Namespace: Amazon.CDK.AWS.CodeBuild
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IBuildImage
Syntax (vb)
Public Interface IBuildImage
Remarks
Use the concrete subclasses, either:
LinuxBuildImage
or WindowsBuildImage
.
Synopsis
Properties
DefaultComputeType | The default |
ImageId | The Docker image identifier that the build environment uses. |
ImagePullPrincipalType | The type of principal that CodeBuild will use to pull this build Docker image. |
Repository | An optional ECR repository that the image is hosted in. |
SecretsManagerCredentials | The secretsManagerCredentials for access to a private registry. |
Type | The type of build environment. |
Methods
RunScriptBuildspec(String) | Make a buildspec to run the indicated script. |
Validate(IBuildEnvironment) | Allows the image a chance to validate whether the passed configuration is correct. |
Properties
DefaultComputeType
The default ComputeType
to use with this image, if one was not specified in BuildEnvironment#computeType
explicitly.
ComputeType DefaultComputeType { get; }
Property Value
ImageId
The Docker image identifier that the build environment uses.
string ImageId { get; }
Property Value
System.String
Remarks
ImagePullPrincipalType
The type of principal that CodeBuild will use to pull this build Docker image.
virtual Nullable<ImagePullPrincipalType> ImagePullPrincipalType { get; }
Property Value
System.Nullable<ImagePullPrincipalType>
Remarks
Default: ImagePullPrincipalType.SERVICE_ROLE
Repository
An optional ECR repository that the image is hosted in.
virtual IRepository Repository { get; }
Property Value
Remarks
Default: no repository
SecretsManagerCredentials
The secretsManagerCredentials for access to a private registry.
virtual ISecret SecretsManagerCredentials { get; }
Property Value
Remarks
Default: no credentials will be used
Type
The type of build environment.
string Type { get; }
Property Value
System.String
Methods
RunScriptBuildspec(String)
Make a buildspec to run the indicated script.
BuildSpec RunScriptBuildspec(string entrypoint)
Parameters
- entrypoint System.String
Returns
Validate(IBuildEnvironment)
Allows the image a chance to validate whether the passed configuration is correct.
string[] Validate(IBuildEnvironment buildEnvironment)
Parameters
- buildEnvironment IBuildEnvironment
the current build environment.
Returns
System.String[]