LinuxArmBuildImage Class
A CodeBuild image running aarch64 Linux.
This class has a bunch of public constants that represent the CodeBuild ARM images.
You can also specify a custom image using the static method:
- LinuxBuildImage.fromEcrRepository(repo[, tag])
- LinuxBuildImage.fromDockerRegistry(image[, { secretsManagerCredentials }])
| Source | aws-codebuild/lib/linux-arm-build-image.ts |
|---|---|
| Type last changed |
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codebuild as codebuild } from 'aws-cdk-lib';
const linuxArmBuildImage = codebuild.LinuxArmBuildImage.fromCodeBuildImageId('id');
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_codebuild as codebuild
linux_arm_build_image = codebuild.LinuxArmBuildImage.from_code_build_image_id("id")
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.codebuild.*;
IBuildImage linuxArmBuildImage = LinuxArmBuildImage.fromCodeBuildImageId("id");
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CodeBuild;
var linuxArmBuildImage = LinuxArmBuildImage.FromCodeBuildImageId("id");
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
linuxArmBuildImage := awscdk.Aws_codebuild.LinuxArmBuildImage_FromCodeBuildImageId(jsii.String("id"))
Properties
AMAZON_LINUX_2_STANDARD_1_0IBuildImageAMAZON_LINUX_2_STANDARD_1_0IBuildImageAMAZON_LINUX_2_STANDARD_1_0IBuildImageAMAZON_LINUX_2_STANDARD_1_0IBuildImageAMAZON_LINUX_2_STANDARD_1_0IBuildImage static deprecated #Use {@link LinuxArmBuildImage.AMAZON_LINUX_2_STANDARD_3_0 } instead.
AMAZON_LINUX_2_STANDARD_2_0IBuildImageAMAZON_LINUX_2_STANDARD_2_0IBuildImageAMAZON_LINUX_2_STANDARD_2_0IBuildImageAMAZON_LINUX_2_STANDARD_2_0IBuildImageAMAZON_LINUX_2_STANDARD_2_0IBuildImage static #Image "aws/codebuild/amazonlinux2-aarch64-standard:2.0" based on Amazon Linux 2.
AMAZON_LINUX_2_STANDARD_3_0IBuildImageAMAZON_LINUX_2_STANDARD_3_0IBuildImageAMAZON_LINUX_2_STANDARD_3_0IBuildImageAMAZON_LINUX_2_STANDARD_3_0IBuildImageAMAZON_LINUX_2_STANDARD_3_0IBuildImage static #Image "aws/codebuild/amazonlinux2-aarch64-standard:3.0" based on Amazon Linux 2023.
AMAZON_LINUX_2023_STANDARD_2_0IBuildImageAMAZON_LINUX_2023_STANDARD_2_0IBuildImageAMAZON_LINUX_2023_STANDARD_2_0IBuildImageAMAZON_LINUX_2023_STANDARD_2_0IBuildImageAMAZON_LINUX_2023_STANDARD_2_0IBuildImage static #Image "aws/codebuild/amazonlinux-aarch64-standard:2.0" based on Amazon Linux 2023.
AMAZON_LINUX_2023_STANDARD_3_0IBuildImageAMAZON_LINUX_2023_STANDARD_3_0IBuildImageAMAZON_LINUX_2023_STANDARD_3_0IBuildImageAMAZON_LINUX_2023_STANDARD_3_0IBuildImageAMAZON_LINUX_2023_STANDARD_3_0IBuildImage static #Image "aws/codebuild/amazonlinux-aarch64-standard:3.0" based on Amazon Linux 2023.
AMAZON_LINUX_2023_STANDARD_4_0IBuildImageAMAZON_LINUX_2023_STANDARD_4_0IBuildImageAMAZON_LINUX_2023_STANDARD_4_0IBuildImageAMAZON_LINUX_2023_STANDARD_4_0IBuildImageAMAZON_LINUX_2023_STANDARD_4_0IBuildImage static #Image "aws/codebuild/amazonlinux-aarch64-standard:4.0" based on Amazon Linux 2023.
defaultComputeTypeComputeTypedefault_compute_typeComputeTypedefaultComputeTypeComputeTypeDefaultComputeTypeComputeTypeDefaultComputeTypeComputeType #The default `ComputeType` to use with this image, if one was not specified in `BuildEnvironment#computeType` explicitly.
The Docker image identifier that the build environment uses.
imagePullPrincipalTypemay be undefinedImagePullPrincipalTypeimage_pull_principal_typemay be undefinedImagePullPrincipalTypeimagePullPrincipalTypemay be undefinedImagePullPrincipalTypeImagePullPrincipalTypemay be undefinedImagePullPrincipalTypeImagePullPrincipalTypemay be undefinedImagePullPrincipalType #The type of principal that CodeBuild will use to pull this build Docker image.
repositorymay be undefinedIRepositoryrepositorymay be undefinedIRepositoryrepositorymay be undefinedIRepositoryRepositorymay be undefinedIRepositoryRepositorymay be undefinedIRepository #An optional ECR repository that the image is hosted in.
secretsManagerCredentialsmay be undefinedISecretsecrets_manager_credentialsmay be undefinedISecretsecretsManagerCredentialsmay be undefinedISecretSecretsManagerCredentialsmay be undefinedISecretSecretsManagerCredentialsmay be undefinedISecret #The secretsManagerCredentials for access to a private registry.
The type of build environment.
Methods
fromCodeBuildImageId(id: string): IBuildImage@staticmethod def from_code_build_image_id(id: str) -> IBuildImagepublic static IBuildImage fromCodeBuildImageId(String id)public static IBuildImage FromCodeBuildImageId(string id)func FromCodeBuildImageId(Id *string) IBuildImage static #Uses a Docker image provided by CodeBuild.
1 parameter · returns · example
Parameters
ididididId— The image identifier.
Returns: A Docker image provided by CodeBuild.
ts
'aws/codebuild/amazonlinux2-aarch64-standard:1.0'
fromDockerRegistry(name: string, options?: DockerImageOptions): IBuildImage@staticmethod def from_docker_registry(name: str, options: typing.Optional[DockerImageOptions] = None) -> IBuildImagepublic static IBuildImage fromDockerRegistry(String name, DockerImageOptions options)public static IBuildImage FromDockerRegistry(string name, DockerImageOptions? options = null)func FromDockerRegistry(Name *string, Options DockerImageOptions) IBuildImage static #returns
Returns: a aarch-64 Linux build image from a Docker Hub image.
fromEcrRepository(repository: IRepository, tagOrDigest?: string): IBuildImage@staticmethod def from_ecr_repository(repository: IRepository, tag_or_digest: typing.Optional[str] = None) -> IBuildImagepublic static IBuildImage fromEcrRepository(IRepository repository, String tagOrDigest)public static IBuildImage FromEcrRepository(IRepository repository, string? tagOrDigest = null)func FromEcrRepository(Repository IRepository, TagOrDigest *string) IBuildImage static #Returns an ARM image running Linux from an ECR repository.
NOTE: if the repository is external (i.e. imported), then we won't be able to add a resource policy statement for it so CodeBuild can pull the image.
2 parameters · returns
Parameters
repositoryrepositoryrepositoryrepositoryRepository— The ECR repository.tagOrDigesttag_or_digesttagOrDigesttagOrDigestTagOrDigest— Image tag or digest (default "latest", digests must start withsha256:).
Returns: An aarch64 Linux build image from an ECR repository.
runScriptBuildspec(entrypoint: string): BuildSpecdef run_script_buildspec(self, entrypoint: str) -> BuildSpecpublic BuildSpec runScriptBuildspec(String entrypoint)public BuildSpec RunScriptBuildspec(string entrypoint)func RunScriptBuildspec(Entrypoint *string) BuildSpec #Make a buildspec to run the indicated script.
validate(buildEnvironment: BuildEnvironment): string[]def validate(self, build_environment: BuildEnvironment) -> typing.List[str]public List<String> validate(BuildEnvironment buildEnvironment)public string[] Validate(BuildEnvironment buildEnvironment)func Validate(BuildEnvironment BuildEnvironment) *[]*string #Validates by checking the BuildEnvironments' images are not Lambda ComputeTypes.
1 parameter
Parameters
buildEnvironmentbuild_environmentbuildEnvironmentbuildEnvironmentBuildEnvironment— BuildEnvironment.